Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/yeshan333/ex_integration_coveralls

A library for run-time system code line-level coverage analysis.
https://github.com/yeshan333/ex_integration_coveralls

code-line-level-coverage coverage elixir-library intergration-test run-time-analysis run-time-system

Last synced: about 2 months ago
JSON representation

A library for run-time system code line-level coverage analysis.

Host: GitHub
URL: https://github.com/yeshan333/ex_integration_coveralls
Owner: yeshan333
License: mit
Created: 2022-06-17T14:37:50.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-03-16T07:05:50.000Z (3 months ago)
Last Synced: 2024-04-17T02:17:47.692Z (2 months ago)
Topics: code-line-level-coverage, coverage, elixir-library, intergration-test, run-time-analysis, run-time-system
Language: Elixir
Homepage: https://hexdocs.pm/ex_integration_coveralls
Size: 138 KB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Lists

awesome-elixir - ex_integration_coveralls - A library for Elixir run-time system code line-level coverage analysis. You can use it to evaluate the integration tests code coverage. [Introduction article](https://github.com/yeshan333/explore_ast_app/blob/main/examples/README.md). (Testing)

README

# ExIntegrationCoveralls

[![Coverage Status](https://coveralls.io/repos/github/yeshan333/ex_integration_coveralls/badge.svg?branch=main)](https://coveralls.io/github/yeshan333/ex_integration_coveralls?branch=main) [![hex.pm version](https://img.shields.io/hexpm/v/ex_integration_coveralls.svg)](https://hex.pm/packages/ex_integration_coveralls) [![hex.pm downloads](https://img.shields.io/hexpm/dt/ex_integration_coveralls.svg)](https://hex.pm/packages/ex_integration_coveralls) [![hex.pm license](https://img.shields.io/hexpm/l/ex_integration_coveralls.svg)](https://github.com/yeshan333/ex_integration_coveralls/blog/main/LICENSE)

A library for run-time system code line-level coverage analysis. You can use it to evaluate the intergration test coverage.

> realistic practice:
> - [en](https://github.com/yeshan333/explore_ast_app/blob/main/examples/README.md)
> - [zh_hans 中文版](https://github.com/yeshan333/explore_ast_app/blob/main/examples/README_cn.md)

## Running Tests

To run tests with coverage data, run the following command:

```shell
mix test --cover --exclude real_cover
```

## Installation

The package can be installed by adding `ex_integration_coveralls` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:ex_integration_coveralls, "~> 0.8.2"}
]
end
```

The docs can be found at [https://hexdocs.pm/ex_integration_coveralls](https://hexdocs.pm/ex_integration_coveralls/readme.html).

## Quick Start

Once your application is release, up and running. You only need the following three steps to do run-time coverage collection:

- Step 1、Connects a shell to the running node which your application is running:

```shell
/path/bin/your_app remote_console
```

- Step 2、Specific the application start coverage collection:

```shell
ExIntegrationCoveralls.start_app_cov("your_app_name")
```

Note: the `your_app_name` must exist in the return app list of [:application.which_applications](https://www.erlang.org/doc/man/application.html#which_applications-0).

- Step 3、Conduct external testing against the above application. Get run-time coverage or post coverage data to coverage system.

```shell
ExIntegrationCoveralls.get_app_total_cov("your_app_name")
# post coverage data
ExIntegrationCoveralls.post_app_cov_to_ci(url, extends, "your_app_name")
```

Note: Your application release package should include the source code. ExIntegrationCoveralls will use the source code to caculate coverage stats. The general structure is as follows:

```shell
.
├── bin
│ ├── explore_ast_app
│ ├── explore_ast_app.bat
│ ├── explore_ast_app_rc_exec.sh
│ ├── no_dot_erlang.boot
│ └── start_clean.boot
├── erts-12.1
│ ├── bin
│ ├── doc
│ ├── include
│ ├── info
│ ├── lib
│ └── src
├── lib
│ ├── artificery-0.4.3
│ ├── asn1-5.0.17
│ ├── certifi-2.9.0
│ ├── elixir-1.12.3
│ ├── ex_integration_coveralls-0.4.0 # your running app
│ ├── explore_ast_app-0.1.0
│ │ ├── consolidated
│ │ ├── ebin
│ │ └── lib # source code in here
│ └── unicode_util_compat-0.7.0
└── releases
├── 0.1.0
├── RELEASES
└── start_erl.data
```

Note: If you use the [distillery](https://github.com/bitwalker/distillery) to get OTP release, and config `set include_src: true`, then you can get the above structure. But if you use the Elixir origin `mix release`, this situation needs to be handled manually.

## License

Distributed under the MIT License. See [LICENSE](LICENSE) for more information.

## Acknowledgements

Thanks for these awesome resources that were used during the development of the **ExIntegrationCoveralls**:

- [Erlang cover](https://www.erlang.org/doc/man/cover.html#description)
- [A brief introduction to BEAM](https://www.erlang.org/blog/a-brief-beam-primer/)
- [excoveralls](https://github.com/parroty/excoveralls)
- [BeamFile - A peek into the BEAM file](https://github.com/hrzndhrn/beam_file)
- [The Elixir AST explorer - ast_ninja](https://github.com/arjan/ast_ninja)