https://github.com/fukamachi/cl-coveralls

https://github.com/fukamachi/cl-coveralls

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/fukamachi/cl-coveralls
• Owner: fukamachi
• Created: 2015-03-18T07:17:43.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-03-08T13:53:51.000Z (over 3 years ago)
• Last Synced: 2024-05-02T01:14:29.805Z (2 months ago)
• Language: Common Lisp
• Size: 73.2 KB
• Stars: 29
• Watchers: 5
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.markdown

Lists

• awesome-cl - cl-coveralls - a helper (Apps ## / Third-party APIs)
• curated-awesome-cl - cl-coveralls

README

        
# CL-Coveralls

CL-Coveralls is a helper library to post test coverage to [Coveralls](https://coveralls.io).

## Warning

This software is still ALPHA quality. The APIs will be likely to change.

## Limitations

### Supported implementations

* SBCL

* Clozure CL 1.4-1.9 (Not support 1.10 because it's broken)

### Supported CI services

* [Travis CI](https://travis-ci.org)

* [CircleCI](https://circleci.com)

* [GitHub Actions](https://docs.github.com/en/actions), there is also

  a ready to use action [40ants/run-tests](https://github.com/40ants/run-tests).

### Number of entered

Coveralls allows us to track the number of entered times for each lines, however all Common Lisp coverage tools don't provide the information. CL-Coveralls posts it as `1` for all lines entered.

## Usage

CL-Coveralls see if `$COVERALLS` is bound for deciding whether recording test coverage or not. Don't forget to set the environment variable before running tests.

```

$ COVERALLS=true sbcl --load test-script.lisp --eval '(sb-ext:exit)'

```

In your test script, wrap your test code with `coveralls:with-coveralls`.

```common-lisp

(coveralls:with-coveralls ()

  ;; Run tests

  (prove:run :your-app))

```

## Examples

* [Lack's circle.yml](https://github.com/fukamachi/lack/blob/master/circle.yml)

## Author

* Eitaro Fukamachi ([email protected])

## Copyright

Copyright (c) 2015 Eitaro Fukamachi ([email protected])

## License

Licensed under the BSD 2-Clause License.