Tr/convert to a sepcific test file

mrT23 commented 4 days ago

PR Type

enhancement, documentation

Description

Enhanced the test command adaptation process to support running a single test file using AI, improving flexibility and automation.
Introduced new CLI options to specify a test file or folder, allowing more granular control over test execution.
Improved logging and error handling for test command conversion, providing better user feedback.
Updated documentation to reflect new features and provide clearer instructions for users.

Changes walkthrough 📝

Relevant files

Enhancement

CoverAgent.py `Enhance test command adaptation for single test execution` cover_agent/CoverAgent.py Added logic to adapt test command for a single test using AI. Improved error handling for command adaptation. Enhanced logging for command conversion.	+14/-7
PromptBuilder.py `Add AI-based test command adaptation function` cover_agent/PromptBuilder.py Introduced function to adapt test command using AI. Integrated AI caller for command adaptation. Added error handling for AI-based command adaptation.	+25/-0
main.py `Add CLI option for separate test execution` cover_agent/main.py - Added CLI option to run each test separately.	+6/-0
main_full_repo.py `Enhance logging for test file extension` cover_agent/main_full_repo.py - Improved logging for test files to be extended.	+1/-1
utils.py `Enhance test file selection with new CLI options` cover_agent/utils.py Added CLI options for specifying test folder and file. Improved logic for finding test files based on new options.	+22/-5

Configuration changes

config_loader.py `Add configuration for AI-based test command adaptation` cover_agent/settings/config_loader.py - Added new configuration file for AI-based test command adaptation.	+1/-0
adapt_test_command_for_a_single_test_via_ai.toml `Add TOML configuration for AI-based test command adaptation` cover_agent/settings/adapt_test_command_for_a_single_test_via_ai.toml - Added configuration for AI-based adaptation of test commands.	+57/-0

Documentation

repo_coverage.md

Update documentation for new test command options

docs/repo_coverage.md

Updated documentation for new CLI options.

Improved guidance on test command usage.

+6/-3

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

codiumai-pr-agent-pro[bot] commented 4 days ago

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review

Error Handling
The error handling in parse_command_to_run_only_a_single_test could be improved. If new_command_line is None, there's no feedback to the user about the failure. Exception Handling
The adapt_test_command_for_a_single_test_via_ai function catches all exceptions generically, which could mask specific issues. Consider handling specific exceptions separately. Code Duplication
The run_each_test_separately argument is defined twice - in both parse_args() and parse_args_full_repo(). Consider consolidating these into a shared function.

codiumai-pr-agent-pro[bot] commented 4 days ago

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible issue	Add validation to ensure test file path exists before attempting to use it ___ Add error handling for the case when `test_file_relative_path` is invalid or doesn't exist. Currently the code assumes the path is valid but this could lead to runtime errors. [cover_agent/CoverAgent.py [71-72]](https://github.com/Codium-ai/cover-agent/pull/226/files#diff-dac868643df79ec6dfcf446359468a88ba6a6617bb8ffa0139757f0fbf5195b1R71-R72) ```diff test_file_relative_path = os.path.relpath(args.test_file_output_path, args.project_root) +if not os.path.exists(os.path.join(args.project_root, test_file_relative_path)): + print(f"Error: Test file path does not exist: {test_file_relative_path}") + return if 'pytest' in test_command: ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion adds critical error handling to prevent runtime failures when dealing with invalid file paths, which could cause the tool to fail silently or produce unexpected behavior.	8
	✅ Validate test folder path exists before attempting to use it ___ Suggestion Impact: The commit added validation to check if the test_folder exists, printing an error message and exiting if it does not, which aligns with the suggestion. code diff: ```diff + # validate that the test folder exists + if hasattr(args, "test_folder") and args.test_folder: + full_path = os.path.join(project_dir, args.test_folder) + if os.path.exists(full_path): + print(f"\nExtending the test folder: `{full_path}`\n") + else: + print(f"Test folder not found: `{full_path}`, exiting.\n") exit(-1) ``` ___ Add validation to ensure that `test_folder` exists when provided, similar to the validation done for `test_file`. This prevents silent failures when an invalid folder is specified. [cover_agent/utils.py [303-305]](https://github.com/Codium-ai/cover-agent/pull/226/files#diff-4b68afa4ecc709b261a42ca40bfe986f4d150bf47184bdecdadc4954d434dcb0R303-R305) ```diff if hasattr(args, "test_folder") and args.test_folder: + test_folder_path = os.path.join(project_dir, args.test_folder) + if not os.path.exists(test_folder_path): + print(f"Test folder not found: `{test_folder_path}`, exiting.\n") + exit(-1) if args.test_folder not in root: continue ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 8 Why: Critical validation to fail fast when an invalid test folder is provided, preventing silent failures and providing clear error messages to users.	8
	Validate AI-generated command is not empty before returning it ___ The function should validate that `new_command_line` is not empty or None before returning it. An empty command could cause issues when executed. [cover_agent/PromptBuilder.py [222-224]](https://github.com/Codium-ai/cover-agent/pull/226/files#diff-1602223755506d62450bdc4cea9140b0a11ccf93f7cd00151970cd1d649786adR222-R224) ```diff response_yaml = load_yaml(response) new_command_line = response_yaml["new_command_line"].strip() +if not new_command_line: + logging.error("Received empty command line from AI") + return None return new_command_line ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 7 Why: Important validation to prevent potential runtime errors by ensuring the AI-generated command is valid before using it, though the existing error handling would catch most issues.	7

💡 Need additional feedback ? start a PR chat

Codium-ai / cover-agent