@@ -16,9 +16,10 @@ import {
1616agentPProfPort ,
1717coderMain ,
1818coderPort ,
19- enterpriseLicense ,
19+ defaultOrganizationName ,
20+ license ,
21+ premiumTestsRequired ,
2022prometheusPort ,
21- requireEnterpriseTests ,
2223requireTerraformTests ,
2324} from "./constants" ;
2425import { expectUrl } from "./expectUrl" ;
@@ -35,22 +36,28 @@ import {
3536type RichParameter ,
3637} from "./provisionerGenerated" ;
3738
38- // requiresEnterpriseLicense will skip the test if we're not running with an enterprise license
39- export function requiresEnterpriseLicense ( ) {
40- if ( requireEnterpriseTests ) {
39+ /**
40+ * requiresLicense will skip the test if we're not running with a license added
41+ */
42+ export function requiresLicense ( ) {
43+ if ( premiumTestsRequired ) {
4144return ;
4245}
4346
44- test . skip ( ! enterpriseLicense ) ;
47+ test . skip ( ! license ) ;
4548}
4649
47- // requireTerraformProvisioner by default is enabled.
50+ /**
51+ * requireTerraformProvisioner by default is enabled.
52+ */
4853export function requireTerraformProvisioner ( ) {
4954test . skip ( ! requireTerraformTests ) ;
5055}
5156
52- // createWorkspace creates a workspace for a template.
53- // It does not wait for it to be running, but it does navigate to the page.
57+ /**
58+ * createWorkspace creates a workspace for a template. It does not wait for it
59+ * to be running, but it does navigate to the page.
60+ */
5461export const createWorkspace = async (
5562page :Page ,
5663templateName :string ,
@@ -90,7 +97,7 @@ export const createWorkspace = async (
9097
9198await expectUrl ( page ) . toHavePathName ( `/@admin/${ name } ) ;
9299
93- await page . waitForSelector ( "* [data-testid='build-status'] >> text=Running" , {
100+ await page . waitForSelector ( "[data-testid='build-status'] >> text=Running" , {
94101state :"visible" ,
95102} ) ;
96103return name ;
@@ -151,8 +158,10 @@ export const verifyParameters = async (
151158}
152159} ;
153160
154- // StarterTemplates are ids of starter templates that can be used in place of
155- // the responses payload. These starter templates will require real provisioners.
161+ /**
162+ * StarterTemplates are ids of starter templates that can be used in place of
163+ * the responses payload. These starter templates will require real provisioners.
164+ */
156165export enum StarterTemplates {
157166STARTER_DOCKER = "docker" ,
158167}
@@ -166,11 +175,14 @@ function isStarterTemplate(
166175return typeof input === "string" ;
167176}
168177
169- // createTemplate navigates to the /templates/new page and uploads a template
170- // with the resources provided in the responses argument.
178+ /**
179+ * createTemplate navigates to the /templates/new page and uploads a template
180+ * with the resources provided in the responses argument.
181+ */
171182export const createTemplate = async (
172183page :Page ,
173184responses ?:EchoProvisionerResponses | StarterTemplates ,
185+ orgName = defaultOrganizationName ,
174186) :Promise < string > => {
175187let path = "/templates/new" ;
176188if ( isStarterTemplate ( responses ) ) {
@@ -191,31 +203,47 @@ export const createTemplate = async (
191203} ) ;
192204}
193205
206+ // If the organization picker is present on the page, select the default
207+ // organization.
208+ const orgPicker = page . getByLabel ( "Belongs to *" ) ;
209+ const organizationsEnabled = await orgPicker . isVisible ( ) ;
210+ if ( organizationsEnabled ) {
211+ await orgPicker . click ( ) ;
212+ await page . getByText ( orgName , { exact :true } ) . click ( ) ;
213+ }
214+
194215const name = randomName ( ) ;
195216await page . getByLabel ( "Name *" ) . fill ( name ) ;
196217await page . getByTestId ( "form-submit" ) . click ( ) ;
197- await expectUrl ( page ) . toHavePathName ( `/templates/${ name } , {
198- timeout :30000 ,
199- } ) ;
218+ await expectUrl ( page ) . toHavePathName (
219+ organizationsEnabled
220+ ?`/templates/${ orgName } ${ name }
221+ :`/templates/${ name } ,
222+ {
223+ timeout :30000 ,
224+ } ,
225+ ) ;
200226return name ;
201227} ;
202228
203- // createGroup navigates to the /groups/create page and creates a group with a
204- // random name.
229+ /**
230+ * createGroup navigates to the /groups/create page and creates a group with a
231+ * random name.
232+ */
205233export const createGroup = async ( page :Page ) :Promise < string > => {
206234await page . goto ( "/groups/create" , { waitUntil :"domcontentloaded" } ) ;
207235await expectUrl ( page ) . toHavePathName ( "/groups/create" ) ;
208236
209237const name = randomName ( ) ;
210238await page . getByLabel ( "Name" , { exact :true } ) . fill ( name ) ;
211239await page . getByTestId ( "form-submit" ) . click ( ) ;
212- await expect ( page ) . toHaveURL (
213- / \/ g r o u p s \/ [ 0 - 9 a - f ] { 8 } - [ 0 - 9 a - f ] { 4 } - [ 0 - 9 a - f ] { 4 } - [ 0 - 9 a - f ] { 4 } - [ 0 - 9 a - f ] { 12 } $ / ,
214- ) ;
240+ await expectUrl ( page ) . toHavePathName ( `/groups/${ name } ) ;
215241return name ;
216242} ;
217243
218- // sshIntoWorkspace spawns a Coder SSH process and a client connected to it.
244+ /**
245+ * sshIntoWorkspace spawns a Coder SSH process and a client connected to it.
246+ */
219247export const sshIntoWorkspace = async (
220248page :Page ,
221249workspace :string ,
@@ -298,17 +326,21 @@ export const buildWorkspaceWithParameters = async (
298326} ) ;
299327} ;
300328
301- // startAgent runs the coder agent with the provided token.
302- // It awaits the agent to be ready before returning.
329+ /**
330+ * startAgent runs the coder agent with the provided token. It waits for the
331+ * agent to be ready before returning.
332+ */
303333export const startAgent = async (
304334page :Page ,
305335token :string ,
306336) :Promise < ChildProcess > => {
307337return startAgentWithCommand ( page , token , "go" , "run" , coderMain ) ;
308338} ;
309339
310- // downloadCoderVersion downloads the version provided into a temporary dir and
311- // caches it so subsequent calls are fast.
340+ /**
341+ * downloadCoderVersion downloads the version provided into a temporary dir and
342+ * caches it so subsequent calls are fast.
343+ */
312344export const downloadCoderVersion = async (
313345version :string ,
314346) :Promise < string > => {
@@ -448,8 +480,10 @@ interface EchoProvisionerResponses {
448480apply ?:RecursivePartial < Response > [ ] ;
449481}
450482
451- // createTemplateVersionTar consumes a series of echo provisioner protobufs and
452- // converts it into an uploadable tar file.
483+ /**
484+ * createTemplateVersionTar consumes a series of echo provisioner protobufs and
485+ * converts it into an uploadable tar file.
486+ */
453487const createTemplateVersionTar = async (
454488responses ?:EchoProvisionerResponses ,
455489) :Promise < Buffer > => {
@@ -619,8 +653,10 @@ export const randomName = () => {
619653return randomUUID ( ) . slice ( 0 , 8 ) ;
620654} ;
621655
622- // Awaiter is a helper that allows you to wait for a callback to be called.
623- // It is useful for waiting for events to occur.
656+ /**
657+ * Awaiter is a helper that allows you to wait for a callback to be called. It
658+ * is useful for waiting for events to occur.
659+ */
624660export class Awaiter {
625661private promise :Promise < void > ;
626662private callback ?:( ) => void ;
@@ -825,7 +861,6 @@ export const updateTemplateSettings = async (
825861await page . goto ( `/templates/${ templateName } , {
826862waitUntil :"domcontentloaded" ,
827863} ) ;
828- await expectUrl ( page ) . toHavePathName ( `/templates/${ templateName } ) ;
829864
830865for ( const [ key , value ] of Object . entries ( templateSettingValues ) ) {
831866// Skip max_port_share_level for now since the frontend is not yet able to handle it
@@ -839,7 +874,7 @@ export const updateTemplateSettings = async (
839874await page . getByTestId ( "form-submit" ) . click ( ) ;
840875
841876const name = templateSettingValues . name ?? templateName ;
842- await expectUrl ( page ) . toHavePathName ( `/templates /${ name } ) ;
877+ await expectUrl ( page ) . toHavePathNameEndingWith ( ` /${ name } ) ;
843878} ;
844879
845880export const updateWorkspace = async (