Updated CHANGELOG and README, added pending changes also

Author: MirkoZETA

.github/workflows/README.md

@@ -55,7 +55,7 @@ This guide helps developers set up, test, and deploy the Flex Net Sim Backend AP
 Run the test suite to ensure code quality:
 
 ```bash
-pytest --cov=backend tests/
+pytest --cov=backend --cov=utils tests/
 ```
 
 ## Docker Deployment

.github/workflows/fns-api-workflow.yml

@@ -45,7 +45,7 @@ jobs:
 
       - name: Run tests with coverage
         run: |
-          pytest --cov=backend --cov-report=html tests/
+          pytest --cov=backend --cov=utils --cov-report=html tests/
 
       - name: Prepare coverage report for GitHub Pages
         run: |

CHANGELOG.md

@@ -8,6 +8,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### ROADMAP
 - Switch to new domain.
 
+## [2.0.2] - 2025-03-11
+
+### Added
+- Comprehensive unit tests for parameter validation in simulation requests
+- Better validation error messages for all simulation parameters
+- Helper methods for test assertions to improve code readability
+
+### Changed
+- Enhanced test coverage for the helpers module
+- Improved test structure with dedicated test methods per parameter
+
+### Fixed
+- Edge case handling in parameter validation
+
+
 ## [2.0.1] - 2025-03-04
 
 ### Fixed
@@ -88,7 +103,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documentation README for the process of develop/deployment located in [workflows](https://github.com/MirkoZETA/FlexNetSim-API/tree/master/.github/workflows/README_DEV.md).
 
 [1.0.0]: https://github.com/MirkoZETA/FlexNetSim-API/releases/tag/v1.0.0
-[1.1.0]: https://github.com/MirkoZETA/FlexNetSim-API/releases/tag/v1.1.0
-[1.1.1]: https://github.com/MirkoZETA/FlexNetSim-API/releases/tag/pipeline-fix
-[2.0.0]: https://github.com/MirkoZETA/FlexNetSim-API/releases/tag/v2.0.0
-[2.0.1]: https://github.com/MirkoZETA/FlexNetSim-API/releases/tag/v2.0.1
+[1.1.0]: https://github.com/MirkoZETA/FlexNetSim-API/compare/v1.0.0...v1.1.0
+[1.1.1]: https://github.com/MirkoZETA/FlexNetSim-API/compare/v1.1.0...pipeline-fix
+[2.0.0]: https://github.com/MirkoZETA/FlexNetSim-API/compare/pipeline-fix...v2.0.0
+[2.0.1]: https://github.com/MirkoZETA/FlexNetSim-API/compare/v2.0.1...v2.0.0
+[2.0.2]: https://github.com/MirkoZETA/FlexNetSim-API/compare/v2.0.2...v2.0.1

README.md

@@ -4,7 +4,7 @@
 ![Static Badge](https://img.shields.io/badge/language-python-blue)
 [![Static Badge](https://img.shields.io/badge/licese-MIT-green)](https://github.com/MirkoZETA/FlexNetSim-API/blob/master/LICENSE)
 [![Static Badge](https://github.com/MirkoZETA/FlexNetSim-API/actions/workflows/fns-api-workflow.yml/badge.svg)](https://github.com/MirkoZETA/FlexNetSim-API/actions/workflows/fns-api-workflow.yml)
-[![Static Badge](https://img.shields.io/badge/coverage-95%25-brightgreen)](https://mirkozeta.github.io/FlexNetSim-API/coverage/)
+[![Static Badge](https://img.shields.io/badge/coverage-93%25-brightgreen)](https://mirkozeta.github.io/FlexNetSim-API/coverage/)
 
 A lightweight API for running optical network simulations with [Flex Net Sim C++](https://gitlab.com/DaniloBorquez/flex-net-sim).
 

tests/test_compilation.py

@@ -27,7 +27,7 @@ def test_compilation_failure(self):
 
     # Test with invalid main.cpp file
     if os.path.exists("./src/test_main.cpp"):
-      with temporarily_rename_file("./src/main.cpp", "./src.main.cpp.temp"):
+      with temporarily_rename_file("./src/main.cpp", "./src/main.cpp.temp"):
         with temporarily_rename_file("./src/test_main.cpp", "./src/main.cpp"):
           compile_result = compile_simulation(debug=True)
           self.assertFalse(compile_result)

tests/test_helpers.py

@@ -5,6 +5,7 @@
 from flask_testing import TestCase
 from backend import app
 from utils.helpers import *
+from tests.test_utils import temporarily_rename_file
 
 class TestHelpers(TestCase):
     """Tests for utils functions"""
@@ -15,20 +16,18 @@ def create_app(self):
 
     def test_compile_simulation(self):
         # Test compilation failure
-        os.rename("./src/main.cpp", "./src/main.cpp.temp")
-        self.assertFalse(compile_simulation(debug=True))
-        os.rename("./src/main.cpp.temp", "./src/main.cpp")
+        with temporarily_rename_file("./src/main.cpp", "./src/main.cpp.temp"):
+            self.assertFalse(compile_simulation(debug=True))
 
         # Test compilation success
         self.assertTrue(compile_simulation(debug=True))
 
     def test_validate_simulation_prerequisites(self):
         # Test when executable is not found
-        os.rename("./src/simulation.out", "./src/simulation.out.temp_error")
-        is_valid, response = validate_simulation_prerequisites()
-        self.assertFalse(is_valid)
-        self.assertEqual(response[1], 500)
-        os.rename("./src/simulation.out.temp_error", "./src/simulation.out")
+        with temporarily_rename_file("./src/simulation.out", "./src/simulation.out.temp_error"):
+            is_valid, response = validate_simulation_prerequisites()
+            self.assertFalse(is_valid)
+            self.assertEqual(response[1], 500)
 
         # Test when executable is found
         self.assertTrue(compile_simulation(debug=True))