Package com.microsoft.playwright.assertions

Interface PlaywrightAssertions

public interface PlaywrightAssertions
Playwright gives you Web-First Assertions with convenience methods for creating assertions that will wait and retry until the expected condition is met.

Consider the following example: 


 ...
 import static com.microsoft.playwright.assertions.PlaywrightAssertions.assertThat;

 public class TestExample {
   ...
   @Test
   void statusBecomesSubmitted() {
     ...
     page.locator("#submit-button").click();
     assertThat(page.locator(".status")).hasText("Submitted");
   }
 }

Playwright will be re-testing the node with the selector .status until fetched Node has the "Submitted" text. It will be re-fetching the node and checking it over and over, until the condition is met or until the timeout is reached. You can pass this timeout as an option.

By default, the timeout for assertions is set to 5 seconds.

  • Method Details

    • assertThat

      static APIResponseAssertions assertThat(APIResponse response)
      Creates a APIResponseAssertions object for the given APIResponse.

      **Usage** 

      
 PlaywrightAssertions.assertThat(response).isOK();
      Parameters:
      response - APIResponse object to use for assertions.
      Since:
      v1.18

    • assertThat

      static LocatorAssertions assertThat(Locator locator)
      Creates a LocatorAssertions object for the given Locator.

      **Usage** 

      
 PlaywrightAssertions.assertThat(locator).isVisible();
      Parameters:
      locator - Locator object to use for assertions.
      Since:
      v1.18

    • assertThat

      static PageAssertions assertThat(Page page)
      Creates a PageAssertions object for the given Page.

      **Usage** 

      
 PlaywrightAssertions.assertThat(page).hasTitle("News");
      Parameters:
      page - Page object to use for assertions.
      Since:
      v1.18

    • setDefaultAssertionTimeout

      static void setDefaultAssertionTimeout(double milliseconds)
      Changes default timeout for Playwright assertions from 5 seconds to the specified value.

      **Usage** 

      
 PlaywrightAssertions.setDefaultAssertionTimeout(30_000);
      Parameters:
      timeout - Timeout in milliseconds.
      Since:
      v1.25