Add convenience find commands

Author: weeman1337

cypress/e2e/create-room/create-room.spec.ts

@@ -20,8 +20,8 @@ import { HomeserverInstance } from "../../plugins/utils/homeserver";
 import Chainable = Cypress.Chainable;
 
 function openCreateRoomDialog(): Chainable<JQuery<HTMLElement>> {
-    cy.findByRole("button", { name: "Add room" }).click();
-    cy.findByRole("menuitem", { name: "New room" }).click();
+    cy.findButton("Add room").click();
+    cy.findMenuitem("New room").click();
     return cy.get(".mx_CreateRoomDialog");
 }
 
@@ -46,15 +46,15 @@ describe("Create Room", () => {
 
         openCreateRoomDialog().within(() => {
             // Fill name & topic
-            cy.findByRole("textbox", { name: "Name" }).type(name);
-            cy.findByRole("textbox", { name: "Topic (optional)" }).type(topic);
+            cy.findTextbox("Name").type(name);
+            cy.findTextbox("Topic (optional)").type(topic);
             // Change room to public
-            cy.findByRole("button", { name: "Room visibility" }).click();
-            cy.findByRole("option", { name: "Public room" }).click();
+            cy.findButton("Room visibility").click();
+            cy.findOption("Public room").click();
             // Fill room address
-            cy.findByRole("textbox", { name: "Room address" }).type("test-room-1");
+            cy.findTextbox("Room address").type("test-room-1");
             // Submit
-            cy.findByRole("button", { name: "Create room" }).click();
+            cy.findButton("Create room").click();
         });
 
         cy.url().should("contain", "/#/room/#test-room-1:localhost");

cypress/support/e2e.ts

@@ -38,3 +38,4 @@ import "./network";
 import "./composer";
 import "./proxy";
 import "./axe";
+import "./find";

cypress/support/find.ts

@@ -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 {};

docs/cypress.md

@@ -157,8 +157,10 @@ creation that can be called to set up tests.
 ### Try to write tests from the users's perspective
 
 Like for instance a user will not look for a button by querying a CSS selector. Instead you should work
-with roles / labels etc.. You can make use of `findBy…` queries provided by
-[Cypress Testing Library](https://github.com/testing-library/cypress-testing-library).
+with roles / labels etc.. You can make use of `cy.findBy…` queries provided by
+[Cypress Testing Library](https://github.com/testing-library/cypress-testing-library) and some convencience
+commands, such as `findButton(name)` or `findTextbox(name)`.
+See [`/cypress/support/find.ts`](../cypress/support/find.ts) for a complete list.
 
 ### Using matrix-js-sdk