Enjinx
  • Enjinx
    • What is Enjinx ?
    • Setup and Installation
      • Install on VSCode
      • Install on JetBrains IDEs
      • Subscription Plans
      • Sign in
      • Extension Settings
      • Uninstall Enjinx
    • Enjinx Chat
      • Focus
        • Current File Focus
        • Git Diff Focus
      • Context
        • Add Context
        • Add image as Context
      • Commands
        • /ask
        • /changelog
        • /commit
        • /describe
        • /docstring
        • /enhance
        • /explain
        • /find-on-github
        • /generate-best-practices
        • /help
        • /improve
        • /issues
        • /quick-test
        • /recap
        • /review
        • /test-suite
      • Chat History
      • Model Selection
      • Company Codebase
    • Code Completion
    • Coding Agent
      • Tasks
      • Continuous Code Improvement
    • Test Generation
      • Using Test Generation
      • Behaviors
      • Test Suite
      • Configuration
      • Example Test
      • Context
      • Running Tests
    • Data Sharing
  • Enjinx cover
    • What is Enjinx Cover ?
    • Setup
      • GitHub Action
      • CLI
    • Feature Flags
    • Database Usage
    • Coverage Report
    • Examples
  • Alpha Codium
    • What is Alpha Codium?
    • Setup
    • Usage
      • Configuration
      • Solving Problems
      • Solving the entire dataset
      • Evaluation
    • Technical Q&A
    • Research Paper
    • Examples
Powered by GitBook
On this page
  1. Enjinx cover

Coverage Report

Enjinx Cover analyzes your code to pinpoint gaps in existing test coverage. It then ensures that every generated or enhanced test adds meaningful value, avoiding redundant or unnecessary tests while improving overall code quality.

Coverage reports provide insights for developers to track progress and understand the impact of new tests.

Get a Coverage Report

  1. Install Enjinx Cover on your existing project venv:

Copy

Copy

pip install git+https://github.com/Codium-ai/cover-agent.git
  1. If your project doesn't have a pyproject.toml file, create one:

Copy

Copy

[tool.poetry]
name = "cover-agent"
version = "0.0.0" # Placeholder
description = "Cover Agent Tool"
authors = ["Enjinx"]
license = "AGPL-3.0 license"
readme = "README.md"
  1. Create a branch in your repository.

  2. cd to your repository root directory.

  3. Run the following command:

Copy

Copy

export AWS_ACCESS_KEY_ID=...
export AWS_SECRET_ACCESS_KEY=...
export AWS_REGION_NAME=...

poetry run cover-agent-full-repo \
  --project-language="python" \
  --project-root="<path_to_your_repo>" \
  --code-coverage-report-path="<path_to_your_repo>/coverage.xml" \
  --test-command="coverage run -m pytest <relative_path_to_unittest_folder> --cov=<path_to_your_repo> --cov-report=xml --cov-report=term" \
  --model=bedrock/anthropic.claude-3-5-sonnet-20241022-v2:0
  1. Alternatively, if you dont want to use poetry, replace poetry run cover-agent-full-repo with:

Copy

Copy

python ./venv/lib/python3.10/site-packages/cover_agent/main_full_repo.py (Give the path to your actual installation)

Additional Configuration Options:

  • --test-file [relative path] Enjinx Cover will extend tests in the provided file only.

  • --test-folder [relative path] Enjinx Cover will automatically extend only test files in the provided folder.

  • --max-test-files-allowed-to-analyze The maximum number of test files to analyze. Default is 20.

  • --look-for-oldest-unchanged-test-files Enjinx Cover will sort the test files by the last modified date and analyze the oldest ones first. Use this option to find the test files that are most likely to be outdated, and for multiple runs. Default is False.

PreviousDatabase UsageNextExamples

Last updated 5 months ago