Fix tests by adding a mock OIDC provider server to the e2e tests

 * Add mock OIDC provider server to the GitLab pipeline
 * Add check connection script to the start of the service

#10

.gitlab-ci.yml

@@ -25,7 +25,7 @@ before_script:
   - python -m pip install -r requirements.txt
   - python -m pip install -r requirements-dev.txt
 
-stages:          # List of stages for jobs, and their order of execution
+stages: # List of stages for jobs, and their order of execution
 #  - build
   - test
 #  - deploy
@@ -36,8 +36,8 @@ stages:          # List of stages for jobs, and their order of execution
 #    - echo "Compiling the code..."
 #    - echo "Compile complete."
 
-integration-test-job:   # This job runs in the test stage.
-  stage: test    # It only starts when the job in the build stage completes successfully.
+integration-test-job: # Runs integration tests with the database
+  stage: test
   variables:
     DB_PASSWORD: "$TEST_DB_PASSWORD"
     DB_USER: "test_api_user"
@@ -64,13 +64,16 @@ integration-test-job:   # This job runs in the test stage.
     reports:
       junit: $BASE_DIR/integration-report.xml
 
-e2e-test-job:   # This job runs in the test stage.
-  stage: test    # It only starts when the job in the build stage completes successfully.
+e2e-test-job: # Runs e2e tests on the API endpoints
+  stage: test
   variables:
     DB_PASSWORD: "$TEST_DB_PASSWORD"
     DB_USER: "test_api_user"
     DB_DATABASE: "e2e-test-db"
     DB_HOST: "e2e-test-db"
+    OIDC_CLIENT_SECRET: "$TEST_OIDC_CLIENT_SECRET"
+    OIDC_CLIENT_ID: "$TEST_OIDC_CLIENT_ID"
+    OIDC_BASE_URI: "http://mock-oidc-server"
   services:
     - name: mysql:8
       alias: e2e-test-db
@@ -79,8 +82,14 @@ e2e-test-job:   # This job runs in the test stage.
         MYSQL_DATABASE: "$DB_DATABASE"
         MYSQL_USER: "$DB_USER"
         MYSQL_PASSWORD: "$DB_PASSWORD"
+    - name: ghcr.io/soluto/oidc-server-mock:latest
+      alias: mock-oidc-server
+      variables:
+        ASPNETCORE_ENVIRONMENT: "Development"
+        CLIENTS_CONFIGURATION_INLINE: "$TEST_OIDC_CLIENT_CONFIGURATION"
   script:
     - python app/check_database_connection.py
+    - python app/check_oidc_connection.py
     - alembic downgrade base
     - alembic upgrade head
     - pytest --junitxml=e2e-report.xml --cov=app --cov-report=term-missing app/tests/api
@@ -92,8 +101,8 @@ e2e-test-job:   # This job runs in the test stage.
     reports:
       junit: $BASE_DIR/e2e-report.xml
 
-unit-test-job:   # This job runs in the test stage.
-  stage: test    # It only starts when the job in the build stage completes successfully.
+unit-test-job: # Runs unit tests
+  stage: test
   script:
     - pytest --junitxml=unit-report.xml --noconftest --cov=app --cov-report=term-missing app/tests/unit
     - mkdir coverage-unit
@@ -104,7 +113,7 @@ unit-test-job:   # This job runs in the test stage.
     reports:
       junit: $BASE_DIR/unit-report.xml
 
-combine-test-coverage-job:   # Combine coverage reports from different test jobs
+combine-test-coverage-job: # Combine coverage reports from different test jobs
   stage: test
   needs:
     - job: "e2e-test-job"
@@ -125,8 +134,8 @@ combine-test-coverage-job:   # Combine coverage reports from different test jobs
         coverage_format: cobertura
         path: $CI_PROJECT_DIR/coverage.xml
 
-lint-test-job:   # This job also runs in the test stage.
-  stage: test    # It can run at the same time as unit-test-job (in parallel).
+lint-test-job: # Runs linters checks on code
+  stage: test
   script:
     - ./scripts/lint.sh
 

ProxyAPI/app/check_oidc_connection.py

+import logging
+
+import httpx
+from tenacity import after_log, before_log, retry, stop_after_attempt, wait_fixed
+
+from app.core.config import settings
+
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+max_tries = 60 * 3  # 3 minutes
+wait_seconds = 2
+
+
+@retry(
+    stop=stop_after_attempt(max_tries),
+    wait=wait_fixed(wait_seconds),
+    before=before_log(logger, logging.INFO),
+    after=after_log(logger, logging.WARN),
+)
+def init() -> None:
+    try:
+        httpx.get(settings.OIDC_BASE_URI + settings.OIDC_META_INFO_PATH, timeout=5.0)
+    except Exception as e:
+        logger.error(e)
+        raise e
+
+
+def main() -> None:
+    logger.info("Check OIDC Provider connection")
+    init()
+    logger.info("OIDC Provider connection established")
+
+
+if __name__ == "__main__":
+    main()

ProxyAPI/pyproject.toml

@@ -20,6 +20,7 @@ omit = [
     "app/tests/*",
     "app/check_database_connection.py",
     "app/check_ceph_connection.py",
+    "app/check_oidc_connection.py",
     "app/db/base*",
     "app/core/config.py",
     "app/main.py"

ProxyAPI/start_service.sh

@@ -2,6 +2,8 @@
 
 # Check Connection to Ceph RGW
 python app/check_ceph_connection.py
+# Check Connection to OIDC provider
+python app/check_oidc_connection.py
 # Let the DB start
 python app/check_database_connection.py