test: add e2e tests for API gateway

Author: cyclimse

.github/workflows/integration-gateway.yml

@@ -0,0 +1,29 @@
+---
+name: Integration tests with Pytest
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  integration-gateway:
+    runs-on: self-hosted
+    container: nikolaik/python-nodejs:python3.10-nodejs18
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: ./.github/actions/setup-poetry
+
+      - name: Test with pytest
+        working-directory: tests
+        run: poetry run pytest integrations/gateway -n $(nproc --all)
+        env:
+          SCW_DEFAULT_ORGANIZATION_ID: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }}
+          SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}
+          SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }}
+          API_GATEWAY_S3_BUCKET: ${{ secrets.API_GATEWAY_S3_BUCKET }}

.github/workflows/pytest-integration.yml

@@ -1,5 +1,5 @@
 ---
-name: Integration tests with Pytest
+name: API Gateway integration tests with Pytest
 
 on:
   push:
@@ -28,7 +28,7 @@ jobs:
 
       - name: Test with pytest
         working-directory: tests
-        run: poetry run pytest integrations -n $(nproc --all)
+        run: poetry run pytest integrations -n $(nproc --all) --ignore=integrations/gateway
         env:
           SCW_DEFAULT_ORGANIZATION_ID: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }}
           SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}

poetry.lock

@@ -51,6 +51,7 @@ pytest-xdist = "^3.1.0"
 pylint = "^2.15.10"
 pylint-per-file-ignores = "^1.1.0"
 responses = ">=0.22,<0.24"
+boto3 = "^1.26.97"
 
 [tool.poetry.group.doc]
 optional = true
@@ -72,7 +73,7 @@ disable = "missing-module-docstring"
 # Commented Black formatted code.
 max-line-length = 89
 # Short and common names. e is commonly used for exceptions.
-good-names = "i,fp,e"
+good-names = "e,fp,i,s,s3"
 # Classes with a single responsibility are fine.
 min-public-methods = 1
 

pyproject.toml

@@ -98,7 +98,7 @@ def deploy(
     backend: Literal["api", "serverless"],
     single_source: bool,
     gateway_url: Optional[str] = None,
-    gayeway_api_key: Optional[str] = None,
+    gateway_api_key: Optional[str] = None,
     profile_name: Optional[str] = None,
     secret_key: Optional[str] = None,
     project_id: Optional[str] = None,
@@ -143,7 +143,7 @@ def deploy(
         raise RuntimeError(
             "Your application requires an API Gateway but no gateway URL was provided"
         )
-    if not gayeway_api_key:
+    if not gateway_api_key:
         raise RuntimeError(
             "Your application requires an API Gateway but "
             + "no gateway API key was provided to manage routes"
@@ -152,7 +152,7 @@ def deploy(
     manager = GatewayManager(
         app_instance=app_instance,
         gateway_url=gateway_url,
-        gateway_api_key=gayeway_api_key,
+        gateway_api_key=gateway_api_key,
         sdk_client=client,
     )
     manager.update_routes()

scw_serverless/cli.py

@@ -2,6 +2,7 @@
 import pathlib
 import subprocess
 import sys
+from importlib.metadata import version
 from typing import Optional
 
 from scw_serverless.logger import get_logger
@@ -71,7 +72,8 @@ def _check_for_scw_serverless(self):
             not self.pkg_path.exists()
             or not self.pkg_path.joinpath(__package__).exists()
         ):
-            self._run_pip_install("scw_serverless")
+            # Installs the current version with pip
+            self._run_pip_install(f"{__package__}=={version(__package__)}")
 
     def _run_pip_install(self, *args: str):
         python_path = sys.executable
@@ -84,6 +86,7 @@ def _run_pip_install(self, *args: str):
             "--target",
             str(self.pkg_path.resolve()),
         ]
+        print(command)
         try:
             subprocess.run(
                 command,

scw_serverless/dependencies_manager.py

@@ -3,18 +3,22 @@
 from scw_serverless.app import Serverless
 
 NAMESPACE_NAME = "integration-tests-gateway"
+MESSAGES = {
+    "/health": "I'm fine!",
+    "/messages": "Could not find any message",
+}
 
 app = Serverless(NAMESPACE_NAME)
 
 
 @app.get(url="/health")
 def health(_event: dict[str, Any], _context: dict[str, Any]):
-    return "I'm fine!"
+    return MESSAGES["/health"]
 
 
 @app.get(url="/messages")
 def get_messages(_event: dict[str, Any], _context: dict[str, Any]):
-    return "Could not find any message"
+    return MESSAGES["/messages"]
 
 
 @app.post(url="/messages/new")

scw_serverless/version.py

@@ -9,6 +9,15 @@
 
 COLD_START_TIMEOUT = 20
 
+API_GATEWAY_IMAGE_TAG = "0.0.5"
+API_GATEWAY_IMAGE = (
+    f"registry.hub.docker.com/shillakerscw/scw-sls-gw:{API_GATEWAY_IMAGE_TAG}"
+)
+API_GATEWAY_MEMORY_LIMIT = 2048
+API_GATEWAY_S3_REGION = REGION_FR_PAR
+API_GATEWAY_S3_BUCKET_ENDPOINT = f"https://s3.{REGION_FR_PAR}.scw.cloud"
+API_GATEWAY_S3_BUCKET = os.getenv("API_GATEWAY_S3_BUCKET")
+
 TESTS_DIR = os.path.realpath(os.path.dirname(__file__))
 
 APP_FIXTURES_PATH = Path(TESTS_DIR, "app_fixtures")

tests/app_fixtures/routed_functions.py

@@ -1,10 +1,12 @@
 # pylint: disable=unused-import,redefined-outer-name # fixture
 
+import time
+
 import scaleway.function.v1beta1 as sdk
 
 from tests import constants
 from tests.app_fixtures import app, app_updated, multiple_functions
-from tests.integrations.deploy.deploy_wrapper import run_deploy_command
+from tests.integrations.deploy_wrapper import run_deploy_command
 from tests.integrations.project_fixture import scaleway_project  # noqa
 from tests.integrations.utils import create_client, trigger_function
 
@@ -50,9 +52,8 @@ def test_integration_deploy_existing_function(scaleway_project: str):  # noqa
         app_path=constants.APP_FIXTURES_PATH / "app_updated.py",
     )
 
-    import time
-
-    time.sleep(60)
+    # TODO?: delete this
+    time.sleep(30)
 
     # Check updated message content
     resp = trigger_function(url)