The cl-junit-xml Reference Manual

Table of Contents

The cl-junit-xml Reference Manual

This is the cl-junit-xml Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:18:44 2020 GMT+0.

1 Introduction

cl-junit-xml

Small library for writing junit-compatible XML files.

Example

CL-JUNIT-XML> (let* ((junit (make-junit))
       (suite (add-child junit (make-testsuite "suite" :timestamp "now"))))
  (add-child suite (make-testcase "test" "class" 1.0
                                  :failure "invalid assertion"))
  (add-child suite (make-testcase "test 2" "class" 2.0
                                  :error "problem running the test"))
  (add-child suite (make-testcase "test 3" "class" 5.0))
  (write-xml junit T :pretty-p T))
<?xml version="1.0" encoding="UTF-8"?>
<testsuite name="suite" timestamp="now" id="0" tests="3" errors="1" failures="1" time="8.0">
  <testcase name="test 3" classname="class" time="5.0"/>
  <testcase name="test 2" classname="class" time="2.0">
    <error>
      <![CDATA[problem running the test]]></error>
  </testcase>
  <testcase name="test" classname="class" time="1.0">
    <failure>
      <![CDATA[invalid assertion]]></failure>
  </testcase>
</testsuite>

API

make-junit

creates a new junit root XML object you can add suites to

make-testsuite

creates a new junit testsuite add testcases to

make-testcase

creates a new junit testcase

(add-child parent child)

add cases to suites, and suites to junit. returns the child

(write-xml junit sink &key pretty-p &allow-other-keys)

writes the junit XML to the given sink. Supports sinks of:

• nil - returs the XML as a string
• T - writes the XML to *standard-output*
• any string - writes the XML to that file, returns the pathname
• any pathname - writes the XML to that file, returns the pathname

if pretty-p is non-nil, then the XML produced is indented.

Other keys are allowed to support integration with other testing libraries.

Integration with other testing libraries

lisp-unit2

lisp-unit2 support is available via the cl-junit-xml.lisp-unit2 ASDF system, and adds some additional write-xml specializations for lisp-unit2 objects.

Any dots (.) in test names will be read as part of the classname for junit, which affects rendering in systems like Jenkins.

For example, assuming you start with (lisp-unit2:run-tests :name :my-tests):

• the test frobs will appear in junit as package MY-TESTS, class MY-TESTS.root, name frobs
• the test foo.frobs will appear in junit as package MY-TESTS, class MY-TESTS.FOO, name foo.frobs

writing XML directly

(write-xml (lisp-unit2:run-tests :name :my-tests) T :pretty-p T)

writing XML via the lisp-unit2's signals:

(handler-bind
    ((lisp-unit2:all-tests-complete
       #'(lambda (c)
           (write-xml c T :pretty-p T))))
  (lisp-unit2:run-tests :name :my-tests))

lisp-unit

lisp-unit support is available via the cl-junit-xml.lisp-unit ASDF system, and adds some additional write-xml specializations for lisp-unit objects.

Adds a :name keyword arg to write-xml that will be used as the default XML classname.

Classname handling is similar to lisp-unit2. For example, assuming you start with (write-xml test-results T :name :my-tests):

• the test frobs will appear in junit as package MY-TESTS, class MY-TESTS.root, name frobs
• the test foo.frobs will appear in junit as package MY-TESTS, class MY-TESTS.FOO, name foo.frobs

writing XML via the lisp-unit's signals:

(handler-bind
    ((lisp-unit:tests-run-complete
       #'(lambda (c)
       (write-xml c T :pretty-p T :name "my-tests"))))
  (lisp-unit:signal-results)
  (lisp-unit:run-tests))

2 Systems

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

2.1 cl-junit-xml

Author

Ryan Davis <ryan@acceleration.net>

License

MIT

Description

Small library for writing junit XML files

Dependencies

• cxml
• iterate
• alexandria

Source

cl-junit-xml.asd (file)

Components

• package.lisp (file)
• cl-junit-xml.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-junit-xml.asd

Location

cl-junit-xml.asd

Systems

cl-junit-xml (system)

3.1.2 cl-junit-xml/package.lisp

Parent

cl-junit-xml (system)

Location

package.lisp

Packages

cl-junit-xml

3.1.3 cl-junit-xml/cl-junit-xml.lisp

Dependency

package.lisp (file)

Parent

cl-junit-xml (system)

Location

cl-junit-xml.lisp

Exported Definitions

• add-child (generic function)
• add-child (method)
• add-child (method)
• make-junit (function)
• make-testcase (function)
• make-testsuite (function)
• write-xml (generic function)
• write-xml (method)
• write-xml (method)
• write-xml (method)
• write-xml (method)

Internal Definitions

• %write-xml (generic function)
• %write-xml (method)
• %write-xml (method)
• %write-xml (method)
• duration (method)
• error-text (method)
• failure-text (method)
• junit-testcase (class)
• junit-testsuite (class)
• junit-xml (class)
• name (method)
• name (method)
• pkg (method)
• testcases (method)
• (setf testcases) (method)
• testsuites (method)
• (setf testsuites) (method)
• timestamp (method)

4 Packages

Packages are listed by definition order.

4.1 cl-junit-xml

Source

package.lisp (file)

Use List

• iterate
• common-lisp

Exported Definitions

• add-child (generic function)
• add-child (method)
• add-child (method)
• make-junit (function)
• make-testcase (function)
• make-testsuite (function)
• write-xml (generic function)
• write-xml (method)
• write-xml (method)
• write-xml (method)
• write-xml (method)

