package junit

  1. Overview
  2. Docs
JUnit XML reports generation library

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (8)

Authors

  1. L
    Louis Roché <louis@louisroche.net>

Maintainers

  1. L
    Louis Roché <louis@louisroche.net>

Sources

junit-2.3.0.tbz
sha256=8fee257ee4045aaf33f2293fcdf039a615aabfc926fad184cea1bfeb771b8533
sha512=546b155c65e6cbe4141c29cd95da68903c8845703bd81b12dd8ceaeb5c91d19137ca8202848d0b5cdfc3090694266c3a1815669c85b4d3d980c6122411136da3

doc/junit/Junit_xml/index.html

Module Junit_xmlSource

Low level interface to build XML elements.

This module defines basic data types for data, attributes and element occuring in JUnit reports.

It is based on the XSD provided in JUnit-schema git repository.

Those are low level functions. Values like id, failures or tests will not be checked.

It allows you to build a report by hand if the facilities that are offered by Junit do not suit your needs.

Categories of elements and attributes

This part defines the categories of elements and attributes.

Attributes

Sourcetype token = string

https://www.w3.org/TR/xmlschema-2/#token

Definition: token represents tokenized strings. The ·value space· of token is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The ·lexical space· of token is the set of strings that do not contain the carriage return (#xD), line feed (#xA) nor tab (#x9) characters, that have no leading or trailing spaces (#x20) and that have no internal sequences of two or more spaces. The ·base type· of token is normalizedString.

Sourcetype timestamp
Sourceval timestamp : Ptime.t -> timestamp

Elements

Properties
Sourcetype property
Sourcetype properties = property list

Properties (e.g., environment settings) set during test execution.

Sourceval property : name:token -> value:string -> property
Sourceval property_to_xml : property -> Tyxml.Xml.elt

Builds an XML element from a property.

Testcases
Sourcetype error = {
  1. message : string option;
  2. typ : string;
  3. description : string;
}

Indicates that the test errored. An errored test is one that had an unanticipated problem. e.g., an unchecked throwable; or a problem with the implementation of the test. Contains as a text node relevant data for the error, e.g., a stack trace.

Sourceval error : ?message:string -> typ:string -> string -> error

error ?message ~typ description creates an error element.

  • parameter message

    The error message. e.g., if a java exception is thrown, the return value of getMessage().

  • parameter typ

    The type of error that occured. e.g., if a java execption is thrown the full class name of the exception.

  • parameter description

    Description of the error.

Sourceval error_to_xml : error -> Tyxml.Xml.elt

Builds an XML element from a error.

Sourcetype failure = {
  1. message : string option;
  2. typ : string;
  3. description : string;
}

Indicates that the test failed. A failure is a test which the code has explicitly failed by using the mechanisms for that purpose. e.g., via an assertEquals. Contains as a text node relevant data for the failure, e.g., a stack trace.

Sourceval failure : ?message:string -> typ:string -> string -> failure

failure ?message ~typ description creates a failure element.

  • parameter message

    The message specified in the assert.

  • parameter typ

    The type of the assert.

  • parameter description

    Description of the failure.

Sourceval failure_to_xml : failure -> Tyxml.Xml.elt

Builds an XML element from a failure.

Sourcetype result =
  1. | Error of error
  2. | Failure of failure
  3. | Pass
  4. | Skipped
    (*

    Not part of the spec, but available in jenkins.

    *)
Sourceval result_to_xml : result -> Tyxml.Xml.elt

Builds an XML element from a result.

Sourcetype testcase
Sourcetype testcases = testcase list
Sourceval testcase : name:token -> classname:token -> time:float -> result -> testcase

Creates a testcase.

  • parameter name

    Name of the test method.

  • parameter classname

    Full class name for the class the test method is in.

  • parameter time

    Time taken (in seconds) to execute the test.

  • parameter result

    Result of the test.

Sourceval testcase_to_xml : testcase -> Tyxml.Xml.elt

Builds an XML element from a testcase.

Testsuites
Sourcetype testsuite

Contains the results of executing a testsuite.

Sourcetype testsuites = testsuite list

Contains an aggregation of testsuite results.

Sourceval testsuite : ?system_out:string -> ?system_err:string -> package:token -> id:int -> name:token -> timestamp:timestamp -> hostname:token -> tests:int -> failures:int -> errors:int -> skipped:int -> time:float -> properties -> testcases -> testsuite

Creates a testsuite.

Attributes

  • parameter package

    Derived from the testsuite name in the non-aggregated documents.

  • parameter id

    Starts at 0 for the first testsuite and is incremented by 1 for each following testsuite.

  • parameter name

    Full class name of the test for non-aggregated testsuite documents. Class name without the package for aggregated testsuites documents.

  • parameter timestamp

    When the test was executed. Timezone may not be specified.

  • parameter hostname

    Host on which the tests were executed. 'localhost' should be used if the hostname cannot be determined.

  • parameter tests

    The total number of tests in the suite.The total number of tests in the suite.

  • parameter failures

    The total number of tests in the suite that failed. A failure is a test which the code has explicitly failed by using the mechanisms for that purpose. e.g., via an assertEquals.

  • parameter errors

    The total number of tests in the suite that errored. An errored test is one that had an unanticipated problem. e.g., an unchecked throwable; or a problem with the implementation of the test.

  • parameter skipped

    The total number of tests in the suite that were skipped. A skipped test is one that was not run because the conditions for running it were not met.

  • parameter time

    Time taken (in seconds) to execute the tests in the suite.

Elements

  • parameter properties

    Properties (e.g., environment settings) set during test execution.

  • parameter testcases

    List of test executed.

  • parameter system_out

    Data that was written to standard out while the test was executed.

  • parameter system_err

    Data that was written to standard error while the test was executed.

Sourceval testsuite_to_xml : testsuite -> Tyxml.Xml.elt

Builds an XML element from a testsuite.

Builds an XML element from a list of testsuites.