#53 Separated Long running tests (v2)

.github/workflows/check-api-outdated.yml

@@ -13,7 +13,6 @@ on:
     # “At 4 am on every day.” (https://crontab.guru)
     - cron: "0 4 * * *"
 
-
 jobs:
 
   check-api-outdated:

.github/workflows/checks.yml

@@ -9,14 +9,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-
       - name: SCM Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0
 
       - name: Check Version(s)
         run: poetry run version-check version.py
@@ -80,36 +79,13 @@ jobs:
         run: poetry run nox -s type-check
 
   tests-job:
-    name: Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
+    name: Tests (Python-${{ matrix.python-version }})
     needs: [build-documentation-job, lint-job, type-check-job]
-    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
         python-version: ["3.10"]
-        exasol-version: ["7.1.9"]
-
-    steps:
-      - name: SCM Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/[email protected]
-        with:
-          python-version: ${{ matrix.python-version }}
-
-      - name: Run Tests and Calculate Coverage
-        env:
-          SAAS_HOST: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_HOST }}
-          SAAS_ACCOUNT_ID: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_ACCOUNT_ID }}
-          SAAS_PAT: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_PAT }}
-          PYTEST_ADDOPTS: -o log_cli=true -o log_cli_level=INFO
-        run: |
-          export PROJECT_SHORT_TAG=$(poetry run nox -s get-project-short-tag)
-          poetry run nox -s coverage -- --
-
-      - name: Upload Artifacts
-        uses: actions/upload-artifact@v3
-        with:
-          name: .coverage
-          path: .coverage
+    uses: ./.github/workflows/run-tests.yml
+    secrets: inherit
+    with:
+      python-version: ${{ matrix.python-version }}

.github/workflows/ci.yml

@@ -23,3 +23,28 @@ jobs:
   metrics:
     needs: [ ci-job ]
     uses: ./.github/workflows/report.yml
+
+  gate-1:
+    name: Regular
+    needs: [ ci-job ]
+    steps:
+      step:
+        - name: Branch Protection
+          run: true
+
+  slow-tests:
+    uses: ./.github/workflows/run-tests.yml
+    secrets: inherit
+    with:
+      slow-tests: true
+      python-version: "3.10"
+    environment:
+      slow-tests
+
+  gate-2:
+    name: Merge
+    needs: [ slow-tests ]
+    steps:
+      step:
+        - name: Branch Protection
+          run: true

.github/workflows/run-tests.yml

@@ -0,0 +1,47 @@
+name: Run Tests
+
+on:
+  workflow_call:
+    inputs:
+      slow-tests:
+        type: boolean
+        default: false
+      python-version:
+        type: string
+        required: true
+
+jobs:
+
+  tests-job:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set pytest markers
+        id: pytest-markers
+        if: ${{ ! inputs.slow-tests }}
+        run: echo slow-tests='-m "not slow"' >> "$GITHUB_OUTPUT"
+
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          python-version: ${{ inputs.python-version }}
+
+      - name: Run Tests and Calculate Coverage
+        env:
+          SAAS_HOST: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_HOST }}
+          SAAS_ACCOUNT_ID: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_ACCOUNT_ID }}
+          SAAS_PAT: ${{ secrets.INTEGRATION_TEAM_SAAS_STAGING_PAT }}
+          PYTEST_ADDOPTS: '-o log_cli=true -o log_cli_level=INFO ${{ steps.pytest-markers.outputs.slow-tests }}'
+        run: |
+          echo "PYTEST_ADDOPTS = $PYTEST_ADDOPTS"
+          export PROJECT_SHORT_TAG=$(poetry run nox -s get-project-short-tag)
+          poetry run nox -s coverage -- --
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: .coverage
+          path: .coverage

doc/changes/unreleased.md

@@ -1,4 +1,9 @@
 # Unreleased
 
+## Refactoring
+
+* #53: Separated long-running tests
+
 ## Features
-    - #55 Added publicly callable function finding the database id from its name.
+
+* #55 Added publicly callable function finding the database id from its name.

doc/developer_guide/developer_guide.md

@@ -58,6 +58,8 @@ After generating the API,
 
 ## Run Tests
 
+### Integration Tests
+
 Executing the integration tests requires the following environment variables to be set:
 
 | Variable          | Description                                           |
@@ -66,6 +68,12 @@ Executing the integration tests requires the following environment variables to
 | `SAAS_ACCOUNT_ID` | ID of the Exasol SAAS account to be used by the tests |
 | `SAAS_PAT`        | Personal access token to access the SAAS API          |
 
+### Slow Tests
+
+Some of the test cases verify connecting to a SaaS database instance and execution will take about 20 minutes.
+
+These test cases are disabled by default and will only be executed by adding a comment `[run-slow-tests]` to your pull request.
+
 ## Creating a Release
 
 ### Prepare the Release