The cl-coveralls Reference Manual

This is the cl-coveralls Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:51:09 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-coveralls

Coverage tracker for Coveralls

Author

Eitaro Fukamachi

License

BSD 2-Clause

Long Description

# 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 (e.arrows@gmail.com)

## Copyright

Copyright (c) 2015 Eitaro Fukamachi (e.arrows@gmail.com)

## License

Licensed under the BSD 2-Clause License.

Version

0.1

Dependencies
  • sb-cover (system).
  • ironclad (system).
  • lquery (system).
  • jonathan (system).
  • dexador (system).
  • uiop (system).
  • cl-ppcre (system).
  • flexi-streams (system).
  • alexandria (system).
  • split-sequence (system).
Source

cl-coveralls.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-coveralls/src

Source

cl-coveralls.asd.

Parent Component

cl-coveralls (system).

Child Components

3.2 cl-coveralls/src/impls

Dependency

util.lisp (file).

Source

cl-coveralls.asd.

Parent Component

src (module).

Child Component

sbcl.lisp (file).


4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 cl-coveralls/cl-coveralls.asd

Source

cl-coveralls.asd.

Parent Component

cl-coveralls (system).

ASDF Systems

cl-coveralls.

Packages

cl-coveralls-asd.


4.1.2 cl-coveralls/src/cl-coveralls.lisp

Dependencies
Source

cl-coveralls.asd.

Parent Component

src (module).

Packages

cl-coveralls.

Public Interface
Internals

4.1.3 cl-coveralls/src/service.lisp

Source

cl-coveralls.asd.

Parent Component

src (module).

Packages

cl-coveralls.service.

Public Interface

4.1.4 cl-coveralls/src/git.lisp

Dependency

service.lisp (file).

Source

cl-coveralls.asd.

Parent Component

src (module).

Packages

cl-coveralls.git.

Public Interface
Internals

git (function).


4.1.5 cl-coveralls/src/impls/sbcl.lisp

Source

cl-coveralls.asd.

Parent Component

impls (module).

Packages

cl-coveralls.impls.sbcl.

Public Interface

4.1.6 cl-coveralls/src/util.lisp

Source

cl-coveralls.asd.

Parent Component

src (module).

Packages

cl-coveralls.util.

Public Interface

get-report-directory (function).

Internals

generate-random-string (function).


5 Packages

Packages are listed by definition order.


5.1 cl-coveralls

Source

cl-coveralls.lisp.

Nickname

coveralls

Use List

common-lisp.

Public Interface
Internals

5.2 cl-coveralls.impls.sbcl

Source

sbcl.lisp.

Nickname

cl-coveralls.impls

Use List

common-lisp.

Public Interface

5.3 cl-coveralls.git

Source

git.lisp.

Use List

common-lisp.

Public Interface
Internals

git (function).


5.4 cl-coveralls.service

Source

service.lisp.

Use List

common-lisp.

Public Interface

5.5 cl-coveralls.util

Source

util.lisp.

Use List

common-lisp.

Public Interface

get-report-directory (function).

Internals

generate-random-string (function).


5.6 cl-coveralls-asd

Source

cl-coveralls.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Macros

Macro: with-coveralls ((&key exclude dry-run project-dir) &body body)

Sends coverage report to the Coveralls.

If dry run specified or code started not inside one of supported CI service, then just prints JSON prepared for sending.

Package

cl-coveralls.

Source

cl-coveralls.lisp.


6.1.2 Ordinary functions

Function: author-email ()
Package

cl-coveralls.git.

Source

git.lisp.

Function: author-name ()
Package

cl-coveralls.git.

Source

git.lisp.

Function: calc-coverage (fn &key project-dir exclude)
Package

cl-coveralls.

Source

cl-coveralls.lisp.

Function: calc-system (system &key exclude)
Package

cl-coveralls.

Source

cl-coveralls.lisp.

Function: commit-message ()
Package

cl-coveralls.git.

Source

git.lisp.

Function: commit-sha (&optional service-name)
Package

cl-coveralls.service.

Source

service.lisp.

Function: committer-email ()
Package

cl-coveralls.git.

Source

git.lisp.

Function: committer-name ()
Package

cl-coveralls.git.

Source

git.lisp.

Function: disable-coverage ()
Package

cl-coveralls.impls.sbcl.

Source

sbcl.lisp.

Function: enable-coverage ()
Package

cl-coveralls.impls.sbcl.

Source

sbcl.lisp.

Function: finalize-coverage ()
Package

cl-coveralls.impls.sbcl.

Source

sbcl.lisp.

Function: get-coverage-from-report-file (html)
Package

cl-coveralls.impls.sbcl.

Source

sbcl.lisp.

Function: get-report-directory ()
Package

cl-coveralls.util.

Source

util.lisp.

Function: git-branch ()
Package

cl-coveralls.git.

Source

git.lisp.

Function: git-sha ()
Package

cl-coveralls.git.

Source

git.lisp.

Function: initialize-coverage ()
Package

cl-coveralls.impls.sbcl.

Source

sbcl.lisp.

Function: project-dir (&optional service-name)
Package

cl-coveralls.service.

Source

service.lisp.

Function: pull-request-num (&optional service-name)
Package

cl-coveralls.service.

Source

service.lisp.

Function: report-files (report-dir)
Package

cl-coveralls.impls.sbcl.

Source

sbcl.lisp.

Function: service-job-id (&optional service-name)
Package

cl-coveralls.service.

Source

service.lisp.

Function: service-name ()
Package

cl-coveralls.service.

Source

service.lisp.

Function: source-path-of-report-file (html)
Package

cl-coveralls.impls.sbcl.

Source

sbcl.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: ensure-string (value)
Package

cl-coveralls.

Source

cl-coveralls.lisp.

Function: generate-random-string ()
Package

cl-coveralls.util.

Source

util.lisp.

Function: get-coverage (fn &key exclude project-dir)
Package

cl-coveralls.

Source

cl-coveralls.lisp.

Function: git (command &key project-dir)
Package

cl-coveralls.git.

Source

git.lisp.

Function: mask-secret (text)
Package

cl-coveralls.

Source

cl-coveralls.lisp.

Function: normalize-exclude-path (root-dir path)
Package

cl-coveralls.

Source

cl-coveralls.lisp.

Function: parse-report-files (report-files &key exclude project-dir)
Package

cl-coveralls.

Source

cl-coveralls.lisp.

Function: pathname-in-directory-p (path directory)
Package

cl-coveralls.

Source

cl-coveralls.lisp.

Function: report-to-coveralls (reports &key dry-run)
Package

cl-coveralls.

Source

cl-coveralls.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   D   E   F   G   I   M   N   P   R   S   W  
Index Entry  Section

A
author-email: Public ordinary functions
author-name: Public ordinary functions

C
calc-coverage: Public ordinary functions
calc-system: Public ordinary functions
commit-message: Public ordinary functions
commit-sha: Public ordinary functions
committer-email: Public ordinary functions
committer-name: Public ordinary functions

D
disable-coverage: Public ordinary functions

E
enable-coverage: Public ordinary functions
ensure-string: Private ordinary functions