Internal Definitions

• %write-xml (generic function)
• %write-xml (method)
• %write-xml (method)
• %write-xml (method)
• duration (generic function)
• duration (method)
• error-text (generic function)
• error-text (method)
• failure-text (generic function)
• failure-text (method)
• junit-testcase (class)
• junit-testsuite (class)
• junit-xml (class)
• name (generic function)
• name (method)
• name (method)
• pkg (generic function)
• pkg (method)
• testcases (generic function)
• testcases (method)
• (setf testcases) (method)
• (setf testcases) (generic function)
• testsuites (generic function)
• testsuites (method)
• (setf testsuites) (method)
• (setf testsuites) (generic function)
• timestamp (generic function)
• timestamp (method)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: make-junit &key TESTSUITES

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

Function: make-testcase NAME CLASS-NAME DURATION &key ERROR FAILURE

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

Function: make-testsuite NAME &key TESTCASES TIMESTAMP PACKAGE

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

5.1.2 Generic functions

Generic Function: add-child PARENT CHILD

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

Methods

Method: add-child (P junit-xml) (C junit-testsuite)

Method: add-child (P junit-testsuite) (C junit-testcase)

Generic Function: write-xml JUNIT-XML SINK &key PRETTY-P &allow-other-keys

write the junit to the given sink (string, pathname, T, nil)

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

Methods

Method: write-xml JUNIT-XML (SINK string) &key PRETTY-P &allow-other-keys

Method: write-xml JUNIT-XML SINK &key PRETTY-P &allow-other-keys

Method: write-xml JUNIT-XML (SINK pathname) &key PRETTY-P &allow-other-keys

Method: write-xml JUNIT-XML (SINK null) &key PRETTY-P &allow-other-keys

5.2 Internal definitions

5.2.1 Generic functions

Generic Function: %write-xml THING &key SINK ID &allow-other-keys

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

Methods

Method: %write-xml (JUNIT-XML junit-xml) &key SINK &allow-other-keys

Method: %write-xml (SUITE junit-testsuite) &key ID &allow-other-keys

Method: %write-xml (TESTCASE junit-testcase) &key &allow-other-keys

Generic Function: duration OBJECT

Package

cl-junit-xml

Methods

Method: duration (JUNIT-TESTCASE junit-testcase)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

Generic Function: error-text OBJECT

Package

cl-junit-xml

Methods

Method: error-text (JUNIT-TESTCASE junit-testcase)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

Generic Function: failure-text OBJECT

Package

cl-junit-xml

Methods

Method: failure-text (JUNIT-TESTCASE junit-testcase)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

Generic Function: name OBJECT

Package

cl-junit-xml

Methods

Method: name (JUNIT-TESTCASE junit-testcase)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

Method: name (JUNIT-TESTSUITE junit-testsuite)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

Generic Function: pkg OBJECT

Package

cl-junit-xml

Methods

Method: pkg (JUNIT-TESTSUITE junit-testsuite)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

Generic Function: testcases OBJECT

Generic Function: (setf testcases) NEW-VALUE OBJECT

Package

cl-junit-xml

Methods

Method: testcases (JUNIT-TESTSUITE junit-testsuite)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

Method: (setf testcases) NEW-VALUE (JUNIT-TESTSUITE junit-testsuite)

automatically generated writer method

Source

cl-junit-xml.lisp (file)

Generic Function: testsuites OBJECT

Generic Function: (setf testsuites) NEW-VALUE OBJECT

Package

cl-junit-xml

Methods

Method: testsuites (JUNIT-XML junit-xml)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

Method: (setf testsuites) NEW-VALUE (JUNIT-XML junit-xml)

automatically generated writer method

Source

cl-junit-xml.lisp (file)

Generic Function: timestamp OBJECT

Package

cl-junit-xml

Methods

Method: timestamp (JUNIT-TESTSUITE junit-testsuite)

automatically generated reader method

Source

cl-junit-xml.lisp (file)

5.2.2 Classes

Class: junit-testcase ()

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• add-child (method)
• %write-xml (method)
• failure-text (method)
• error-text (method)
• class-name (method)
• duration (method)
• name (method)

Direct slots

Slot: name

Initargs

:name

Readers

name (generic function)

Slot: duration

Initargs

:duration

Readers

duration (generic function)

Slot: class-name

Initargs

:class-name

Readers

class-name (generic function)

Slot: error-text

Initargs

:error-text

Readers

error-text (generic function)

Slot: failure-text

Initargs

:failure-text

Readers

failure-text (generic function)

Class: junit-testsuite ()

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• add-child (method)
• add-child (method)
• %write-xml (method)
• timestamp (method)
• pkg (method)
• name (method)
• testcases (method)
• testcases (method)

Direct slots

Slot: testcases

Initargs

:testcases

Readers

testcases (generic function)

Writers

(setf testcases) (generic function)

Slot: name

Initargs

:name

Readers

name (generic function)

Slot: pkg

Initargs

:package

Readers

pkg (generic function)

Slot: timestamp

Initargs

:timestamp

Readers

timestamp (generic function)

Class: junit-xml ()

Package

cl-junit-xml

Source

cl-junit-xml.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• add-child (method)
• %write-xml (method)
• testsuites (method)
• testsuites (method)

Direct slots

Slot: testsuites

Initargs

:testsuites

Readers

testsuites (generic function)

Writers

(setf testsuites) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types