test_cov 0.2.0

  • Readme
  • Changelog
  • Installing
  • 57

test_cov Build Status

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_cov: ^0.1.0

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

pub run test_cov

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.

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_cov.dart file which is essentially a "test all" script.

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

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

// Auto-generated by test_cov. 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-vm-service test/.test_cov.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.

0.2.0 #

  • Make non-zero exit code throw error

0.1.0 #

Initial reissue of the test_coverage package that has previously been maintained by @pulyaevskiy

  • Remove badge generation
  • Enable more logging (information about cause of test failure)

Use this package as an executable

1. Install it

You can install the package from the command line:


$ pub global activate test_cov

2. Use it

The package has the following executables:


$ test_cov

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  test_cov: ^0.2.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:test_cov/test_cov.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
23
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
57
Learn more about scoring.

We analyzed this package on Oct 16, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, other

Primary library: package:test_cov/test_cov.dart with components: io.

Health issues and suggestions

Document public APIs. (-1 points)

9 out of 9 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance issues and suggestions

Support latest dependencies. (-10 points)

The version constraint in pubspec.yaml does not support the latest published versions for 1 dependency (coverage).

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and test_cov.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
coverage ^0.12.4 0.12.4 0.13.3
lcov ^5.1.0 5.4.0
path ^1.6.2 1.6.4
Transitive dependencies
args 1.5.2
async 2.4.0
charcode 1.1.2
collection 1.14.12
convert 2.1.1
crypto 2.1.3
json_annotation 3.0.0
json_rpc_2 2.1.0
logging 0.11.3+2
package_config 1.1.0
pub_semver 1.4.2
source_span 1.5.5
stack_trace 1.9.3
stream_channel 2.0.0
term_glyph 1.1.0
typed_data 1.1.6
vm_service_client 0.2.6+3
web_socket_channel 1.1.0
Dev dependencies
test ^1.6.1