chore: add e2e tests for basic template and workspace flow #5637
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
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,24 @@ | ||
| import { Page } from "@playwright/test" | ||
|
|
||
| export const buttons = { | ||
| starterTemplates: "Starter templates", | ||
| dockerTemplate: "Develop in Docker", | ||
| useTemplate: "Use template", | ||
| createTemplate: "Create template", | ||
| createWorkspace: "Create workspace", | ||
| submitCreateWorkspace: "Create workspace", | ||
| stopWorkspace: "Stop", | ||
| startWorkspace: "Start", | ||
| } | ||
|
There was a problem hiding this comment. I'm not sure I would decouple this page-specific constant from the test for that page. |
||
|
|
||
| export const clickButton = async (page: Page, name: string): Promise<void> => { | ||
| await page.getByRole("button", { name, exact: true }).click() | ||
| } | ||
|
|
||
| export const fillInput = async ( | ||
| page: Page, | ||
| label: string, | ||
| value: string, | ||
| ): Promise<void> => { | ||
| await page.fill(`text=${label}`, value) | ||
| } | ||
|
There was a problem hiding this comment. Is there a reason we made helpers for these? They seem to wrap fairly trivial built-in methods. There was a problem hiding this comment. To address this comment and the one about the constant: previously, we wrote Playwright tests with POMs, so for each page, you'd have a file with a class and methods. I started doing that here and it felt too heavy since the current plan isn't to write many e2e tests. (Although after seeing how pleasant they were to debug, I'm reconsidering that!) So instead, I just dumped everything I would normally have put in the class into these few helpers. But I agree that it's not that much easier to read and write than just inlining everything. There was a problem hiding this comment. As someone who isn't familiar with playwright, I appreciate them and makes test-authoring seem a bit easier. No strong opinions though! |
||
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,40 @@ | ||
| import { test } from "@playwright/test" | ||
|
There was a problem hiding this comment. Perhaps the file name There was a problem hiding this comment. Yeah, we discussed having one long test instead of several short ones since e2e tests tend to build on each other, and so I didn't have something really specific to name it. But again, now that I'm feeling more positive on e2e tests, we should probably talk as a team about whether we want to do more of them. |
||
| import { email, password } from "../constants" | ||
| import { SignInPage } from "../pom" | ||
| import { clickButton, buttons, fillInput } from "../helpers" | ||
|
|
||
| test("Basic flow", async ({ baseURL, page }) => { | ||
| test.slow() | ||
| await page.goto(baseURL + "/", { waitUntil: "networkidle" }) | ||
|
|
||
| // Log-in with the default credentials we set up in the development server | ||
| const signInPage = new SignInPage(baseURL, page) | ||
| await signInPage.submitBuiltInAuthentication(email, password) | ||
|
|
||
| // create Docker template | ||
| await page.waitForSelector("text=Templates") | ||
| await page.click("text=Templates") | ||
|
|
||
| await clickButton(page, buttons.starterTemplates) | ||
|
|
||
| await page.click(`text=${buttons.dockerTemplate}`) | ||
|
|
||
| await clickButton(page, buttons.useTemplate) | ||
|
|
||
| await clickButton(page, buttons.createTemplate) | ||
|
|
||
| // create workspace | ||
| await clickButton(page, buttons.createWorkspace) | ||
|
|
||
| await fillInput(page, "Workspace Name", "my-workspace") | ||
| await clickButton(page, buttons.submitCreateWorkspace) | ||
|
|
||
| // stop workspace | ||
| await page.waitForSelector("text=Started") | ||
| await clickButton(page, buttons.stopWorkspace) | ||
|
|
||
| // start workspace | ||
| await page.waitForSelector("text=Stopped") | ||
| await clickButton(page, buttons.startWorkspace) | ||
presleyp marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| await page.waitForSelector("text=Started") | ||
| }) | ||
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 |
|---|---|---|
|
|
@@ -1921,13 +1921,13 @@ | |
| tiny-glob "^0.2.9" | ||
| tslib "^2.4.0" | ||
|
|
||
| "@playwright/test@1.29.2": | ||
| version "1.29.2" | ||
| resolved "https://registry.yarnpkg.com/@playwright/test/-/test-1.29.2.tgz#c48184721d0f0b7627a886e2ec42f1efb2be339d" | ||
| integrity sha512-+3/GPwOgcoF0xLz/opTnahel1/y42PdcgZ4hs+BZGIUjtmEFSXGg+nFoaH3NSmuc7a6GSFwXDJ5L7VXpqzigNg== | ||
| dependencies: | ||
| "@types/node" "*" | ||
| playwright-core "1.29.2" | ||
|
|
||
| "@pmmmwh/react-refresh-webpack-plugin@^0.5.3": | ||
| version "0.5.9" | ||
|
|
@@ -11326,10 +11326,17 @@ pkg-dir@^5.0.0: | |
| dependencies: | ||
| find-up "^5.0.0" | ||
|
|
||
| [email protected]: | ||
| version "1.29.2" | ||
| resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.29.2.tgz#2e8347e7e8522409f22b244e600e703b64022406" | ||
| integrity sha512-94QXm4PMgFoHAhlCuoWyaBYKb92yOcGVHdQLoxQ7Wjlc7Flg4aC/jbFW7xMR52OfXMVkWicue4WXE7QEegbIRA== | ||
|
|
||
| playwright@^1.29.2: | ||
| version "1.29.2" | ||
| resolved "https://registry.yarnpkg.com/playwright/-/playwright-1.29.2.tgz#d6a0a3e8e44f023f7956ed19ffa8af915a042769" | ||
| integrity sha512-hKBYJUtdmYzcjdhYDkP9WGtORwwZBBKAW8+Lz7sr0ZMxtJr04ASXVzH5eBWtDkdb0c3LLFsehfPBTRfvlfKJOA== | ||
| dependencies: | ||
| playwright-core "1.29.2" | ||
|
|
||
| pluralize@^8.0.0: | ||
| version "8.0.0" | ||
|
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.