Class TestRailReportingPlugin

this plugin uses the following configuration to control its operation via aftconfig.json and if the logLevel is unset it will be set from the value in AftConfig.logLevel before falling back to a value of warn

{
    "TestRailConfig": {
        "logLevel": "warn",
        "maxLogCharacters": 300,
        "planId": 1234,
        "projectId": 12,
        "suiteIds": [34, 567]
    }
}

NOTE:

if no value is set for planId and a logLevel value other than none is used then a new TestRail Plan will be created from the specified projectId and suiteIds configuration keys

Hierarchy

  • ReportingPlugin
    • TestRailReportingPlugin

Constructors

constructor

Properties

_api _level _logs _maxLogChars initialise

Accessors

aftCfg aftLogger enabled logLevel

Methods

_getTestRailResultForTestResult finalise log logs submitResult

Constructors

constructor

Properties

Private Readonly _api

_api: TestRailApi

Private Readonly _level

_level: "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"

Private Readonly _logs

_logs: Map<string, string>

Private Readonly _maxLogChars

_maxLogChars: number

initialise

initialise: ((logName) => Promise<void>)

Type declaration

    • (logName): Promise<void>

    • called by the parent ReportingManager on load to allow any plugins to configure themselves for a new logger

      Parameters

      • logName: string

        the name of the ReportingManager instance calling dispose

      Returns Promise<void>

Accessors

aftCfg

  • get aftCfg(): AftConfig

  • Returns AftConfig

aftLogger

  • get aftLogger(): AftLogger

  • Returns AftLogger

enabled

  • get enabled(): boolean

  • Returns boolean

logLevel

Methods

Private _getTestRailResultForTestResult

finalise

log

logs

submitResult

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc