Check type of test-utils in CI

Author: cbornet

.github/workflows/ci-unit-tests.yml

@@ -89,6 +89,9 @@ jobs:
       - name: "Type check (knowledge-store)"
         run: tox -e type -c libs/knowledge-store && rm -rf libs/knowledge-store/.tox
 
+      - name: "Type check (test-utils)"
+        run: tox -e type -c libs/tests-utils && rm -rf libs/tests-utils/.tox
+
   unit-tests:
     name: Unit Tests (Python ${{ matrix.python-version }})
     needs: ["preconditions"]

libs/tests-utils/pyproject.toml

@@ -16,6 +16,22 @@ testcontainers = "^3.7.1"
 requests = "^2.32.2"
 pytest = "^7.3.0"
 
-
 [tool.poetry.group.dev.dependencies]
-setuptools = "^70.0.0"
+mypy = "^1.10.0"
+
+[tool.mypy]
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+follow_imports = "normal"
+ignore_missing_imports = true
+no_implicit_reexport = true
+show_error_codes = true
+show_error_context = true
+strict_equality = true
+strict_optional = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_ignores = true

libs/tests-utils/ragstack_tests_utils/cassandra_container.py

@@ -1,13 +1,16 @@
+from typing import Any
+
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.waiting_utils import wait_for_logs
+from typing_extensions import Self
 
 
 class CassandraContainer(DockerContainer):
     def __init__(
         self,
         image: str = "docker.io/stargateio/dse-next:4.0.11-b259738f492f",
         port: int = 9042,
-        **kwargs,
+        **kwargs: Any,
     ) -> None:
         super().__init__(image=image, **kwargs)
         self.port = port
@@ -22,13 +25,10 @@ def __init__(
         self.with_env("CASSANDRA_DC", "datacenter1")
         self.with_exposed_ports(self.port)
 
-    def _configure(self):
-        pass
-
-    def start(self):
-        start_res = super().start()
+    def start(self) -> Self:
+        super().start()
         wait_for_logs(self, "Startup complete")
-        return start_res
+        return self
 
-    def get_mapped_port(self):
-        return self.get_exposed_port(self.port)
+    def get_mapped_port(self) -> int:
+        return int(self.get_exposed_port(self.port))

libs/tests-utils/ragstack_tests_utils/test_data.py

@@ -23,7 +23,7 @@ def _get_csv_embedding(csv_file_name: str) -> Embedding:
             return [[float(value) for value in row] for row in reader]
 
     @staticmethod
-    def save_csv_embedding(csv_file_name: str, embedding: Embedding):
+    def save_csv_embedding(csv_file_name: str, embedding: Embedding) -> None:
         with open(TestData._get_test_data_path(csv_file_name), "w", newline="") as f:
             writer = csv.writer(f)
             writer.writerows(embedding)

libs/tests-utils/ragstack_tests_utils/test_store.py

@@ -1,6 +1,7 @@
 import logging
 import os
 from abc import ABC, abstractmethod
+from typing import Optional
 
 import cassio
 from cassandra.cluster import Cluster, PlainTextAuthProvider, Session
@@ -17,7 +18,7 @@ def create_cassandra_session(self) -> Session:
 
 
 class LocalCassandraTestStore(TestStore):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
         start_container = os.environ.get("CASSANDRA_START_CONTAINER", "true")
         self.port = 9042
@@ -45,11 +46,11 @@ def create_cassandra_session(self) -> Session:
 
 
 class AstraDBTestStore(TestStore):
-    token: str
-    database_id: str
+    token: Optional[str]
+    database_id: Optional[str]
     env: str
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
         if not os.getenv("ASTRA_DB_ID") or not os.getenv("ASTRA_DB_TOKEN"):
             raise ValueError(

libs/tests-utils/tox.ini

@@ -0,0 +1,16 @@
+[tox]
+min_version = 4.0
+envlist = type
+
+[testenv]
+description = install dependencies
+skip_install = true
+allowlist_externals = poetry
+commands_pre =
+    poetry env use system
+    poetry install
+
+[testenv:type]
+description = run type checking
+commands =
+    poetry run mypy {toxinidir}