Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

test(site): improve E2E framework#9438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
mtojek merged 6 commits intomainfrome2e-cleanup
Aug 30, 2023
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion.github/workflows/ci.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -554,7 +554,7 @@ jobs:
- run: pnpm playwright:install
working-directory: site

- run: pnpm playwright:test
- run: pnpm playwright:test --workers 1
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Why are we setting workers to1?

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

If you delete this, playwright will run tests in parallel, and it may cause the Coder backend overloaded.

I want to reduce the amount of points that can break e2e tests. Additionally, our e2e tests are relatively quick, so if it isn't a problem I would disable parallelism for now.

env:
DEBUG: pw:api
working-directory: site
Expand Down
53 changes: 53 additions & 0 deletionssite/e2e/hooks.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import { Page } from "@playwright/test"

export const beforeCoderTest = async (page: Page) => {
// eslint-disable-next-line no-console -- Show everything that was printed with console.log()
page.on("console", (msg) => console.log("[onConsole] " + msg.text()))

page.on("request", (request) => {
if (!isApiCall(request.url())) {
return
}

// eslint-disable-next-line no-console -- Log HTTP requests for debugging purposes
console.log(
`[onRequest] method=${request.method()} url=${request.url()} postData=${
request.postData() ? request.postData() : ""
}`,
)
})
page.on("response", async (response) => {
if (!isApiCall(response.url())) {
return
}

const shouldLogResponse =
!response.url().endsWith("/api/v2/deployment/config") &&
!response.url().endsWith("/api/v2/debug/health")

let responseText = ""
try {
if (shouldLogResponse) {
const buffer = await response.body()
responseText = buffer.toString("utf-8")
responseText = responseText.replace(/\n$/g, "")
} else {
responseText = "skipped..."
}
} catch (error) {
responseText = "not_available"
}

// eslint-disable-next-line no-console -- Log HTTP requests for debugging purposes
console.log(
`[onResponse] url=${response.url()} status=${response.status()} body=${responseText}`,
)
})
}

