Skip to content

test(site): e2e: update workspace with parameters #9338

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
101 changes: 101 additions & 0 deletions site/e2e/helpers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ export const createWorkspace = async (
await page.goto("/templates/" + templateName + "/workspace", {
waitUntil: "networkidle",
})
await expect(page).toHaveURL("/templates/" + templateName + "/workspace")

const name = randomName()
await page.getByLabel("name").fill(name)

Expand Down Expand Up @@ -117,7 +119,10 @@ export const createTemplate = async (
await page.addInitScript({
content: "window.playwright = true",
})

await page.goto("/templates/new", { waitUntil: "networkidle" })
await expect(page).toHaveURL("/templates/new")

await page.getByTestId("file-upload").setInputFiles({
buffer: await createTemplateVersionTar(responses),
mimeType: "application/x-tar",
Expand Down Expand Up @@ -616,3 +621,99 @@ export const fillParameters = async (
}
}
}

export const updateTemplate = async (
page: Page,
templateName: string,
responses?: EchoProvisionerResponses,
) => {
const tarball = await createTemplateVersionTar(responses)

const sessionToken = await findSessionToken(page)
const child = spawn(
"go",
[
"run",
coderMainPath(),
"templates",
"push",
"--test.provisioner",
"echo",
"-y",
"-d",
"-",
templateName,
],
{
env: {
...process.env,
CODER_SESSION_TOKEN: sessionToken,
CODER_URL: "http://localhost:3000",
},
},
)

const uploaded = new Awaiter()
child.on("exit", (code) => {
if (code === 0) {
uploaded.done()
return
}

throw new Error(`coder templates push failed with code ${code}`)
})

child.stdin.write(tarball)
child.stdin.end()

await uploaded.wait()
}

export const updateWorkspace = async (
page: Page,
workspaceName: string,
richParameters: RichParameter[] = [],
buildParameters: WorkspaceBuildParameter[] = [],
) => {
await page.goto("/@admin/" + workspaceName, {
waitUntil: "domcontentloaded",
})
await expect(page).toHaveURL("/@admin/" + workspaceName)

await page.getByTestId("workspace-update-button").click()
await page.getByTestId("confirm-button").click()

await fillParameters(page, richParameters, buildParameters)
await page.getByTestId("form-submit").click()

await page.waitForSelector(
"span[data-testid='build-status'] >> text=Running",
{
state: "visible",
},
)
}

export const updateWorkspaceParameters = async (
page: Page,
workspaceName: string,
richParameters: RichParameter[] = [],
buildParameters: WorkspaceBuildParameter[] = [],
) => {
await page.goto("/@admin/" + workspaceName + "/settings/parameters", {
waitUntil: "domcontentloaded",
})
await expect(page).toHaveURL(
"/@admin/" + workspaceName + "/settings/parameters",
)

await fillParameters(page, richParameters, buildParameters)
await page.getByTestId("form-submit").click()

await page.waitForSelector(
"span[data-testid='build-status'] >> text=Running",
{
state: "visible",
},
)
}
1 change: 1 addition & 0 deletions site/e2e/playwright.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export default defineConfig({
`--access-url=http://localhost:${port} ` +
`--http-address=localhost:${port} ` +
`--in-memory --telemetry=false ` +
`--dangerous-disable-rate-limits ` +
`--provisioner-daemons 10 ` +
`--provisioner-daemons-echo ` +
`--provisioner-daemon-poll-interval 50ms`,
Expand Down
8 changes: 7 additions & 1 deletion site/e2e/tests/createWorkspace.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { test } from "@playwright/test"
import { test, Page } from "@playwright/test"
import {
createTemplate,
createWorkspace,
Expand All @@ -17,6 +17,11 @@ import {
} from "../parameters"
import { RichParameter } from "../provisionerGenerated"

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("create workspace", async ({ page }) => {
const template = await createTemplate(page, {
apply: [
Expand Down Expand Up @@ -107,6 +112,7 @@ test("create workspace and overwrite default parameters", async ({ page }) => {
page,
echoResponsesWithParameters(richParameters),
)

const workspaceName = await createWorkspace(
page,
template,
Expand Down
136 changes: 136 additions & 0 deletions site/e2e/tests/updateWorkspace.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
import { test, Page } from "@playwright/test"

import {
createTemplate,
createWorkspace,
echoResponsesWithParameters,
updateTemplate,
updateWorkspace,
updateWorkspaceParameters,
verifyParameters,
} from "../helpers"

import {
fifthParameter,
firstParameter,
secondParameter,
sixthParameter,
secondBuildOption,
} from "../parameters"
import { RichParameter } from "../provisionerGenerated"

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("update workspace, new optional, immutable parameter added", async ({
page,
}) => {
const richParameters: RichParameter[] = [firstParameter, secondParameter]
const template = await createTemplate(
page,
echoResponsesWithParameters(richParameters),
)

const workspaceName = await createWorkspace(page, template)

// Verify that parameter values are default.
await verifyParameters(page, workspaceName, richParameters, [
{ name: firstParameter.name, value: firstParameter.defaultValue },
{ name: secondParameter.name, value: secondParameter.defaultValue },
])

// Push updated template.
const updatedRichParameters = [...richParameters, fifthParameter]
await updateTemplate(
page,
template,
echoResponsesWithParameters(updatedRichParameters),
)

// Now, update the workspace, and select the value for immutable parameter.
await updateWorkspace(page, workspaceName, updatedRichParameters, [
{ name: fifthParameter.name, value: fifthParameter.options[0].value },
])

// Verify parameter values.
await verifyParameters(page, workspaceName, updatedRichParameters, [
{ name: firstParameter.name, value: firstParameter.defaultValue },
{ name: secondParameter.name, value: secondParameter.defaultValue },
{ name: fifthParameter.name, value: fifthParameter.options[0].value },
])
})

test("update workspace, new required, mutable parameter added", async ({
page,
}) => {
const richParameters: RichParameter[] = [firstParameter, secondParameter]
const template = await createTemplate(
page,
echoResponsesWithParameters(richParameters),
)

const workspaceName = await createWorkspace(page, template)

// Verify that parameter values are default.
await verifyParameters(page, workspaceName, richParameters, [
{ name: firstParameter.name, value: firstParameter.defaultValue },
{ name: secondParameter.name, value: secondParameter.defaultValue },
])

// Push updated template.
const updatedRichParameters = [...richParameters, sixthParameter]
await updateTemplate(
page,
template,
echoResponsesWithParameters(updatedRichParameters),
)

// Now, update the workspace, and provide the parameter value.
const buildParameters = [{ name: sixthParameter.name, value: "99" }]
await updateWorkspace(
page,
workspaceName,
updatedRichParameters,
buildParameters,
)

// Verify parameter values.
await verifyParameters(page, workspaceName, updatedRichParameters, [
{ name: firstParameter.name, value: firstParameter.defaultValue },
{ name: secondParameter.name, value: secondParameter.defaultValue },
...buildParameters,
])
})

test("update workspace with ephemeral parameter enabled", async ({ page }) => {
const richParameters: RichParameter[] = [firstParameter, secondBuildOption]
const template = await createTemplate(
page,
echoResponsesWithParameters(richParameters),
)

const workspaceName = await createWorkspace(page, template)

// Verify that parameter values are default.
await verifyParameters(page, workspaceName, richParameters, [
{ name: firstParameter.name, value: firstParameter.defaultValue },
{ name: secondBuildOption.name, value: secondBuildOption.defaultValue },
])

// Now, update the workspace, and select the value for ephemeral parameter.
const buildParameters = [{ name: secondBuildOption.name, value: "true" }]
await updateWorkspaceParameters(
page,
workspaceName,
richParameters,
buildParameters,
)

// Verify that parameter values are default.
await verifyParameters(page, workspaceName, richParameters, [
{ name: firstParameter.name, value: firstParameter.defaultValue },
{ name: secondBuildOption.name, value: secondBuildOption.defaultValue },
])
})
8 changes: 7 additions & 1 deletion site/src/pages/WorkspacePage/UpdateBuildParametersDialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,13 @@ export const UpdateBuildParametersDialog: FC<
<Button fullWidth type="button" onClick={dialogProps.onClose}>
Cancel
</Button>
<Button color="primary" fullWidth type="submit" form="updateParameters">
<Button
color="primary"
fullWidth
type="submit"
form="updateParameters"
data-testid="form-submit"
>
Update
</Button>
</DialogActions>
Expand Down