begin work on terraform e2e test

Emyrk · Emyrk · commit 8fdaf2c44c70 · 2024-05-03T10:55:01.000-05:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -222,5 +222,7 @@
   "go.testFlags": ["-short", "-coverpkg=./..."],
   // We often use a version of TypeScript that's ahead of the version shipped
   // with VS Code.
-  "typescript.tsdk": "./site/node_modules/typescript/lib"
+  "typescript.tsdk": "./site/node_modules/typescript/lib",
+  // Playwright tests in VSCode will open a browser to live "view" the test.
+  "playwright.reuseBrowser": true
 }
diff --git a/site/e2e/constants.ts b/site/e2e/constants.ts
@@ -41,9 +41,7 @@ export const enterpriseLicense = process.env.CODER_E2E_ENTERPRISE_LICENSE ?? "";
 
 // Disabling terraform tests is optional for environments without Docker + Terraform.
 // By default, we opt into these tests.
-export const requireTerraformTests = !Boolean(
-  process.env.CODER_E2E_DISABLE_TERRAFORM,
-);
+export const requireTerraformTests = !process.env.CODER_E2E_DISABLE_TERRAFORM;
 
 // Fake experiments to verify that site presents them as enabled.
 export const e2eFakeExperiment1 = "e2e-fake-experiment-1";
diff --git a/site/e2e/helpers.ts b/site/e2e/helpers.ts
@@ -18,7 +18,8 @@ import {
   coderPort,
   enterpriseLicense,
   prometheusPort,
-  requireEnterpriseTests, requireTerraformTests,
+  requireEnterpriseTests,
+  requireTerraformTests,
 } from "./constants";
 import { expectUrl } from "./expectUrl";
 import {
@@ -52,7 +53,6 @@ export function requiresTerraform() {
   test.skip(!requireTerraformTests);
 }
 
-
 // createWorkspace creates a workspace for a template.
 // It does not wait for it to be running, but it does navigate to the page.
 export const createWorkspace = async (
@@ -159,25 +159,48 @@ export const verifyParameters = async (
   }
 };
 
+// StarterTemplates are ids of starter templates that can be used in place of
+// the responses payload. These starter templates will require real provisioners.
+export enum StarterTemplates {
+  STARTER_DOCKER = "docker",
+}
+
+function isStarterTemplate(
+  input: EchoProvisionerResponses | StarterTemplates | undefined,
+): input is StarterTemplates {
+  if (!input) {
+    return false;
+  }
+  return typeof input === "string";
+}
+
 // createTemplate navigates to the /templates/new page and uploads a template
 // with the resources provided in the responses argument.
 export const createTemplate = async (
   page: Page,
-  responses?: EchoProvisionerResponses,
+  responses?: EchoProvisionerResponses | StarterTemplates,
 ): Promise<string> => {
   // Required to have templates submit their provisioner type as echo!
   await page.addInitScript({
     content: "window.playwright = true",
   });
 
-  await page.goto("/templates/new", { waitUntil: "domcontentloaded" });
+  let path = "/templates/new";
+  if (isStarterTemplate(responses)) {
+    path += `?exampleId=${responses}`;
+  }
+
+  await page.goto(path, { waitUntil: "domcontentloaded" });
   await expectUrl(page).toHavePathName("/templates/new");
 
-  await page.getByTestId("file-upload").setInputFiles({
-    buffer: await createTemplateVersionTar(responses),
-    mimeType: "application/x-tar",
-    name: "template.tar",
-  });
+  if (!isStarterTemplate(responses)) {
+    await page.getByTestId("file-upload").setInputFiles({
+      buffer: await createTemplateVersionTar(responses),
+      mimeType: "application/x-tar",
+      name: "template.tar",
+    });
+  }
+
   const name = randomName();
   await page.getByLabel("Name *").fill(name);
   await page.getByTestId("form-submit").click();
diff --git a/site/e2e/tests/createWorkspace.spec.ts b/site/e2e/tests/createWorkspace.spec.ts
@@ -1,8 +1,10 @@
 import { test, expect } from "@playwright/test";
 import {
+  StarterTemplates,
   createTemplate,
   createWorkspace,
   echoResponsesWithParameters,
+  requiresTerraform,
   verifyParameters,
 } from "../helpers";
 import { beforeCoderTest } from "../hooks";
@@ -147,3 +149,18 @@ test("create workspace with disable_param search params", async ({ page }) => {
   await expect(page.getByLabel(/First parameter/i)).toBeDisabled();
   await expect(page.getByLabel(/Second parameter/i)).toBeDisabled();
 });
+
+test("docker based workspace", async ({ page }) => {
+  requiresTerraform();
+  const templateName = await createTemplate(
+    page,
+    StarterTemplates.STARTER_DOCKER,
+  );
+
+  await page.goto(`/templates/${templateName}/workspace`, {
+    waitUntil: "domcontentloaded",
+  });
+
+  await expect(page.getByLabel(/First parameter/i)).toBeDisabled();
+  await expect(page.getByLabel(/Second parameter/i)).toBeDisabled();
+});

Original file line number	Diff line number	Diff line change
`@@ -222,5 +222,7 @@`
`222`	`222`	`"go.testFlags": ["-short", "-coverpkg=./..."],`
`223`	`223`	`// We often use a version of TypeScript that's ahead of the version shipped`
`224`	`224`	`// with VS Code.`
`225`		`- "typescript.tsdk": "./site/node_modules/typescript/lib"`
	`225`	`+ "typescript.tsdk": "./site/node_modules/typescript/lib",`
	`226`	`+ // Playwright tests in VSCode will open a browser to live "view" the test.`
	`227`	`+ "playwright.reuseBrowser": true`
`226`	`228`	`}`