test(main): Add unit tests for Helm template generation and IaC workflows (basic, bugfix, install, template) with pytest and mocker, and update README with testing instructions.

Author: maralzar

README.md

@@ -1,61 +1,84 @@
 # DevOps-GPT
+
 Use a brilliant assistant as your friend in your DevOps Journey.
 
 ## What does this project offer?
-This project helps you to balance your daily work as a DevOps engineer, from simple bug fixes to project template generation.<br />
-you don't need to search on Google for some routine jobs and it helps you with a robust prompt to simplify your career.
+
+This project helps you to balance your daily work as a DevOps engineer, from simple bug fixes to project template generation.
+You don't need to search on Google for some routine jobs, and it helps you with a robust prompt to simplify your career.
 
 ## How it works?
-This is a wrapper between DevOps engineers and large language models like GPT-4-mini. The main strength of it is prompt engineering.<br />
 
-We have developed some (Extendable) prompt-driven solutions with a simplified interface for the DevOps process cost reduction.<br />
+This is a wrapper between DevOps engineers and large language models like GPT-4-mini. The main strength of it is prompt engineering.
+
+We have developed some (extendable) prompt-driven solutions with a simplified interface for the DevOps process cost reduction.
 
 ### Docker services
-We run our services using docker-compose (the main Fast-API-based backend and MongoDB), so we package all dependencies and don't use any external service.<br />
-The second one is Mongodb. we need to save the prompt and GPT-4_mini response in the Mongo document for future use. (for example, fine-tuning the other model with our data) <br />
+
+We run our services using docker-compose (the main Fast-API-based backend and MongoDB), so we package all dependencies and don't use any external service.
+The second one is MongoDB. We need to save the prompt and GPT-4-mini response in the Mongo document for future use (e.g., fine-tuning another model with our data).
 
 ### Media directory
-The third one is in the media directory. for now, We save a project called (MyTerraform) which is a Terraform template generated based on user requirements. so users can download it and use it.<be />
-surely we can save any static data in the `/media`.
 
-![teramedia](https://github.com/user-attachments/assets/b8e10d83-68ac-4efc-b064-45f1d1a870dc)
+The third one is the media directory. For now, we save a project called (MyTerraform), which is a Terraform template generated based on user requirements, so users can download it and use it.
+Surely we can save any static data in the `/media`.
 
 This is an example of a template generated in the `/media`
 
-and the input is something like that
-
-![Screenshot from 2024-10-27 10-56-54](https://github.com/user-attachments/assets/63d1db07-2c25-4c10-a841-69a2c1235d9d)
-
-
+The input is something like this:
 
 ### directory_generators
-This directory becomes updated when we trigger the template generation API. finally, It generates the MyTerraform directory based on user input which is a template.
 
+This directory gets updated when we trigger the template generation API. Finally, it generates the MyTerraform directory based on user input, which is a template.
 
 ## ToolChain
+
 1. Python
 2. Docker
-3. GPT-4o-mini
+3. GPT-4-mini
 4. FastAPI
 5. Helm
 
 ## Pre-requisites
+
 1. Python
 2. Docker
 
 ## How to use?
-execute `sh run.sh` in your terminal
 
-> [!WARNING]  
-> Do Not change the GPT model! Prompts have been developed for the GPT-4-mini model and they can't be integrated with other GPT models. it can cause horrible incompatibility.
+Execute `sh run.sh` in your terminal
+
+> [!WARNING]\
+> Do Not change the GPT model! Prompts have been developed for the GPT-4-mini model, and they can't be integrated with other GPT models. It can cause horrible incompatibility.
 
-## Run it local on kubernetes
-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
+## Run it locally on Kubernetes
 
-    helm install [RELEASE_NAME] helm/ -f helm/values.yaml
+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
+```
+
+## Tests
+
+We have added unit tests to ensure the stability and reliability of the project.
+
+### Running Tests
+
+To run the tests, use the following command:
+
+```
+cd app
+pytest tests/
+```
+
+This command will execute all the test cases present in the `tests` folder. The tests include validation of the API endpoints, ensuring correct interactions with GPT services, and verifying that the generated outputs meet expected standards.
 
 # Contributing
-please read the [Contribution guide](https://github.com/abolfazl8131/devops-gpt/blob/master/CONTRIBUTING.md)
+
+Please read the [Contribution guide](https://github.com/abolfazl8131/devops-gpt/blob/master/CONTRIBUTING.md)
+
 # Maintenance
-** [Abolfazl Andalib](https://github.com/abolfazl8131) - abolfazlandalib@gmail.com **<br />
-** [Mohammad Madanipour](https://github.com/mohammadll) - m.madanipourr@gmail.com **
+
+**[Abolfazl Andalib](https://github.com/abolfazl8131)** - [abolfazlandalib@gmail.com](mailto:abolfazlandalib@gmail.com)
+**[Mohammad Madanipour](https://github.com/mohammadll)** - [m.madanipourr@gmail.com](mailto:m.madanipourr@gmail.com)

app/tests/__init__.py

@@ -0,0 +1,32 @@
+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
+
+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=[{"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")
+@patch("app.main.execute_pythonfile")
+def test_helm_template_generation(mock_execute_pythonfile, mock_edit_directory_generator, mock_gpt_service, sample_helm_template_input):
+    mock_gpt_service.return_value = "Generated Python Code"
+
+    response = client.post("/Helm-template/", json=sample_helm_template_input.dict())
+
+    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")

app/tests/test_helm_template.py

@@ -0,0 +1,35 @@
+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_basic_data():
+    return IaCBasicInput(
+        input="Create a basic configuration",
+        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):
+    """
+    Test the /IaC-basic/ endpoint with valid input data.
+    """
+    response = client.post("/IaC-basic/", json=valid_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
+    """
+    actual_prompt = " ".join(mock_gpt_service.call_args[0][0].split())
+    normalized_expected_prompt = " ".join(expected_prompt.split())
+    assert actual_prompt == normalized_expected_prompt

app/tests/test_iac_basic.py

@@ -0,0 +1,38 @@
+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(
+        input="Fix the deployment issue",
+        bug_description="Application fails to start on version 1.2.3",
+        version="1.2.3",
+        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):
+    """
+    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}
+
+    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
+    """
+    actual_prompt = " ".join(mock_gpt_service.call_args[0][0].split())
+    normalized_expected_prompt = " ".join(expected_prompt.split())
+    assert actual_prompt == normalized_expected_prompt

app/tests/test_iac_bugfix.py

@@ -0,0 +1,34 @@
+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_iac_install_generation(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 acript about installation terraform in ubuntu based on terraform document.
+        without any additional note. just script for installation.
+    """
+    actual_prompt = " ".join(mock_gpt_service.call_args[0][0].split())
+    normalized_expected_prompt = " ".join(expected_prompt.split())
+    assert actual_prompt == normalized_expected_prompt

app/tests/test_iac_install.py

@@ -0,0 +1,30 @@
+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="MyService",
+        CI_integration=True,
+        base_config="BasicConfig"
+    )
+
+@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):
+    mock_gpt_service.return_value = "Generated Python Code"
+
+    response = client.post("/IaC-template/", json=sample_iac_template_input.dict())
+
+    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")