Enable Sync testing in GitLab CI

Add a tag that disables/skips Sync tests when the build is not a 'Sync' variant.

Author: Shubham

.gitlab-ci.yml

@@ -27,6 +27,22 @@ build:
     paths:
       - dist/*.whl
 
+# Build the Sync version of the package
+build-sync:
+  tags: [ x64, docker, linux ]
+  image: python:latest
+  stage: build
+  script:
+    - python -m pip install --upgrade pip
+    # Using released C library (Sync version)
+    - make depend-sync
+    - make test
+    - make build-sync
+  artifacts:
+    expire_in: 1 days
+    paths:
+      - dist/*.whl
+
 # Next, test the packaged wheel built by "build"
 .test:
   stage: test
@@ -72,3 +88,49 @@ test:windows:x64:
   tags: [windows, x64, python]
   variables:
     PYTHON: "python.exe"
+
+# Sync version test jobs
+.test-sync:
+  stage: test
+  needs: [ build-sync ]
+  script:
+    - pip3 install --user pytest
+    - rm -r objectbox  # todo this is ugly; let's copy required files in a sub-folder instead?
+    - pip3 install --user --force-reinstall dist/*.whl  # Artifacts from build-sync
+    - ${PYTHON} -m pytest --runsync
+  variables:
+    PYTHON: "python3"
+
+test-sync:linux:x64:
+  extends: .test-sync
+  tags: [ x64, docker, linux ]
+  image: python:$PYTHON_VERSION
+  parallel:
+    matrix:
+      - PYTHON_VERSION: [ '3.7', '3.8', '3.9', '3.10', '3.11', '3.12' ]
+
+test-sync:linux:armv7hf:
+  extends: .test-sync
+  tags: [ armv7hf, shell, linux, python3 ]
+
+test-sync:linux:aarch64:
+  extends: .test-sync
+  tags: [ aarch64, shell, linux, python3 ]
+
+test-sync:mac:x64:
+  extends: .test-sync
+  script:
+    - python3 -m venv .venv
+    - source .venv/bin/activate
+    - python3 -m pip install pytest
+    - rm -r objectbox  # todo this is ugly; let's copy required files in a sub-folder instead?
+    - pip3 install --force-reinstall dist/*.whl  # Artifacts from build-sync
+    - python -m pytest --runsync
+  tags: [ mac, x64, shell, python3 ]
+
+test-sync:windows:x64:
+  extends: .test-sync
+  tags: [ windows, x64, python ]
+  variables:
+    PYTHON: "python.exe"
+

tests/conftest.py

@@ -1,7 +1,5 @@
-import pytest
-from objectbox.logger import logger
-from objectbox.sync import SyncLoginListener, SyncConnectionListener, SyncErrorListener, SyncClient, SyncCredentials
 from common import *
+from objectbox.sync import SyncLoginListener, SyncConnectionListener, SyncErrorListener, SyncClient, SyncCredentials
 
 
 # Fixtures in this file are used by all files in the same directory:
@@ -95,3 +93,22 @@ def sync_server():
     yield server_config
     if server_config:
         stop_sync_server(server_config.container_id)
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--runsync", action="store_false", default=False, help="run Sync tests"
+    )
+
+
+def pytest_configure(config):
+    config.addinivalue_line("markers", "sync: run Sync tests")
+
+
+def pytest_collection_modifyitems(config, items):
+    if config.getoption("--runsync"):
+        return
+    skip_sync = pytest.mark.skip(reason="need --runsync option to run")
+    for item in items:
+        if "sync" in item.keywords:
+            item.add_marker(skip_sync)

tests/test_sync.py

@@ -6,11 +6,13 @@
 from objectbox.sync import *
 
 
+@pytest.mark.sync
 def test_sync_protocol_version():
     version = SyncClient.protocol_version()
     assert version >= 1
 
 
+@pytest.mark.sync
 def test_sync_client_states(sync_client):
     assert sync_client.get_sync_state() == SyncState.CREATED
     sync_client.start()
@@ -20,6 +22,7 @@ def test_sync_client_states(sync_client):
     sync_client.close()
 
 
+@pytest.mark.sync
 def test_sync_listener(sync_server, sync_client, login_listener, connection_listener):
     if not sync_server:
         pytest.skip("Sync server not available")
@@ -34,6 +37,7 @@ def test_sync_listener(sync_server, sync_client, login_listener, connection_list
     assert connection_listener.connected_called
 
 
+@pytest.mark.sync
 def test_filter_variables(test_store):
     server_urls = ["ws://localhost:9999"]
 
@@ -54,6 +58,7 @@ def test_filter_variables(test_store):
     client.close()
 
 
+@pytest.mark.sync
 def test_outgoing_message_count(sync_client):
     count = sync_client.get_outgoing_message_count()
     assert count == 0
@@ -67,6 +72,7 @@ def test_outgoing_message_count(sync_client):
         sync_client.get_outgoing_message_count()
 
 
+@pytest.mark.sync
 def test_multiple_credentials(sync_client):
     # empty list should raise ValueError
     with pytest.raises(ValueError, match='Provide at least one credential'):
@@ -87,17 +93,20 @@ def test_multiple_credentials(sync_client):
     ])
 
 
+@pytest.mark.sync
 def test_client_closed_when_store_closed(test_store, sync_client):
     assert not sync_client.is_closed()
     test_store.close()
     assert sync_client.is_closed()
 
 
+@pytest.mark.sync
 def assert_raises_value_error(fn: Callable[[], object | None], message: str | None = None):
     with pytest.raises(ValueError, match=message):
         fn()
 
 
+@pytest.mark.sync
 def test_client_access_after_close_throws_error(sync_client):
     sync_client.close()