This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 833
Add Cypress Testing Library #10446
Merged
Merged
Add Cypress Testing Library #10446
Changes from all commits
Commits
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 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 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 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,70 @@ | ||
| /* | ||
| Copyright 2023 The Matrix.org Foundation C.I.C. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| /// <reference types="cypress" /> | ||
|
|
||
| import Chainable = Cypress.Chainable; | ||
|
|
||
| declare global { | ||
| // eslint-disable-next-line @typescript-eslint/no-namespace | ||
| namespace Cypress { | ||
| interface Chainable { | ||
| /** | ||
| * Finds an element with the role "button". | ||
| * | ||
| * @param name - accessible name of the element to find | ||
| */ | ||
| findButton(name: string): Chainable<JQuery>; | ||
| /** | ||
| * Finds an element with the role "textbox". | ||
| * | ||
| * @param name - accessible name of the element to find | ||
| */ | ||
| findTextbox(name: string): Chainable<JQuery>; | ||
| /** | ||
| * Finds an element with the role "option". | ||
| * | ||
| * @param name - accessible name of the element to find | ||
| */ | ||
| findOption(name: string): Chainable<JQuery>; | ||
| /** | ||
| * Finds an element with the role "menuitem". | ||
| * | ||
| * @param name - accessible name of the element to find | ||
| */ | ||
| findMenuitem(name: string): Chainable<JQuery>; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Cypress.Commands.add("findButton", (name: string): Chainable<JQuery> => { | ||
| return cy.findByRole("button", { name }); | ||
| }); | ||
|
|
||
| Cypress.Commands.add("findTextbox", (name: string): Chainable<JQuery> => { | ||
| return cy.findByRole("textbox", { name }); | ||
| }); | ||
|
|
||
| Cypress.Commands.add("findOption", (name: string): Chainable<JQuery> => { | ||
| return cy.findByRole("option", { name }); | ||
| }); | ||
|
|
||
| Cypress.Commands.add("findMenuitem", (name: string): Chainable<JQuery> => { | ||
| return cy.findByRole("menuitem", { name }); | ||
| }); | ||
|
|
||
| // Needed to make this file a module | ||
| export {}; | ||
This file contains 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 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 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 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
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.
@weeman1337 I think I'm missing the value of these helper functions.
As someone relatively new to the react-sdk codebase and cypress, and completely new to the cypress testing library, I spent a while trying to find documentation online these helper functions: I didn't realise that they were helpers that we had defined ourselves.
Given they are so short, why not just inline them?
In other words: I feel like these helpers are making our codebase less accessible to new contributors, whilst doing little to simplify the code.
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.
🤷 I don't have a strong opinion on them. My intention was that „I want to find a button“ by
findButton("Submit")is probably better understandable thanfindByRole("button", { name: "Submit" }).@richvdh would you like to raise this in one of our discussions? We can then decide whether to inline and remove them.
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.
Just for the record: we are going to remove them; it's cleaner and more flexible just to call
cy.findByRoledirectly.