1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 const path = require('path');
7 describe('Collection panel tests', function () {
13 // Only set up common users once. These aren't set up as aliases because
14 // aliases are cleaned up after every test. Also it doesn't make sense
15 // to set the same users on beforeEach() over and over again, so we
16 // separate a little from Cypress' 'Best Practices' here.
17 cy.getUser('admin', 'Admin', 'User', true, true)
18 .as('adminUser').then(function () {
19 adminUser = this.adminUser;
22 cy.getUser('collectionuser1', 'Collection', 'User', false, true)
23 .as('activeUser').then(function () {
24 activeUser = this.activeUser;
27 downloadsFolder = Cypress.config('downloadsFolder');
30 beforeEach(function () {
32 cy.clearLocalStorage();
35 it('allows to download mountain duck config for a collection', () => {
36 cy.createCollection(adminUser.token, {
37 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
38 owner_uuid: activeUser.user.uuid,
39 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
41 .as('testCollection').then(function (testCollection) {
42 cy.loginAs(activeUser);
43 cy.goToPath(`/collections/${testCollection.uuid}`);
45 cy.get('[data-cy=collection-panel-options-btn]').click();
46 cy.get('[data-cy=context-menu]').contains('Open as network folder or S3 bucket').click();
47 cy.get('[data-cy=download-button').click();
49 const filename = path.join(downloadsFolder, `${testCollection.name}.duck`);
51 cy.readFile(filename, { timeout: 15000 })
53 const childrenCollection = Array.prototype.slice.call(Cypress.$(body).find('dict')[0].children);
57 for (i=0; i < childrenCollection.length; i += j) {
58 map[childrenCollection[i].outerText] = childrenCollection[i + 1].outerText;
61 cy.get('#simple-tabpanel-0').find('a')
63 const [host, port] = a.text().split('@')[1].split('/')[0].split(':');
64 expect(map['Protocol']).to.equal('davs');
65 expect(map['UUID']).to.equal(testCollection.uuid);
66 expect(map['Username']).to.equal(activeUser.user.username);
67 expect(map['Port']).to.equal(port);
68 expect(map['Hostname']).to.equal(host);
70 expect(map['Path']).to.equal(`/c=${testCollection.uuid}`);
74 .then(() => cy.task('clearDownload', { filename }));
78 it('uses the property editor with vocabulary terms', function () {
79 cy.createCollection(adminUser.token, {
80 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
81 owner_uuid: activeUser.user.uuid,
82 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
84 .as('testCollection').then(function () {
85 cy.loginAs(activeUser);
86 cy.goToPath(`/collections/${this.testCollection.uuid}`);
88 // Key: Color (IDTAGCOLORS) - Value: Magenta (IDVALCOLORS3)
89 cy.get('[data-cy=resource-properties-form]').within(() => {
90 cy.get('[data-cy=property-field-key]').within(() => {
91 cy.get('input').type('Color');
93 cy.get('[data-cy=property-field-value]').within(() => {
94 cy.get('input').type('Magenta');
98 // Confirm proper vocabulary labels are displayed on the UI.
99 cy.get('[data-cy=collection-properties-panel]')
100 .should('contain', 'Color')
101 .and('contain', 'Magenta');
102 // Confirm proper vocabulary IDs were saved on the backend.
103 cy.doRequest('GET', `/arvados/v1/collections/${this.testCollection.uuid}`)
104 .its('body').as('collection')
106 expect(this.collection.properties.IDTAGCOLORS).to.equal('IDVALCOLORS3');
111 it('shows collection by URL', function () {
112 cy.loginAs(activeUser);
113 [true, false].map(function (isWritable) {
114 // Using different file names to avoid test flakyness: the second iteration
115 // on this loop may pass an assertion from the first iteration by looking
116 // for the same file name.
117 const fileName = isWritable ? 'bar' : 'foo';
118 const subDirName = 'subdir';
119 cy.createGroup(adminUser.token, {
120 name: 'Shared project',
121 group_class: 'project',
122 }).as('sharedGroup').then(function () {
123 // Creates the collection using the admin token so we can set up
124 // a bogus manifest text without block signatures.
125 cy.createCollection(adminUser.token, {
126 name: 'Test collection',
127 owner_uuid: this.sharedGroup.uuid,
128 properties: { someKey: 'someValue' },
129 manifest_text: `. 37b51d194a7513e45b56f6524f2d51f2+3 0:3:${fileName}\n./${subDirName} 37b51d194a7513e45b56f6524f2d51f2+3 0:3:${fileName}\n`
131 .as('testCollection').then(function () {
132 // Share the group with active user.
133 cy.createLink(adminUser.token, {
134 name: isWritable ? 'can_write' : 'can_read',
135 link_class: 'permission',
136 head_uuid: this.sharedGroup.uuid,
137 tail_uuid: activeUser.user.uuid
139 cy.goToPath(`/collections/${this.testCollection.uuid}`);
141 // Check that name & uuid are correct.
142 cy.get('[data-cy=collection-info-panel]')
143 .should('contain', this.testCollection.name)
144 .and('contain', this.testCollection.uuid)
145 .and('not.contain', 'This is an old version');
146 // Check for the read-only icon
147 cy.get('[data-cy=read-only-icon]').should(`${isWritable ? 'not.' : ''}exist`);
148 // Check that both read and write operations are available on
149 // the 'More options' menu.
150 cy.get('[data-cy=collection-panel-options-btn]')
152 cy.get('[data-cy=context-menu]')
153 .should('contain', 'Add to favorites')
154 .and(`${isWritable ? '' : 'not.'}contain`, 'Edit collection');
155 cy.get('body').click(); // Collapse the menu avoiding details panel expansion
156 cy.get('[data-cy=collection-properties-panel]')
157 .should('contain', 'someKey')
158 .and('contain', 'someValue')
159 .and('not.contain', 'anotherKey')
160 .and('not.contain', 'anotherValue')
161 if (isWritable === true) {
162 // Check that properties can be added.
163 cy.get('[data-cy=resource-properties-form]').within(() => {
164 cy.get('[data-cy=property-field-key]').within(() => {
165 cy.get('input').type('anotherKey');
167 cy.get('[data-cy=property-field-value]').within(() => {
168 cy.get('input').type('anotherValue');
172 cy.get('[data-cy=collection-properties-panel]')
173 .should('contain', 'anotherKey')
174 .and('contain', 'anotherValue')
176 // Properties form shouldn't be displayed.
177 cy.get('[data-cy=resource-properties-form]').should('not.exist');
179 // Check that the file listing show both read & write operations
180 cy.get('[data-cy=collection-files-panel]').within(() => {
181 cy.root().should('contain', fileName);
183 cy.get('[data-cy=upload-button]')
184 .should(`${isWritable ? '' : 'not.'}contain`, 'Upload data');
187 // Test context menus
188 cy.get('[data-cy=collection-files-panel]')
189 .contains(fileName).rightclick({ force: true });
190 cy.get('[data-cy=context-menu]')
191 .should('contain', 'Download')
192 .and('contain', 'Open in new tab')
193 .and('contain', 'Copy to clipboard')
194 .and(`${isWritable ? '' : 'not.'}contain`, 'Rename')
195 .and(`${isWritable ? '' : 'not.'}contain`, 'Remove');
196 cy.get('body').click(); // Collapse the menu
197 cy.get('[data-cy=collection-files-panel]')
198 .contains(subDirName).rightclick({ force: true });
199 cy.get('[data-cy=context-menu]')
200 .should('not.contain', 'Download')
201 .and('contain', 'Open in new tab')
202 .and('contain', 'Copy to clipboard')
203 .and(`${isWritable ? '' : 'not.'}contain`, 'Rename')
204 .and(`${isWritable ? '' : 'not.'}contain`, 'Remove');
205 cy.get('body').click(); // Collapse the menu
206 // Hamburger 'more options' menu button
207 cy.get('[data-cy=collection-files-panel-options-btn]')
209 cy.get('[data-cy=context-menu]')
210 .should('contain', 'Select all')
212 cy.get('[data-cy=collection-files-panel-options-btn]')
214 cy.get('[data-cy=context-menu]')
215 .should(`${isWritable ? '' : 'not.'}contain`, 'Remove selected')
216 cy.get('body').click(); // Collapse the menu
222 it('renames a file using valid names', function () {
223 function eachPair(lst, func){
224 for(var i=0; i < lst.length - 1; i++){
225 func(lst[i], lst[i + 1])
228 // Creates the collection using the admin token so we can set up
229 // a bogus manifest text without block signatures.
230 cy.createCollection(adminUser.token, {
231 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
232 owner_uuid: activeUser.user.uuid,
233 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
235 .as('testCollection').then(function () {
236 cy.loginAs(activeUser);
237 cy.goToPath(`/collections/${this.testCollection.uuid}`);
240 'bar', // initial name already set
247 'some name with whitespaces',
249 'is this name legal? I hope it is',
257 "G%C3%BCnter's%20file.pdf",
259 'bar' // make sure we can go back to the original name as a last step
261 eachPair(names, (from, to) => {
262 cy.get('[data-cy=collection-files-panel]')
263 .contains(`${from}`).rightclick();
264 cy.get('[data-cy=context-menu]')
267 cy.get('[data-cy=form-dialog]')
268 .should('contain', 'Rename')
271 .type('{selectall}{backspace}')
272 .type(to, { parseSpecialCharSequences: false });
274 cy.get('[data-cy=form-submit-btn]').click();
275 cy.get('[data-cy=collection-files-panel]')
276 .should('not.contain', `${from}`)
277 .and('contain', `${to}`);
282 it('renames a file to a different directory', function () {
283 // Creates the collection using the admin token so we can set up
284 // a bogus manifest text without block signatures.
285 cy.createCollection(adminUser.token, {
286 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
287 owner_uuid: activeUser.user.uuid,
288 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
290 .as('testCollection').then(function () {
291 cy.loginAs(activeUser);
292 cy.goToPath(`/collections/${this.testCollection.uuid}`);
294 ['subdir', 'G%C3%BCnter\'s%20file', 'table%&?*2'].forEach((subdir) => {
295 cy.get('[data-cy=collection-files-panel]')
296 .contains('bar').rightclick({force: true});
297 cy.get('[data-cy=context-menu]')
300 cy.get('[data-cy=form-dialog]')
301 .should('contain', 'Rename')
303 cy.get('input').type(`{selectall}{backspace}${subdir}/foo`);
305 cy.get('[data-cy=form-submit-btn]').click();
306 cy.get('[data-cy=collection-files-panel]')
307 .should('not.contain', 'bar')
308 .and('contain', subdir);
309 // Look for the "arrow icon" and expand the "subdir" directory.
310 cy.get('[data-cy=virtual-file-tree] > div > i').click();
311 // Rename 'subdir/foo' to 'foo'
312 cy.get('[data-cy=collection-files-panel]')
313 .contains('foo').rightclick();
314 cy.get('[data-cy=context-menu]')
317 cy.get('[data-cy=form-dialog]')
318 .should('contain', 'Rename')
321 .should('have.value', `${subdir}/foo`)
322 .type(`{selectall}{backspace}bar`);
324 cy.get('[data-cy=form-submit-btn]').click();
325 cy.get('[data-cy=collection-files-panel]')
326 .should('contain', subdir) // empty dir kept
327 .and('contain', 'bar');
329 cy.get('[data-cy=collection-files-panel]')
330 .contains(subdir).rightclick();
331 cy.get('[data-cy=context-menu]')
334 cy.get('[data-cy=confirmation-dialog-ok-btn]').click();
339 it('tries to rename a file with illegal names', function () {
340 // Creates the collection using the admin token so we can set up
341 // a bogus manifest text without block signatures.
342 cy.createCollection(adminUser.token, {
343 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
344 owner_uuid: activeUser.user.uuid,
345 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
347 .as('testCollection').then(function () {
348 cy.loginAs(activeUser);
349 cy.goToPath(`/collections/${this.testCollection.uuid}`);
351 const illegalNamesFromUI = [
352 ['.', "Name cannot be '.' or '..'"],
353 ['..', "Name cannot be '.' or '..'"],
354 ['', 'This field is required'],
355 [' ', 'Leading/trailing whitespaces not allowed'],
356 [' foo', 'Leading/trailing whitespaces not allowed'],
357 ['foo ', 'Leading/trailing whitespaces not allowed'],
358 ['//foo', 'Empty dir name not allowed']
360 illegalNamesFromUI.forEach(([name, errMsg]) => {
361 cy.get('[data-cy=collection-files-panel]')
362 .contains('bar').rightclick();
363 cy.get('[data-cy=context-menu]')
366 cy.get('[data-cy=form-dialog]')
367 .should('contain', 'Rename')
369 cy.get('input').type(`{selectall}{backspace}${name}`);
371 cy.get('[data-cy=form-dialog]')
372 .should('contain', 'Rename')
374 cy.contains(`${errMsg}`);
376 cy.get('[data-cy=form-cancel-btn]').click();
381 it('can correctly display old versions', function () {
382 const colName = `Versioned Collection ${Math.floor(Math.random() * 999999)}`;
384 let oldVersionUuid = '';
385 // Make sure no other collections with this name exist
386 cy.doRequest('GET', '/arvados/v1/collections', null, {
387 filters: `[["name", "=", "${colName}"]]`,
388 include_old_versions: true
390 .its('body.items').as('collections')
392 expect(this.collections).to.be.empty;
394 // Creates the collection using the admin token so we can set up
395 // a bogus manifest text without block signatures.
396 cy.createCollection(adminUser.token, {
398 owner_uuid: activeUser.user.uuid,
399 preserve_version: true,
400 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
402 .as('originalVersion').then(function () {
403 // Change the file name to create a new version.
404 cy.updateCollection(adminUser.token, this.originalVersion.uuid, {
405 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:foo\n"
407 colUuid = this.originalVersion.uuid;
409 // Confirm that there are 2 versions of the collection
410 cy.doRequest('GET', '/arvados/v1/collections', null, {
411 filters: `[["name", "=", "${colName}"]]`,
412 include_old_versions: true
414 .its('body.items').as('collections')
416 expect(this.collections).to.have.lengthOf(2);
417 this.collections.map(function (aCollection) {
418 expect(aCollection.current_version_uuid).to.equal(colUuid);
419 if (aCollection.uuid !== aCollection.current_version_uuid) {
420 oldVersionUuid = aCollection.uuid;
423 // Check the old version displays as what it is.
424 cy.loginAs(activeUser)
425 cy.goToPath(`/collections/${oldVersionUuid}`);
427 cy.get('[data-cy=collection-info-panel]').should('contain', 'This is an old version');
428 cy.get('[data-cy=read-only-icon]').should('exist');
429 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
430 cy.get('[data-cy=collection-files-panel]').should('contain', 'bar');
434 it('uses the collection version browser to view a previous version', function () {
435 const colName = `Test Collection ${Math.floor(Math.random() * 999999)}`;
437 // Creates the collection using the admin token so we can set up
438 // a bogus manifest text without block signatures.
439 cy.createCollection(adminUser.token, {
441 owner_uuid: activeUser.user.uuid,
442 preserve_version: true,
443 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:foo 0:3:bar\n"
445 .as('collection').then(function () {
446 // Visit collection, check basic information
447 cy.loginAs(activeUser)
448 cy.goToPath(`/collections/${this.collection.uuid}`);
450 cy.get('[data-cy=collection-info-panel]').should('not.contain', 'This is an old version');
451 cy.get('[data-cy=read-only-icon]').should('not.exist');
452 cy.get('[data-cy=collection-version-number]').should('contain', '1');
453 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
454 cy.get('[data-cy=collection-files-panel]').should('contain', 'foo').and('contain', 'bar');
456 // Modify collection, expect version number change
457 cy.get('[data-cy=collection-files-panel]').contains('foo').rightclick();
458 cy.get('[data-cy=context-menu]').contains('Remove').click();
459 cy.get('[data-cy=confirmation-dialog]').should('contain', 'Removing file');
460 cy.get('[data-cy=confirmation-dialog-ok-btn]').click();
461 cy.get('[data-cy=collection-version-number]').should('contain', '2');
462 cy.get('[data-cy=collection-files-panel]').should('not.contain', 'foo').and('contain', 'bar');
464 // Click on version number, check version browser. Click on past version.
465 cy.get('[data-cy=collection-version-browser]').should('not.exist');
466 cy.get('[data-cy=collection-version-number]').contains('2').click();
467 cy.get('[data-cy=collection-version-browser]')
468 .should('contain', 'Nr').and('contain', 'Size').and('contain', 'Date')
470 // Version 1: 6 bytes in size
471 cy.get('[data-cy=collection-version-browser-select-1]')
472 .should('contain', '1').and('contain', '6 B');
473 // Version 2: 3 bytes in size (one file removed)
474 cy.get('[data-cy=collection-version-browser-select-2]')
475 .should('contain', '2').and('contain', '3 B');
476 cy.get('[data-cy=collection-version-browser-select-3]')
477 .should('not.exist');
478 cy.get('[data-cy=collection-version-browser-select-1]')
481 cy.get('[data-cy=collection-info-panel]').should('contain', 'This is an old version');
482 cy.get('[data-cy=read-only-icon]').should('exist');
483 cy.get('[data-cy=collection-version-number]').should('contain', '1');
484 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
485 cy.get('[data-cy=collection-files-panel]')
486 .should('contain', 'foo').and('contain', 'bar');
488 // Check that only old collection action are available on context menu
489 cy.get('[data-cy=collection-panel-options-btn]').click();
490 cy.get('[data-cy=context-menu]')
491 .should('contain', 'Restore version')
492 .and('not.contain', 'Add to favorites');
493 cy.get('body').click(); // Collapse the menu avoiding details panel expansion
495 // Click on "head version" link, confirm that it's the latest version.
496 cy.get('[data-cy=collection-info-panel]').contains('head version').click();
497 cy.get('[data-cy=collection-info-panel]')
498 .should('not.contain', 'This is an old version');
499 cy.get('[data-cy=read-only-icon]').should('not.exist');
500 cy.get('[data-cy=collection-version-number]').should('contain', '2');
501 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
502 cy.get('[data-cy=collection-files-panel]').
503 should('not.contain', 'foo').and('contain', 'bar');
505 // Check that old collection action isn't available on context menu
506 cy.get('[data-cy=collection-panel-options-btn]').click()
507 cy.get('[data-cy=context-menu]').should('not.contain', 'Restore version')
508 cy.get('body').click(); // Collapse the menu avoiding details panel expansion
510 // Make another change, confirm new version.
511 cy.get('[data-cy=collection-panel-options-btn]').click();
512 cy.get('[data-cy=context-menu]').contains('Edit collection').click();
513 cy.get('[data-cy=form-dialog]')
514 .should('contain', 'Edit Collection')
517 cy.get('input').first().type(' renamed');
519 cy.get('[data-cy=form-submit-btn]').click();
520 cy.get('[data-cy=collection-info-panel]')
521 .should('not.contain', 'This is an old version');
522 cy.get('[data-cy=read-only-icon]').should('not.exist');
523 cy.get('[data-cy=collection-version-number]').should('contain', '3');
524 cy.get('[data-cy=collection-info-panel]').should('contain', colName + ' renamed');
525 cy.get('[data-cy=collection-files-panel]')
526 .should('not.contain', 'foo').and('contain', 'bar');
527 cy.get('[data-cy=collection-version-browser-select-3]')
528 .should('contain', '3').and('contain', '3 B');
530 // Check context menus on version browser
531 cy.get('[data-cy=collection-version-browser-select-3]').rightclick()
532 cy.get('[data-cy=context-menu]')
533 .should('contain', 'Add to favorites')
534 .and('contain', 'Make a copy')
535 .and('contain', 'Edit collection');
536 cy.get('body').click();
537 // (and now an old version...)
538 cy.get('[data-cy=collection-version-browser-select-1]').rightclick()
539 cy.get('[data-cy=context-menu]')
540 .should('not.contain', 'Add to favorites')
541 .and('contain', 'Make a copy')
542 .and('not.contain', 'Edit collection');
543 cy.get('body').click();
545 // Restore first version
546 cy.get('[data-cy=collection-version-browser]').within(() => {
547 cy.get('[data-cy=collection-version-browser-select-1]').click();
549 cy.get('[data-cy=collection-panel-options-btn]').click()
550 cy.get('[data-cy=context-menu]').contains('Restore version').click();
551 cy.get('[data-cy=confirmation-dialog]').should('contain', 'Restore version');
552 cy.get('[data-cy=confirmation-dialog-ok-btn]').click();
553 cy.get('[data-cy=collection-info-panel]')
554 .should('not.contain', 'This is an old version');
555 cy.get('[data-cy=collection-version-number]').should('contain', '4');
556 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
557 cy.get('[data-cy=collection-files-panel]')
558 .should('contain', 'foo').and('contain', 'bar');
562 it('creates new collection on home project', function () {
563 cy.loginAs(activeUser);
564 cy.goToPath(`/projects/${activeUser.user.uuid}`);
565 cy.get('[data-cy=breadcrumb-first]').should('contain', 'Projects');
566 cy.get('[data-cy=breadcrumb-last]').should('not.exist');
567 // Create new collection
568 cy.get('[data-cy=side-panel-button]').click();
569 cy.get('[data-cy=side-panel-new-collection]').click();
570 // Name between brackets tests bugfix #17582
571 const collName = `[Test collection (${Math.floor(999999 * Math.random())})]`;
572 cy.get('[data-cy=form-dialog]')
573 .should('contain', 'New collection')
575 cy.get('[data-cy=parent-field]').within(() => {
576 cy.get('input').should('have.value', 'Home project');
578 cy.get('[data-cy=name-field]').within(() => {
579 cy.get('input').type(collName);
582 cy.get('[data-cy=form-submit-btn]').click();
583 // Confirm that the user was taken to the newly created thing
584 cy.get('[data-cy=form-dialog]').should('not.exist');
585 cy.get('[data-cy=breadcrumb-first]').should('contain', 'Projects');
586 cy.get('[data-cy=breadcrumb-last]').should('contain', collName);
589 it.only('shows responsible person for collection if available', () => {
590 cy.createCollection(adminUser.token, {
591 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
592 owner_uuid: activeUser.user.uuid,
593 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
595 .as('testCollection1');
597 cy.createCollection(adminUser.token, {
598 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
599 owner_uuid: adminUser.user.uuid,
600 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
602 .as('testCollection2').then(function (testCollection2) {
603 cy.shareWith(adminUser.token, activeUser.user.uuid, testCollection2.uuid, 'can_write');
606 cy.getAll('@testCollection1', '@testCollection2')
607 .then(function ([testCollection1, testCollection2]) {
608 cy.loginAs(activeUser);
610 cy.goToPath(`/collections/${testCollection1.uuid}`);
611 cy.get('[data-cy=responsible-person-wrapper]')
612 .contains(activeUser.user.uuid);
614 cy.goToPath(`/collections/${testCollection2.uuid}`);
615 cy.get('[data-cy=responsible-person-wrapper]')
616 .contains(adminUser.user.uuid);