pyats.aereport.results package

Submodules

resultsummary – ResultSummary

This module implements ResultSummary class.

class pyats.aereport.results.resultsummary.ResultSummary

Bases: pyats.aereport.toplevel.aereportelement.AEReportElement

Result summary is contains information about number of passes, fails, aborts, never rans, number of crashes, pauses, cleans, reloads, etc

Class based on the following schema definition

<xs:complexType name="ResultSummaryType">
    <xs:sequence>
        <xs:element name="NumAbort" type="xs:nonNegativeInteger"/>
        <xs:element name="NumFail" type="xs:nonNegativeInteger"/>
        <xs:element name="NumPassX" type="xs:nonNegativeInteger"/>
        <xs:element name="NumBlock" type="xs:nonNegativeInteger"/>
        <xs:element name="NumPass" type="xs:nonNegativeInteger"/>
        <xs:element name="NumSkip" type="xs:nonNegativeInteger"/>
        <xs:element name="NumPauses" type="xs:nonNegativeInteger"/>
        <xs:element name="NumCleans" type="xs:nonNegativeInteger"/>
        <xs:element name="NumReloads" type="xs:nonNegativeInteger"/>
        <xs:element name="NumCrashes" type="xs:nonNegativeInteger"/>
    </xs:sequence>
</xs:complexType>

tag

Default value = ‘notag’. This is to ensure that all elements contain a tag attribute.

Type

str

NumAbort

Number of Abort

Type

str

NumPass

Number of Pass

Type

str

NumBlock

Number of Block

Type

str

NumSkip

Number of Skip

Type

str

NumPauses

Number of Pauses

Type

str

NumCleans

Number of Cleans

Type

str

NumReloads

Number of Reloads

Type

str

NumCrashes

Number of Crashes

Type

str

result – Result

This module implements RollUpResult element.

class pyats.aereport.results.rollupresult.RollUpResult

Bases: pyats.aereport.toplevel.aereportelement.AEReportElement

Rollup Result is calulated based on individual result values of corresponding sections and its value is limited to pass, passx, fail, abort, skip, block

Class based on the following schema definition

<xs:element name="rollupResult">
    <xs:annotation>...</xs:annotation>
    <xs:simpleType>
        <xs:restriction base="xs:string">
            <xs:enumeration value="pass"/>
            <xs:enumeration value="passx"/>
            <xs:enumeration value="failed"/>
            <xs:enumeration value="error"/>
            <xs:enumeration value="skip"/>
            <xs:enumeration value="abort"/>
            <xs:enumeration value="block"/>
        </xs:restriction>
    </xs:simpleType>
</xs:element>

tag

Default value = ‘notag’. This is to ensure that all elements contain a tag attribute.

Type

str

value

Value can be pass, passx, failed, error, skip, abort and block

Type

str

summary – Summary

This module implements Summary class used by TestSuite, TestScript and TestGroup.

class pyats.aereport.results.summary.Summary

Bases: pyats.aereport.toplevel.aereportelement.AEReportElement, pyats.results.counter.ResultCounter

Result element for storing test summary used by TestGroup, TestScript and TestSuite

Class based on the following schema definition

<xs:complexType name="summaryType">
    <xs:sequence>
        <xs:element name="pass" type="xs:integer"/>
        <xs:element name="passx"/>
        <xs:element name="fail"/>
        <xs:element name="abort"/>
        <xs:element name="block"/>
        <xs:element name="skip"/>
        <xs:element name="error"/>
        <xs:element name="unknown"/>
        <xs:element name="never_ran/>
    </xs:sequence>
</xs:complexType>

tag

Default value = ‘notag’. This is to ensure that all elements contain a tag attribute.

Type

str

aborted

Result is abort

Type

str

passed

Result is pass

Type

str

passx

Result is pass

Type

str

failed

Result is fail

Type

str

blocked

Result is block

Type

str

skipped

Result is skip

Type

str

errored

Result is error

Type

str

unknown

Result is unknown

Type

str

never_ran

Result is never_ran

Type

str

generate_dom(parent)

Override the default behavior of AEReportElement.generate_dom

Parameters

parent (AEReportElement) – The xml element that should be used as a parent for this summary

generate_resultsonly_dom(parent)

Override the default behavior of AEReportElement.generate_dom. This method is used for ResultsSummary.xml report only. TRADe expects ResultsSummary.xml report to contain testresults in past tense (e.g. aborted, passed, etc)

Parameters

parent (AEReportElement) – The xml element that should be used as a parent for this summary

set_args(**kwargs)

Set testsuite initinfo attributes

Parameters

• aborted (str or int) – Result is aborted

• passed (str) – Result is passed

• passx (str) – Result is passx

• failed (str or int) – Result is failed

• blocked (str or int) – Result is blocked

• skipped (str or int) – Result is skipped

• errored (str or int) – Result is errored

• never_ran (str or int) – Result is never_ran

• unknown (str or int) – Result is unknown

tag = 'summary'