The ptester Reference Manual

Table of Contents

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

The ptester Reference Manual

This is the ptester Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:26:52 2018 GMT+0.


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

1 Systems

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


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

1.1 ptester

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Kevin Layer, Franz, Inc / Kevin Rosenberg

License

LLGPL

Description

Portable test harness package

Long Description

ptester is a portable testing framework based on Franz’s tester module

Source

ptester.asd (file)

Component

src.lisp (file)


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

2 Files

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


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

2.1 Lisp


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

2.1.1 ptester.asd

Location

ptester.asd

Systems

ptester (system)

Packages

ptester-system


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

2.1.2 ptester/src.lisp

Parent

ptester (system)

Location

src.lisp

Packages

ptester

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 ptester-system

Source

ptester.asd

Use List

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

3.2 ptester

Source

src.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Special variables

Special Variable: *break-on-test-failures*

When a test failure occurs, common-lisp:break is called, allowing interactive debugging of the failure.

Package

ptester

Source

src.lisp (file)

Special Variable: *error-protect-tests*

Protect each test from errors. If an error occurs, then that will be taken as a test failure unless test-error is being used.

Package

ptester

Source

src.lisp (file)

Special Variable: *test-errors*

The value is the number of test errors which have occurred.

Package

ptester

Source

src.lisp (file)

Special Variable: *test-successes*

The value is the number of test successes which have occurred.

Package

ptester

Source

src.lisp (file)

Special Variable: *test-unexpected-failures*

The value is the number of unexpected test failures which have occurred.

Package

ptester

Source

src.lisp (file)


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

4.1.2 Macros

Macro: test EXPECTED-VALUE TEST-FORM &key TEST MULTIPLE-VALUES FAIL-INFO KNOWN-FAILURE ERRORSET REPORTED-FORM WANTED-MESSAGE GOT-MESSAGE

Perform a single test. ‘expected-value’ is the reference value for the test. ‘test-form’ is a form that will produce the value to be compared to the expected-value. If the values are not the same, then an error is logged, otherwise a success is logged.

Normally the comparison of values is done with ‘eql’. The ‘test’ keyword argument can be used to specify other comparison functions, such as eq, equal,equalp, string=, string-equal, etc.

Normally, only the first return value from the test-form is considered, however if ‘multiple-values’ is t, then all values returned from test-form are considered.

‘fail-info’ allows more information to be printed with a test failure.

‘known-failure’ marks the test as a known failure. This allows for programs that do regression analysis on the output from a test run to discriminate on new versus known failures.

Package

ptester

Source

src.lisp (file)

Macro: test-error FORM &key ANNOUNCE CATCH-BREAKS FAIL-INFO KNOWN-FAILURE CONDITION-TYPE INCLUDE-SUBTYPES FORMAT-CONTROL FORMAT-ARGUMENTS

Test that ‘form’ signals an error. The order of evaluation of the arguments is keywords first, then test form.

If ‘announce’ is non-nil, then cause the error message to be printed.

The ‘catch-breaks’ is non-nil then consider a call to common-lisp:break an ‘error’.

‘fail-info’ allows more information to be printed with a test failure.

‘known-failure’ marks the test as a known failure. This allows for programs that do regression analysis on the output from a test run to discriminate on new versus known failures.

If ‘condition-type’ is non-nil, it should be a symbol naming a condition type, which is used to check against the signalled condition type. The test will fail if they do not match.

‘include-subtypes’, used with ‘condition-type’, can be used to match a condition to an entire subclass of the condition type hierarchy.

‘format-control’ and ‘format-arguments’ can be used to check the error message itself.

Package

ptester

Source

src.lisp (file)

Macro: test-no-error FORM &key ANNOUNCE CATCH-BREAKS FAIL-INFO KNOWN-FAILURE

Test that ‘form’ does not signal an error. The order of evaluation of the arguments is keywords first, then test form.

If ‘announce’ is non-nil, then cause the error message to be printed.

The ‘catch-breaks’ is non-nil then consider a call to common-lisp:break an ‘error’.

‘fail-info’ allows more information to be printed with a test failure.

‘known-failure’ marks the test as a known failure. This allows for programs that do regression analysis on the output from a test run to discriminate on new versus known failures.

Package

ptester

Source

src.lisp (file)

Macro: test-no-warning FORM &key FAIL-INFO KNOWN-FAILURE

Test that ‘form’ does not signal a warning. The order of evaluation of the arguments is keywords first, then test form.

‘fail-info’ allows more information to be printed with a test failure.

‘known-failure’ marks the test as a known failure. This allows for programs that do regression analysis on the output from a test run to discriminate on new versus known failures.

Package

ptester

Source

src.lisp (file)

Macro: test-warning FORM &key FAIL-INFO KNOWN-FAILURE

Test that ‘form’ signals a warning. The order of evaluation of the arguments is keywords first, then test form.

‘fail-info’ allows more information to be printed with a test failure.

