From ed62447eb2777578e36456f1b8c249c16b1e2997 Mon Sep 17 00:00:00 2001 From: Aleksey Kulikov Date: Wed, 26 Jan 2022 19:34:31 +0300 Subject: [PATCH] chore: add coverage badge --- README.md | 19 ++++++++++++------- coverage.sh | 2 ++ coverage_badge.svg | 20 ++++++++++++++++++++ 3 files changed, 34 insertions(+), 7 deletions(-) create mode 100755 coverage.sh create mode 100644 coverage_badge.svg diff --git a/README.md b/README.md index 41cb0fe..f2f2fa5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # libgit2dart +![Coverage](coverage_badge.svg) + **Dart bindings to libgit2** libgit2dart package provides ability to use [libgit2](https://github.com/libgit2/libgit2) in Dart/Flutter. @@ -717,6 +719,8 @@ submodule.sync(); Fork libgit2dart, improve libgit2dart, send a pull request. +--- + ## Development ### Troubleshooting @@ -743,23 +747,24 @@ To generate bindings with ffigen use (adjust paths to yours): dart run ffigen --compiler-opts "-I/path/to/libgit2dart/libgit2/headers/ -I/lib64/clang/12.0.1/include" ``` -## Running Tests +### Running Tests -To run all tests and generate coverage report use the following commands: +To run all tests and generate coverage report make sure to have activated packages and [lcov](https://github.com/linux-test-project/lcov) installed: ```sh $ dart pub global activate coverage -$ dart test --coverage="coverage" -$ format_coverage --lcov --check-ignore --in=coverage --out=coverage/lcov.info --packages=.packages --report-on=lib +$ dart pub global activate flutter_coverage_badge ``` -To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov): +And run: ```sh -$ genhtml coverage/lcov.info -o coverage/ +$ ./coverage.sh $ open coverage/index.html ``` +--- + ## Licence -MIT. See LICENSE file for more information. +MIT. See [LICENSE](LICENSE) file for more information. diff --git a/coverage.sh b/coverage.sh new file mode 100755 index 0000000..8b87ed6 --- /dev/null +++ b/coverage.sh @@ -0,0 +1,2 @@ +#!/bin/bash +dart test --coverage="coverage" --test-randomize-ordering-seed random && format_coverage --lcov --check-ignore --in=coverage --out=coverage/lcov.info --packages=.packages --report-on=lib && genhtml coverage/lcov.info -o coverage/ && dart pub global run flutter_coverage_badge \ No newline at end of file diff --git a/coverage_badge.svg b/coverage_badge.svg new file mode 100644 index 0000000..0c4efc0 --- /dev/null +++ b/coverage_badge.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + coverage + coverage + 100% + 100% + +