Add integration test framework

.env.integration-test

@@ -1,3 +1,3 @@
-METADATA_DB_URL=sqlite:///:memory:
-ARTIFACT_REGISTRY_URL=europe-west2-docker.pkg.dev/runsandbox-449400/
+METADATA_DB_URL=postgresql+psycopg2://at_user:at_pass@localhost:5432/at_db
+ARTIFACT_REGISTRY_URL=localhost:5001
 LOG_LEVEL=INFO

.github/workflows/python-ci.yaml

@@ -31,3 +31,13 @@ jobs:
 
       - name: Run tests
         run: make test
+
+      - name: Install docker-compose
+        run: |
+          sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+          sudo chmod +x /usr/local/bin/docker-compose
+          docker-compose --version
+
+      - name: Run integration tests
+        run: |
+          make test-integration

Makefile

@@ -12,15 +12,24 @@ publish: build
 launch:
 	docker-compose up -d
 
+.PHONY: lint
+lint:
+	$(POETRY) run ruff check .
+
 .PHONY: format
 format:
 	$(POETRY) run ruff format .
-	$(POETRY) run ruff check .
 
 .PHONY: test
-test: format
+test: lint
 	$(POETRY) run pytest tests/unit
 
 .PHONY: test-integration
-test-integration: format
-	$(POETRY) run pytest tests/integration
+test-integration: lint
+	@bash -c '\
+	set -e; \
+	docker-compose up -d; \
+	trap "docker-compose down" EXIT; \
+	until docker exec postgres pg_isready -U at_user; do sleep 1; done; \
+	$(POETRY) run pytest tests/integration; \
+	'

alphatrion/artifact/artifact.py

@@ -9,12 +9,12 @@
 
 
 class Artifact:
-    def __init__(self, runtime: Runtime):
+    def __init__(self, runtime: Runtime, insecure: bool = False):
         self._runtime = runtime
         self._url = os.environ.get(consts.ARTIFACT_REGISTRY_URL)
         self._url = self._url.replace("https://", "").replace("http://", "")
         self._client = oras.client.OrasClient(
-            hostname=self._url.strip("/"), auth_backend="token"
+            hostname=self._url.strip("/"), auth_backend="token", insecure=insecure
         )
 
     def push(self, experiment_name: str, files: list[str], version: str = "latest"):

docker-compose.yaml

@@ -1,20 +1,26 @@
-version: "3.9"
-
 services:
   postgres:
+    container_name: postgres
     image: postgres:16
     environment:
       POSTGRES_USER: at_user
       POSTGRES_PASSWORD: at_pass
       POSTGRES_DB: at_db
     ports:
       - "5432:5432"
-    volumes:
-      - pg_data:/var/lib/postgresql/data
+    # volumes:
+    #   - pg_data:/var/lib/postgresql/data
     deploy:
       replicas: 1
       restart_policy:
         condition: any
-
-volumes:
-  pg_data:
+  registry:
+    container_name: registry
+    image: registry:3
+    ports:
+      - "5001:5000"
+#     volumes:
+#       - oras-data:/data
+# volumes:
+#   pg_data:
+#   oras-data:

docs/development.md

@@ -23,9 +23,15 @@ To run tests, use:
 make test
 ```
 
+To run integration tests, use:
+
+```bash
+make test-integration
+```
+
 ## How to Build and Publish
 
-> NOTE: You need to have the PyPI token set in your environment variables to publish the package.
+> Note: You need to have the PyPI token set in your environment variables to publish the package.
 
 To build the project, run:
 

pyproject.toml

@@ -10,6 +10,7 @@ dependencies = [
     "sqlalchemy (>=2.0.43,<3.0.0)",
     "python-dotenv (>=1.1.1,<2.0.0)",
     "oras (>=0.2.38,<0.3.0)",
+    "psycopg2-binary (>=2.9.10,<3.0.0)",
 ]
 
 [tool.poetry.group.dev.dependencies]

tests/integration/artifact/test_artifact.py

@@ -11,8 +11,11 @@
 
 @pytest.fixture
 def artifact():
-    runtime = Runtime(project_id="ckpt")
-    artifact = Artifact(runtime=runtime)
+    # We use a local registry for testing, it doesn't mean
+    # it will always successfully with cloud registries.
+    # We may need e2e tests for that.
+    runtime = Runtime(project_id="test_project")
+    artifact = Artifact(runtime=runtime, insecure=True)
     yield artifact
 
 
@@ -35,6 +38,6 @@ def test_push(artifact):
         tags = artifact.list_tags("test_experiment")
         assert "v1" in tags
 
-        # artifact.delete_tags(experiment_name="test_experiment", versions="v1")
-        # tags = artifact.list_tags("test_experiment")
-        # assert "v1" not in tags
+        artifact.delete_tags(experiment_name="test_experiment", versions="v1")
+        tags = artifact.list_tags("test_experiment")
+        assert "v1" not in tags