element-web/cypress/support/views.ts

/*
Copyright 2022 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 {
            /**
             * Opens the given room by name. The room must be visible in the room list.
             * It uses a start-anchored regexp to accommodate for room tiles for unread rooms containing additional
             * context in their aria labels, e.g. "Room name 3 unread messages."
             *
             * @param name The room name to find and click on/open.
             */
            viewRoomByName(name: string): Chainable<JQuery<HTMLElement>>;

            /**
             * Opens the given room by room ID.
             *
             * This works by browsing to `/#/room/${id}`, so it will also work for room aliases.
             *
             * @param id
             */
            viewRoomById(id: string): void;

            /**
             * Returns the space panel space button based on a name. The space
             * must be visible in the space panel
             * @param name The space name to find
             */
            getSpacePanelButton(name: string): Chainable<JQuery<HTMLElement>>;

            /**
             * Opens the given space home by name. The space must be visible in
             * the space list.
             * @param name The space name to find and click on/open.
             */
            viewSpaceHomeByName(name: string): Chainable<JQuery<HTMLElement>>;

            /**
             * Opens the given space by name. The space must be visible in the
             * space list.
             * @param name The space name to find and click on/open.
             */
            viewSpaceByName(name: string): Chainable<JQuery<HTMLElement>>;
        }
    }
}

Cypress.Commands.add("viewRoomByName", (name: string): Chainable<JQuery<HTMLElement>> => {
    return cy
        .findByRole("treeitem", { name: new RegExp("^" + name) })
        .should("have.class", "mx_RoomTile")
        .click();
});

Cypress.Commands.add("viewRoomById", (id: string): void => {
    cy.visit(`/#/room/${id}`);
});

Cypress.Commands.add("getSpacePanelButton", (name: string): Chainable<JQuery<HTMLElement>> => {
    return cy.findByRole("button", { name: name }).should("have.class", "mx_SpaceButton");
});

Cypress.Commands.add("viewSpaceByName", (name: string): Chainable<JQuery<HTMLElement>> => {
    return cy.getSpacePanelButton(name).click();
});

Cypress.Commands.add("viewSpaceHomeByName", (name: string): Chainable<JQuery<HTMLElement>> => {
    return cy.getSpacePanelButton(name).dblclick();
});

// Needed to make this file a module
export {};