skip some stateful tests from CI runs

Author: tbarbugli

README.md

@@ -121,6 +121,21 @@ uv run ruff format getstream/ tests/
 
 pytest is used to run tests and to inject fixtures, simple tests can be written as simple python functions making assert calls. Make sure to have a look at the available test fixtures under `tests/fixtures.py`
 
+#### Skipping Tests in CI
+
+Some tests may not be suitable for running in a CI environment (GitHub Actions). To skip a test in CI, use the `@pytest.mark.skip_in_ci` decorator:
+
+```python
+import pytest
+
+@pytest.mark.skip_in_ci
+def test_something():
+    # This test will be skipped when running in GitHub Actions
+    ...
+```
+
+The test will run normally in local development environments but will be automatically skipped when running in GitHub Actions.
+
 ### Generate code from spec
 
 To regenerate the Python source from OpenAPI, just run the `./generate.sh` script from this repo.

tests/conftest.py

@@ -1,4 +1,5 @@
 import pytest
+import os
 from dotenv import load_dotenv
 from tests.fixtures import client, call, get_user, shared_call
 
@@ -8,3 +9,23 @@
 @pytest.fixture(scope="session", autouse=True)
 def load_env():
     load_dotenv()
+
+
+def pytest_configure(config):
+    """Register custom markers."""
+    config.addinivalue_line(
+        "markers", "skip_in_ci: mark test to skip when running in CI"
+    )
+
+
+def is_running_in_github_actions():
+    """Check if the tests are running in GitHub Actions CI."""
+    return os.environ.get("GITHUB_ACTIONS") == "true"
+
+
+def pytest_runtest_setup(item):
+    """Skip tests marked with skip_in_ci when running in GitHub Actions."""
+    if is_running_in_github_actions():
+        skip_in_ci_marker = item.get_closest_marker("skip_in_ci")
+        if skip_in_ci_marker is not None:
+            pytest.skip("Test skipped in CI environment")

tests/test_video_examples.py

@@ -297,6 +297,7 @@ def test_create_call_with_custom_session_inactivity_timeout(call: Call):
     assert response.data.call.settings.session.inactivity_timeout_seconds == 5
 
 
+@pytest.mark.skip_in_ci
 def test_create_call_type_with_custom_session_inactivity_timeout(client: Stream):
     # create a call type with a session inactivity timeout of 5 minutes
     response = client.video.create_call_type(
@@ -358,6 +359,7 @@ def test_create_call_with_custom_frame_recording_settings(client: Stream):
     assert response.data.call.settings.frame_recording.quality == "1080p"
 
 
+@pytest.mark.skip_in_ci
 def test_create_call_type_with_custom_frame_recording_settings(client: Stream):
     # create a call type with frame recording settings
     response = client.video.create_call_type(

tests/test_video_integration.py

@@ -103,6 +103,7 @@ def test_teams(client: Stream):
     assert len(response.data.calls) > 0
 
 
+@pytest.mark.skip_in_ci
 class TestCallTypes:
     def test_creating_storage_with_reserved_name_should_fail(self, client: Stream):
         with pytest.raises(Exception) as exc_info:
@@ -290,6 +291,7 @@ def test_custom_recording_website(self, client: Stream):
             ),
         )
 
+    @pytest.mark.skip_in_ci
     def test_delete_call_type(self, client: Stream):
         try:
             response = client.video.delete_call_type(name=CALL_TYPE_NAME)