-
-
Notifications
You must be signed in to change notification settings - Fork 60
feat: Support $$() with all element's matchers
#1990
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
dprevost-LMI
wants to merge
7
commits into
webdriverio:main
Choose a base branch
from
dprevost-LMI:fix-matchers-with-$$
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+10,460
−3,838
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
b3c2ecc
fix failure msg with `enhanceErrorBe` + code refactoring simplification
dprevost-LMI f2bb99c
Ensure mocks used represented wdio framework reality
dprevost-LMI 1766734
fix bad command
dprevost-LMI 1566131
Working case of $$ aka ElementArray with `toBeDisplayed`
dprevost-LMI 7174df9
Reivew waitUntil and fixes multiple not tests
dprevost-LMI 2bde717
Review waitUntil implementation
dprevost-LMI d69a855
Fix bad mocks
dprevost-LMI File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # Multiple Elements Support | ||
|
|
||
| Matchers element array support (e.g., `$$()`): | ||
|
|
||
| - **Strict Index-based Matching**: If an array of expected values is provided, it must match the elements' count; each value is checked at its index. | ||
| - If a single value is provided, every element is compared to it. | ||
| - Asymmetric matchers (e.g., `expect.stringContaining`) work within expected value arrays. | ||
| - An error is thrown if no elements are found (except with `toBeElementsArrayOfSize`). | ||
| - Options like `StringOptions` or `HTMLOptions` apply to the whole array; `NumberOptions` behaves like any expected provided value. | ||
| - The assertion passes only if **all** elements match. | ||
| - Using `.not` means all elements must **not** match. | ||
|
|
||
| **Note:** Strict Index-based matching does not apply to `toHaveText`, since an existing behavior was already in placed. | ||
|
|
||
| ## Limitations | ||
| - Instead of `StringOptions` for a single expected value, use RegExp or asymmetric matchers. | ||
| - For `ignoreCase` use RegEx (`/MyExample/i`) | ||
| - For `containing` use Asymmetric Matchers (`expect.stringContaining('Example')`) | ||
| - Passing an array of "containing" values is deprecated and not supported outside `toHaveText`. | ||
|
|
||
| ## Supported types | ||
| You can pass any of these element types to `expect`: | ||
| - `ChainablePromiseArray` (the non-awaited case) | ||
| - `ElementArray` (the awaited case) | ||
| - `Element[]` (the filtered case) | ||
|
|
||
| ## Alternative | ||
|
|
||
| For more granular or explicit per-element validation, use a parameterized test of your framework. | ||
| Example in Mocha: | ||
| ```ts | ||
| describe('Element at index of `$$`', function () { | ||
| [ { expectedText: 'one', index: 0 }, | ||
| { expectedText: 'two', index: 2 }, | ||
| { expectedText: 'four', index: 4 }, | ||
| ].forEach(function ( { expectedText, index } ) { | ||
| it("Element at $index of `$$('label')` is $expectedText", function () { | ||
| expect($$('label')[index]).toHaveText(expectedText); | ||
| }); | ||
| }); | ||
| }); | ||
| ``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Waiting on merge of #1991