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',
207 eachPair(names, (from, to) => {
208 cy.get('[data-cy=collection-files-panel]')
209 .contains(`${from}`).rightclick();
210 cy.get('[data-cy=context-menu]')
213 cy.get('[data-cy=form-dialog]')
214 .should('contain', 'Rename')
216 cy.get('input').type(`{selectall}{backspace}${to}`);
218 cy.get('[data-cy=form-submit-btn]').click();
219 cy.get('[data-cy=collection-files-panel]')
220 .should('not.contain', `${from}`)
221 .and('contain', `${to}`);
226 it('renames a file to a different directory', function () {
227 // Creates the collection using the admin token so we can set up
228 // a bogus manifest text without block signatures.
229 cy.createCollection(adminUser.token, {
230 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
231 owner_uuid: activeUser.user.uuid,
232 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
234 .as('testCollection').then(function () {
235 cy.loginAs(activeUser);
236 cy.doSearch(`${this.testCollection.uuid}`);
238 // Rename 'bar' to 'subdir/foo'
239 cy.get('[data-cy=collection-files-panel]')
240 .contains('bar').rightclick();
241 cy.get('[data-cy=context-menu]')
244 cy.get('[data-cy=form-dialog]')
245 .should('contain', 'Rename')
247 cy.get('input').type(`{selectall}{backspace}subdir/foo`);
249 cy.get('[data-cy=form-submit-btn]').click();
250 cy.get('[data-cy=collection-files-panel]')
251 .should('not.contain', 'bar')
252 .and('contain', 'subdir');
253 // Look for the "arrow icon" and expand the "subdir" directory.
254 cy.get('[data-cy=virtual-file-tree] > div > i').click();
255 // Rename 'subdir/foo' to 'baz'
256 cy.get('[data-cy=collection-files-panel]')
257 .contains('foo').rightclick();
258 cy.get('[data-cy=context-menu]')
261 cy.get('[data-cy=form-dialog]')
262 .should('contain', 'Rename')
265 .should('have.value', 'subdir/foo')
266 .type(`{selectall}{backspace}baz`);
268 cy.get('[data-cy=form-submit-btn]').click();
269 cy.get('[data-cy=collection-files-panel]')
270 .should('contain', 'subdir') // empty dir kept
271 .and('contain', 'baz');
275 it('tries to rename a file with illegal names', function () {
276 // Creates the collection using the admin token so we can set up
277 // a bogus manifest text without block signatures.
278 cy.createCollection(adminUser.token, {
279 name: `Test collection ${Math.floor(Math.random() * 999999)}`,
280 owner_uuid: activeUser.user.uuid,
281 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
283 .as('testCollection').then(function () {
284 cy.loginAs(activeUser);
285 cy.doSearch(`${this.testCollection.uuid}`);
287 const illegalNamesFromUI = [
288 ['.', "Name cannot be '.' or '..'"],
289 ['..', "Name cannot be '.' or '..'"],
290 ['', 'This field is required'],
291 [' ', 'Leading/trailing whitespaces not allowed'],
292 [' foo', 'Leading/trailing whitespaces not allowed'],
293 ['foo ', 'Leading/trailing whitespaces not allowed'],
294 ['//foo', 'Empty dir name not allowed']
296 illegalNamesFromUI.forEach(([name, errMsg]) => {
297 cy.get('[data-cy=collection-files-panel]')
298 .contains('bar').rightclick();
299 cy.get('[data-cy=context-menu]')
302 cy.get('[data-cy=form-dialog]')
303 .should('contain', 'Rename')
305 cy.get('input').type(`{selectall}{backspace}${name}`);
307 cy.get('[data-cy=form-dialog]')
308 .should('contain', 'Rename')
310 cy.contains(`${errMsg}`);
312 cy.get('[data-cy=form-cancel-btn]').click();
317 it('can correctly display old versions', function () {
318 const colName = `Versioned Collection ${Math.floor(Math.random() * 999999)}`;
320 let oldVersionUuid = '';
321 // Make sure no other collections with this name exist
322 cy.doRequest('GET', '/arvados/v1/collections', null, {
323 filters: `[["name", "=", "${colName}"]]`,
324 include_old_versions: true
326 .its('body.items').as('collections')
328 expect(this.collections).to.be.empty;
330 // Creates the collection using the admin token so we can set up
331 // a bogus manifest text without block signatures.
332 cy.createCollection(adminUser.token, {
334 owner_uuid: activeUser.user.uuid,
335 preserve_version: true,
336 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:bar\n"
338 .as('originalVersion').then(function () {
339 // Change the file name to create a new version.
340 cy.updateCollection(adminUser.token, this.originalVersion.uuid, {
341 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:foo\n"
343 colUuid = this.originalVersion.uuid;
345 // Confirm that there are 2 versions of the collection
346 cy.doRequest('GET', '/arvados/v1/collections', null, {
347 filters: `[["name", "=", "${colName}"]]`,
348 include_old_versions: true
350 .its('body.items').as('collections')
352 expect(this.collections).to.have.lengthOf(2);
353 this.collections.map(function (aCollection) {
354 expect(aCollection.current_version_uuid).to.equal(colUuid);
355 if (aCollection.uuid !== aCollection.current_version_uuid) {
356 oldVersionUuid = aCollection.uuid;
359 // Check the old version displays as what it is.
360 cy.loginAs(activeUser)
361 cy.doSearch(`${oldVersionUuid}`);
363 cy.get('[data-cy=collection-info-panel]').should('contain', 'This is an old version');
364 cy.get('[data-cy=read-only-icon]').should('exist');
365 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
366 cy.get('[data-cy=collection-files-panel]').should('contain', 'bar');
370 it('uses the collection version browser to view a previous version', function () {
371 const colName = `Test Collection ${Math.floor(Math.random() * 999999)}`;
373 // Creates the collection using the admin token so we can set up
374 // a bogus manifest text without block signatures.
375 cy.createCollection(adminUser.token, {
377 owner_uuid: activeUser.user.uuid,
378 preserve_version: true,
379 manifest_text: ". 37b51d194a7513e45b56f6524f2d51f2+3 0:3:foo 0:3:bar\n"
381 .as('collection').then(function () {
382 // Visit collection, check basic information
383 cy.loginAs(activeUser)
384 cy.doSearch(`${this.collection.uuid}`);
386 cy.get('[data-cy=collection-info-panel]').should('not.contain', 'This is an old version');
387 cy.get('[data-cy=read-only-icon]').should('not.exist');
388 cy.get('[data-cy=collection-version-number]').should('contain', '1');
389 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
390 cy.get('[data-cy=collection-files-panel]').should('contain', 'foo').and('contain', 'bar');
392 // Modify collection, expect version number change
393 cy.get('[data-cy=collection-files-panel]').contains('foo').rightclick();
394 cy.get('[data-cy=context-menu]').contains('Remove').click();
395 cy.get('[data-cy=confirmation-dialog]').should('contain', 'Removing file');
396 cy.get('[data-cy=confirmation-dialog-ok-btn]').click();
397 cy.get('[data-cy=collection-version-number]').should('contain', '2');
398 cy.get('[data-cy=collection-files-panel]').should('not.contain', 'foo').and('contain', 'bar');
400 // Click on version number, check version browser. Click on past version.
401 cy.get('[data-cy=collection-version-browser]').should('not.exist');
402 cy.get('[data-cy=collection-version-number]').contains('2').click();
403 cy.get('[data-cy=collection-version-browser]')
404 .should('contain', 'Nr').and('contain', 'Size').and('contain', 'Date')
406 // Version 1: 6 bytes in size
407 cy.get('[data-cy=collection-version-browser-select-1]')
408 .should('contain', '1').and('contain', '6 B');
409 // Version 2: 3 bytes in size (one file removed)
410 cy.get('[data-cy=collection-version-browser-select-2]')
411 .should('contain', '2').and('contain', '3 B');
412 cy.get('[data-cy=collection-version-browser-select-3]')
413 .should('not.exist');
414 cy.get('[data-cy=collection-version-browser-select-1]')
417 cy.get('[data-cy=collection-info-panel]').should('contain', 'This is an old version');
418 cy.get('[data-cy=read-only-icon]').should('exist');
419 cy.get('[data-cy=collection-version-number]').should('contain', '1');
420 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
421 cy.get('[data-cy=collection-files-panel]')
422 .should('contain', 'foo').and('contain', 'bar');
424 // Check that only old collection action are available on context menu
425 cy.get('[data-cy=collection-panel-options-btn]').click();
426 cy.get('[data-cy=context-menu]')
427 .should('contain', 'Restore version')
428 .and('not.contain', 'Add to favorites');
429 cy.get('body').click(); // Collapse the menu avoiding details panel expansion
431 // Click on "head version" link, confirm that it's the latest version.
432 cy.get('[data-cy=collection-info-panel]').contains('head version').click();
433 cy.get('[data-cy=collection-info-panel]')
434 .should('not.contain', 'This is an old version');
435 cy.get('[data-cy=read-only-icon]').should('not.exist');
436 cy.get('[data-cy=collection-version-number]').should('contain', '2');
437 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
438 cy.get('[data-cy=collection-files-panel]').
439 should('not.contain', 'foo').and('contain', 'bar');
441 // Check that old collection action isn't available on context menu
442 cy.get('[data-cy=collection-panel-options-btn]').click()
443 cy.get('[data-cy=context-menu]').should('not.contain', 'Restore version')
444 cy.get('body').click(); // Collapse the menu avoiding details panel expansion
446 // Make another change, confirm new version.
447 cy.get('[data-cy=collection-panel-options-btn]').click();
448 cy.get('[data-cy=context-menu]').contains('Edit collection').click();
449 cy.get('[data-cy=form-dialog]')
450 .should('contain', 'Edit Collection')
453 cy.get('input').first().type(' renamed');
455 cy.get('[data-cy=form-submit-btn]').click();
456 cy.get('[data-cy=collection-info-panel]')
457 .should('not.contain', 'This is an old version');
458 cy.get('[data-cy=read-only-icon]').should('not.exist');
459 cy.get('[data-cy=collection-version-number]').should('contain', '3');
460 cy.get('[data-cy=collection-info-panel]').should('contain', colName + ' renamed');
461 cy.get('[data-cy=collection-files-panel]')
462 .should('not.contain', 'foo').and('contain', 'bar');
463 cy.get('[data-cy=collection-version-browser-select-3]')
464 .should('contain', '3').and('contain', '3 B');
466 // Check context menus on version browser
467 cy.get('[data-cy=collection-version-browser-select-3]').rightclick()
468 cy.get('[data-cy=context-menu]')
469 .should('contain', 'Add to favorites')
470 .and('contain', 'Make a copy')
471 .and('contain', 'Edit collection');
472 cy.get('body').click();
473 // (and now an old version...)
474 cy.get('[data-cy=collection-version-browser-select-1]').rightclick()
475 cy.get('[data-cy=context-menu]')
476 .should('not.contain', 'Add to favorites')
477 .and('contain', 'Make a copy')
478 .and('not.contain', 'Edit collection');
479 cy.get('body').click();
481 // Restore first version
482 cy.get('[data-cy=collection-version-browser]').within(() => {
483 cy.get('[data-cy=collection-version-browser-select-1]').click();
485 cy.get('[data-cy=collection-panel-options-btn]').click()
486 cy.get('[data-cy=context-menu]').contains('Restore version').click();
487 cy.get('[data-cy=confirmation-dialog]').should('contain', 'Restore version');
488 cy.get('[data-cy=confirmation-dialog-ok-btn]').click();
489 cy.get('[data-cy=collection-info-panel]')
490 .should('not.contain', 'This is an old version');
491 cy.get('[data-cy=collection-version-number]').should('contain', '4');
492 cy.get('[data-cy=collection-info-panel]').should('contain', colName);
493 cy.get('[data-cy=collection-files-panel]')
494 .should('contain', 'foo').and('contain', 'bar');
498 it('creates new collection on home project', function () {
499 cy.loginAs(activeUser);
500 cy.doSearch(`${activeUser.user.uuid}`);
501 cy.get('[data-cy=breadcrumb-first]').should('contain', 'Projects');
502 cy.get('[data-cy=breadcrumb-last]').should('not.exist');
503 // Create new collection
504 cy.get('[data-cy=side-panel-button]').click();
505 cy.get('[data-cy=side-panel-new-collection]').click();
506 const collName = `Test collection (${Math.floor(999999 * Math.random())})`;
507 cy.get('[data-cy=form-dialog]')
508 .should('contain', 'New collection')
510 cy.get('[data-cy=parent-field]').within(() => {
511 cy.get('input').should('have.value', 'Home project');
513 cy.get('[data-cy=name-field]').within(() => {
514 cy.get('input').type(collName);
517 cy.get('[data-cy=form-submit-btn]').click();
518 // Confirm that the user was taken to the newly created thing
519 cy.get('[data-cy=form-dialog]').should('not.exist');
520 cy.get('[data-cy=breadcrumb-first]').should('contain', 'Projects');
521 cy.get('[data-cy=breadcrumb-last]').should('contain', collName);