‘known-failure’ marks the test as a known failure. This allows for programs that do regression analysis on the output from a test run to discriminate on new versus known failures.

Package

ptester

Source

src.lisp (file)

Macro: with-tests (&key NAME) &body BODY
Package

ptester

Source

src.lisp (file)


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

4.2 Internal definitions


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

4.2.1 Special variables

Special Variable: *announce-test*
Package

ptester

Source

src.lisp (file)

Special Variable: *warn-cookie*
Package

ptester

Source

src.lisp (file)

Special Variable: if*-keyword-list
Package

ptester

Source

src.lisp (file)


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

4.2.2 Macros

Macro: errorset FORM
Package

ptester

Source

src.lisp (file)

Macro: if* &rest ARGS
Package

ptester

Source

src.lisp (file)

Macro: test-values FORM &optional ANNOUNCE CATCH-BREAKS
Package

ptester

Source

src.lisp (file)

Macro: test-values-errorset FORM &optional ANNOUNCE CATCH-BREAKS
Package

ptester

Source

src.lisp (file)


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

4.2.3 Functions

Function: gc-print-state ()
Function: (setf gc-print-state) STATE
Package

ptester

Source

src.lisp (file)

Function: test-check &key PREDICATE EXPECTED-RESULT TEST-RESULTS TEST-FORM MULTIPLE-VALUES FAIL-INFO KNOWN-FAILURE WANTED-MESSAGE GOT-MESSAGE CONDITION-TYPE CONDITION INCLUDE-SUBTYPES FORMAT-CONTROL FORMAT-ARGUMENTS &aux FAIL PREDICATE-FAILED GOT WANTED
Package

ptester

Source

src.lisp (file)


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

4.2.4 Generic functions

Generic Function: conditionp THING
Package

ptester

Source

src.lisp (file)

Methods
Method: conditionp THING
Method: conditionp (THING condition)

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

4.2.5 Conditions

Condition: simple-break ()
Package

ptester

Source

src.lisp (file)

Direct superclasses
  • simple-condition (condition)
  • error (condition)

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, ptester.asd: The ptester<dot>asd file
File, Lisp, ptester/src.lisp: The ptester/src<dot>lisp file

L
Lisp File, ptester.asd: The ptester<dot>asd file
Lisp File, ptester/src.lisp: The ptester/src<dot>lisp file

P
ptester.asd: The ptester<dot>asd file
ptester/src.lisp: The ptester/src<dot>lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   (  
C   E   F   G   I   M   T   W  
Index Entry  Section

(
(setf gc-print-state): Internal functions

C
conditionp: Internal generic functions
conditionp: Internal generic functions
conditionp: Internal generic functions

E
errorset: Internal macros

F
Function, (setf gc-print-state): Internal functions
Function, gc-print-state: Internal functions
Function, test-check: Internal functions

G
gc-print-state: Internal functions
Generic Function, conditionp: Internal generic functions

I
if*: Internal macros

M
Macro, errorset: Internal macros
Macro, if*: Internal macros
Macro, test: Exported macros
Macro, test-error: Exported macros
Macro, test-no-error: Exported macros
Macro, test-no-warning: Exported macros
Macro, test-values: Internal macros
Macro, test-values-errorset: Internal macros
Macro, test-warning: Exported macros
Macro, with-tests: Exported macros
Method, conditionp: Internal generic functions
Method, conditionp: Internal generic functions

T
test: Exported macros
test-check: Internal functions
test-error: Exported macros
test-no-error: Exported macros
test-no-warning: Exported macros
test-values: Internal macros
test-values-errorset: Internal macros
test-warning: Exported macros

W
with-tests: Exported macros

Jump to:   (  
C   E   F   G   I   M   T   W  

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

A.3 Variables

Jump to:   *  
I   S  
Index Entry  Section

*
*announce-test*: Internal special variables
*break-on-test-failures*: Exported special variables
*error-protect-tests*: Exported special variables
*test-errors*: Exported special variables
*test-successes*: Exported special variables
*test-unexpected-failures*: Exported special variables
*warn-cookie*: Internal special variables

I
if*-keyword-list: Internal special variables

S
Special Variable, *announce-test*: Internal special variables
Special Variable, *break-on-test-failures*: Exported special variables
Special Variable, *error-protect-tests*: Exported special variables
Special Variable, *test-errors*: Exported special variables
Special Variable, *test-successes*: Exported special variables
Special Variable, *test-unexpected-failures*: Exported special variables
Special Variable, *warn-cookie*: Internal special variables
Special Variable, if*-keyword-list: Internal special variables

Jump to:   *  
I   S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Condition, simple-break: Internal conditions

P
Package, ptester: The ptester package
Package, ptester-system: The ptester-system package
ptester: The ptester system
ptester: The ptester package
ptester-system: The ptester-system package

S
simple-break: Internal conditions
System, ptester: The ptester system

Jump to:   C   P   S