Entity

The Entity class provides a way to verify if an entity/object has a desired attribute optinally with a desired value. It allows for positive and negative checks. This class extends the Question<boolean> class. Entity does not rely on any specific Ability.

Extends

This class extends the abstract Question<boolean> class from Core.

Methods

answeredBy

public async answeredBy(actor: Actor): Promise<boolean>;

• Description: Perform the verification based on the specified action.
• Parameters:
  • actor - The actor performing the action.
• Returns: Promise<boolean> - The verification result (true or false).

has

Introduced in: 1.0.0

static get has(): Entity;

• Description: Create a new instance of the Entity class for positive verification.
• Returns: Entity - A new instance of the Entity class.

Usage:

await actor.asks(
    Entity.has.attribute(myArray, 'length'),
);

hasNot

Introduced in: 1.0.0

static get hasNot(): Entity;

• Description: Create a new instance of the Entity class for negative verification.
• Returns: Entity - A new instance of the Entity class.

Usage:

await actor.asks(
    Entity.hasNot.attribute(myArray, 'length'),
);

attribute

Introduced in: 1.0.0

public attribute(obj: object, attribute: string): Entity;

• Description: Set up the verification for entity/object attribute lookup.
• Returns: Entity - The updated instance of the Entity class.

Usage:

// To verify that the entity has an attribute length
await actor.asks(
    Entity.has.attribute(myArray, 'length'),
);
// To verify that the entity has no attribute length
await actor.asks(
    Entity.hasNot.attribute(myObject, 'length'),
);

withValue

Introduced in: 1.0.0

public withValue(value: unknown): Entity;

• Description: Set up the verification for entity/object attribute value lookup.
• Returns: Entity - The updated instance of the Entity class.

Usage:

// To verify that the entity has an attribute length with value 1
await actor.asks(
    Entity.has.attribute(myArray, 'length').withValue(1),
);
// To verify that the entity has no attribute length with value 1
await actor.asks(
    Entity.hasNot.attribute(myArray, 'length').withValue(1),
);

Methods inherited from Core Question

failAsFalse

Introduced in core: 0.5.0

In some cases you may want to ask questions to find out about the status of the system under test to make decisions on how to move on with your test. In order to not fail a test but receive information about questions being answered negative you can use failAsFalse on a question which then returns a boolean value instead.

public get failAsFalse(): Question;

• Description: Returns false instead of failing when exception occurrs.
• Returns: Question - Returns the current question.

Usage:

// get evaluation result based on valid check
const evaluationResult = await actor.asks(
    MyQuestion.is.asExpected().failAsFalse,
);

// proceed based on answer from above
if (wasLoggedIn === false) {
    // some code to be executed on false case
}

withAbilityAlias

Introduced in core: 0.3.0

It happens that there is the need to make use of the same ability but with different settings. The solution Testla Screenplay offers is Ability Aliasing. With that multiple instances of an ability can be assigned to a user at the same time. To use an aliased ability in a question you can use the withAbilityAlias method to define the alias to be used during execution.

public withAbilityAlias(alias: string): Question;

• Description: Defines the ability alias to be used during execution.
• Parameters:
  • alias - The alias.
• Returns: Question - Returns the current question.

Usage:

await actor.asks(
    MyQuestion.is.asExpected().withAbilityAlias('myAlias'),
);