Merge pull request #37 from maralzar/master

test(main): Add unit tests for Helm template generation and IaC workf…

Author: abolfazl8131

README.md

@@ -53,7 +53,13 @@ execute `sh run.sh` in your terminal
 If you want to run and use this chatbot app within your Kubernetes cluster, you can easily install it using the Helm chart provided in this repository
 
     helm install [RELEASE_NAME] helm/ -f helm/values.yaml
+# Test
 
+Run tests:
+```
+cd app
+pytest tests/
+```
 # Contributing
 please read the [Contribution guide](https://github.com/abolfazl8131/devops-gpt/blob/master/CONTRIBUTING.md)
 # Maintenance

app/prompt_generators.py

@@ -19,7 +19,7 @@ def IaC_bugfix_generator(input : IaCBugfixInput) -> str:
                 Write a clear answer to debug {input.service}
                 focusing on the version {input.version} of {input.service} and based on this bug:{input.bug_description},
                 generate a correct code that help us to solve this bug.
-                minimun length of answer is {input.min_tokens} and maximum length is {input.max_tokens}
+                minimum length of answer is {input.min_tokens} and maximum length is {input.max_tokens}
 
             """
     return prompt
@@ -28,8 +28,8 @@ def IaC_bugfix_generator(input : IaCBugfixInput) -> str:
 def IaC_installation_generator(input : IaCInstallationInput) -> str:
 
     prompt = f"""
-                generate a clear shell acript about installation {input.service} in {input.os} based on {input.service} document.
-                without any additional note. just script for installation. please consider new lines with out any additional comment.
+                generate a clear shell script about installation {input.service} in {input.os} based on {input.service} document.
+                without any additional note. just script for installation. please consider new lines without any additional comment.
 
             """
     return prompt

app/tests/__init__.py

@@ -0,0 +1,119 @@
+import pytest
+from unittest.mock import patch
+from fastapi.testclient import TestClient
+from app.main import app
+from app.models import HelmTemplateGeneration, Pod, Persistance, Ingress, Environment, Output
+
+client = TestClient(app)
+
+@pytest.fixture
+def sample_helm_template_input():
+    return HelmTemplateGeneration(
+        api_version=3,
+        pods=[
+            Pod(
+                name="nginx",
+                image="nginx:latest",
+                target_port=80,
+                replicas=2,
+                persistance=Persistance(enabled=False),
+                environment=[Environment(name="DEBUG", value="true")],
+                stateless=True,
+                ingress=Ingress(enabled=True)
+            ),
+            Pod(
+                name="redis",
+                image="redis:latest",
+                target_port=6379,
+                replicas=1,
+                persistance=Persistance(enabled=True),
+                environment=[],
+                stateless=False,
+                ingress=Ingress(enabled=False)
+            )
+        ]
+    )
+
+@pytest.fixture
+def invalid_input():
+    return {
+        "api_version": 0,  # Invalid api_version
+        "pods": [
+            {
+                "name": "",  # Invalid: empty name
+                "image": "nginx:latest",
+                "target_port": 70000,  # Invalid: exceeds 65535
+                "replicas": 0,  # Invalid: less than 1
+                "persistance": {"size": "invalid_size", "accessModes": "InvalidMode"},  # Invalid size and accessModes
+                "environment": [{"name": "", "value": ""}],  # Invalid: empty name and value
+                "stateless": True,
+                "ingress": {"enabled": True, "host": ""}  # Invalid: empty host
+            }
+        ]
+    }
+
+@patch("app.main.execute_pythonfile")
+@patch("app.main.edit_directory_generator")
+@patch("app.main.gpt_service")
+def test_helm_template_generation(
+    mock_gpt_service,
+    mock_edit_directory_generator,
+    mock_execute_pythonfile,
+    sample_helm_template_input
+):
+    mock_gpt_service.return_value = "Generated Python Code"
+
+    response = client.post("/Helm-template/", json=sample_helm_template_input.model_dump())
+
+    assert response.status_code == 200
+    assert response.json()["output"] == "output"
+
+    mock_gpt_service.assert_called_once()
+    mock_edit_directory_generator.assert_called_once_with("helm_generator", "Generated Python Code")
+    mock_execute_pythonfile.assert_called_once_with("MyHelm", "helm_generator")
+
+@patch("app.main.execute_pythonfile")
+@patch("app.main.edit_directory_generator")
+@patch("app.main.gpt_service")
+def test_helm_invalid_api(
+    mock_gpt_service,
+    mock_edit_directory_generator,
+    mock_execute_pythonfile,
+    invalid_input
+):
+    invalid_input = invalid_input.copy()
+    invalid_input["api_version"] = 0  
+    response = client.post("/Helm-template/", json=invalid_input)
+    assert response.status_code == 422  
+    assert "detail" in response.json()
+    errors = response.json()["detail"]
+    assert any(
+        error["loc"] == ["body", "api_version"] and "API version must be a positive integer." in error["msg"]
+        for error in errors
+    )
+    mock_gpt_service.assert_not_called()
+    mock_edit_directory_generator.assert_not_called()
+    mock_execute_pythonfile.assert_not_called()
+
+@patch("app.main.execute_pythonfile")
+@patch("app.main.edit_directory_generator")
+@patch("app.main.gpt_service")
+def test_helm_invalid_port(
+    mock_gpt_service,
+    mock_edit_directory_generator,
+    mock_execute_pythonfile,
+    invalid_input):
+
+    invalid_input = invalid_input.copy()
+    invalid_input["pods"][0]["target_port"] = 70000  # Invalid target_port
+    response = client.post("/Helm-template/", json=invalid_input)
+    assert response.status_code == 422
+    assert "detail" in response.json()
+    errors = response.json()["detail"]
+    assert any(
+        error["loc"] == ["body", "pods", 0, "target_port"] and "Target port must be between 1 and 65535." in error["msg"]
+        for error in errors
+    )
+    mock_gpt_service.assert_not_called()
+    mock_edit_directory_generator.assert_not_called()
+    mock_execute_pythonfile.assert_not_called()

app/tests/test_helm_template.py

@@ -0,0 +1,52 @@
+import pytest
+from fastapi.testclient import TestClient
+from unittest.mock import patch
+from app.main import app
+from app.models import IaCBasicInput
+
+client = TestClient(app)
+mocked_gpt_response = "Mocked GPT response for IaC-basic"
+
+@pytest.fixture
+def valid_iac_basic_data():
+    return IaCBasicInput(
+        input="How do I manage state effectively in Terraform?",
+        service="terraform",
+        min_tokens=100,
+        max_tokens=500
+    )
+
+@patch('app.main.gpt_service', return_value=mocked_gpt_response)
+def test_iac_basic_generation(mock_gpt_service, valid_iac_basic_data):
+    """
+    Test the /IaC-basic/ endpoint with valid input data to ensure correct output.
+    """
+    response = client.post("/IaC-basic/", json=valid_iac_basic_data.model_dump())
+    assert response.status_code == 200
+    assert response.json() == {"output": mocked_gpt_response}
+    
+@patch('app.main.gpt_service')  
+def test_basic_generation(mock_gpt_service):
+    """
+    Test the /IaC-basic/ endpoint with an invalid service to ensure proper validation.
+    """
+    invalid_input = {
+        "input": "Create a basic configuration",
+        "service": "invalid_service",  # Unsupported service (invalid)
+        "min_tokens": 100,
+        "max_tokens": 500
+    }
+
+    response = client.post("/IaC-basic/", json=invalid_input)
+    assert response.status_code == 422, f"Expected status code 422, got {response.status_code}"
+    assert "detail" in response.json(), "Response JSON does not contain 'detail'"
+    errors = response.json()["detail"]
+    expected_error_loc = ["body", "service"]
+    expected_error_msg = "Service must be one of ['terraform']."
+    assert any(
+        error["loc"] == expected_error_loc and error_msg in error["msg"]
+        for error in errors
+        for error_msg in [expected_error_msg]
+    ), f"Expected error message '{expected_error_msg}' at location {expected_error_loc}, but not found."
+
+    mock_gpt_service.assert_not_called()

app/tests/test_iac_basic.py

@@ -0,0 +1,51 @@
+import pytest
+from fastapi.testclient import TestClient
+from unittest.mock import patch
+from app.main import app
+from app.models import IaCBugfixInput
+
+client = TestClient(app)
+mocked_gpt_response = "Mocked GPT response for IaC-bugfix"
+
+@pytest.fixture
+def valid_bugfix_data():
+    return IaCBugfixInput(
+        bug_description="Application fails to start on version latest",
+        version="latest",
+        service="terraform",
+        min_tokens=100,
+        max_tokens=500
+    )
+
+@patch('app.main.gpt_service', return_value=mocked_gpt_response)
+def test_bugfix(mock_gpt_service, valid_bugfix_data):
+    """
+    Test the /IaC-bugfix/ endpoint with valid input data to ensure correct output.
+    """
+    response = client.post("/IaC-bugfix/", json=valid_bugfix_data.model_dump())
+    assert response.status_code == 200
+    assert response.json() == {"output": mocked_gpt_response}
+
+@patch('app.main.gpt_service') 
+def test_bugfix_invalid(mock_gpt_service):
+    """
+    Test the /IaC-bugfix/ endpoint with a single invalid input to ensure proper validation.
+    """
+    invalid_input = {
+        "bug_description": "",  # Emptydescription
+        "version": "latest",
+        "service": "terraform",
+        "min_tokens": 100,
+        "max_tokens": 500
+    }
+    response = client.post("/IaC-bugfix/", json=invalid_input)
+    assert response.status_code == 422, f"Expected status code 422, got {response.status_code}"
+    assert "detail" in response.json(), "Response JSON does not contain 'detail'"
+    errors = response.json()["detail"]
+    expected_error_loc = ["body", "bug_description"]
+    expected_error_msg = "Bug description cannot be empty."
+    assert any(
+        error["loc"] == expected_error_loc and expected_error_msg in error["msg"]
+        for error in errors
+    ), f"Expected error message '{expected_error_msg}' at location {expected_error_loc}, but not found."
+    mock_gpt_service.assert_not_called()

app/tests/test_iac_bugfix.py

@@ -0,0 +1,51 @@
+import pytest
+from fastapi.testclient import TestClient
+from unittest.mock import patch
+from app.main import app
+from app.models import IaCInstallationInput
+
+client = TestClient(app)
+mocked_gpt_response = "Mocked shell script for installing terraform on Ubuntu."
+
+@pytest.fixture
+def valid_installation_data():
+    return IaCInstallationInput(
+        os="ubuntu",
+        service="terraform",
+        min_tokens=100,
+        max_tokens=500
+    )
+@patch('app.main.gpt_service', return_value=mocked_gpt_response)
+def test_install(mock_gpt_service, valid_installation_data):
+    """
+    Test the /IaC-install/ endpoint with valid input data to ensure correct output.
+    """
+    response = client.post("/IaC-install/", json=valid_installation_data.model_dump())
+    assert response.status_code == 200
+    assert response.json() == {"output": mocked_gpt_response}
+
+@patch('app.main.gpt_service')
+def test_install_invalid(mock_gpt_service):
+    """
+    Test the /IaC-install/ endpoint with an invalid 'os' value to ensure proper validation.
+    """
+    invalid_input = {
+        "os": "Kali",  
+        "service": "terraform"
+    }
+
+    response = client.post("/IaC-install/", json=invalid_input)
+
+    assert response.status_code == 422, f"Expected status code 422, got {response.status_code}"
+    assert "detail" in response.json(), "Response JSON does not contain 'detail'"
+    errors = response.json()["detail"]
+
+    expected_error_loc = ["body", "os"]
+    expected_error_msg = "OS must be one of ['ubuntu', 'centos', 'debian']."
+
+    assert any(
+        error["loc"] == expected_error_loc and error_msg in error["msg"]
+        for error in errors
+        for error_msg in [expected_error_msg]
+    ), f"Expected error message '{expected_error_msg}' at location {expected_error_loc}, but not found."
+    mock_gpt_service.assert_not_called()

app/tests/test_iac_install.py

@@ -0,0 +1,56 @@
+import pytest
+from unittest.mock import patch
+from fastapi.testclient import TestClient
+from app.main import app
+from app.models import IaCTemplateGeneration
+
+client = TestClient(app)
+
+@pytest.fixture
+def sample_iac_template_input():
+    return IaCTemplateGeneration(
+        service="terraform",        
+        CI_integration=True,
+        base_config="ec2"           
+    )
+
+@patch("app.main.gpt_service")
+@patch("app.main.edit_directory_generator")
+@patch("app.main.execute_pythonfile")
+def test_template(mock_execute_pythonfile, mock_edit_directory_generator, mock_gpt_service, sample_iac_template_input):
+    mock_gpt_service.return_value = "Generated Python Code"
+
+    response = client.post("/IaC-template/", json=sample_iac_template_input.model_dump())
+
+    assert response.status_code == 200
+    assert response.json()["output"] == "output"
+
+    mock_gpt_service.assert_called_once()
+    mock_edit_directory_generator.assert_called_once_with("terraform_generator", "Generated Python Code")
+    mock_execute_pythonfile.assert_called_once_with("MyTerraform", "terraform_generator")
+
+@patch("app.main.gpt_service")
+@patch("app.main.edit_directory_generator")
+@patch("app.main.execute_pythonfile")
+def test_template_invalid(mock_execute_pythonfile, mock_edit_directory_generator, mock_gpt_service):
+    """
+    Test the /IaC-template/ endpoint with an invalid 'base_config' to ensure proper validation.
+    """
+    invalid_input = {
+        "CI_integration": True,
+        "base_config": "k8s",  
+        "service": "terraform"
+    }
+    response = client.post("/IaC-template/", json=invalid_input)
+    assert response.status_code == 422, f"Expected status code 422, got {response.status_code}"
+    assert "detail" in response.json(), "Response JSON does not contain 'detail'"
+    errors = response.json()["detail"]
+    expected_error_loc = ["body", "base_config"]
+    expected_error_msg = "Base config must be one of ['ec2', 's3', 'rds']."
+    assert any(
+        error["loc"] == expected_error_loc and expected_error_msg in error["msg"]
+        for error in errors
+    ), f"Expected error message '{expected_error_msg}' at location {expected_error_loc}, but not found."
+    mock_gpt_service.assert_not_called()
+    mock_edit_directory_generator.assert_not_called()
+    mock_execute_pythonfile.assert_not_called()