-
-
Notifications
You must be signed in to change notification settings - Fork 827
Remove mx_HeaderButtons
class and add a test
#10713
Changes from 2 commits
8af7270
5f3b148
2922c66
d7a700d
de2dd1c
b20ceec
8c9eee1
831ee06
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,182 @@ | ||
/* | ||
Copyright 2023 Suguru Hirahara | ||
|
||
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 { HomeserverInstance } from "../../plugins/utils/homeserver"; | ||
import { SettingLevel } from "../../../src/settings/SettingLevel"; | ||
|
||
describe("Room Header", () => { | ||
let homeserver: HomeserverInstance; | ||
|
||
beforeEach(() => { | ||
cy.startHomeserver("default").then((data) => { | ||
homeserver = data; | ||
cy.initTestUser(homeserver, "Sakura"); | ||
}); | ||
}); | ||
|
||
afterEach(() => { | ||
cy.stopHomeserver(homeserver); | ||
}); | ||
|
||
it("should render seven buttons by default", () => { | ||
cy.createRoom({ name: "Test Room" }).viewRoomByName("Test Room"); | ||
|
||
cy.get(".mx_RoomHeader").within(() => { | ||
cy.findAllByRole("button").should("have.length", 7).should("be.visible"); | ||
|
||
cy.findByRole("button", { name: "Room options" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Voice call" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Video call" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Search" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Threads" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Notifications" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Room info" }).should("be.visible"); | ||
}); | ||
|
||
cy.get(".mx_RoomHeader").percySnapshotElement("Room header", { | ||
widths: [300, 600], // Magic numbers | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Again I'm unfamiliar with percy too - what are these magic numbers for? Are they the widths the snapshots are performed at? How come you chose these values? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Values specified with On this case, Percy creates a snapshot of The custom values are indeed relevant only for There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Addressed with 2922c66. |
||
}); | ||
}); | ||
|
||
it("should render the pin button for pinned messages card", () => { | ||
cy.enableLabsFeature("feature_pinning"); | ||
|
||
cy.createRoom({ name: "Test Room" }).viewRoomByName("Test Room"); | ||
|
||
cy.getComposer().type("Test message{enter}"); | ||
|
||
cy.get(".mx_EventTile_last").realHover().findByRole("button", { name: "Options" }).click(); | ||
|
||
cy.findByRole("menuitem", { name: "Pin" }).should("be.visible").click(); | ||
|
||
cy.get(".mx_RoomHeader").within(() => { | ||
cy.findByRole("button", { name: "Pinned messages" }).should("be.visible"); | ||
}); | ||
}); | ||
|
||
it("should render a very long room name without collapsing the buttons", () => { | ||
const LONG_ROOM_NAME = | ||
"Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore " + | ||
"et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut " + | ||
"aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum " + | ||
"dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui " + | ||
"officia deserunt mollit anim id est laborum."; | ||
|
||
cy.createRoom({ name: LONG_ROOM_NAME }).viewRoomByName(LONG_ROOM_NAME); | ||
|
||
cy.get(".mx_RoomHeader").within(() => { | ||
// Wait until the room name is set | ||
cy.get(".mx_RoomHeader_nametext").within(() => { | ||
cy.findByText(LONG_ROOM_NAME).should("exist"); | ||
}); | ||
|
||
// Assert the size of buttons on RoomHeader (except mx_RoomHeader_name) are specified | ||
// and the buttons are not compressed | ||
cy.get(".mx_RoomHeader_button") | ||
.should("have.length", 3) | ||
.should("be.visible") | ||
.should("have.css", "height", "32px") | ||
.should("have.css", "width", "32px"); | ||
cy.get(".mx_RightPanel_headerButton") // TODO: use the same class name | ||
.should("have.length", 3) | ||
.should("be.visible") | ||
.should("have.css", "height", "32px") | ||
.should("have.css", "width", "32px"); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How come we have a test for 7 buttons earlier on, but we only check 6 here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm going to add a comment about it. It is indeed confusing. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Addressed with de2dd1c |
||
}); | ||
|
||
cy.get(".mx_RoomHeader").percySnapshotElement("Room header - with a long room name", { | ||
widths: [300, 600], // Magic numbers | ||
}); | ||
}); | ||
|
||
it("should have a button highlighted by being clicked", () => { | ||
cy.createRoom({ name: "Test Room" }).viewRoomByName("Test Room"); | ||
|
||
cy.findByRole("button", { name: "Room info" }) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would we want to test for all buttons here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Currently only buttons which display content on the right panel by being clicked are highlighted; Thread, Notification, and Room Info, though I am not sure if this is intended or not. 8c9eee1 should address this. |
||
.click() // Highlight the button | ||
.then(($btn) => { | ||
// Note it is not possible to get CSS values of a pseudo class with "have.css". | ||
const color = $btn[0].ownerDocument.defaultView // get window reference from element | ||
.getComputedStyle($btn[0], "before") // get the pseudo selector | ||
.getPropertyValue("background-color"); // get "background-color" value | ||
|
||
// Assert the value is equal to $accent == hex #0dbd8b == rgba(13, 189, 139) | ||
expect(color).to.eq("rgb(13, 189, 139)"); | ||
}); | ||
|
||
cy.get(".mx_RoomHeader").percySnapshotElement("Room header - with a highlighted button", { | ||
widths: [300, 600], // Magic numbers | ||
}); | ||
}); | ||
|
||
describe("with a video room", () => { | ||
const createVideoRoom = () => { | ||
// Enable video rooms. This command reloads the app | ||
cy.setSettingValue("feature_video_rooms", null, SettingLevel.DEVICE, true); | ||
|
||
cy.get(".mx_LeftPanel_roomListContainer", { timeout: 20000 }) | ||
.findByRole("button", { name: "Add room" }) | ||
.click(); | ||
|
||
cy.findByRole("menuitem", { name: "New video room" }).click(); | ||
|
||
cy.findByRole("textbox", { name: "Name" }).type("Test video room"); | ||
|
||
cy.findByRole("button", { name: "Create video room" }).click(); | ||
|
||
cy.viewRoomByName("Test video room"); | ||
}; | ||
|
||
it("should render buttons for room options, beta pill, invite, chat, and room info", () => { | ||
createVideoRoom(); | ||
|
||
cy.get(".mx_RoomHeader").within(() => { | ||
cy.findByRole("button", { name: "Room options" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Video rooms are a beta feature Click for more info" }).should( | ||
"be.visible", | ||
); // Beta pill | ||
cy.findByRole("button", { name: "Invite" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Chat" }).should("be.visible"); | ||
cy.findByRole("button", { name: "Room info" }).should("be.visible"); | ||
|
||
// Assert that there is not a button except those buttons | ||
cy.findAllByRole("button").should("have.length", 5); | ||
}); | ||
|
||
cy.get(".mx_RoomHeader").percySnapshotElement("Room header - with a video room", { | ||
widths: [300, 600], // Magic numbers | ||
}); | ||
}); | ||
|
||
it("should render a working chat button which opens the timeline on a right panel", () => { | ||
createVideoRoom(); | ||
|
||
cy.get(".mx_RoomHeader").findByRole("button", { name: "Chat" }).click(); | ||
|
||
// Assert that the video is rnedered | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tiny typo here in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks! Fixed with d7a700d |
||
cy.get(".mx_CallView video").should("exist"); | ||
|
||
cy.get(".mx_RightPanel .mx_TimelineCard") | ||
.should("exist") | ||
.within(() => { | ||
// Assert that GELS is visible | ||
cy.findByText("Sakura created and configured the room.").should("exist"); | ||
}); | ||
}); | ||
}); | ||
}); |
This file was deleted.
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'll preface this comment with saying I'm pretty new to cypress (and specifically the testing-library stuff with it).
To me, it seems that on line 40 we're already doing this test, aren't we? We're grabbing all the buttons, checking there are 7 of them, and I think checking that each thing with the role of button is visible (I could be misunderstanding how chaining a
.should
after afindAllBy*
works though).There may still be value in checking that we have these 7 specific buttons on the page though (ie checking the name of each button).
I've had a look to see if there's a neater way of doing this, nothing leaps out at me from the jest documentation. Perhaps something like:
Might make it a bit easier to read. What do you think?
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.
Basically the object of this test is to ensure that just those seven (not six or eight) buttons are rendered by default. This can be achieved by combining
findAllBy
query withshould(have.length)
by counting the exact number of the all found buttons.Each
findByRole
query does ensure that button whose name is specified exists, but it cannot ensure that there was not another button rendered besides them unexpectedly.Based on your hint, b20ceec should optimize the readability and the test flow.