F
finalize-coverage: Public ordinary functions
Function, author-email: Public ordinary functions
Function, author-name: Public ordinary functions
Function, calc-coverage: Public ordinary functions
Function, calc-system: Public ordinary functions
Function, commit-message: Public ordinary functions
Function, commit-sha: Public ordinary functions
Function, committer-email: Public ordinary functions
Function, committer-name: Public ordinary functions
Function, disable-coverage: Public ordinary functions
Function, enable-coverage: Public ordinary functions
Function, ensure-string: Private ordinary functions
Function, finalize-coverage: Public ordinary functions
Function, generate-random-string: Private ordinary functions
Function, get-coverage: Private ordinary functions
Function, get-coverage-from-report-file: Public ordinary functions
Function, get-report-directory: Public ordinary functions
Function, git: Private ordinary functions
Function, git-branch: Public ordinary functions
Function, git-sha: Public ordinary functions
Function, initialize-coverage: Public ordinary functions
Function, mask-secret: Private ordinary functions
Function, normalize-exclude-path: Private ordinary functions
Function, parse-report-files: Private ordinary functions
Function, pathname-in-directory-p: Private ordinary functions
Function, project-dir: Public ordinary functions
Function, pull-request-num: Public ordinary functions
Function, report-files: Public ordinary functions
Function, report-to-coveralls: Private ordinary functions
Function, service-job-id: Public ordinary functions
Function, service-name: Public ordinary functions
Function, source-path-of-report-file: Public ordinary functions

G
generate-random-string: Private ordinary functions
get-coverage: Private ordinary functions
get-coverage-from-report-file: Public ordinary functions
get-report-directory: Public ordinary functions
git: Private ordinary functions
git-branch: Public ordinary functions
git-sha: Public ordinary functions

I
initialize-coverage: Public ordinary functions

M
Macro, with-coveralls: Public macros
mask-secret: Private ordinary functions

N
normalize-exclude-path: Private ordinary functions

P
parse-report-files: Private ordinary functions
pathname-in-directory-p: Private ordinary functions
project-dir: Public ordinary functions
pull-request-num: Public ordinary functions

R
report-files: Public ordinary functions
report-to-coveralls: Private ordinary functions

S
service-job-id: Public ordinary functions
service-name: Public ordinary functions
source-path-of-report-file: Public ordinary functions

W
with-coveralls: Public macros


A.3 Variables


A.4 Data types

Jump to:   C   F   G   I   M   P   S   U  
Index Entry  Section

C
cl-coveralls: The cl-coveralls system
cl-coveralls: The cl-coveralls package
cl-coveralls-asd: The cl-coveralls-asd package
cl-coveralls.asd: The cl-coveralls/cl-coveralls․asd file
cl-coveralls.git: The cl-coveralls․git package
cl-coveralls.impls.sbcl: The cl-coveralls․impls․sbcl package
cl-coveralls.lisp: The cl-coveralls/src/cl-coveralls․lisp file
cl-coveralls.service: The cl-coveralls․service package
cl-coveralls.util: The cl-coveralls․util package

F
File, cl-coveralls.asd: The cl-coveralls/cl-coveralls․asd file
File, cl-coveralls.lisp: The cl-coveralls/src/cl-coveralls․lisp file
File, git.lisp: The cl-coveralls/src/git․lisp file
File, sbcl.lisp: The cl-coveralls/src/impls/sbcl․lisp file
File, service.lisp: The cl-coveralls/src/service․lisp file
File, util.lisp: The cl-coveralls/src/util․lisp file

G
git.lisp: The cl-coveralls/src/git․lisp file

I
impls: The cl-coveralls/src/impls module

M
Module, impls: The cl-coveralls/src/impls module
Module, src: The cl-coveralls/src module

P
Package, cl-coveralls: The cl-coveralls package
Package, cl-coveralls-asd: The cl-coveralls-asd package
Package, cl-coveralls.git: The cl-coveralls․git package
Package, cl-coveralls.impls.sbcl: The cl-coveralls․impls․sbcl package
Package, cl-coveralls.service: The cl-coveralls․service package
Package, cl-coveralls.util: The cl-coveralls․util package

S
sbcl.lisp: The cl-coveralls/src/impls/sbcl․lisp file
service.lisp: The cl-coveralls/src/service․lisp file
src: The cl-coveralls/src module
System, cl-coveralls: The cl-coveralls system

U
util.lisp: The cl-coveralls/src/util․lisp file