test(main) Add unit tests for Helm template generation and IaC workflows (basic, bugfix, install, template) with pytest and mocker

Author: maralzar

app/tests/test_helm_template.py

@@ -2,31 +2,118 @@
 from unittest.mock import patch
 from fastapi.testclient import TestClient
 from app.main import app
-from app.models import HelmTemplateGeneration, Pod, Persistance, Ingress
+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",
+        api_version=3,
         pods=[
-            Pod(name="nginx", image="nginx:latest", target_port=80, replicas=2, persistance=Persistance(enabled=False), 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))
+            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)
+            )
         ]
     )
 
-@patch("app.main.gpt_service")
-@patch("app.main.edit_directory_generator")
+@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")
-def test_helm_template_generation(mock_execute_pythonfile, mock_edit_directory_generator, mock_gpt_service, sample_helm_template_input):
+@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.dict())
+    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_iac_basic.py

@@ -8,28 +8,53 @@
 mocked_gpt_response = "Mocked GPT response for IaC-basic"
 
 @pytest.fixture
-def valid_basic_data():
+def valid_iac_basic_data():
     return IaCBasicInput(
-        input="Create a basic configuration",
+        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_basic_data):
+def test_iac_basic_generation(mock_gpt_service, valid_iac_basic_data):
     """
-    Test the /IaC-basic/ endpoint with valid input data.
+    Test the /IaC-basic/ endpoint with valid input data to ensure correct output.
     """
-    response = client.post("/IaC-basic/", json=valid_basic_data.model_dump())
+    response = client.post("/IaC-basic/", json=valid_iac_basic_data.model_dump())
     assert response.status_code == 200
     assert response.json() == {"output": mocked_gpt_response}
 
     expected_prompt = """
-        Write a robust answer about terraform,
-        focusing on the latest update of terraform and based on this question:Create a basic configuration,
-        minimun length of answer is 100 and maximum length is 500
+    Write a robust answer about terraform, focusing on the latest update of terraform and based on this question:How do I manage state effectively in Terraform?,
+    minimun length of answer is 100 and maximum length is 500
     """
     actual_prompt = " ".join(mock_gpt_service.call_args[0][0].split())
     normalized_expected_prompt = " ".join(expected_prompt.split())
     assert actual_prompt == normalized_expected_prompt
+
+@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_bugfix.py

@@ -10,16 +10,15 @@
 @pytest.fixture
 def valid_bugfix_data():
     return IaCBugfixInput(
-        input="Fix the deployment issue",
-        bug_description="Application fails to start on version 1.2.3",
-        version="1.2.3",
+        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_iac_bugfix_generation(mock_gpt_service, valid_bugfix_data):
+def test_bugfix(mock_gpt_service, valid_bugfix_data):
     """
     Test the /IaC-bugfix/ endpoint with valid input data to ensure correct output.
     """
@@ -28,11 +27,38 @@ def test_iac_bugfix_generation(mock_gpt_service, valid_bugfix_data):
     assert response.json() == {"output": mocked_gpt_response}
 
     expected_prompt = """
-        Write a clear answer to debug terraform
-        focusing on the version 1.2.3 of terraform and based on this bug:Application fails to start on version 1.2.3,
-        generate a correct code that help us to solve this bug.
-        minimun length of answer is 100 and maximum length is 500
+    Write a clear answer to debug terraform
+    focusing on the version latest of terraform and based on this bug:Application fails to start on version latest,
+    generate a correct code that help us to solve this bug.
+    minimum length of answer is 100 and maximum length is 500
     """
+
+
     actual_prompt = " ".join(mock_gpt_service.call_args[0][0].split())
     normalized_expected_prompt = " ".join(expected_prompt.split())
     assert actual_prompt == normalized_expected_prompt
+
+
+@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_install.py

@@ -15,20 +15,48 @@ def valid_installation_data():
         min_tokens=100,
         max_tokens=500
     )
-
 @patch('app.main.gpt_service', return_value=mocked_gpt_response)
-def test_iac_install_generation(mock_gpt_service, valid_installation_data):
+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}
-
     expected_prompt = """
         generate a clear shell script about installation terraform in ubuntu based on terraform document.
-        without any additional note. just script for installation.
+        without any additional note. just script for installation. please consider new lines without any additional comment.
     """
-    actual_prompt = " ".join(mock_gpt_service.call_args[0][0].split())
-    normalized_expected_prompt = " ".join(expected_prompt.split())
+    actual_prompt = " ".join(mock_gpt_service.call_args[0][0].split()).strip()
+    normalized_expected_prompt = " ".join(expected_prompt.split()).strip()
+    if actual_prompt != normalized_expected_prompt:
+        print("Expected Prompt:", repr(normalized_expected_prompt))
+        print("Actual Prompt:", repr(actual_prompt))
+
     assert actual_prompt == normalized_expected_prompt
+
+@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_template.py

@@ -9,22 +9,48 @@
 @pytest.fixture
 def sample_iac_template_input():
     return IaCTemplateGeneration(
-        service="MyService",
+        service="terraform",        
         CI_integration=True,
-        base_config="BasicConfig"
+        base_config="ec2"           
     )
 
 @patch("app.main.gpt_service")
 @patch("app.main.edit_directory_generator")
 @patch("app.main.execute_pythonfile")
-def test_iac_template_generation(mock_execute_pythonfile, mock_edit_directory_generator, mock_gpt_service, sample_iac_template_input):
+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.dict())
+    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()