Class TestRailPolicyPlugin

NOTE:

this plugin has no configuration options as they are all retrieved from TestRailConfig under the TestRailConfig section of your aftconfig.json file

Hierarchy

  • PolicyPlugin
    • TestRailPolicyPlugin

Constructors

constructor

Properties

_api _enabled

Accessors

aftCfg aftLogger enabled

Methods

_findTestsByField findTestCases getTestCase shouldRun

Constructors

constructor

Properties

Private Readonly _api

_api: TestRailApi

Private Readonly _enabled

_enabled: boolean

Accessors

aftCfg

  • get aftCfg(): AftConfig

  • Returns AftConfig

aftLogger

  • get aftLogger(): AftLogger

  • Returns AftLogger

enabled

Methods

Private _findTestsByField

findTestCases

  • the searchTerm must take the format of key=value where the key is a valid field on a TestRailTest or TestRailCase object and the value is the expected value to be found for said key

    Parameters

    • searchTerm: string

      a string containing a key and a value to be used to locate tests

    Returns Promise<(TestRailCase | TestRailTest)[]>

getTestCase

shouldRun

  • function will find a TestRail test or case by case id and if found will return true if the test is not already marked as passed. if no test is found then false is returned

    Parameters

    • caseId: string

      the TestRail case id used to lookup either a test in an existing plan or a case in an existing suite

    Returns Promise<ProcessingResult<boolean>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc