Restrict the individual test execution time

Normally, individual tests should not take longer than 1 second, preferably closer to 0 seconds. Some selected tests, however, are slow by their nature (e.g. ngrok or kopf-runner) — so they take around 1-2 seconds. But this limit is only applicable to CI — not to local dev-mode runs, where breakpoints and infinite pauses are needed. This change should prevent the test-runs from being stuck at one single test if the test is designed improperly or because of the environment issues. This removes the need to keep the timing safeguards inside the tests, which complicates the tests themselves (e.g. with `async-timeout`) — unless such safe-guards are a part of the test design. Signed-off-by: Sergey Vasilyev <nolar@nolar.info>
nolar · Dec 25, 2021 · ae3411f · ae3411f
1 parent 2564558
commit ae3411f
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -51,7 +51,7 @@ jobs:
       - run: pip install -r requirements.txt
       - run: pip install -e .[${{ matrix.install-extras }}]
         if: ${{ matrix.install-extras }}
-      - run: pytest --color=yes --cov=kopf --cov-branch
+      - run: pytest --color=yes --timeout=2 --cov=kopf --cov-branch
 
       - name: Publish coverage to Coveralls.io
         if: success()
@@ -94,7 +94,7 @@ jobs:
       - run: pip install -r requirements.txt
       - run: pip install -e .[${{ matrix.install-extras }}]
         if: ${{ matrix.install-extras }}
-      - run: pytest --color=yes --no-cov
+      - run: pytest --color=yes --timeout=2 --no-cov
 
   functional:
     strategy:
@@ -114,7 +114,7 @@ jobs:
           version: ${{ matrix.k3s }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
       - run: pip install -r requirements.txt -r examples/requirements.txt
-      - run: pytest --color=yes --only-e2e
+      - run: pytest --color=yes --timeout=10 --only-e2e
 
   coveralls-finish:
     name: Finalize coveralls.io

diff --git a/.github/workflows/thorough.yaml b/.github/workflows/thorough.yaml
@@ -55,7 +55,7 @@ jobs:
       - run: pip install -r requirements.txt
       - run: pip install -e .[${{ matrix.install-extras }}]
         if: ${{ matrix.install-extras }}
-      - run: pytest --color=yes --cov=kopf --cov-branch
+      - run: pytest --color=yes --timeout=2 --cov=kopf --cov-branch
 
       - name: Publish coverage to Coveralls.io
         if: success()
@@ -98,7 +98,7 @@ jobs:
       - run: pip install -r requirements.txt
       - run: pip install -e .[${{ matrix.install-extras }}]
         if: ${{ matrix.install-extras }}
-      - run: pytest --color=yes --no-cov
+      - run: pytest --color=yes --timeout=2 --no-cov
 
   functional:
     strategy:
@@ -118,7 +118,7 @@ jobs:
           version: ${{ matrix.k3s }}
           github-token: ${{ secrets.GITHUB_TOKEN }}
       - run: pip install -r requirements.txt -r examples/requirements.txt
-      - run: pytest --color=yes --only-e2e
+      - run: pytest --color=yes --timeout=10 --only-e2e
 
   full-scale:
     strategy:
@@ -137,7 +137,7 @@ jobs:
           python-version: "3.10"
       - run: tools/install-minikube.sh
       - run: pip install -r requirements.txt -r examples/requirements.txt
-      - run: pytest --color=yes --only-e2e
+      - run: pytest --color=yes --timeout=10 --only-e2e
 
   coveralls-finish:
     name: Finalize coveralls.io

diff --git a/pytest.ini b/pytest.ini
@@ -0,0 +1,3 @@
+[pytest]
+addopts =
+    --strict-markers
diff --git a/requirements.txt b/requirements.txt
@@ -23,5 +23,6 @@ pytest-aiohttp
 pytest-asyncio
 pytest-cov
 pytest-mock
+pytest-timeout
 types-pkg_resources
 types-PyYAML