add unit testing to ci_cd

Author: laurasgkadri98

.github/workflows/ci_cd.yml

@@ -2,11 +2,7 @@ name: CI/CD
 on:
   pull_request:
   push:
-    tags:
-      - "*"
-    branches:
-      - main
-
+  
 env:
   MAIN_PYTHON_VERSION: '3.12'
 
@@ -26,6 +22,40 @@ jobs:
       - name: "Run PyAnsys code style checks"
         uses: ansys/actions/code-style@v6
 
+  tests:
+    name: "Tests"
+    runs-on: ${{ matrix.os }}
+    needs: [code-style]
+    strategy:
+      matrix:
+       os: [ubuntu-latest, windows-latest]
+       python-version: ['3.9', '3.12']
+      fail-fast: false
+    steps:
+      - name: Testing (Linux)
+        uses: ansys/actions/tests-pytest@v6
+        timeout-minutes: 12
+        if: runner.os == 'Linux'
+        with:
+          checkout: false
+          pytest-extra-args: "--cov=ansys.allie.flowkit.python --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml"
+
+      - name: Testing (Windows)
+        uses: ansys/actions/tests-pytest@v6
+        timeout-minutes: 12
+        if: runner.os == 'Windows'
+        with:
+          checkout: false
+          pytest-extra-args: "--cov=ansys.allie.flowkit.python --cov-report=term --cov-report=html:.cov/html --cov-report=xml:.cov/coverage.xml"
+
+      - name: Upload coverage results (HTML)
+        uses: actions/upload-artifact@v4
+        if: (matrix.python-version == env.MAIN_PYTHON_VERSION) && (runner.os == 'Linux')
+        with:
+          name: coverage-html
+          path: .cov/html
+          retention-days: 7
+
   release:
     name: "Release project"
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')

tests/conftest.py

@@ -1,11 +1,13 @@
-import pytest
 from unittest.mock import patch
 
+import pytest
+
 # Mock API key for testing
 MOCK_API_KEY = "test_api_key"
 
+
 @pytest.fixture(autouse=True)
 def mock_api_key():
     """Mock the API key for testing."""
-    with patch('app.config.CONFIG.flowkit_python_api_key', MOCK_API_KEY):
-        yield
+    with patch("app.config.CONFIG.flowkit_python_api_key", MOCK_API_KEY):
+        yield

tests/test_endpoints_splitter.py

@@ -1,19 +1,23 @@
 import base64
-from fastapi import HTTPException
-import pytest
-from fastapi.testclient import TestClient
+
 from app.app import app
 from app.endpoints.splitter import validate_request
 from app.models.splitter import SplitterRequest
+from fastapi import HTTPException
+from fastapi.testclient import TestClient
+import pytest
+
 from tests.conftest import MOCK_API_KEY
 
 # Create a test client
 client = TestClient(app)
 
+
 def encode_file_to_base64(file_path):
     """Encode a file to base64 string."""
     with open(file_path, "rb") as file:
-        return base64.b64encode(file.read()).decode('utf-8')
+        return base64.b64encode(file.read()).decode("utf-8")
+
 
 @pytest.mark.asyncio
 async def test_split_ppt():
@@ -22,111 +26,81 @@ async def test_split_ppt():
     request_payload = {
         "document_content": ppt_content_base64,
         "chunk_size": 100,
-        "chunk_overlap": 10
+        "chunk_overlap": 10,
     }
-    response = client.post(
-        "/splitter/ppt",
-        json=request_payload,
-        headers={"api-key": MOCK_API_KEY}
-    )
+    response = client.post("/splitter/ppt", json=request_payload, headers={"api-key": MOCK_API_KEY})
     if response.status_code != 200:
         print(f"Response status code: {response.status_code}")
         print(f"Response content: {response.json()}")
     assert response.status_code == 200
     assert "chunks" in response.json()
 
+
 @pytest.mark.asyncio
 async def test_split_py():
     """Test splitting Python code into chunks."""
     python_code = """
     def hello_world():
         print("Hello, world!")
     """
-    python_code_base64 = base64.b64encode(python_code.encode()).decode('utf-8')
-    request_payload = {
-        "document_content": python_code_base64,
-        "chunk_size": 50,
-        "chunk_overlap": 5
-    }
-    response = client.post(
-        "/splitter/py",
-        json=request_payload,
-        headers={"api-key": MOCK_API_KEY}
-    )
+    python_code_base64 = base64.b64encode(python_code.encode()).decode("utf-8")
+    request_payload = {"document_content": python_code_base64, "chunk_size": 50, "chunk_overlap": 5}
+    response = client.post("/splitter/py", json=request_payload, headers={"api-key": MOCK_API_KEY})
     assert response.status_code == 200
     assert "chunks" in response.json()
 
