Split UTGenerator into generator and validator

[coderustic]

User description

Issue #170 aims to tackle the refactor of UnitTestGenerator and
this is an attempt to split UnitTestGenerator into generator and
validator. This PR is a first of a series of refactoring we can
apply to UnitTestGenerator.

• Created a new class UnitTestValidator by copying running,
  validating and processing coverage from UnitTestGenerator

• Doesn't include any cleanup or optimization and kept the PR
  to be minimal structural changes.

• Use prompt from UnitTestGenerator when storing a failed test
  into the database.

---

PR Type

enhancement, tests

---

Description

• Refactored UnitTestGenerator by splitting its functionality into two separate classes: UnitTestGenerator and UnitTestValidator.
• Integrated UnitTestValidator into CoverAgent for handling test validation and coverage checks.
• Simplified UnitTestGenerator by removing validation and coverage-related methods.
• Added comprehensive tests for UnitTestValidator to ensure proper validation and error handling.
• Updated existing tests to accommodate the new UnitTestValidator class and its integration.

---

Changes walkthrough 📝

	Relevant files
Enhancement	CoverAgent.py Integrate UnitTestValidator into CoverAgent for validation cover_agent/CoverAgent.py Added UnitTestValidator class to CoverAgent. Updated methods to use UnitTestValidator for validation. Adjusted logging and coverage checks to use UnitTestValidator. +32/-14  UnitTestGenerator.py Simplify UnitTestGenerator by removing validation logic    cover_agent/UnitTestGenerator.py Removed validation and coverage methods. Simplified generate_tests method. Adjusted prompt building to accept failed test runs. +14/-558 UnitTestValidator.py Introduce UnitTestValidator for test validation and coverage cover_agent/UnitTestValidator.py Created UnitTestValidator class for test validation. Implemented methods for running coverage and validating tests. Added error message extraction and logging. +741/-0
Tests	test_CoverAgent.py Update CoverAgent tests to incorporate UnitTestValidator  tests/test_CoverAgent.py Updated tests to use UnitTestValidator. Adjusted mock setups for new validation process. +11/-7    test_UnitTestGenerator.py Remove validation tests from UnitTestGenerator tests          tests/test_UnitTestGenerator.py Removed tests related to validation logic. Updated tests to reflect changes in UnitTestGenerator. +4/-162  test_UnitTestValidator.py Add tests for UnitTestValidator functionality                        tests/test_UnitTestValidator.py Added tests for UnitTestValidator. Covered error handling and coverage validation. +170/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-pro]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 170 - Fully compliant Fully compliant requirements: Split UnitTestGenerator into two separate classes: UnitTestGenerator and UnitTestValidator Move validation and coverage functionality from UnitTestGenerator to UnitTestValidator Let CoverAgent handle test validation using UnitTestValidator Move run_coverage into UnitTestValidator

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Code Smell Commented out build_prompt method implementation but left empty method stub. Should either implement or remove completely. Potential Bug Validator stores test_headers_indentation and line numbers as instance variables which could cause issues if multiple tests are validated concurrently Code Duplication Constructor arguments are duplicated between test_gen and test_validator initialization. Consider refactoring to avoid duplication.

[codiumai-pr-agent-pro]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	Fix infinite recursion in method by removing recursive self-call The build_prompt method is called recursively which will cause infinite recursion - the method calls itself with the same arguments. This needs to be fixed to avoid stack overflow errors. cover_agent/UnitTestGenerator.py [164] def build_prompt(self, failed_test_runs): - # ... - self.prompt = self.build_prompt(failed_test_runs=failed_test_runs) + # ... rest of the method implementation ... + # Remove the recursive call + return self.prompt_builder.build_prompt() Suggestion importance[1-10]: 10 Why: The recursive call would cause a stack overflow error since the method calls itself with the same arguments. This is a critical bug that needs to be fixed.	10
	Add error handling around test validation to prevent crashes from failed test executions Add error handling around test validation to catch potential exceptions that could occur during test execution. cover_agent/CoverAgent.py [163-167] -test_result = self.test_validator.validate_test( - generated_test, self.args.run_tests_multiple_times -) -test_result["prompt"] = self.test_gen.prompt["user"] -test_results_list.append(test_result) +try: + test_result = self.test_validator.validate_test( + generated_test, self.args.run_tests_multiple_times + ) + test_result["prompt"] = self.test_gen.prompt["user"] + test_results_list.append(test_result) +except Exception as e: + self.logger.error(f"Failed to validate test: {str(e)}") Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding error handling around test validation is crucial as test execution can fail for various reasons. This suggestion would improve robustness and prevent the entire process from crashing due to individual test failures.	8
	Add error handling for file operations to gracefully handle IO errors Add error handling for potential file read failure when loading source code in init. cover_agent/UnitTestValidator.py [91-92] -with open(self.source_file_path, "r") as f: - self.source_code = f.read() +try: + with open(self.source_file_path, "r") as f: + self.source_code = f.read() +except IOError as e: + self.logger.error(f"Failed to read source file {self.source_file_path}: {e}") + raise Apply this suggestion Suggestion importance[1-10]: 7 Why: Adding proper error handling for file operations is important for robustness, as it helps identify and handle file access issues explicitly while maintaining proper logging.	7
	Add validation for empty or None return values before using them in subsequent operations Add a check for failed_test_runs being None or empty before using it to build the prompt, as get_coverage() could potentially return no failed tests. cover_agent/CoverAgent.py [142-144] self.test_validator.initial_test_suite_analysis() failed_test_runs = self.test_validator.get_coverage() -self.test_gen.build_prompt(failed_test_runs) +if failed_test_runs: + self.test_gen.build_prompt(failed_test_runs) Apply this suggestion Suggestion importance[1-10]: 7 Why: This is a valid defensive programming suggestion that could prevent potential runtime errors if get_coverage() returns None or empty results. The validation is particularly important since this code is part of the core test generation flow.	7
General	Remove redundant commented out method definition to improve code clarity The commented out build_prompt method definition should be removed since it's redundant with the actual implementation below. Having both the commented and actual method creates confusion and makes the code harder to maintain. cover_agent/UnitTestGenerator.py [88-96] -# def build_prompt(self, failed_test_runs): -# """ -# Run code coverage and build the prompt to be used for generating tests. +# Remove the commented out method definition entirely -# Returns: -# None -# """ -# # Run coverage and build the prompt -# self.prompt = self.build_prompt(failed_test_runs=failed_test_runs) - Apply this suggestion Suggestion importance[1-10]: 7 Why: The commented out code is redundant and adds confusion since the actual implementation exists below. Removing it would improve code readability and maintainability.	7
	Prevent division by zero by checking denominator before division rather than catching exception Handle potential division by zero error when calculating percentage_covered by checking if total_lines is 0 before performing the division. cover_agent/UnitTestValidator.py [306-310] -try: +if total_lines > 0: percentage_covered = total_lines_covered / total_lines -except ZeroDivisionError: - self.logger.error(f"ZeroDivisionError: Attempting to perform total_lines_covered / total_lines: {total_lines_covered} / {total_lines}.") +else: + self.logger.error(f"Cannot calculate coverage - no lines to cover: total_lines_covered={total_lines_covered}, total_lines={total_lines}") percentage_covered = 0 Apply this suggestion Suggestion importance[1-10]: 3 Why: While the suggestion proposes a more proactive approach to handling division by zero, the existing code already handles this case adequately with exception handling. The improvement is mainly stylistic.	3

💡 Need additional feedback ? start a PR chat

[EmbeddedDevops1]

Good to go.