17500: Cleans up previously created objects before running each test.
[arvados-workbench2.git] / cypress / support / commands.js
index 228e1cabb14e3b68fe43705add938c03cc45bb0d..36358991f0d1241d8acf211a44ee6d8c95ec626a 100644 (file)
 
 const controllerURL = Cypress.env('controller_url');
 const systemToken = Cypress.env('system_token');
+let createdResources = [];
 
-Cypress.Commands.add(
-    "doRequest", (method='GET', path='', data=null, qs=null,
-                   token=systemToken, auth=false, followRedirect=true) => {
-        return cy.request({
-            method: method,
-            url: `${controllerURL}/${path}`,
-            body: data,
-            qs: auth ? qs : Object.assign({api_token: token}, qs),
-            auth: auth ? {bearer: `${token}`} : undefined,
-            followRedirect: followRedirect
-        })
+// Clean up on a 'before' hook to allow post-mortem analysis on individual tests.
+beforeEach(function () {
+    if (createdResources.length === 0) {
+        return;
     }
-)
+    cy.log(`Cleaning ${createdResources.length} previously created resource(s)`);
+    createdResources.forEach(function({suffix, uuid}) {
+        // Don't fail when a resource isn't already there, some objects may have
+        // been removed, directly or indirectly, from the test that created them.
+        cy.deleteResource(systemToken, suffix, uuid, false);
+    });
+    createdResources = [];
+});
 
-// This resets the DB removing all content and seeding it with the fixtures.
-// TODO: Maybe we can add an optional param to avoid the loading part?
 Cypress.Commands.add(
-    "resetDB", () => {
-        cy.request('POST', `${controllerURL}/database/reset?api_token=${systemToken}`);
-    }
-)
+    "doRequest", (method = 'GET', path = '', data = null, qs = null,
+        token = systemToken, auth = false, followRedirect = true, failOnStatusCode = true) => {
+    return cy.request({
+        method: method,
+        url: `${controllerURL.replace(/\/+$/, '')}/${path.replace(/^\/+/, '')}`,
+        body: data,
+        qs: auth ? qs : Object.assign({ api_token: token }, qs),
+        auth: auth ? { bearer: `${token}` } : undefined,
+        followRedirect: followRedirect,
+        failOnStatusCode: failOnStatusCode
+    });
+});
 
 Cypress.Commands.add(
-    "getUser", (username, first_name='', last_name='', is_admin=false, is_active=true) => {
+    "getUser", (username, first_name = '', last_name = '', is_admin = false, is_active = true) => {
         // Create user if not already created
         return cy.doRequest('POST', '/auth/controller/callback', {
             auth_info: JSON.stringify({
@@ -66,30 +73,30 @@ Cypress.Commands.add(
             }),
             return_to: ',https://example.local'
         }, null, systemToken, true, false) // Don't follow redirects so we can catch the token
-        .its('headers.location').as('location')
-        // Get its token and set the account up as admin and/or active
-        .then(function() {
-            this.userToken = this.location.split("=")[1]
-            assert.isString(this.userToken)
-            return cy.doRequest('GET', '/arvados/v1/users', null, {
-                filters: `[["username", "=", "${username}"]]`
-            })
-            .its('body.items.0')
-            .as('aUser')
-            .then(function() {
-                cy.doRequest('PUT', `/arvados/v1/users/${this.aUser.uuid}`, {
-                    user: {
-                        is_admin: is_admin,
-                        is_active: is_active
-                    }
-                })
-                .its('body')
-                .as('theUser')
-                .then(function() {
-                    return {user: this.theUser, token: this.userToken};
+            .its('headers.location').as('location')
+            // Get its token and set the account up as admin and/or active
+            .then(function () {
+                this.userToken = this.location.split("=")[1]
+                assert.isString(this.userToken)
+                return cy.doRequest('GET', '/arvados/v1/users', null, {
+                    filters: `[["username", "=", "${username}"]]`
                 })
+                    .its('body.items.0')
+                    .as('aUser')
+                    .then(function () {
+                        cy.doRequest('PUT', `/arvados/v1/users/${this.aUser.uuid}`, {
+                            user: {
+                                is_admin: is_admin,
+                                is_active: is_active
+                            }
+                        })
+                            .its('body')
+                            .as('theUser')
+                            .then(function () {
+                                return { user: this.theUser, token: this.userToken };
+                            })
+                    })
             })
-        })
     }
 )
 
@@ -116,6 +123,16 @@ Cypress.Commands.add(
     }
 )
 
+
+Cypress.Commands.add(
+    "createWorkflow", (token, data) => {
+        return cy.createResource(token, 'workflows', {
+            workflow: JSON.stringify(data),
+            ensure_unique_name: true
+        })
+    }
+)
+
 Cypress.Commands.add(
     "createCollection", (token, data) => {
         return cy.createResource(token, 'collections', {
@@ -135,39 +152,104 @@ Cypress.Commands.add(
 
 Cypress.Commands.add(
     "createResource", (token, suffix, data) => {
-        return cy.doRequest('POST', '/arvados/v1/'+suffix, data, null, token, true)
-        .its('body').as('resource')
-        .then(function() {
-            return this.resource;
-        })
+        return cy.doRequest('POST', '/arvados/v1/' + suffix, data, null, token, true)
+            .its('body').as('resource')
+            .then(function () {
+                createdResources.push({suffix, uuid: this.resource.uuid});
+                return this.resource;
+            })
     }
 )
 
 Cypress.Commands.add(
-    "deleteResource", (token, suffix, uuid) => {
-        return cy.doRequest('DELETE', '/arvados/v1/'+suffix+'/'+uuid)
-        .its('body').as('resource')
-        .then(function() {
-            return this.resource;
-        })
+    "deleteResource", (token, suffix, uuid, failOnStatusCode = true) => {
+        return cy.doRequest('DELETE', '/arvados/v1/' + suffix + '/' + uuid, null, null, token, false, true, failOnStatusCode)
+            .its('body').as('resource')
+            .then(function () {
+                return this.resource;
+            })
     }
 )
 
 Cypress.Commands.add(
     "updateResource", (token, suffix, uuid, data) => {
-        return cy.doRequest('PUT', '/arvados/v1/'+suffix+'/'+uuid, data, null, token, true)
-        .its('body').as('resource')
-        .then(function() {
-            return this.resource;
-        })
+        return cy.doRequest('PUT', '/arvados/v1/' + suffix + '/' + uuid, data, null, token, true)
+            .its('body').as('resource')
+            .then(function () {
+                return this.resource;
+            })
     }
 )
 
 Cypress.Commands.add(
     "loginAs", (user) => {
         cy.visit(`/token/?api_token=${user.token}`);
-        cy.url().should('contain', '/projects/');
+        cy.url({timeout: 10000}).should('contain', '/projects/');
         cy.get('div#root').should('contain', 'Arvados Workbench (zzzzz)');
         cy.get('div#root').should('not.contain', 'Your account is inactive');
     }
 )
+
+Cypress.Commands.add(
+    "doSearch", (searchTerm) => {
+        cy.get('[data-cy=searchbar-input-field]').type(`{selectall}${searchTerm}{enter}`);
+    }
+)
+
+Cypress.Commands.add(
+    "goToPath", (path) => {
+        return cy.window().its('appHistory').invoke('push', path);
+    }
+)
+
+Cypress.Commands.add('getAll', (...elements) => {
+    const promise = cy.wrap([], { log: false })
+
+    for (let element of elements) {
+        promise.then(arr => cy.get(element).then(got => cy.wrap([...arr, got])))
+    }
+
+    return promise
+})
+
+Cypress.Commands.add('shareWith', (srcUserToken, targetUserUUID, itemUUID, permission = 'can_write') => {
+    cy.createLink(srcUserToken, {
+        name: permission,
+        link_class: 'permission',
+        head_uuid: itemUUID,
+        tail_uuid: targetUserUUID
+    });
+})
+
+Cypress.Commands.add('addToFavorites', (userToken, userUUID, itemUUID) => {
+    cy.createLink(userToken, {
+        head_uuid: itemUUID,
+        link_class: 'star',
+        name: '',
+        owner_uuid: userUUID,
+        tail_uuid: userUUID,
+    });
+})
+
+Cypress.Commands.add('createProject', ({
+    owningUser,
+    targetUser,
+    projectName,
+    canWrite,
+    addToFavorites
+}) => {
+    const writePermission = canWrite ? 'can_write' : 'can_read';
+
+    cy.createGroup(owningUser.token, {
+        name: `${projectName} ${Math.floor(Math.random() * 999999)}`,
+        group_class: 'project',
+    }).as(`${projectName}`).then((project) => {
+        if (targetUser && targetUser !== owningUser) {
+            cy.shareWith(owningUser.token, targetUser.user.uuid, project.uuid, writePermission);
+        }
+        if (addToFavorites) {
+            const user = targetUser ? targetUser : owningUser;
+            cy.addToFavorites(user.token, user.user.uuid, project.uuid);
+        }
+    });
+});
\ No newline at end of file