+
 @pytest.mark.asyncio
 async def test_split_pdf():
     """Test splitting text in a PDF document into chunks."""
     pdf_content_base64 = encode_file_to_base64("./tests/test_files/test_document.pdf")
     request_payload = {
         "document_content": pdf_content_base64,
         "chunk_size": 200,
-        "chunk_overlap": 20
+        "chunk_overlap": 20,
     }
-    response = client.post(
-        "/splitter/pdf",
-        json=request_payload,
-        headers={"api-key": MOCK_API_KEY}
-    )
+    response = client.post("/splitter/pdf", json=request_payload, headers={"api-key": MOCK_API_KEY})
     assert response.status_code == 200
     assert "chunks" in response.json()
 
+
 # Define test cases for validate_request()
 validate_request_test_cases = [
     # Test case 1: valid request
     (
         SplitterRequest(
-            document_content="dGVzdA==",  # base64 for "test"
-            chunk_size=100,
-            chunk_overlap=10
+            document_content="dGVzdA==", chunk_size=100, chunk_overlap=10  # base64 for "test"
         ),
         MOCK_API_KEY,
         None,
     ),
     # Test case: invalid API key
     (
-        SplitterRequest(
-            document_content="dGVzdA==",
-            chunk_size=100,
-            chunk_overlap=10
-        ),
+        SplitterRequest(document_content="dGVzdA==", chunk_size=100, chunk_overlap=10),
         "invalid_api_key",
         HTTPException(status_code=401, detail="Invalid API key"),
     ),
     # Test case 2: missing document content
     (
-        SplitterRequest(
-            document_content="",
-            chunk_size=100,
-            chunk_overlap=10
-        ),
+        SplitterRequest(document_content="", chunk_size=100, chunk_overlap=10),
         MOCK_API_KEY,
         HTTPException(status_code=400, detail="No document content provided"),
     ),
     # Test case 4: invalid chunk size
     (
-        SplitterRequest(
-            document_content="dGVzdA==",
-            chunk_size=0,
-            chunk_overlap=10
-        ),
+        SplitterRequest(document_content="dGVzdA==", chunk_size=0, chunk_overlap=10),
         MOCK_API_KEY,
         HTTPException(status_code=400, detail="No chunk size provided"),
     ),
     # Test case 5: invalid chunk overlap
     (
-        SplitterRequest(
-            document_content="dGVzdA==",
-            chunk_size=100,
-            chunk_overlap=-1
-        ),
+        SplitterRequest(document_content="dGVzdA==", chunk_size=100, chunk_overlap=-1),
         MOCK_API_KEY,
         HTTPException(status_code=400, detail="Chunk overlap must be greater than or equal to 0"),
     ),
 ]
 
+
 @pytest.mark.parametrize("api_request, api_key, expected_exception", validate_request_test_cases)
 def test_validate_request(api_request, api_key, expected_exception):
     """Test the validate_request function with various scenarios."""

tests/test_list_functions.py

@@ -0,0 +1,64 @@
+import pytest
+from fastapi.testclient import TestClient
+from app.app import app
+
+# Initialize the test client
+client = TestClient(app)
+
+@pytest.mark.asyncio
+async def test_list_functions():
+    """Test listing available functions."""
+    # Test splitter results
+    response = client.get("/", headers={"api-key": "test_api_key"})
+    assert response.status_code == 200
+    response_data = response.json()
+    
+    expected_response_start = [
+        {
+            "name": "split_ppt",
+            "path": "/splitter/ppt",
+            "inputs": [
+                {"name": "document_content", "type": "string(binary)"},
+                {"name": "chunk_size", "type": "integer"},
+                {"name": "chunk_overlap", "type": "integer"}
+            ],
+            "outputs": [
+                {"name": "chunks", "type": "array<string>"}
+            ],
+            "definitions": {}
+        },
+        {
+            "name": "split_py",
+            "path": "/splitter/py",
+            "inputs": [
+                {"name": "document_content", "type": "string(binary)"},
+                {"name": "chunk_size", "type": "integer"},
+                {"name": "chunk_overlap", "type": "integer"}
+            ],
+            "outputs": [
+                {"name": "chunks", "type": "array<string>"}
+            ],
+            "definitions": {}
+        },
+        {
+            "name": "split_pdf",
+            "path": "/splitter/pdf",
+            "inputs": [
+                {"name": "document_content", "type": "string(binary)"},
+                {"name": "chunk_size", "type": "integer"},
+                {"name": "chunk_overlap", "type": "integer"}
+            ],
+            "outputs": [
+                {"name": "chunks", "type": "array<string>"}
+            ],
+            "definitions": {}
+        }
+    ]
+
+    assert response_data[:3] == expected_response_start
+
+    # Test invalid API key
+    response = client.get("/", headers={"api-key": "invalid_api_key"})
+    assert response.status_code == 401
+    assert response.json() == {"detail": "Invalid API key"}
+