Skip to main content

Assertions

Assertions are used to check expected behaviors or outcomes in tests. At Qualiti, you can add an assertion as its own step anywhere in a Test Case — meaning that you can have as many assertions as you want.

We like to think of Assertion steps as anchor points along the flow of your test case, making sure that everything is working as expected and recognizing when bugs or errors have surfaced. One key difference between Assertion steps and regular Action steps is how they use code:

  • Action steps can generate their own code and self-repair when the code doesn't work
  • Assertion steps will never generate code or self-repair; this means you can always trust Assertion steps to do what they say, and fail if that isn't possible

You may find yourself asking "If Assertion steps never generate code, does that mean I have to write all the code myself?" Certainly not! You can just write the Assertion step's description in English, and Qualiti's AI will evaluate the assertion without any code at all! These no-code AI assertions provide a powerful and dynamic way to validate your application's behavior in a humanistic way. For example, you could assert that "The page is laid out with no visual errors, such as overlapping text or buttons"; this check would be very complicated to code, but it's a piece of cake for a no-code AI assertion 🍰

As wonderful as no-code AI assertions are, there may still be some situations where you do want to use code to write an Assertion step. For these situations we recommend leveraging Playwright's powerful expect() implementation, which includes many generic matchers like to_be_ok, to_contain_text, to_have_url, or specific assertions for specific elements on the webpage.

info

For more info regarding assertions, visit Playwright Assertions

Add an Assertion​

To add an assertion, open a Test Case and switch to the Steps tab to see the list of steps. Then either click the Edit or Add icon on any step to fill in the Assertion step's details.

  1. Fill the Step Description textbox with a description of what the step should check. We recommend the following format:
    Assertion: [statement in the present tense]
  2. Select "Assertion step"
  3. If you'd like to use code for your assertion, you can put it in the lower textbox (more details below)
  4. Click Save

Writing Assertions​

Once you've identified what you want to assert, then edit an existing step or add a new step to automate it! Let's use some examples to illustrate this. We will be using OrangeHRM as the example so you can follow along!

Example: Assert login was successful using the URL​

Here's simple Gherkin to describe the behavior we're checking:

GIVEN I enter valid admin credentials
WHEN I attempt to login
THEN I should login successfully with the URL ending in /dashboard/index

Qualiti auto-generated this Test Case but didn't add the exact assertion I was looking for. I can open the Test Case in the Qualiti Portal and add a new Test Step!

Current Steps:

  1. Enter 'Admin' into username field
  2. Enter 'admin123' into password field
  3. Click Login button

At this point I want a new step to check that login worked, so I click the Add icon on Step 3 and enter the following info:

  • Step Description: Assertion: the "/dashboard/index" page is displayed

  • Select "Assertion step"

  • Code: expect(page).to_have_url(re.compile("/dashboard/index$"))

    tip

    .to_have_url() can take either a string or a compiled regex pattern

Once I save the new Test Step, my list of steps should look like this:

  1. Enter 'Admin' into username field
  2. Enter 'admin123' into password field
  3. Click Login button
  4. Assertion: the "/dashboard/index" page is displayed

Example: Assert login was successful using an element​

I'll use simple Gherkin to describe the behavior we're checking:

GIVEN I enter valid admin credentials
WHEN I attempt to login
THEN I should login successfully with my username in the Account Dropdown

Qualiti auto-generated this Test Case but didn't add the exact assertion I was looking for. I can open the Test Case in the Qualiti Portal and add a new Test Step!

Current Steps:

  1. Enter 'Admin' into username field
  2. Enter 'admin123' into password field
  3. Click Login button

At this point I want a new step so I click the Add icon on Step 3 and enter the following info:

  • Step Description: Assertion: the Account Dropdown is visible
  • Select "Assertion step"
  • Code: expect(page.locator(".oxd-userdropdown")).to_be_visible()

Once I save the new Test Step, my list of steps should look like this:

  1. Enter 'Admin' into username field
  2. Enter 'admin123' into password field
  3. Click Login button
  4. Assertion: the Account Dropdown is visible