1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
5 describe('Collection panel tests', function () {
10 // Only set up common users once. These aren't set up as aliases because
11 // aliases are cleaned up after every test. Also it doesn't make sense
12 // to set the same users on beforeEach() over and over again, so we
13 // separate a little from Cypress' 'Best Practices' here.
14 cy.getUser('admin', 'Admin', 'User', true, true)
15 .as('adminUser').then(function () {
16 adminUser = this.adminUser;
19 cy.getUser('collectionuser1', 'Collection', 'User', false, true)
20 .as('activeUser').then(function () {
21 activeUser = this.activeUser;
26 beforeEach(function () {
28 cy.clearLocalStorage();
31 it('uses the property editor with vocabulary terms', function () {
32 cy.createCollection(adminUser.token, {
33 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
34 owner_uuid: activeUser.user.uuid,
35 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
37 .as('testCollection').then(function () {
38 cy.loginAs(activeUser);
39 cy.doSearch(`${this.testCollection.uuid}`);
41 // Key: Color (IDTAGCOLORS) - Value: Magenta (IDVALCOLORS3)
42 cy.get('[data-cy=resource-properties-form]').within(() => {
43 cy.get('[data-cy=property-field-key]').within(() => {
44 cy.get('input').type('Color');
46 cy.get('[data-cy=property-field-value]').within(() => {
47 cy.get('input').type('Magenta');
51 // Confirm proper vocabulary labels are displayed on the UI.
52 cy.get('[data-cy=collection-properties-panel]')
53 .should('contain', 'Color')
54 .and('contain', 'Magenta');
55 // Confirm proper vocabulary IDs were saved on the backend.
56 cy.doRequest('GET', `/arvados/v1/collections/${this.testCollection.uuid}`)
57 .its('body').as('collection')
59 expect(this.collection.properties).to.deep.equal(
60 { IDTAGCOLORS: 'IDVALCOLORS3' });
65 it('shows collection by URL', function () {
66 cy.loginAs(activeUser);
67 [true, false].map(function (isWritable) {
68 // Using different file names to avoid test flakyness: the second iteration
69 // on this loop may pass an assertion from the first iteration by looking
70 // for the same file name.
71 const fileName = isWritable ? 'bar' : 'foo';
72 cy.createGroup(adminUser.token, {
73 name: 'Shared project',
74 group_class: 'project',
75 }).as('sharedGroup').then(function () {
76 // Creates the collection using the admin token so we can set up
77 // a bogus manifest text without block signatures.
78 cy.createCollection(adminUser.token, {
79 name: 'Test collection',
80 owner_uuid: this.sharedGroup.uuid,
81 properties: { someKey: 'someValue' },
82 manifest_text: `. 37b51d194a7513e45b56f6524f2d51f2+3 0:3:${fileName}\n`
84 .as('testCollection').then(function () {
85 // Share the group with active user.
86 cy.createLink(adminUser.token, {
87 name: isWritable ? 'can_write' : 'can_read',
88 link_class: 'permission',
89 head_uuid: this.sharedGroup.uuid,
90 tail_uuid: activeUser.user.uuid
92 cy.doSearch(`${this.testCollection.uuid}`);
94 // Check that name & uuid are correct.
95 cy.get('[data-cy=collection-info-panel]')
96 .should('contain', this.testCollection.name)
97 .and('contain', this.testCollection.uuid)
98 .and('not.contain', 'This is an old version');
99 // Check for the read-only icon
100 cy.get('[data-cy=read-only-icon]').should(`${isWritable ? 'not.' : ''}exist`);
101 // Check that both read and write operations are available on
102 // the 'More options' menu.
103 cy.get('[data-cy=collection-panel-options-btn]')
105 cy.get('[data-cy=context-menu]')
106 .should('contain', 'Add to favorites')
107 .and(`${isWritable ? '' : 'not.'}contain`, 'Edit collection');
108 cy.get('body').click(); // Collapse the menu avoiding details panel expansion
109 cy.get('[data-cy=collection-properties-panel]')
110 .should('contain', 'someKey')
111 .and('contain', 'someValue')
112 .and('not.contain', 'anotherKey')
113 .and('not.contain', 'anotherValue')
114 if (isWritable === true) {
115 // Check that properties can be added.
116 cy.get('[data-cy=resource-properties-form]').within(() => {
117 cy.get('[data-cy=property-field-key]').within(() => {
118 cy.get('input').type('anotherKey');
120 cy.get('[data-cy=property-field-value]').within(() => {
121 cy.get('input').type('anotherValue');
125 cy.get('[data-cy=collection-properties-panel]')
126 .should('contain', 'anotherKey')
127 .and('contain', 'anotherValue')
129 // Properties form shouldn't be displayed.
130 cy.get('[data-cy=resource-properties-form]').should('not.exist');
132 // Check that the file listing show both read & write operations
133 cy.get('[data-cy=collection-files-panel]').within(() => {
134 cy.root().should('contain', fileName);
136 cy.get('[data-cy=upload-button]')
137 .should(`${isWritable ? '' : 'not.'}contain`, 'Upload data');
140 cy.get('[data-cy=collection-files-panel]')
141 .contains(fileName).rightclick({ force: true });
142 cy.get('[data-cy=context-menu]')
143 .should('contain', 'Download')
144 .and('contain', 'Open in new tab')
145 .and('contain', 'Copy to clipboard')
146 .and(`${isWritable ? '' : 'not.'}contain`, 'Rename')
147 .and(`${isWritable ? '' : 'not.'}contain`, 'Remove');
148 cy.get('body').click(); // Collapse the menu
149 // Hamburger 'more options' menu button
150 cy.get('[data-cy=collection-files-panel-options-btn]')
152 cy.get('[data-cy=context-menu]')
153 .should('contain', 'Select all')
155 cy.get('[data-cy=collection-files-panel-options-btn]')
157 cy.get('[data-cy=context-menu]')
158 // .should('contain', 'Download selected')
159 .should(`${isWritable ? '' : 'not.'}contain`, 'Remove selected')
160 cy.get('body').click(); // Collapse the menu
161 // File item 'more options' button
162 cy.get('[data-cy=file-item-options-btn')
164 cy.get('[data-cy=context-menu]')
165 .should('contain', 'Download')
166 .and(`${isWritable ? '' : 'not.'}contain`, 'Remove');
167 cy.get('body').click(); // Collapse the menu
173 it('renames a file using valid names', function () {
174 function eachPair(lst, func){
175 for(var i=0; i < lst.length - 1; i++){
176 func(lst[i], lst[i + 1])
179 // Creates the collection using the admin token so we can set up
180 // a bogus manifest text without block signatures.
181 cy.createCollection(adminUser.token, {
182 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
183 owner_uuid: activeUser.user.uuid,
184 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
186 .as('testCollection').then(function () {
187 cy.loginAs(activeUser);
188 cy.doSearch(`${this.testCollection.uuid}`);
191 'bar', // initial name already set
198 'some name with whitespaces',
200 'is this name legal? I hope it is',
206 eachPair(names, (from, to) => {
207 cy.get('[data-cy=collection-files-panel]')
208 .contains(`${from}`).rightclick();
209 cy.get('[data-cy=context-menu]')
212 cy.get('[data-cy=form-dialog]')
213 .should('contain', 'Rename')
215 cy.get('input').type(`{selectall}{backspace}${to}`);
217 cy.get('[data-cy=form-submit-btn]').click();
218 cy.get('[data-cy=collection-files-panel]')
219 .should('not.contain', `${from}`)
220 .and('contain', `${to}`);
225 it('renames a file to a different directory', function () {
226 // Creates the collection using the admin token so we can set up
227 // a bogus manifest text without block signatures.
228 cy.createCollection(adminUser.token, {
229 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
230 owner_uuid: activeUser.user.uuid,
231 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
233 .as('testCollection').then(function () {
234 cy.loginAs(activeUser);
235 cy.doSearch(`${this.testCollection.uuid}`);
237 // Rename 'bar' to 'subdir/foo'
238 cy.get('[data-cy=collection-files-panel]')
239 .contains('bar').rightclick();
240 cy.get('[data-cy=context-menu]')
243 cy.get('[data-cy=form-dialog]')
244 .should('contain', 'Rename')
246 cy.get('input').type(`{selectall}{backspace}subdir/foo`);
248 cy.get('[data-cy=form-submit-btn]').click();
249 cy.get('[data-cy=collection-files-panel]')
250 .should('not.contain', 'bar')
251 .and('contain', 'subdir');
252 // Look for the "arrow icon" and expand the "subdir" directory.
253 cy.get('[data-cy=virtual-file-tree] > div > i').click();
254 // Rename 'subdir/foo' to 'baz'
255 cy.get('[data-cy=collection-files-panel]')
256 .contains('foo').rightclick();
257 cy.get('[data-cy=context-menu]')
260 cy.get('[data-cy=form-dialog]')
261 .should('contain', 'Rename')
264 .should('have.value', 'subdir/foo')
265 .type(`{selectall}{backspace}baz`);
267 cy.get('[data-cy=form-submit-btn]').click();
268 cy.get('[data-cy=collection-files-panel]')
269 .should('contain', 'subdir') // empty dir kept
270 .and('contain', 'baz');
274 it('tries to rename a file with illegal names', function () {
275 // Creates the collection using the admin token so we can set up
276 // a bogus manifest text without block signatures.
277 cy.createCollection(adminUser.token, {
278 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
279 owner_uuid: activeUser.user.uuid,
280 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
282 .as('testCollection').then(function () {
283 cy.loginAs(activeUser);
284 cy.doSearch(`${this.testCollection.uuid}`);
286 const illegalNamesFromUI = [
287 ['.', "Name cannot be '.' or '..'"],
288 ['..', "Name cannot be '.' or '..'"],
289 ['', 'This field is required'],
290 [' ', 'Leading/trailing whitespaces not allowed'],
291 [' foo', 'Leading/trailing whitespaces not allowed'],
292 ['foo ', 'Leading/trailing whitespaces not allowed'],
293 ['//foo', 'Empty dir name not allowed']
295 illegalNamesFromUI.forEach(([name, errMsg]) => {
296 cy.get('[data-cy=collection-files-panel]')
297 .contains('bar').rightclick();
298 cy.get('[data-cy=context-menu]')
301 cy.get('[data-cy=form-dialog]')
302 .should('contain', 'Rename')
304 cy.get('input').type(`{selectall}{backspace}${name}`);
306 cy.get('[data-cy=form-dialog]')
307 .should('contain', 'Rename')
309 cy.contains(`${errMsg}`);
311 cy.get('[data-cy=form-cancel-btn]').click();
316 it('can correctly display old versions', function () {
317 const colName = `Versioned Collection ${Math.floor(Math.random() * 999999)}`;
319 let oldVersionUuid = '';
320 // Make sure no other collections with this name exist
321 cy.doRequest('GET', '/arvados/v1/collections', null, {
322 filters: `[["name", "=", "${colName}"]]`,
323 include_old_versions: true
325 .its('body.items').as('collections')
327 expect(this.collections).to.be.empty;
329 // Creates the collection using the admin token so we can set up
330 // a bogus manifest text without block signatures.
331 cy.createCollection(adminUser.token, {
333 owner_uuid: activeUser.user.uuid,
334 preserve_version: true,
335 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
337 .as('originalVersion').then(function () {
338 // Change the file name to create a new version.
339 cy.updateCollection(adminUser.token, this.originalVersion.uuid, {
340 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:foo\n"
342 colUuid = this.originalVersion.uuid;
344 // Confirm that there are 2 versions of the collection
345 cy.doRequest('GET', '/arvados/v1/collections', null, {
346 filters: `[["name", "=", "${colName}"]]`,
347 include_old_versions: true
349 .its('body.items').as('collections')
351 expect(this.collections).to.have.lengthOf(2);
352 this.collections.map(function (aCollection) {
353 expect(aCollection.current_version_uuid).to.equal(colUuid);
354 if (aCollection.uuid !== aCollection.current_version_uuid) {
355 oldVersionUuid = aCollection.uuid;
358 // Check the old version displays as what it is.
359 cy.loginAs(activeUser)
360 cy.doSearch(`${oldVersionUuid}`);
362 cy.get('[data-cy=collection-info-panel]').should('contain', 'This is an old version');
363 cy.get('[data-cy=read-only-icon]').should('exist');
364 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
365 cy.get('[data-cy=collection-files-panel]').should('contain', 'bar');
369 it('uses the collection version browser to view a previous version', function () {
370 const colName = `Test Collection ${Math.floor(Math.random() * 999999)}`;
372 // Creates the collection using the admin token so we can set up
373 // a bogus manifest text without block signatures.
374 cy.createCollection(adminUser.token, {
376 owner_uuid: activeUser.user.uuid,
377 preserve_version: true,
378 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:foo 0:3:bar\n"
380 .as('collection').then(function () {
381 // Visit collection, check basic information
382 cy.loginAs(activeUser)
383 cy.doSearch(`${this.collection.uuid}`);
385 cy.get('[data-cy=collection-info-panel]').should('not.contain', 'This is an old version');
386 cy.get('[data-cy=read-only-icon]').should('not.exist');
387 cy.get('[data-cy=collection-version-number]').should('contain', '1');
388 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
389 cy.get('[data-cy=collection-files-panel]').should('contain', 'foo').and('contain', 'bar');
391 // Modify collection, expect version number change
392 cy.get('[data-cy=collection-files-panel]').contains('foo').rightclick();
393 cy.get('[data-cy=context-menu]').contains('Remove').click();
394 cy.get('[data-cy=confirmation-dialog]').should('contain', 'Removing file');
395 cy.get('[data-cy=confirmation-dialog-ok-btn]').click();
396 cy.get('[data-cy=collection-version-number]').should('contain', '2');
397 cy.get('[data-cy=collection-files-panel]').should('not.contain', 'foo').and('contain', 'bar');
399 // Click on version number, check version browser. Click on past version.
400 cy.get('[data-cy=collection-version-browser]').should('not.exist');
401 cy.get('[data-cy=collection-version-number]').contains('2').click();
402 cy.get('[data-cy=collection-version-browser]')
403 .should('contain', 'Nr').and('contain', 'Size').and('contain', 'Date')
405 // Version 1: 6 bytes in size
406 cy.get('[data-cy=collection-version-browser-select-1]')
407 .should('contain', '1').and('contain', '6 B');
408 // Version 2: 3 bytes in size (one file removed)
409 cy.get('[data-cy=collection-version-browser-select-2]')
410 .should('contain', '2').and('contain', '3 B');
411 cy.get('[data-cy=collection-version-browser-select-3]')
412 .should('not.exist');
413 cy.get('[data-cy=collection-version-browser-select-1]')
416 cy.get('[data-cy=collection-info-panel]').should('contain', 'This is an old version');
417 cy.get('[data-cy=read-only-icon]').should('exist');
418 cy.get('[data-cy=collection-version-number]').should('contain', '1');
419 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
420 cy.get('[data-cy=collection-files-panel]')
421 .should('contain', 'foo').and('contain', 'bar');
423 // Check that only old collection action are available on context menu
424 cy.get('[data-cy=collection-panel-options-btn]').click();
425 cy.get('[data-cy=context-menu]')
426 .should('contain', 'Restore version')
427 .and('not.contain', 'Add to favorites');
428 cy.get('body').click(); // Collapse the menu avoiding details panel expansion
430 // Click on "head version" link, confirm that it's the latest version.
431 cy.get('[data-cy=collection-info-panel]').contains('head version').click();
432 cy.get('[data-cy=collection-info-panel]')
433 .should('not.contain', 'This is an old version');
434 cy.get('[data-cy=read-only-icon]').should('not.exist');
435 cy.get('[data-cy=collection-version-number]').should('contain', '2');
436 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
437 cy.get('[data-cy=collection-files-panel]').
438 should('not.contain', 'foo').and('contain', 'bar');
440 // Check that old collection action isn't available on context menu
441 cy.get('[data-cy=collection-panel-options-btn]').click()
442 cy.get('[data-cy=context-menu]').should('not.contain', 'Restore version')
443 cy.get('body').click(); // Collapse the menu avoiding details panel expansion
445 // Make another change, confirm new version.
446 cy.get('[data-cy=collection-panel-options-btn]').click();
447 cy.get('[data-cy=context-menu]').contains('Edit collection').click();
448 cy.get('[data-cy=form-dialog]')
449 .should('contain', 'Edit Collection')
452 cy.get('input').first().type(' renamed');
454 cy.get('[data-cy=form-submit-btn]').click();
455 cy.get('[data-cy=collection-info-panel]')
456 .should('not.contain', 'This is an old version');
457 cy.get('[data-cy=read-only-icon]').should('not.exist');
458 cy.get('[data-cy=collection-version-number]').should('contain', '3');
459 cy.get('[data-cy=collection-info-panel]').should('contain', colName + ' renamed');
460 cy.get('[data-cy=collection-files-panel]')
461 .should('not.contain', 'foo').and('contain', 'bar');
462 cy.get('[data-cy=collection-version-browser-select-3]')
463 .should('contain', '3').and('contain', '3 B');
465 // Check context menus on version browser
466 cy.get('[data-cy=collection-version-browser-select-3]').rightclick()
467 cy.get('[data-cy=context-menu]')
468 .should('contain', 'Add to favorites')
469 .and('contain', 'Make a copy')
470 .and('contain', 'Edit collection');
471 cy.get('body').click();
472 // (and now an old version...)
473 cy.get('[data-cy=collection-version-browser-select-1]').rightclick()
474 cy.get('[data-cy=context-menu]')
475 .should('not.contain', 'Add to favorites')
476 .and('contain', 'Make a copy')
477 .and('not.contain', 'Edit collection');
478 cy.get('body').click();
480 // Restore first version
481 cy.get('[data-cy=collection-version-browser]').within(() => {
482 cy.get('[data-cy=collection-version-browser-select-1]').click();
484 cy.get('[data-cy=collection-panel-options-btn]').click()
485 cy.get('[data-cy=context-menu]').contains('Restore version').click();
486 cy.get('[data-cy=confirmation-dialog]').should('contain', 'Restore version');
487 cy.get('[data-cy=confirmation-dialog-ok-btn]').click();
488 cy.get('[data-cy=collection-info-panel]')
489 .should('not.contain', 'This is an old version');
490 cy.get('[data-cy=collection-version-number]').should('contain', '4');
491 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
492 cy.get('[data-cy=collection-files-panel]')
493 .should('contain', 'foo').and('contain', 'bar');
497 it('creates new collection on home project', function () {
498 cy.loginAs(activeUser);
499 cy.doSearch(`${activeUser.user.uuid}`);
500 cy.get('[data-cy=breadcrumb-first]').should('contain', 'Projects');
501 cy.get('[data-cy=breadcrumb-last]').should('not.exist');
502 // Create new collection
503 cy.get('[data-cy=side-panel-button]').click();
504 cy.get('[data-cy=side-panel-new-collection]').click();
505 const collName = `Test collection (${Math.floor(999999 * Math.random())})`;
506 cy.get('[data-cy=form-dialog]')
507 .should('contain', 'New collection')
509 cy.get('[data-cy=parent-field]').within(() => {
510 cy.get('input').should('have.value', 'Home project');
512 cy.get('[data-cy=name-field]').within(() => {
513 cy.get('input').type(collName);
516 cy.get('[data-cy=form-submit-btn]').click();
517 // Confirm that the user was taken to the newly created thing
518 cy.get('[data-cy=form-dialog]').should('not.exist');
519 cy.get('[data-cy=breadcrumb-first]').should('contain', 'Projects');
520 cy.get('[data-cy=breadcrumb-last]').should('contain', collName);