externalTestCompromisedError

Thrown to indicate that the test can't be performed due to an issue with a downstream dependency. For example, it makes no sense to run a full-stack integration test if we already know that the database server is down.

Throwing a TestCompromisedError from a custom Interaction

import { Interaction } from '@serenity-js/core';

const SetUpTestDatabase = () =>
  Interaction.where(`#actor sets up a test database`, actor => {
    return SomeCustomDatabaseSpecificAbility.as(actor).setUpTestDatabase().catch(error => {
      throw new TestCompromisedError('Could not set up the test database', error)
    })
})

Hierarchy

• RuntimeError
  • TestCompromisedError

Index

Constructors

• constructor

Properties

• cause
• name
• message
• stack

Methods

• fromJSON
• toString
• toJSON

Constructors

externalconstructor

• new TestCompromisedError(message: string, cause?: Error): TestCompromisedError

• Overrides RuntimeError.constructor

  Parameters

  • externalmessage: string

    Human-readable description of the error

  • externaloptionalcause: Error

    The root cause of this RuntimeError, if any

  Returns TestCompromisedError

Properties

publicexternaloptionalreadonlycause

cause?: Error

Inherited from RuntimeError.cause

The root cause of this RuntimeError, if any

externalname

name: string

Inherited from RuntimeError.name

externalmessage

message: string

Inherited from RuntimeError.message

externaloptionalstack

stack?: string

Inherited from RuntimeError.stack

Methods

staticexternalfromJSON

• fromJSON(serialised: JSONObject): TestCompromisedError

• Parameters

  • externalserialised: JSONObject

  Returns TestCompromisedError

externaltoString

• toString(): string

• Inherited from RuntimeError.toString

  Human-readable description of the error

  ---

  Returns string

externaltoJSON

• toJSON(): object

• Inherited from RuntimeError.toJSON

  Returns object