Class JiraReportingPlugin

this plugin uses the following configuration to control its operation via aftconfig.json

{
    "JiraConfig": {
        "url": "https://your.jira.inst",
        "user": "you@jira.com",
        "accessKey": "your-jira-api-token",
        "openDefectOnFail": true,
        "closeDefectOnPass": true
    }
}

NOTE:

if openDefectOnFail and closeDefectOnPass are both false this plugin will be disabled

Hierarchy

  • ReportingPlugin
    • JiraReportingPlugin

Constructors

constructor

Properties

_api _closeOnPass _logs _openOnFail initialise

Accessors

aftCfg aftLogger enabled logLevel

Methods

_closeDefects _openNewDefectOrUpdateExisting finalise log logs submitResult

Constructors

constructor

Properties

Private Readonly _api

_api: JiraApi

Private Readonly _closeOnPass

_closeOnPass: boolean

Private Readonly _logs

_logs: Map<string, string>

Private Readonly _openOnFail

_openOnFail: boolean

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

logLevel

  • get logLevel(): "warn" | "trace" | "debug" | "info" | "step" | "pass" | "fail" | "error" | "none"

  • allows for filtering out of erroneous information from logs by assigning values to different types of logging. the purpose of each log level is as follows:

    • trace - used when logging low-level debug events that occur within a loop
    • debug - used for debug logging that does not run within a loop or at a high frequency
    • info - used for informational events providing current state of a system
    • step - used within a test to denote where within the test steps we are
    • warn - used for unexpected errors that are recoverable
    • pass - used to indicate the success of a test expectation or assertion
    • fail - used to indicate the failure of a test expectation or assertion
    • error - used for unexpected errors that are not recoverable
    • none - used when no logging is desired (disables logging)

    Returns "warn" | "trace" | "debug" | "info" | "step" | "pass" | "fail" | "error" | "none"

Methods

Private _closeDefects

Private _openNewDefectOrUpdateExisting

finalise

log

logs

submitResult

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc