The cl-coveralls Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-coveralls Reference Manual

This is the cl-coveralls Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:11:20 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CL-Coveralls

CL-Coveralls is a helper library to post test coverage to Coveralls.

Warning

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

Limitations

Supported implementations

Supported CI services

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.

(coveralls:with-coveralls ()
  ;; Run tests
  (prove:run :your-app))

Examples

Author

Copyright

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

License

Licensed under the BSD 2-Clause License.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-coveralls

Author

Eitaro Fukamachi

License

BSD 2-Clause

Description

Coverage tracker for Coveralls

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)

### 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
Source

cl-coveralls.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Next: , Previous: , Up: Modules   [Contents][Index]

3.1 cl-coveralls/src

Parent

cl-coveralls (system)

Location

src/

Components

Previous: , Up: Modules   [Contents][Index]

3.2 cl-coveralls/src/impls

Dependency

util.lisp (file)

Parent

src (module)

Location

src/impls/

Component

sbcl.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-coveralls.asd

Location

cl-coveralls.asd

Systems

cl-coveralls (system)

Packages

cl-coveralls-asd


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependencies
Parent

src (module)

Location

src/cl-coveralls.lisp

Packages

cl-coveralls

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-coveralls/src/service.lisp

Parent

src (module)

Location

src/service.lisp

Packages

cl-coveralls.service

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 cl-coveralls/src/git.lisp

Dependency

service.lisp (file)

Parent

src (module)

Location

src/git.lisp

Packages

cl-coveralls.git

Exported Definitions
Internal Definitions

git (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

impls (module)

Location

src/impls/sbcl.lisp

Packages

cl-coveralls.impls.sbcl

Exported Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.6 cl-coveralls/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Packages

cl-coveralls.util

Exported Definitions

get-report-directory (function)

Internal Definitions

generate-random-string (function)


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 cl-coveralls-asd

Source

cl-coveralls.asd

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

5.2 cl-coveralls

Source

cl-coveralls.lisp (file)

Nickname

coveralls

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.3 cl-coveralls.service

Source

service.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

5.4 cl-coveralls.git

Source

git.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

git (function)


Next: , Previous: , Up: Packages   [Contents][Index]

5.5 cl-coveralls.impls.sbcl

Source

sbcl.lisp (file)

Nickname

cl-coveralls.impls

Use List

common-lisp

Exported Definitions

Previous: , Up: Packages   [Contents][Index]

5.6 cl-coveralls.util

Source

util.lisp (file)

Use List

common-lisp

Exported Definitions

get-report-directory (function)

Internal Definitions

generate-random-string (function)


Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Macros

Macro: with-coveralls (&key EXCLUDE DRY-RUN PROJECT-DIR) &body BODY
Package

cl-coveralls

Source

cl-coveralls.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: author-email ()
Package

cl-coveralls.git

Source

git.lisp (file)

Function: author-name ()
Package

cl-coveralls.git

Source

git.lisp (file)

Function: calc-coverage FN &key PROJECT-DIR EXCLUDE
Package

cl-coveralls

Source

cl-coveralls.lisp (file)

Function: calc-system SYSTEM &key EXCLUDE
Package

cl-coveralls

Source

cl-coveralls.lisp (file)

Function: commit-message ()
Package

cl-coveralls.git

Source

git.lisp (file)

Function: commit-sha &optional SERVICE-NAME
Package

cl-coveralls.service

Source

service.lisp (file)

Function: committer-email ()
Package

cl-coveralls.git

Source

git.lisp (file)

Function: committer-name ()
Package

cl-coveralls.git

Source

git.lisp (file)

Function: disable-coverage ()
Package

cl-coveralls.impls.sbcl

Source

sbcl.lisp (file)

Function: enable-coverage ()
Package

cl-coveralls.impls.sbcl

Source

sbcl.lisp (file)

Function: finalize-coverage ()
Package

cl-coveralls.impls.sbcl

Source

sbcl.lisp (file)

Function: get-coverage-from-report-file HTML
Package

cl-coveralls.impls.sbcl

Source

sbcl.lisp (file)

Function: get-report-directory ()
Package

cl-coveralls.util

Source

util.lisp (file)

Function: git-branch ()
Package

cl-coveralls.git

Source

git.lisp (file)

Function: initialize-coverage ()
Package

cl-coveralls.impls.sbcl

Source

sbcl.lisp (file)

Function: project-dir &optional SERVICE-NAME
Package

cl-coveralls.service

Source

service.lisp (file)

Function: pull-request-num &optional SERVICE-NAME
Package

cl-coveralls.service

Source

service.lisp (file)

Function: service-job-id &optional SERVICE-NAME
Package

cl-coveralls.service

Source

service.lisp (file)

Function: service-name ()
Package

cl-coveralls.service

Source

service.lisp (file)

Function: source-path-of-report-file HTML
Package

cl-coveralls.impls.sbcl

Source

sbcl.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Functions

Function: generate-random-string ()
Package

cl-coveralls.util

Source

util.lisp (file)

Function: get-coverage FN &key EXCLUDE PROJECT-DIR
Package

cl-coveralls

Source

cl-coveralls.lisp (file)

Function: git COMMAND &key PROJECT-DIR
Package

cl-coveralls.git

Source

git.lisp (file)

Function: normalize-exclude-path ROOT-DIR PATH
Package

cl-coveralls

Source

cl-coveralls.lisp (file)

Function: pathname-in-directory-p PATH DIRECTORY
Package

cl-coveralls

Source

cl-coveralls.lisp (file)

Function: report-to-coveralls REPORTS &key DRY-RUN
Package

cl-coveralls

Source

cl-coveralls.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cl-coveralls.asd: The cl-coveralls<dot>asd file
cl-coveralls/src: The cl-coveralls/src module
cl-coveralls/src/cl-coveralls.lisp: The cl-coveralls/src/cl-coveralls<dot>lisp file
cl-coveralls/src/git.lisp: The cl-coveralls/src/git<dot>lisp file
cl-coveralls/src/impls: The cl-coveralls/src/impls module
cl-coveralls/src/impls/sbcl.lisp: The cl-coveralls/src/impls/sbcl<dot>lisp file
cl-coveralls/src/service.lisp: The cl-coveralls/src/service<dot>lisp file
cl-coveralls/src/util.lisp: The cl-coveralls/src/util<dot>lisp file

F
File, Lisp, cl-coveralls.asd: The cl-coveralls<dot>asd file
File, Lisp, cl-coveralls/src/cl-coveralls.lisp: The cl-coveralls/src/cl-coveralls<dot>lisp file
File, Lisp, cl-coveralls/src/git.lisp: The cl-coveralls/src/git<dot>lisp file
File, Lisp, cl-coveralls/src/impls/sbcl.lisp: The cl-coveralls/src/impls/sbcl<dot>lisp file
File, Lisp, cl-coveralls/src/service.lisp: The cl-coveralls/src/service<dot>lisp file
File, Lisp, cl-coveralls/src/util.lisp: The cl-coveralls/src/util<dot>lisp file

L
Lisp File, cl-coveralls.asd: The cl-coveralls<dot>asd file
Lisp File, cl-coveralls/src/cl-coveralls.lisp: The cl-coveralls/src/cl-coveralls<dot>lisp file
Lisp File, cl-coveralls/src/git.lisp: The cl-coveralls/src/git<dot>lisp file
Lisp File, cl-coveralls/src/impls/sbcl.lisp: The cl-coveralls/src/impls/sbcl<dot>lisp file
Lisp File, cl-coveralls/src/service.lisp: The cl-coveralls/src/service<dot>lisp file
Lisp File, cl-coveralls/src/util.lisp: The cl-coveralls/src/util<dot>lisp file

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

Jump to:   C   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

A
author-email: Exported functions
author-name: Exported functions

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

D
disable-coverage: Exported functions

E
enable-coverage: Exported functions

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

G
generate-random-string: Internal functions
get-coverage: Internal functions
get-coverage-from-report-file: Exported functions
get-report-directory: Exported functions
git: Internal functions
git-branch: Exported functions

I
initialize-coverage: Exported functions

M
Macro, with-coveralls: Exported macros

N
normalize-exclude-path: Internal functions

P
pathname-in-directory-p: Internal functions
project-dir: Exported functions
pull-request-num: Exported functions

R
report-to-coveralls: Internal functions

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

W
with-coveralls: Exported macros

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S  
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.git: The cl-coveralls<dot>git package
cl-coveralls.impls.sbcl: The cl-coveralls<dot>impls<dot>sbcl package
cl-coveralls.service: The cl-coveralls<dot>service package
cl-coveralls.util: The cl-coveralls<dot>util package

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

S
System, cl-coveralls: The cl-coveralls system

Jump to:   C   P   S