Merge branch '20899-wf-delete' refs #20899
[arvados-workbench2.git] / cypress / support / commands.js
index c2d78b54b2e71f3b295bbee47d63a6352193f926..67ddf45d8365bc77b769d4b7a857666d23af00ab 100644 (file)
 // -- This will overwrite an existing command --
 // Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
 
+import { extractFilesData } from "services/collection-service/collection-service-files-response";
+
 const controllerURL = Cypress.env('controller_url');
 const systemToken = Cypress.env('system_token');
 let createdResources = [];
 
-// Clean up on a 'before' hook to allow post-mortem analysis on individual tests.
-beforeEach(function () {
+const containerLogFolderPrefix = 'log for container ';
+
+// Clean up anything that was created.  You can temporarily add
+// 'return' to the top if you need the resources to hang around to
+// debug a specific test.
+afterEach(function () {
     if (createdResources.length === 0) {
         return;
     }
-    cy.log(`Cleaning ${createdResources.length} previously created resource(s)`);
+    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.
@@ -60,6 +66,22 @@ Cypress.Commands.add(
     });
 });
 
+Cypress.Commands.add(
+    "doWebDAVRequest", (method = 'GET', path = '', data = null, qs = null,
+        token = systemToken, auth = false, followRedirect = true, failOnStatusCode = true) => {
+    return cy.doRequest('GET', '/arvados/v1/config', null, null).then(({body: config}) => {
+        return cy.request({
+            method: method,
+            url: `${config.Services.WebDAVDownload.ExternalURL.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) => {
         // Create user if not already created
@@ -73,30 +95,48 @@ 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
+        .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 () {
-                this.userToken = this.location.split("=")[1]
-                assert.isString(this.userToken)
-                return cy.doRequest('GET', '/arvados/v1/users', null, {
-                    filters: `[["username", "=", "${username}"]]`
+                cy.doRequest('PUT', `/arvados/v1/users/${this.aUser.uuid}`, {
+                    user: {
+                        is_admin: is_admin,
+                        is_active: is_active
+                    }
                 })
-                    .its('body.items.0')
-                    .as('aUser')
+                .its('body').as('theUser')
+                .then(function () {
+                    cy.doRequest('GET', '/arvados/v1/api_clients', null, {
+                        filters: `[["is_trusted", "=", false]]`,
+                        order: `["created_at desc"]`
+                    })
+                    .its('body.items').as('apiClients')
                     .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 };
+                        if (this.apiClients.length > 0) {
+                            cy.doRequest('PUT', `/arvados/v1/api_clients/${this.apiClients[0].uuid}`, {
+                                api_client: {
+                                    is_trusted: true
+                                }
+                            })
+                            .its('body').as('updatedApiClient')
+                            .then(function() {
+                                assert(this.updatedApiClient.is_trusted);
                             })
+                        }
                     })
+                    .then(function () {
+                        return { user: this.theUser, token: this.userToken };
+                    })
+                })
             })
+        })
     }
 )
 
@@ -133,12 +173,6 @@ Cypress.Commands.add(
     }
 )
 
-Cypress.Commands.add(
-    "getCollection", (token, uuid) => {
-        return cy.getResource(token, 'collections', uuid)
-    }
-)
-
 Cypress.Commands.add(
     "createCollection", (token, data) => {
         return cy.createResource(token, 'collections', {
@@ -148,6 +182,12 @@ Cypress.Commands.add(
     }
 )
 
+Cypress.Commands.add(
+    "getCollection", (token, uuid) => {
+        return cy.getResource(token, 'collections', uuid)
+    }
+)
+
 Cypress.Commands.add(
     "updateCollection", (token, uuid, data) => {
         return cy.updateResource(token, 'collections', uuid, {
@@ -156,6 +196,17 @@ Cypress.Commands.add(
     }
 )
 
+Cypress.Commands.add(
+    "collectionReplaceFiles", (token, uuid, data) => {
+        return cy.updateResource(token, 'collections', uuid, {
+            collection: {
+                preserve_version: true,
+            },
+            replace_files: JSON.stringify(data)
+        })
+    }
+)
+
 Cypress.Commands.add(
     "getContainer", (token, uuid) => {
         return cy.getResource(token, 'containers', uuid)
@@ -170,6 +221,12 @@ Cypress.Commands.add(
     }
 )
 
+Cypress.Commands.add(
+    "getContainerRequest", (token, uuid) => {
+        return cy.getResource(token, 'container_requests', uuid)
+    }
+)
+
 Cypress.Commands.add(
     'createContainerRequest', (token, data) => {
         return cy.createResource(token, 'container_requests', {
@@ -187,31 +244,83 @@ Cypress.Commands.add(
     }
 )
 
+/**
+ * Requires an admin token for log_uuid modification to succeed
+ */
 Cypress.Commands.add(
-    "createLog", (token, data) => {
-        return cy.createResource(token, 'logs', {
-            log: JSON.stringify(data)
+    "appendLog", (token, crUuid, fileName, lines = []) => (
+        cy.getContainerRequest(token, crUuid).then((containerRequest) => {
+            if (containerRequest.log_uuid) {
+                cy.listContainerRequestLogs(token, crUuid).then((logFiles) => {
+                    const filePath = `${containerRequest.log_uuid}/${containerLogFolderPrefix}${containerRequest.container_uuid}/${fileName}`;
+                    if (logFiles.find((file) => (file.name === fileName))) {
+                        // File exists, fetch and append
+                        return cy.doWebDAVRequest(
+                                "GET",
+                                `c=${filePath}`,
+                                null,
+                                null,
+                                token
+                            )
+                            .then(({ body: contents }) => cy.doWebDAVRequest(
+                                "PUT",
+                                `c=${filePath}`,
+                                contents.split("\n").concat(lines).join("\n"),
+                                null,
+                                token
+                            ));
+                    } else {
+                        // File not exists, put new file
+                        cy.doWebDAVRequest(
+                            "PUT",
+                            `c=${filePath}`,
+                            lines.join("\n"),
+                            null,
+                            token
+                        )
+                    }
+                });
+            } else {
+                // Create log collection
+                return cy.createCollection(token, {
+                    name: `Test log collection ${Math.floor(Math.random() * 999999)}`,
+                    owner_uuid: containerRequest.owner_uuid,
+                    manifest_text: ""
+                }).then((collection) => {
+                    // Update CR log_uuid to fake log collection
+                    cy.updateContainerRequest(token, containerRequest.uuid, {
+                        log_uuid: collection.uuid,
+                    }).then(() => (
+                        // Create empty directory for container uuid
+                        cy.collectionReplaceFiles(token, collection.uuid, {
+                            [`/${containerLogFolderPrefix}${containerRequest.container_uuid}`]: "d41d8cd98f00b204e9800998ecf8427e+0"
+                        }).then(() => (
+                            // Put new log file with contents into fake log collection
+                            cy.doWebDAVRequest(
+                                'PUT',
+                                `c=${collection.uuid}/${containerLogFolderPrefix}${containerRequest.container_uuid}/${fileName}`,
+                                lines.join('\n'),
+                                null,
+                                token
+                            )
+                        ))
+                    ));
+                });
+            }
         })
-    }
+    )
 )
 
 Cypress.Commands.add(
-    "logsForContainer", (token, uuid, logType, logTextArray = []) => {
-        let logs = [];
-        for (const logText of logTextArray) {
-            logs.push(cy.createLog(token, {
-                object_uuid: uuid,
-                event_type: logType,
-                properties: {
-                    text: logText
-                }
-            }).as('lastLogRecord'))
-        }
-        cy.getAll('@lastLogRecord').then(function () {
-            return logs;
-        })
-    }
-)
+    "listContainerRequestLogs", (token, crUuid) => (
+        cy.getContainerRequest(token, crUuid).then((containerRequest) => (
+            cy.doWebDAVRequest('PROPFIND', `c=${containerRequest.log_uuid}/${containerLogFolderPrefix}${containerRequest.container_uuid}`, null, null, token)
+                .then(({body: data}) => {
+                    return extractFilesData(new DOMParser().parseFromString(data, "text/xml"));
+                })
+        ))
+    )
+);
 
 Cypress.Commands.add(
     "createVirtualMachine", (token, data) => {
@@ -369,9 +478,11 @@ Cypress.Commands.add(
     {
         prevSubject: 'element',
     },
-    (subject, file, fileName) => {
+    (subject, file, fileName, binaryMode = true) => {
         cy.window().then(window => {
-            const blob = b64toBlob(file, '', 512);
+            const blob = binaryMode
+                ? b64toBlob(file, '', 512)
+                : new Blob([file], {type: 'text/plain'});
             const testFile = new window.File([blob], fileName);
 
             cy.wrap(subject).trigger('drop', {
@@ -405,7 +516,10 @@ function b64toBlob(b64Data, contentType = '', sliceSize = 512) {
 // From https://github.com/cypress-io/cypress/issues/7306#issuecomment-1076451070=
 // This command requires the async package (https://www.npmjs.com/package/async)
 Cypress.Commands.add('waitForDom', () => {
-    cy.window().then(win => {
+    cy.window().then({
+        // Don't timeout before waitForDom finishes
+        timeout: 10000
+    }, win => {
       let timeElapsed = 0;
 
       cy.log("Waiting for DOM mutations to complete");