const isApiCall = (urlString: string): boolean => {
const url = new URL(urlString)
const apiPath = "/api/v2"

return url.pathname.startsWith(apiPath)
}
1 change: 1 addition & 0 deletionssite/e2e/playwright.config.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -30,6 +30,7 @@ export default defineConfig({
timeout: 60000,
},
],
reporter: [["./reporter.ts"]],
use: {
baseURL: `http://localhost:${port}`,
video: "retain-on-failure",
Expand Down
53 changes: 53 additions & 0 deletionssite/e2e/reporter.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
import type {
FullConfig,
Suite,
TestCase,
TestResult,
FullResult,
Reporter,
} from "@playwright/test/reporter"

class CoderReporter implements Reporter {
onBegin(config: FullConfig, suite: Suite) {
// eslint-disable-next-line no-console -- Helpful for debugging
console.log(`Starting the run with ${suite.allTests().length} tests`)
}

onTestBegin(test: TestCase) {
// eslint-disable-next-line no-console -- Helpful for debugging
console.log(`Starting test ${test.title}`)
}

onStdOut(chunk: string, test: TestCase, _: TestResult): void {
// eslint-disable-next-line no-console -- Helpful for debugging
console.log(
`[stdout] [${test ? test.title : "unknown"}]: ${chunk.replace(
/\n$/g,
"",
)}`,
)
}

onStdErr(chunk: string, test: TestCase, _: TestResult): void {
// eslint-disable-next-line no-console -- Helpful for debugging
console.log(
`[stderr] [${test ? test.title : "unknown"}]: ${chunk.replace(
/\n$/g,
"",
)}`,
)
}

onTestEnd(test: TestCase, result: TestResult) {
// eslint-disable-next-line no-console -- Helpful for debugging
console.log(`Finished test ${test.title}: ${result.status}`)
}

onEnd(result: FullResult) {
// eslint-disable-next-line no-console -- Helpful for debugging
console.log(`Finished the run: ${result.status}`)
}
}

// eslint-disable-next-line no-unused-vars -- Playwright config uses it
export default CoderReporter
3 changes: 3 additions & 0 deletionssite/e2e/tests/app.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,9 @@ import { test } from "@playwright/test"
import { randomUUID } from "crypto"
import * as http from "http"
import { createTemplate, createWorkspace, startAgent } from "../helpers"
import { beforeCoderTest } from "../hooks"

test.beforeEach(async ({ page }) => await beforeCoderTest(page))

test("app", async ({ context, page }) => {
const appContent = "Hello World"
Expand Down
8 changes: 3 additions & 5 deletionssite/e2e/tests/createWorkspace.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { test, Page } from "@playwright/test"
import { test } from "@playwright/test"
import {
createTemplate,
createWorkspace,
Expand All@@ -16,11 +16,9 @@ import {
sixthParameter,
} from "../parameters"
import { RichParameter } from "../provisionerGenerated"
import { beforeCoderTest } from "../hooks"

test.beforeEach(async ({ page }: { page: Page }) => {
// eslint-disable-next-line no-console -- For debugging purposes
page.on("console", (msg) => console.log("Console: " + msg.text()))
})
test.beforeEach(async ({ page }) => await beforeCoderTest(page))

test("create workspace", async ({ page }) => {
const template = await createTemplate(page, {
Expand Down
3 changes: 3 additions & 0 deletionssite/e2e/tests/gitAuth.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,9 @@ import { gitAuth } from "../constants"
import { Endpoints } from "@octokit/types"
import { GitAuthDevice } from "api/typesGenerated"
import { Awaiter, createServer } from "../helpers"
import { beforeCoderTest } from "../hooks"

test.beforeEach(async ({ page }) => await beforeCoderTest(page))

// Ensures that a Git auth provider with the device flow functions and completes!
test("git auth device", async ({ page }) => {
Expand Down
3 changes: 3 additions & 0 deletionssite/e2e/tests/outdatedAgent.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,12 @@ import {
sshIntoWorkspace,
startAgentWithCommand,
} from "../helpers"
import { beforeCoderTest } from "../hooks"

const agentVersion = "v0.14.0"

test.beforeEach(async ({ page }) => await beforeCoderTest(page))

test("ssh with agent " + agentVersion, async ({ page }) => {
const token = randomUUID()
const template = await createTemplate(page, {
Expand Down
3 changes: 3 additions & 0 deletionssite/e2e/tests/outdatedCLI.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,12 @@ import {
sshIntoWorkspace,
startAgent,
} from "../helpers"
import { beforeCoderTest } from "../hooks"

const clientVersion = "v0.14.0"

test.beforeEach(async ({ page }) => await beforeCoderTest(page))

test("ssh with client " + clientVersion, async ({ page }) => {
const token = randomUUID()
const template = await createTemplate(page, {
Expand Down
3 changes: 3 additions & 0 deletionssite/e2e/tests/restartWorkspace.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,9 @@ import {

import { firstBuildOption, secondBuildOption } from "../parameters"
import { RichParameter } from "../provisionerGenerated"
import { beforeCoderTest } from "../hooks"

test.beforeEach(async ({ page }) => await beforeCoderTest(page))

test("restart workspace with ephemeral parameters", async ({ page }) => {
const richParameters: RichParameter[] = [firstBuildOption, secondBuildOption]
Expand Down
8 changes: 3 additions & 5 deletionssite/e2e/tests/updateWorkspace.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { test, Page } from "@playwright/test"
import { test } from "@playwright/test"

import {
createTemplate,
Expand All@@ -18,11 +18,9 @@ import {
secondBuildOption,
} from "../parameters"
import { RichParameter } from "../provisionerGenerated"
import { beforeCoderTest } from "../hooks"

test.beforeEach(async ({ page }: { page: Page }) => {
// eslint-disable-next-line no-console -- For debugging purposes
page.on("console", (msg) => console.log("Console: " + msg.text()))
})
test.beforeEach(async ({ page }) => await beforeCoderTest(page))

test("update workspace, new optional, immutable parameter added", async ({
page,
Expand Down
3 changes: 3 additions & 0 deletionssite/e2e/tests/webTerminal.spec.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
import { test } from "@playwright/test"
import { createTemplate, createWorkspace, startAgent } from "../helpers"
import { randomUUID } from "crypto"
import { beforeCoderTest } from "../hooks"

test.beforeEach(async ({ page }) => await beforeCoderTest(page))

test("web terminal", async ({ context, page }) => {
const token = randomUUID()
Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp