Class CoverAgent

cover_agent/CoverAgent.py:22–394

A class that manages the generation and validation of unit tests to achieve desired code coverage. This agent coordinates between test generation and validation components, handles file management, and tracks the progress of coverage improvements over multiple iterations.

class CoverAgent:
    """
    A class that manages the generation and validation of unit tests to achieve desired code coverage.
    
    This agent coordinates between test generation and validation components, handles file management,
    and tracks the progress of coverage improvements over multiple iterations.
    """
    def __init__(
        self,
        config: CoverAgentConfig,
        agent_completion: AgentCompletionABC=None,
        logger: Optional[CustomLogger]=None,
    ):
        """
        Initialize the CoverAgent instance.

        Args:
            config (CoverAgentConfig): Configuration object containing all necessary settings for the agent.
            agent_completion (AgentCompletionABC, optional): Custom agent completion object. Defaults to None,
                in which case a default completion object is initialized.
            logger (Optional[CustomLogger], optional): Custom logger instance. Defaults to None,
                in which case a default logger is created.

        Attributes:
            logger (CustomLogger): Logger instance for logging messages.
            config (CoverAgentConfig): Configuration object for the agent.
            agent_completion (AgentCompletionABC): Agent completion object for handling AI interactions.
        """
        self.config = config
        self.generate_log_files = not config.suppress_log_files

        # Initialize logger with file generation flag
        self.logger = logger or CustomLogger.get_logger(__name__, generate_log_files=self.generate_log_files)
        if config.suppress_log_files:
            self.logger.info("Suppressed all generated log files.")

        self._validate_paths()
        self._duplicate_test_file()

        # Configure the AgentCompletion object
        if agent_completion:
            self.agent_completion = agent_completion
        else:
            self.ai_caller = self._initialize_ai_caller()
            self.agent_completion = DefaultAgentCompletion(
                caller=self.ai_caller, generate_log_files=self.generate_log_files
            )

        # Modify test command for a single test execution if needed
        test_command = self.config.test_command
        new_command_line = None
        if hasattr(self.config, "run_each_test_separately") and self.config.run_each_test_separately:
            # Calculate a relative path for a test file
            test_file_relative_path = os.path.relpath(
                self.config.test_file_output_path, self.config.project_root
            )
            # Handle pytest commands specifically
            if "pytest" in test_command: