Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the trivial-coverage Reference Manual, version 0.0.4, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 19:22:34 2020 GMT+0.
| • Introduction | What trivial-coverage is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
A simple Common Lisp library to print out the code coverage collected. Supports SBCL and CCL.
This project is available in the latest QuickLisp distribution, so installing it is reduced to calling:
(ql:quickload :trivial-coverage)
But if you want access to the latest updates, install it by cloning the Git repository with
cd $HOME/quicklisp/local-projects
git clone https://gitlab.com/ediethelm/trivial-coverage.git
and then loading it as usual via QuickLisp as above.
Assuming there is a system being tested and named :system-under-test, which has three files that should not be included in the coverage calculation. The following expression loads the system, executes the tests and reports the total coverage:
(trivial-coverage:test-and-print-coverage :system-under-test
:exclude '("test-system-under-test.lisp"
"test-data-generator.lisp"
"documentation.lisp"))
To access the coverage value programatically the following is possible:
(declaim (optimize sb-cover:store-coverage-data))
((asdf:oos 'asdf:load-op :system-under-test)
(let ((report-path (merge-pathnames "coverage-report/" (asdf:system-source-directory :system-under-test))))
(sb-cover:reset-coverage)
(asdf:oos 'asdf:test-op :system-under-test)
(sb-cover:report report-path)
(get-coverage report-path :exclude exclude))
[function] TEST-AND-PRINT-COVERAGE SYSTEM &KEY EXCLUDE KEEP-REPORT (STREAM T)
Loads and tests the given system collecting coverage information. Also prints a line containing the coverage to stream.
system - name of the system to be tested
exclude - files to be excluded from the calculation
keep-report - if NIL, the generated HTML coverage files are removed
stream - the stream to which the coverage result shall be written
[function] GET-COVERAGE REPORT-PATH &KEY EXCLUDE
Calculates the total code coverage reported by sb-cover (via the HTML report) and returns this value.
report-path - the path to the directory containing the HTML coverage report
exclude - files to be excluded from the calculation
This library is released under the MIT License. Please refer to the LICENSE to get the full licensing text.
Please refer to the CONTRIBUTING document for more information.
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The trivial-coverage system |
Eric Diethelm <ediethelm@yahoo.com>
MIT
A simple Common Lisp library to print out the code coverage collected. Supports SBCL and CCL.
0.0.4
lquery
trivial-coverage.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The trivial-coverage.asd file | ||
| • The trivial-coverage/package.lisp file | ||
| • The trivial-coverage/trivial-coverage.lisp file |
Next: The trivial-coverage/package․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
trivial-coverage.asd
trivial-coverage (system)
Next: The trivial-coverage/trivial-coverage․lisp file, Previous: The trivial-coverage․asd file, Up: Lisp files [Contents][Index]
trivial-coverage (system)
package.lisp
Previous: The trivial-coverage/package․lisp file, Up: Lisp files [Contents][Index]
trivial-coverage (system)
trivial-coverage.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The trivial-coverage package |
A simple Common Lisp library to print out the code coverage collected by sb-cover. As such it only supports SBCL.
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported functions |
Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Calculates the total code coverage reported by sb-cover (via the HTML report) and returns this value.
*report-path* - the path to the directory containing the HTML coverage report
*exclude* - files to be excluded from the calculation
trivial-coverage.lisp (file)
Loads and tests the given *system* collecting coverage information. Also prints a line containing the coverage to *stream*.
*system* - name of the system to be tested
*exclude* - files to be excluded from the calculation
*keep-report* - if NIL, the generated HTML coverage files are removed
*stream* - the stream to which the coverage result shall be written
trivial-coverage.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
trivial-coverage.lisp (file)
trivial-coverage.lisp (file)
trivial-coverage.lisp (file)
trivial-coverage.lisp (file)
trivial-coverage.lisp (file)
trivial-coverage.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index | ||
| • Function index | ||
| • Variable index | ||
| • Data type index |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L T |
|---|
| Jump to: | F L T |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | C D E F G P T |
|---|
| Jump to: | C D E F G P T |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | P S T |
|---|
| Jump to: | P S T |
|---|