create_task.md

Back to overview

Task

The idea that underpins the Screenplay Pattern is to capture your domain language and use your acceptance tests as an opportunity to demonstrate how actors interacting with your system accomplish their goals.

Conceptually similar to functions, tasks offer an easy way to associate business meaning with sequences of activities and turn them into reusable building blocks.

Define your task

Here, we create a simple login task which can be performed by an actor.

import { Actor, Task } from '@testla/screenplay-playwright';
import { Navigate, Fill, Click, Wait } from '@testla/screenplay-playwright/web';
import { LoginScreen } from '../screen/login-screen';

export class Login extends Task {
    private constructor() {
        super();
    }

    public async performAs(actor: Actor): Promise<any> {
        return actor.attemptsTo(
            Navigate.to(loginURL),
            Fill.in(LoginScreen.USER_NAME_INPUT, actor.states('username') || ''),
            Fill.in(LoginScreen.PASSWORD_INPUT, actor.states('password') || ''),            
            Click.on(LoginScreen.LOGIN_BUTTON),
            Wait.forLoadState('networkidle'),
        );
    }

    public static toApp(): Login {
            return new Login();
    }
}

In Detail

The performAs method is required to be implemented by any class extending the Task abstract class. It takes an Actor object as a parameter, representing the actor performing the task. It encapsulates a sequence of actions that an actor needs to perform. This makes the task reusable and provides a clear representation of the process in the domain language of the application. The Login class follows the Screenplay Pattern's concept of using tasks to model sequences of activities, making the test scenarios more readable and aligned with the business language.

Back to overview