Coverco is designed to fine-tune coverage percentages. It is intended to integrate seamlessly into CI/CD pipelines or serve as a tool for developers to assess their code's test coverage. Additionally, Coverco helps filter out noisy coverages that contribute minimally to overall value. It can be intgrated with VSCode for a great developemnt experience.
- Thresholds: Define coverage thresholds for individual packages or patterns.
- Exclusions: Exclude specific packages from coverage analysis.
- Logging: Configure logging levels and optionally log to a file.
- Command-Line Flags: Override default configurations using command-line flags.
Configuration is managed via a YAML file (config.yaml by default) with the following structure:
# Default coverage threshold applied to all packages not explicitly listed
default_coverage_threshold: 80.0
# Directory to save coverage reports
coverage_reports_dir: "coverage_reports"
# File Format of coverage reports
coverage-reports-format: "lcov"
# List of package coverage configurations
cover_packages:
# Pattern to match package and its specific threshold
- name: "demo/arrays"
threshold: 95.0
- name: "demo/services/*"
threshold: 90.0
- name: "demo/utility/*"
threshold: 85.0
- name: "*" # Default pattern covering all packages
threshold: 80.0
# Patterns to exclude specific packages
exclude_packages:
- "demo/exclude/*"
- "demo/skip/*"
# Logging configuration
logging:
level: "info" # Can be "debug", "info", "warn", "error"
file: "coverage.log" # Log file path (optional)- Install gcov2lcov: Used to convert golang test coverage to lcov format.
go install github.com/jandelgado/gcov2lcov@latest-
Install Coverco: Install the
Covercotool.go install github.com/mkabdelrahman/coverco
-
Create Configuration File: Create a
config.yamlfile in your project root with desired configurations. Example configurations are provided above. -
Run Coverco:
coverco [flags...] [dir]
- Replace
config.yamlwith your actual configuration file path. If no-configflag is provided, Coverco will use internal defaults. [dir]is the path to the folder to list Go packages, with a default value of..
- Replace
-
Command-Line Flags:
-config: Path to the configuration file (optional; default:config.yaml).-default-threshold: Default coverage threshold (default:80.0).-coverage-dir: Directory for coverage reports (default:./coverage_reports).-coverage-reports-format: Format for coverage reports (default:lcov).-log-level: Log level (debug,info,warn,error; default:info).-log-file: Log file path (default: log to stdout).-keep-reports: Keep coverage reports after printing (default:false).-exclude: Comma-separated list of package patterns to exclude (e.g.,-exclude=demo/exclude/*,demo/skip/*).
-
Configuration Priority:
- Command-line flags have the highest priority.
- YAML configuration file values have higher priority than defaults.
- Internal defaults are used if neither flags nor configuration file values are provided.
❯ git clone https://github.com/fyne-io/fyne.git
❯ git cd fyne
❯ coverco -exclude "*/cmd/*,*/driver/*,*/app" -default-threshold 70
2024/06/17 01:06:28 INFO Running go mod tidy...
2024/06/17 01:06:28 INFO Excluding package: fyne.io/fyne/v2/app
2024/06/17 01:06:28 INFO Excluding package: fyne.io/fyne/
.
.
.
+-------------------------------------------+---------------------+-----------+
| PACKAGE NAME | COVERAGE PERCENTAGE | THRESHOLD |
+-------------------------------------------+---------------------+-----------+
| fyne.io/fyne/v2 | 65.80% | 70.00% |
| fyne.io/fyne/v2/canvas | 59.80% | 70.00% |
| fyne.io/fyne/v2/container | 86.20% | 70.00% |
| fyne.io/fyne/v2/data/binding | 43.40% | 70.00% |
| fyne.io/fyne/v2/data/validation | 88.20% | 70.00% |
| fyne.io/fyne/v2/dialog | 79.70% | 70.00% |
| fyne.io/fyne/v2/driver | 100.00% | 70.00% |
| fyne.io/fyne/v2/internal | 69.40% | 70.00% |
| fyne.io/fyne/v2/internal/animation | 77.90% | 70.00% |
| fyne.io/fyne/v2/internal/async | 54.50% | 70.00% |
| fyne.io/fyne/v2/internal/cache | 61.60% | 70.00% |
| fyne.io/fyne/v2/internal/color | 16.40% | 70.00% |
| fyne.io/fyne/v2/internal/driver | 90.80% | 70.00% |
| fyne.io/fyne/v2/internal/painter | 52.10% | 70.00% |
| fyne.io/fyne/v2/internal/painter/gl | 0.00% | 70.00% |
| fyne.io/fyne/v2/internal/painter/software | 92.10% | 70.00% |
| fyne.io/fyne/v2/internal/repository | 86.10% | 70.00% |
| fyne.io/fyne/v2/internal/repository/mime | 100.00% | 70.00% |
| fyne.io/fyne/v2/internal/scale | 0.00% | 70.00% |
| fyne.io/fyne/v2/internal/svg | 60.60% | 70.00% |
| fyne.io/fyne/v2/internal/test | 68.20% | 70.00% |
| fyne.io/fyne/v2/internal/widget | 88.80% | 70.00% |
| fyne.io/fyne/v2/layout | 94.50% | 70.00% |
| fyne.io/fyne/v2/storage | 62.00% | 70.00% |
| fyne.io/fyne/v2/storage/repository | 47.40% | 70.00% |
| fyne.io/fyne/v2/test | 63.80% | 70.00% |
| fyne.io/fyne/v2/theme | 57.10% | 70.00% |
| fyne.io/fyne/v2/tools/playground | 0.00% | 70.00% |
| fyne.io/fyne/v2/widget | 92.20% | 70.00% |
+-------------------------------------------+---------------------+-----------+Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
ext install ryanluker.vscode-coverage-gutters
Then modify the base direcotry in the extension settings to coverage-dir.
Contributions are welcome! Please fork the repository and submit pull requests for any improvements you'd like to make.