Search packages, repositories and app categories

Package detailsv0.5.0

test_coverage

Command line utility to run tests in Dart VM and collect coverage data.

30-day downloads
1.6K
Likes
44
Pub points
30

Install package

flutter pub add test_coverage

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

A command-line utility for running Dart tests on the VM and collecting coverage data. It helps developers measure how much of their code is exercised by tests, enabling better test quality and identification of untested code paths. The tool integrates seamlessly into CI/CD pipelines and supports both unit and integration tests. Coverage reports can be generated in various formats for analysis and reporting. Designed for simplicity and efficiency, it's particularly useful for teams aiming to maintain high test coverage standards.

Use cases

  • Measuring test coverage in CI/CD workflows
  • Identifying untested code regions
  • Generating coverage reports for team reviews
  • Integrating with automated testing pipelines
  • Validating test completeness before release
  • Monitoring coverage trends over time

Key features

  • Runs tests on the Dart VM
  • Collects detailed code coverage data
  • Supports unit and integration tests
  • Generates coverage reports
  • Easy CLI integration
  • Compatible with Flutter and Dart projects

Suitable for

  • Dart and Flutter developers
  • Teams focused on test quality
  • CI/CD automation engineers
  • Projects requiring coverage compliance
  • Developers improving test coverage
  • Quality assurance teams

Considerations

  • Requires Dart SDK setup
  • No built-in visualization (external tools needed)
  • Limited to VM-based testing
  • Coverage data not available for web or mobile platforms
  • May require additional configuration for complex projects
  • Does not support hot reload during testing

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

test_coverage Build Status Pub Coverage

A simple command-line tool to collect test coverage information from Dart VM tests. It is useful if you need to generate coverage reports locally during development.

Usage

Add dev dependency to your pubspec.yaml:

dev_dependencies:
  test_coverage: ^0.4.2

Run pub get to install. Then, in the root of your project run:

pub run test_coverage

Result is saved in coverage/lcov.info. If you have lcov tool installed on your system (for Mac it's brew install lcov) you can generate coverage reports using genhtml command:

genhtml -o coverage coverage/lcov.info
# Open in the default browser (mac):
open coverage/index.html

Integrations

Resulting coverage/lcov.info file is ready to be consumed by Codecov command-line tool, so no extra step is needed.

This library was not tested with coveralls yet.

Generating badge image

Coverage

Coverage badge SVG image is automatically generated and saved to coverage_badge.svg in your project root directory. You can add it to Git and use in README.md on Github as follows:

![Coverage](https://raw.githubusercontent.com/{you}/{repo}/master/coverage_badge.svg?sanitize=true)

If you don't need it you can pass --no-badge flag when running test coverage.

Known limitations

  • This library was created to run Dart VM tests. It has not been tested and likely won't work for Dart code targeting web platform (compiled to JavaScript). There is no need to use this tool for Flutter as it allows collecting coverage information with flutter test --coverage.

How it works

The tool performs following steps:

1. Generates test/.test_coverage.dart file (a "test all" script).

Scans your test/ directory to find all *_test.dart files and creates test/.test_coverage.dart which imports all found test files and runs corresponding main() of all tests functions within the same file (and process), which simplifies collection of coverage information.

It is recommended to add this file to your .gitignore.

Below is an example of test/.test_coverage.dart:

// Auto-generated by test_coverage. Do not edit by hand.
// Consider adding this file to your .gitignore.

import 'some_test.dart' as some_test;
import 'nested/other_test.dart' as other_test;
import 'some_other_test.dart' as some_other_test;

void main() {
  some_test.main();
  other_test.main();
  some_other_test.main();
}
2. Runs the tests

Following command is used to run the tests:

dart --pause-isolates-on-exit --enable_asserts --enable-vm-service \
  test/.test_coverage.dart
3. Collects and formats coverage information

When test execution is completed the tool uses functionality of the coverage package to collect and format coverage report.

Feel free to file feature requests and bug reports at the issue tracker.

4. Minimal coverage percentage

Set minimal coverage percentage to pass min-coverage percentage value of coverage.

5. See test output

print-test-output to show test output.

Show output of tests

Feel free to file feature requests and bug reports at the issue tracker.

Categories

Dependencies

Dependency list 5 items

Source repository

Projects using this package