I'm so lost

aslilac · aslilac · commit 05099a4314f4 · 2024-10-14T20:20:47.000Z
diff --git a/site/e2e/constants.ts b/site/e2e/constants.ts
@@ -34,7 +34,7 @@ export const gitAuth = {
 	installationsPath: "/installations",
 };
 
-export const requirePremiumTests = Boolean(
+export const premiumTestsRequired = Boolean(
 	process.env.CODER_E2E_REQUIRE_PREMIUM_TESTS,
 );
 export const license = process.env.CODER_E2E_LICENSE ?? "";
diff --git a/site/e2e/global.setup.ts b/site/e2e/global.setup.ts
@@ -28,7 +28,7 @@ test("setup deployment", async ({ page }) => {
 	await page.getByTestId("button-select-template").isVisible();
 
 	// Setup license
-	if (constants.requirePremiumTests || constants.license) {
+	if (constants.premiumTestsRequired || constants.license) {
 		// Make sure that we have something that looks like a real license
 		expect(constants.license).toBeTruthy();
 		expect(constants.license.length).toBeGreaterThan(92); // the signature alone should be this long
diff --git a/site/e2e/helpers.ts b/site/e2e/helpers.ts
@@ -18,7 +18,7 @@ import {
 	coderPort,
 	license,
 	prometheusPort,
-	requirePremiumTests,
+	premiumTestsRequired,
 	requireTerraformTests,
 } from "./constants";
 import { expectUrl } from "./expectUrl";
@@ -35,22 +35,37 @@ import {
 	type RichParameter,
 } from "./provisionerGenerated";
 
-// requiresLicense will skip the test if we're not running with a license added
+/**
+ * requiresLicense will skip the test if we're not running with a license added
+ */
 export function requiresLicense() {
-	if (requirePremiumTests) {
+	if (premiumTestsRequired) {
 		return;
 	}
 
 	test.skip(!license);
 }
 
-// requireTerraformProvisioner by default is enabled.
+/**
+ * This function is used to mark a few e2e tests that seem to always fail when
+ * running with a license. If we can ever get all of them fixed we should remove
+ * this.
+ */
+export function failsWithLicense() {
+	test.skip(Boolean(license));
+}
+
+/**
+ * requireTerraformProvisioner by default is enabled.
+ */
 export function requireTerraformProvisioner() {
 	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.
+/**
+ * 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 (
 	page: Page,
 	templateName: string,
@@ -90,7 +105,7 @@ export const createWorkspace = async (
 
 	await expectUrl(page).toHavePathName(`/@admin/${name}`);
 
-	await page.waitForSelector("*[data-testid='build-status'] >> text=Running", {
+	await page.waitForSelector("[data-testid='build-status'] >> text=Running", {
 		state: "visible",
 	});
 	return name;
@@ -151,8 +166,10 @@ 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.
+/**
+ * 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",
 }
@@ -166,8 +183,10 @@ function isStarterTemplate(
 	return typeof input === "string";
 }
 
-// createTemplate navigates to the /templates/new page and uploads a template
-// with the resources provided in the responses argument.
+/**
+ * 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 | StarterTemplates,
@@ -200,8 +219,10 @@ export const createTemplate = async (
 	return name;
 };
 
-// createGroup navigates to the /groups/create page and creates a group with a
-// random name.
+/**
+ * createGroup navigates to the /groups/create page and creates a group with a
+ * random name.
+ */
 export const createGroup = async (page: Page): Promise<string> => {
 	await page.goto("/groups/create", { waitUntil: "domcontentloaded" });
 	await expectUrl(page).toHavePathName("/groups/create");
@@ -215,7 +236,9 @@ export const createGroup = async (page: Page): Promise<string> => {
 	return name;
 };
 
-// sshIntoWorkspace spawns a Coder SSH process and a client connected to it.
+/**
+ * sshIntoWorkspace spawns a Coder SSH process and a client connected to it.
+ */
 export const sshIntoWorkspace = async (
 	page: Page,
 	workspace: string,
@@ -298,17 +321,21 @@ export const buildWorkspaceWithParameters = async (
 	});
 };
 
-// startAgent runs the coder agent with the provided token.
-// It awaits the agent to be ready before returning.
+/**
+ * startAgent runs the coder agent with the provided token. It waits for the
+ * agent to be ready before returning.
+ */
 export const startAgent = async (
 	page: Page,
 	token: string,
 ): Promise<ChildProcess> => {
 	return startAgentWithCommand(page, token, "go", "run", coderMain);
 };
 
-// downloadCoderVersion downloads the version provided into a temporary dir and
-// caches it so subsequent calls are fast.
+/**
+ * downloadCoderVersion downloads the version provided into a temporary dir and
+ * caches it so subsequent calls are fast.
+ */
 export const downloadCoderVersion = async (
 	version: string,
 ): Promise<string> => {
@@ -448,8 +475,10 @@ interface EchoProvisionerResponses {
 	apply?: RecursivePartial<Response>[];
 }
 
-// createTemplateVersionTar consumes a series of echo provisioner protobufs and
-// converts it into an uploadable tar file.
+/**
+ * createTemplateVersionTar consumes a series of echo provisioner protobufs and
+ * converts it into an uploadable tar file.
+ */
 const createTemplateVersionTar = async (
 	responses?: EchoProvisionerResponses,
 ): Promise<Buffer> => {
@@ -619,8 +648,10 @@ export const randomName = () => {
 	return randomUUID().slice(0, 8);
 };
 
-// Awaiter is a helper that allows you to wait for a callback to be called.
-// It is useful for waiting for events to occur.
+/**
+ * Awaiter is a helper that allows you to wait for a callback to be called. It
+ * is useful for waiting for events to occur.
+ */
 export class Awaiter {
 	private promise: Promise<void>;
 	private callback?: () => void;
diff --git a/site/e2e/reporter.ts b/site/e2e/reporter.ts
@@ -110,7 +110,7 @@ class CoderReporter implements Reporter {
 		console.info(`==> Tests ${result.status}`);
 		if (!license) {
 			console.info(
-				"==> Premium tests were skipped, because no license was provided",
+				"==> Tests that require a license were skipped, because no license was provided",
 			);
 		}
 		console.info(`${this.passedCount} passed`);

Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ class CoderReporter implements Reporter {`
`110`	`110`	console.info(`==> Tests ${result.status}`);
`111`	`111`	`if (!license) {`
`112`	`112`	`console.info(`
`113`		`- "==> Premium tests were skipped, because no license was provided",`
	`113`	`+ "==> Tests that require a license were skipped, because no license was provided",`
`114`	`114`	`);`
`115`	`115`	`}`
`116`	`116`	console.info(`${this.passedCount} passed`);