code-server/test/goHome.test.ts

111 lines
3.7 KiB
TypeScript
Raw Normal View History

2021-02-04 21:54:08 +00:00
import { chromium, Page, Browser, BrowserContext, Cookie } from "playwright"
import { createCookieIfDoesntExist } from "../src/common/util"
import { hash } from "../src/node/util"
import { CODE_SERVER_ADDRESS, PASSWORD, STORAGE } from "./constants"
2021-01-28 18:48:57 +00:00
2021-02-11 18:18:15 +00:00
async function setTimeoutPromise(milliseconds: number): Promise<void> {
return new Promise((resolve, _) => {
setTimeout(() => {
resolve()
}, milliseconds)
})
}
describe("go home", () => {
2021-01-28 18:48:57 +00:00
let browser: Browser
let page: Page
let context: BrowserContext
2021-02-11 18:18:15 +00:00
beforeAll(async () => {
browser = await chromium.launch()
2021-02-01 21:38:53 +00:00
// Create a new context with the saved storage state
const storageState = JSON.parse(STORAGE) || {}
2021-02-04 21:54:08 +00:00
const cookieToStore = {
sameSite: "Lax" as const,
name: "key",
value: hash(PASSWORD),
2021-02-04 21:54:08 +00:00
domain: "localhost",
path: "/",
expires: -1,
httpOnly: false,
secure: false,
}
// For some odd reason, the login method used in globalSetup.ts doesn't always work
// I don't know if it's on playwright clearing our cookies by accident
// or if it's our cookies disappearing.
// This means we need an additional check to make sure we're logged in.
// We do this by manually adding the cookie to the browser environment
// if it's not there at the time the test starts
const cookies: Cookie[] = storageState.cookies || []
// If the cookie exists in cookies then
// this will return the cookies with no changes
// otherwise if it doesn't exist, it will create it
// hence the name maybeUpdatedCookies
//
// TODO(@jsjoeio)
// The playwright storage thing sometimes works and sometimes doesn't. We should investigate this further
// at some point.
// See discussion: https://github.com/cdr/code-server/pull/2648#discussion_r575434946
2021-02-04 21:54:08 +00:00
const maybeUpdatedCookies = createCookieIfDoesntExist(cookies, cookieToStore)
context = await browser.newContext({
storageState: { cookies: maybeUpdatedCookies },
recordVideo: { dir: "./test/videos/" },
})
2021-01-28 18:48:57 +00:00
})
2021-02-11 18:18:15 +00:00
afterAll(async () => {
2021-02-01 21:38:53 +00:00
// Remove password from local storage
await context.clearCookies()
2021-01-28 18:48:57 +00:00
await browser.close()
await context.close()
2021-01-28 18:48:57 +00:00
})
2021-02-11 18:18:15 +00:00
beforeEach(async () => {
2021-01-28 18:48:57 +00:00
page = await context.newPage()
})
2021-02-04 21:54:08 +00:00
// NOTE: this test will fail if you do not run code-server with --home $CODE_SERVER_ADDRESS/healthz
2021-02-11 18:18:15 +00:00
it("should see a 'Go Home' button in the Application Menu that goes to /healthz", async () => {
let requestedGoHomeUrl = false
2021-02-04 21:54:08 +00:00
const GO_HOME_URL = `${CODE_SERVER_ADDRESS}/healthz`
page.on("request", (request) => {
// This ensures that we did make a request to the GO_HOME_URL
// Most reliable way to test button
// because we don't care if the request has a response
// only that it was made
if (request.url() === GO_HOME_URL) {
requestedGoHomeUrl = true
}
})
// Sometimes a dialog shows up when you navigate
// asking if you're sure you want to leave
// so we listen if it comes, we accept it
page.on("dialog", (dialog) => dialog.accept())
2021-02-01 21:38:53 +00:00
// waitUntil: "domcontentloaded"
// In case the page takes a long time to load
await page.goto(CODE_SERVER_ADDRESS, { waitUntil: "domcontentloaded" })
// Click the Home menu
await page.click(".home-bar ul[aria-label='Home'] li")
2021-01-28 18:48:57 +00:00
// See the Go Home button
const goHomeButton = "a.action-menu-item span[aria-label='Go Home']"
2021-01-28 18:48:57 +00:00
expect(await page.isVisible(goHomeButton))
// Click it and navigate to /healthz
// NOTE: ran into issues of it failing intermittently
// without having button: "middle"
2021-02-11 18:18:15 +00:00
await Promise.all([
page.waitForNavigation(),
page.click(goHomeButton, { button: "middle" })
])
expect(page.url()).toBe(GO_HOME_URL)
2021-01-28 18:48:57 +00:00
})
})