Achieving the Fluent Page Object Design Pattern with Patrol Possible?

[RashmiShashindra]

Hello,

I am a user of Patrol for e2e integration tests in our product.

Currently, I am building a proper model to carry out the scripting tasks for the integration tests using Patrol. I was able to achieve the Page Object Model using the Patrol but my current goal is to achieve the the Fluent Page Object Model which supports the simplicity and the test method chaining.

But I get that the Patrol methods which are $.tap, $.enterText and etc are all Future async methods which uses awaits to resolve the Promises. Because of this behavior, I am unable to achieve the Fluent pattern to simplify the tests.

I have tried Cascading in dart as well but it actually did not work and it has some promise resolving limitations when it comes to the test method chaining. Issue

Below is my Fluent Implementation

Test with method chaining

void main() {
  patrolTest(
    'Validate incorrect login',
    nativeAutomation: true,
    (PatrolTester $) async {
      await $.pumpWidgetAndSettle(const MyApp());

      SignInPage($)
          .stepSignIn(
            IncorrectUserCredentialsData.incorrectUsername,
            IncorrectUserCredentialsData.incorrectPassword,
          )
          .isCorrectErrorMessageDisplayed(SignInMessagesData.wrongUsernamePwdErrMsg)
          .stepSignIn(
            IncorrectUserCredentialsData.exceedCharUsername,
            IncorrectUserCredentialsData.exceedCharPassword,
          )
          .isCorrectErrorMessageDisplayed(SignInMessagesData.wrongUsernamePwdErrMsg);
    },
  );
}

Page Layer with the Methods to support Fluent (Without Future async and await)

final PatrolTester $;

SignInPage(this.$);

SignInPage stepSignIn(String username, String password) {
    $(usernameFld).enterText(username);
    $(passwordFld).enterText(password);
    $.scrollUntilVisible(finder: signInBtn);
    $(signInBtn).tap();
    return this;
  }

  SignInPage isCorrectErrorMessageDisplayed(String errorMessage) {
    $(errorFld).waitUntilVisible();
    expect($(errorMessage).visible, true);
    return this;
  }

Error that I get on the runtime is due to the unresolved promises. Where I need to make my methods also Future Async and usage of awaits.

@bartekpacia I would like to know if there is a way that I can use the Patrol methods and resolve the promises without awaits? Or do you have any solution already in place to achieve the Fluent Pattern?

Highly appreciate your support on this.

Thank you!