report

Documentation

Overview

Package report provides an API to add properties to, and extract properties from, the JUnit XML test report.

To attach a key-value property to the currently running test suite in the XML report, use the `AddSuiteProperty` method. For example:

ondatra.Report().AddSuiteProperty("mySuiteKey", "mySuiteValue")

To attach a key-value property to the currently running test case, use the `AddTestProperty` method. For example:

ondatra.Report().AddTestProperty(t, "myTestKey", "myTestValue")

In reality, JUnit XML only supports top-level/suite properties, so `AddTestProperty` must specially-encode test properties in suite properties. Use `ReadXML` to programmatically parse the XML file into a structured JUnit report, and use `ExtractProperties` to decode the suite properties back into separate test-level and suite-level properties.

Index

• func ExtractProperties(suites junit.Testsuites) map[string]map[string]string
• func ReadXML(r io.Reader) (junit.Testsuites, error)
• type Report
  • func (r *Report) AddRawProperty(test, name, value string)
  • func (r *Report) AddSuiteProperty(name, value string)
  • func (r *Report) AddTestProperty(t testing.TB, name, value string)

Functions

func ExtractProperties

func ExtractProperties(suites junit.Testsuites) map[string]map[string]string

ExtractProperties extracts a testName->propertyName->propertyValue map from the specified JUnit Testsuites. It assumes the specified Testsuites contains exactly one Testsuite, since the XML report always contains exactly one, and if the Testsuite contains multiple properties with the same name, later property values overwrite earlier property values.

func ReadXML

func ReadXML(r io.Reader) (junit.Testsuites, error)

ReadXML decodes XML bytes into a JUnit Testsuites element.

Types

type Report

type Report struct{}

Report is the API to customizing a JUnit XML report.

func (*Report) AddRawProperty

func (r *Report) AddRawProperty(test, name, value string)

AddRawProperty attaches a name-value property to the specified test name in the generated the XML report. If the test name is the empty string, the property is attached to the test suite. For improved test readability, callers should prefer using AddSuiteProperty or AddTestProperty.

func (*Report) AddSuiteProperty

func (r *Report) AddSuiteProperty(name, value string)

AddSuiteProperty attaches a name-value property to the test suite in the generated XML report. This is preferred, but equivalent, to calling AddRawProperty("", name, value).

func (*Report) AddTestProperty

func (r *Report) AddTestProperty(t testing.TB, name, value string)

AddTestProperty attaches a name-value property to the current test in the generated XML report. This is preferred, but equivalent, to calling AddRawProperty(t.Name(), name, value).