Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nifoc/ecoveralls

Coveralls reports for Erlang projects.
https://github.com/nifoc/ecoveralls

Last synced: 29 days ago
JSON representation

Coveralls reports for Erlang projects.

Host: GitHub
URL: https://github.com/nifoc/ecoveralls
Owner: nifoc
Created: 2014-08-04T19:28:21.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2014-12-30T17:16:43.000Z (almost 10 years ago)
Last Synced: 2023-10-26T05:32:40.056Z (about 1 year ago)
Language: Erlang
Size: 301 KB
Stars: 4
Watchers: 3
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# ECoveralls

[Coveralls](https://coveralls.io) reports for Erlang projects.

[![Build Status](https://travis-ci.org/nifoc/ecoveralls.png)](https://travis-ci.org/nifoc/ecoveralls) [![Coverage Status](https://coveralls.io/repos/nifoc/ecoveralls/badge.png?branch=master)](https://coveralls.io/r/nifoc/ecoveralls?branch=master)

## Status

This is alpha software. Things might still change in ways that break everything.

## Usage

**This is currently only known to work with erlang.mk, Common Test and Travis CI.**

### cover.spec

In order to have one `.coverdata` file that includes all test suites it is recommended to add the following line to your `cover.spec`:

```erlang
{export, "logs/all.coverdata"}.
```

This will write an `all.coverdata` file to your `logs` directory, which is what Common Test uses by default.

### erlang.mk

Just add ECoveralls as a testing dependency.

```makefile
TEST_DEPS = ecoveralls
dep_ecoveralls = git https://github.com/nifoc/ecoveralls master
```

If you only want to depend on ECoveralls when tests are running on Travis CI, you can do something like the following instead:

```makefile
ifeq ($(USER),travis)
TEST_DEPS += ecoveralls
dep_ecoveralls = git https://github.com/nifoc/ecoveralls master
endif
```

Your `CT_OPTS` have to reference the `cover.spec` file.

```makefile
CT_OPTS = -cover ./test/cover.spec
```

### Travis CI

Add the following target to your `Makefile` (after the erlang.mk include):

```makefile
coverage-report: $(shell ls -1rt `find logs -type f -name \*.coverdata 2>/dev/null` | tail -n1)
$(gen_verbose) erl -noshell -pa ebin deps/*/ebin -eval 'ecoveralls:travis_ci("$?"), init:stop()'

.PHONY: coverage-report
```

If you're not using erlang.mk you should replace `$(gen_verbose) ` with `@`.

Now you have to tell Travis to send data to Coveralls after a (successful) test run. You can do this by adding the following lines to your `.travis.yml`:

```yaml
after_success:
- make coverage-report
```

## License

[ISC](https://en.wikipedia.org/wiki/ISC_license).

Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
```