pyats.aereport.initinfo.id package

id – Id

This module implements Id element.

class pyats.aereport.initinfo.id.Id

Bases: pyats.aereport.toplevel.aereportelement.AEReportElement

Class based on this schema definition

<xs:complexType name="idType">
    <xs:sequence>
        <xs:choice minOccurs="0">
            <xs:element name="tc" type="xs:string"></xs:element>
            <xs:element name="subtc" type="xs:string"></xs:element>
        </xs:choice>
        <xs:element name="variance" minOccurs="0"></xs:element>
        <xs:element name="tims" minOccurs="0"></xs:element>
        <xs:element name="testplan" minOccurs="0"></xs:element>
    </xs:sequence>
    <xs:attribute name="name" type="xs:string" use="required"></xs:attribute>
    <xs:attribute name="md5"></xs:attribute>
</xs:complexType>
tag

Default value = ‘id’

Type

str

attrs

Dictionary of xml attributes: 1- name: required 2- md5

Type

dict

idtypechoice

Valid values are: ‘tc’: This is the testcase id in aetest context specified via -tc_id to aetest::testcase API. For TIMS, this will be passed as case_id attribute. and ‘subtc’: This is the subtestcase id in aetest context for the subtest and is specified via -subtc_id to aetest::subtest API. For TIMS, this will be passed as case_id attribute.

Type

str

idtypevalue

The value of idtype

Type

str

variance

Optional - Variance id is the same as TIMS config id. There cannot be a variance id at testcase level if it contains subtests. In such case the variance id will be part of subtest.

Type

str

tims

Tims id which is created and stored in TIMS

Type

IdTims

testplan

Optional - Test Plan id which should be an EDCS number

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 userdef

set_args(**kwargs)

Set log file attributes

Parameters
  • md5 (str) – Md5Id is calculated based on testcase name, test parameters, testbed name etc to ensure uniqueness

  • variance (str) – Variance id is the same as TIMS config id. There cannot be a variance id at testcase level if it contains subtests. In such case the variance id will be part of subtest.

  • tims (dict) – Tims id which is created and stored in TIMS

  • testplan (str) – Test Plan id which should be an EDCS number

Submodules

idtims – IdTims

This module implements IdTims element.

class pyats.aereport.initinfo.id.idtims.IdTims

Bases: pyats.aereport.toplevel.aereportelement.AEReportElement

Class based on this schema definition

<xs:element name="tims" minOccurs="0">
    <xs:annotation>
        <xs:documentation>Tims id which is created and stored in TIMS</xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:sequence>
            <xs:element name="case" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>TIMS case id which is of the format "Tnt...c"</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="config" minOccurs="0">
                <xs:annotation>
                    <xs:documentation>TIMS config id which is of the format "Tnt...g"</xs:documentation>
                </xs:annotation>
            </xs:element>
        </xs:sequence>
    </xs:complexType>
</xs:element>
set_args(**kwargs)

Set log file attributes

Parameters
  • case (str) – TIMS case id which is of the format “Tnt…c”

  • config (str) – TIMS config id which is of the format “Tnt…g”