Auto Waiting
Introduction
KWIKQA performs a range of actionability checks on the elements before making actions to ensure these actions behave as expected. It auto-waits for all the relevant checks to pass and only then performs the requested action. If the required checks do not pass within the given timeout, action fails with the TimeoutError.
For example, for click(), KWIKQA will ensure that:
- locator resolves to an exactly one element
- element is Visible
- element is Stable, as in not animating or completed animation
- element Receives Events, as in not obscured by other elements
- element is Enabled
Here is the complete list of actionability checks performed for each action:
| Action | Visible | Stable | Receives Events | Enabled | Editable |
|---|---|---|---|---|---|
| locator.check() | Yes | Yes | Yes | Yes | - |
| locator.click() | Yes | Yes | Yes | Yes | - |
| locator.dblclick() | Yes | Yes | Yes | Yes | - |
| locator.setChecked() | Yes | Yes | Yes | Yes | - |
| locator.uncheck() | Yes | Yes | Yes | Yes | - |
| locator.hover() | Yes | Yes | Yes | - | - |
| locator.dragTo() | Yes | Yes | Yes | - | - |
| locator.screenshot() | Yes | Yes | - | - | - |
| locator.fill() | Yes | - | - | Yes | Yes |
| locator.clear() | Yes | - | - | Yes | Yes |
| locator.selectOption() | Yes | - | - | Yes | - |
| locator.selectText() | Yes | - | - | - | - |
| locator.scrollIntoViewIfNeeded() | - | Yes | - | - | - |
| locator.focus() | - | - | - | - | - |
| locator.press() | - | - | - | - | - |
| locator.pressSequentially() | - | - | - | - | - |
| locator.setInputFiles() | - | - | - | - | - |
Assertions
KWIKQA includes auto-retrying assertions that remove flakiness by waiting until the condition is met, similarly to auto-waiting before actions.
| Assertion | Description |
|---|---|
| expect(locator).toBeAttached() | Element is attached |
| expect(locator).toBeChecked() | Checkbox is checked |
| expect(locator).toBeDisabled() | Element is disabled |
| expect(locator).toBeEditable() | Element is editable |
| expect(locator).toBeEmpty() | Container is empty |
| expect(locator).toBeEnabled() | Element is enabled |
| expect(locator).toBeFocused() | Element is focused |
| expect(locator).toBeHidden() | Element is not visible |
| expect(locator).toBeInViewport() | Element intersects viewport |
| expect(locator).toBeVisible() | Element is visible |
| expect(locator).toContainText() | Element contains text |
| expect(locator).toHaveAttribute() | Element has a DOM attribute |
| expect(locator).toHaveClass() | Element has a class property |
| expect(locator).toHaveCount() | List has exact number of children |
| expect(locator).toHaveCSS() | Element has CSS property |
| expect(locator).toHaveId() | Element has an ID |
| expect(locator).toHaveJSProperty() | Element has a JavaScript property |
| expect(locator).toHaveText() | Element matches text |
| expect(locator).toHaveValue() | Input has a value |
| expect(locator).toHaveValues() | Select has options selected |
| expect(page).toHaveTitle() | Page has a title |
| expect(page).toHaveURL() | Page has a URL |
| expect(response).toBeOK() | Response has an OK status |
Learn more in the assertions guide.
Visible
Element is considered visible when it has non-empty bounding box and does not have visibility:hidden computed style.
Note that according to this definition:
- Elements of zero size are not considered visible.
- Elements with
display:noneare not considered visible. - Elements with
opacity:0are considered visible.
Stable
Element is considered stable when it has maintained the same bounding box for at least two consecutive animation frames.
Enabled
Element is considered enabled unless it is a <button>, <select>, <input> or <textarea> with a disabled property.
Editable
Element is considered editable when it is enabled and does not have readonly property set.
Receives Events
Element is considered receiving pointer events when it is the hit target of the pointer event at the action point. For example, when clicking at the point (10;10), KWIKQA checks whether some other element (usually an overlay) will instead capture the click at (10;10).
For example, consider a scenario where KWIKQA will click Sign Up button regardless of when the locator.click() call was made:
- page is checking that user name is unique and
Sign Upbutton is disabled; - after checking with the server, the disabled
Sign Upbutton is replaced with another one that is now enabled.