add sdk tests and enable in actions workflow

Author: Deepthi-Chand

.github/workflows/sdk-tests.yml

@@ -0,0 +1,43 @@
+name: SDK Tests
+
+on:
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev, main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run type checking with mypy
+        run: |
+          mypy dataspace_sdk/ --ignore-missing-imports
+
+      - name: Run tests with pytest
+        run: |
+          pytest tests/ -v --cov=dataspace_sdk --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

docs/sdk/DEVELOPMENT.md

@@ -85,18 +85,26 @@ datasets = client.datasets.search(query="test")
 print(datasets)
 ```
 
-### Unit Tests (To Be Implemented)
+### Unit Tests
 
-Create tests in `tests/` directory:
+The SDK includes comprehensive unit tests in the `tests/` directory:
 
 ```bash
-# Run tests
-pytest
+# Run all SDK tests (recommended - uses current Python environment)
+python run_sdk_tests.py
+
+# Run specific test files
+python -m pytest tests/test_auth.py -v
+python -m pytest tests/test_datasets.py -v
+python -m pytest tests/test_aimodels.py -v
+python -m pytest tests/test_usecases.py -v
 
 # Run with coverage
-pytest --cov=dataspace_sdk --cov-report=html
+python -m pytest tests/ --cov=dataspace_sdk --cov-report=html
 ```
 
+See [QUICK_TEST_GUIDE.md](QUICK_TEST_GUIDE.md) for more testing options.
+
 ## Code Quality
 
 ### Formatting

docs/sdk/QUICK_TEST_GUIDE.md

@@ -0,0 +1,41 @@
+# Quick Test Guide
+
+## Setup (One Time)
+
+```bash
+# Install SDK with dev dependencies
+pip install -e ".[dev]"
+```
+
+## Run Tests
+
+```bash
+# Run all SDK tests (recommended - uses current Python environment)
+python run_sdk_tests.py
+
+# Or run specific tests
+python -m pytest tests/test_auth.py -v
+python -m pytest tests/test_datasets.py -v
+python -m pytest tests/test_aimodels.py -v
+python -m pytest tests/test_usecases.py -v
+```
+
+## Check Coverage
+
+```bash
+python -m pytest tests/ --cov=dataspace_sdk --cov-report=term-missing
+```
+
+## Type Checking
+
+```bash
+mypy dataspace_sdk/ --ignore-missing-imports
+```
+
+## CI/CD
+
+Tests run automatically on:
+- Push to `dev` or `main`
+- Pull requests to `dev` or `main`
+
+Check results in GitHub Actions tab.

run_sdk_tests.py

@@ -0,0 +1,103 @@
+#!/usr/bin/env python
+"""Script to run SDK tests in the current Python environment."""
+
+import subprocess
+import sys
+
+
+def check_dependencies() -> bool:
+    """Check if required dependencies are installed."""
+    try:
+        import mypy  # type: ignore
+        import pytest  # type: ignore
+
+        return True
+    except ImportError as e:
+        print(f"\n❌ Missing dependency: {e.name}")
+        print("\nPlease install dev dependencies:")
+        print('   pip install -e ".[dev]"')
+        return False
+
+
+def has_coverage() -> bool:
+    """Check if pytest-cov is installed."""
+    try:
+        import pytest_cov  # type: ignore
+
+        return True
+    except ImportError:
+        return False
+
+
+def run_command(description: str, command: list[str]) -> None:
+    """Run a command and handle errors."""
+    print(f"\n{description}")
+    print("-" * 60)
+
+    try:
+        result = subprocess.run(command, check=True, capture_output=False, text=True)
+    except subprocess.CalledProcessError as e:
+        print(f"\n❌ Error: {description} failed")
+        sys.exit(1)
+    except FileNotFoundError:
+        print(f"\n❌ Error: Command not found. Please install dev dependencies:")
+        print('   pip install -e ".[dev]"')
+        sys.exit(1)
+
+
+def main() -> None:
+    """Run all SDK tests."""
+    print("=" * 60)
+    print("Running DataSpace SDK Tests")
+    print("=" * 60)
+    print(f"Python: {sys.version}")
+    print(f"Executable: {sys.executable}")
+    print("=" * 60)
+
+    # Check dependencies
+    if not check_dependencies():
+        sys.exit(1)
+
+    # Run type checking
+    run_command(
+        "1. Running mypy type checking...",
+        [sys.executable, "-m", "mypy", "dataspace_sdk/", "--ignore-missing-imports"],
+    )
+
+    # Run SDK-specific tests (without Django)
+    test_files = [
+        "tests/test_auth.py",
+        "tests/test_base.py",
+        "tests/test_client.py",
+        "tests/test_datasets.py",
+        "tests/test_aimodels.py",
+        "tests/test_usecases.py",
+        "tests/test_exceptions.py",
+    ]
+
+    # Build pytest command
+    pytest_cmd = [
+        sys.executable,
+        "-m",
+        "pytest",
+        *test_files,
+        "-v",
+        "-p",
+        "no:django",  # Disable Django plugin for SDK tests
+        "-o",
+        "addopts=",  # Override addopts from pytest.ini to remove --nomigrations
+        "--override-ini=django_find_project=false",  # Disable Django project finding
+        "--noconftest",  # Don't load any conftest.py files
+    ]
+
+    pytest_cmd.extend(["--cov=dataspace_sdk", "--cov-report=term-missing"])
+
+    run_command("2. Running SDK unit tests...", pytest_cmd)
+
+    print("\n" + "=" * 60)
+    print("✅ All SDK tests passed!")
+    print("=" * 60)
+
+
+if __name__ == "__main__":
+    main()

tests/test_aimodels.py

@@ -0,0 +1,122 @@
+"""Tests for AI model resource client."""
+
+import unittest
+from unittest.mock import MagicMock, patch
+
+from dataspace_sdk.resources.aimodels import AIModelClient
+
+
+class TestAIModelClient(unittest.TestCase):
+    """Test cases for AIModelClient."""
+
+    def setUp(self) -> None:
+        """Set up test fixtures."""
+        self.base_url = "https://api.test.com"
+        self.auth_client = MagicMock()
+        self.client = AIModelClient(self.base_url, self.auth_client)
+
+    def test_init(self) -> None:
+        """Test AIModelClient initialization."""
+        self.assertEqual(self.client.base_url, self.base_url)
+        self.assertEqual(self.client.auth_client, self.auth_client)
+
+    @patch.object(AIModelClient, "get")
+    def test_search_models(self, mock_get: MagicMock) -> None:
+        """Test AI model search."""
+        mock_get.return_value = {
+            "total": 5,
+            "results": [{"id": "1", "displayName": "Test Model", "modelType": "LLM"}],
+        }
+
+        result = self.client.search(query="test", page=1, page_size=10)
+
+        self.assertEqual(result["total"], 5)
+        self.assertEqual(len(result["results"]), 1)
+        self.assertEqual(result["results"][0]["displayName"], "Test Model")
+        mock_get.assert_called_once()
+
+    @patch.object(AIModelClient, "get")
+    def test_get_model_by_id(self, mock_get: MagicMock) -> None:
+        """Test get AI model by ID."""
+        mock_get.return_value = {
+            "id": "123",
+            "displayName": "Test Model",
+            "modelType": "LLM",
+            "provider": "OpenAI",
+        }
+
+        result = self.client.get_by_id("123")
+
+        self.assertEqual(result["id"], "123")
+        self.assertEqual(result["displayName"], "Test Model")
+        mock_get.assert_called_once()
+
+    @patch.object(AIModelClient, "post")
+    def test_get_model_by_id_graphql(self, mock_post: MagicMock) -> None:
+        """Test get AI model by ID using GraphQL."""
+        mock_post.return_value = {
+            "data": {
+                "aiModel": {
+                    "id": "123",
+                    "displayName": "Test Model",
+                    "description": "A test model",
+                }
+            }
+        }
+
+        result = self.client.get_by_id_graphql("123")
+
+        self.assertEqual(result["id"], "123")
+        self.assertEqual(result["displayName"], "Test Model")
+        mock_post.assert_called_once()
+
+    @patch.object(AIModelClient, "post")
+    def test_list_all_models(self, mock_post: MagicMock) -> None:
+        """Test list all AI models."""
+        mock_post.return_value = {"data": {"aiModels": [{"id": "1", "displayName": "Model 1"}]}}
+
+        result = self.client.list_all(limit=10, offset=0)
+
+        self.assertIsInstance(result, (list, dict))
+        mock_post.assert_called_once()
+
+    @patch.object(AIModelClient, "post")
+    def test_get_organization_models(self, mock_post: MagicMock) -> None:
+        """Test get organization AI models."""
+        mock_post.return_value = {"data": {"aiModels": [{"id": "1", "name": "Org Model"}]}}
+
+        result = self.client.get_organization_models("org-123", limit=10)
+
+        self.assertIsInstance(result, (list, dict))
+        mock_post.assert_called_once()
+
+    @patch.object(AIModelClient, "get")
+    def test_search_with_filters(self, mock_get: MagicMock) -> None:
+        """Test AI model search with filters."""
+        mock_get.return_value = {"total": 3, "results": []}
+
+        result = self.client.search(
+            query="language",
+            tags=["nlp"],
+            sectors=["tech"],
+            model_type="LLM",
+            provider="OpenAI",
+            status="ACTIVE",
+        )
+
+        self.assertEqual(result["total"], 3)
+        mock_get.assert_called_once()
+
+    @patch.object(AIModelClient, "post")
+    def test_graphql_error_handling(self, mock_post: MagicMock) -> None:
+        """Test GraphQL error handling."""
+        from dataspace_sdk.exceptions import DataSpaceAPIError
+
+        mock_post.return_value = {"errors": [{"message": "GraphQL error"}]}
+
+        with self.assertRaises(DataSpaceAPIError):
+            self.client.get_by_id_graphql("123")
+
+
+if __name__ == "__main__":
+    unittest.main()