pkp/pkp-lib#7191 Split submission creation commands into pieces; fix author data

Author: asmecher

cypress/support/commands.js

@@ -7,6 +7,7 @@
  *
  */
 
+import Api from '../../lib/pkp/cypress/support/api.js';
 import '../../lib/pkp/cypress/support/commands';
 
 Cypress.Commands.add('addCategory', (categoryName, categoryPath) => {
@@ -24,3 +25,51 @@ Cypress.Commands.add('isInIssue', (submissionTitle, issueTitle) => {
 	cy.get('a:contains("' + issueTitle + '")').click();
 	cy.get('a:contains("' + submissionTitle + '")');
 });
+
+Cypress.Commands.add('addSubmissionGalleys', (files) => {
+	files.forEach(file => {
+		cy.get('a:contains("Add File")').click();
+		cy.wait(2000); // Avoid occasional failure due to form init taking time
+		cy.get('div.pkp_modal_panel').then($modalDiv => {
+			cy.wait(3000);
+			$modalDiv.find('div.header:contains("Add File")');
+			cy.get('div.pkp_modal_panel input[id^="label-"]').type('PDF', {delay: 0});
+			cy.get('div.pkp_modal_panel button:contains("Save")').click();
+			cy.wait(2000); // Avoid occasional failure due to form init taking time
+		});
+		cy.get('select[id=genreId]').select(file.genre);
+		cy.fixture(file.file, 'base64').then(fileContent => {
+			cy.get('input[type=file]').attachFile(
+				{fileContent, 'filePath': file.fileName, 'mimeType': 'application/pdf', 'encoding': 'base64'}
+			);
+		});
+		cy.get('#continueButton').click();
+		cy.wait(2000);
+		for (const field in file.metadata) {
+			cy.get('input[id^="' + Cypress.$.escapeSelector(field) + '"]:visible,textarea[id^="' + Cypress.$.escapeSelector(field) + '"]').type(file.metadata[field], {delay: 0});
+			cy.get('input[id^="language"').click({force: true}); // Close multilingual and datepicker pop-overs
+		}
+		cy.get('#continueButton').click();
+		cy.get('#continueButton').click();
+	});
+});
+
+Cypress.Commands.add('createSubmissionWithApi', (data, csrfToken) => {
+	const api = new Api(Cypress.env('baseUrl') + '/index.php/publicknowledge/api/v1');
+
+	return cy.beginSubmissionWithApi(api, data, csrfToken)
+		.putMetadataWithApi(data, csrfToken)
+		.get('@submissionId').then((submissionId) => {
+			if (typeof data.files === 'undefined' || !data.files.length) {
+				return;
+			}
+			cy.visit('/index.php/publicknowledge/submission?id=' + submissionId);
+
+			// Must use the UI to upload files until we upgrade Cypress
+			// to 7.4.0 or higher.
+			// @see https://github.com/cypress-io/cypress/issues/1647
+			cy.addSubmissionGalleys(data.files);
+		})
+		.addSubmissionAuthorsWithApi(api, data, csrfToken);
+});
+

cypress/tests/data/60-content/CcorinoSubmission.spec.js

@@ -23,15 +23,6 @@ describe('Data suite: Ccorino', function() {
 			authorNames: ['Carla Corino'],
 			sectionId: 1,
 			assignedAuthorNames: ['Carla Corino'],
-			authors: [
-				{
-					givenName: 'Carla',
-					familyName: 'Corino',
-					email: '[email protected]',
-					country: 'Italy',
-					affiliation: 'University of Bologna'
-				}
-			],
 			files: [
 				{
 					'file': 'dummy.pdf',
@@ -52,19 +43,13 @@ describe('Data suite: Ccorino', function() {
 			'country': 'Italy'
 		});
 
-		// Go to page where CSRF token is available
-		cy.visit('/index.php/publicknowledge/user/profile');
-
-		let csrfToken = '';
+		cy.getCsrfToken();
 		cy.window()
-			.then((win) => {
-				csrfToken = win.pkp.currentUser.csrfToken;
-			})
 			.then(() => {
-				return cy.createSubmissionWithApi(submission, csrfToken);
+				return cy.createSubmissionWithApi(submission, this.csrfToken);
 			})
-			.then(xhr => {
-				return cy.submitSubmissionWithApi(submission.id, csrfToken);
+			.then(() => {
+				return cy.submitSubmissionWithApi(submission.id, this.csrfToken);
 			});
 	});
 })

cypress/tests/data/60-content/CkwantesSubmission.spec.js

@@ -86,7 +86,7 @@ describe('Data suite: Ckwantes', function() {
 		// Upload files and set file genres
 		cy.get('h2').contains('Upload Files');
 		cy.get('h2').contains('Files');
-		cy.uploadSubmissionFiles(submission.files);
+		cy.addSubmissionGalleys(submission.files);
 
 		cy.get('.submissionWizard__footer button').contains('Continue').click();
 

cypress/tests/data/60-content/CmontgomerieSubmission.spec.js

@@ -24,20 +24,14 @@ describe('Data suite: Cmontgomerie', function() {
 			authorNames: ['Craig Montgomerie', 'Mark Irvine'],
 			sectionId: 1,
 			assignedAuthorNames: ['Craig Montgomerie'],
-			authors: [
+			additionalAuthors: [
 				{
-					givenName: 'Craig',
-					familyName: 'Montgomerie',
-					email: '[email protected]',
-					country: 'Canada',
-					affiliation: 'University of Alberta'
-				},
-				{
-					givenName: 'Mark',
-					familyName: 'Irvine',
-					country: 'Canada',
-					affiliation: 'University of Victoria',
-					email: '[email protected]'
+					givenName: {en_US: 'Mark'},
+					familyName: {en_US: 'Irvine'},
+					country: 'CA',
+					affiliation: {en_US: 'University of Victoria'},
+					email: '[email protected]',
+					userGroupId: Cypress.env('authorUserGroupId')
 				}
 			],
 			files: [
@@ -70,19 +64,13 @@ describe('Data suite: Cmontgomerie', function() {
 			'country': 'Canada'
 		});
 
-		// Go to page where CSRF token is available
-		cy.visit('/index.php/publicknowledge/user/profile');
-
-		let csrfToken = '';
+		cy.getCsrfToken();
 		cy.window()
-			.then((win) => {
-				csrfToken = win.pkp.currentUser.csrfToken;
-			})
 			.then(() => {
-				return cy.createSubmissionWithApi(submission, csrfToken);
+				return cy.createSubmissionWithApi(submission, this.csrfToken);
 			})
 			.then(xhr => {
-				return cy.submitSubmissionWithApi(submission.id, csrfToken);
+				return cy.submitSubmissionWithApi(submission.id, this.csrfToken);
 			});
 
 		cy.logout();

cypress/tests/data/60-content/DdioufSubmission.spec.js

@@ -23,15 +23,6 @@ describe('Data suite: Ddiouf', function() {
 			authorNames: ['Diaga Diouf'],
 			sectionId: 1,
 			assignedAuthorNames: ['Diaga Diouf'],
-			authors: [
-				{
-					givenName: 'Diaga',
-					familyName: 'Diouf',
-					email: '[email protected]',
-					country: 'Egypt',
-					affiliation: 'Alexandria University'
-				}
-			],
 			files: [
 				{
 					'file': 'dummy.pdf',
@@ -52,19 +43,13 @@ describe('Data suite: Ddiouf', function() {
 			'country': 'Egypt',
 		});
 
-		// Go to page where CSRF token is available
-		cy.visit('/index.php/publicknowledge/user/profile');
-
-		let csrfToken = '';
+		cy.getCsrfToken();
 		cy.window()
-			.then((win) => {
-				csrfToken = win.pkp.currentUser.csrfToken;
-			})
 			.then(() => {
-				return cy.createSubmissionWithApi(submission, csrfToken);
+				return cy.createSubmissionWithApi(submission, this.csrfToken);
 			})
 			.then(xhr => {
-				return cy.submitSubmissionWithApi(submission.id, csrfToken);
+				return cy.submitSubmissionWithApi(submission.id, this.csrfToken);
 			});
 	});
 

cypress/tests/data/60-content/DphillipsSubmission.spec.js

@@ -23,15 +23,6 @@ describe('Data suite: Dphillips', function() {
 			authorNames: ['Dana Phillips'],
 			sectionId: 1,
 			assignedAuthorNames: ['Dana Phillips'],
-			authors: [
-				{
-					givenName: 'Dana',
-					familyName: 'Phillips',
-					email: '[email protected]',
-					country: 'Canada',
-					affiliation: 'University of Toronto'
-				}
-			],
 			files: [
 				{
 					'file': 'dummy.pdf',
@@ -52,19 +43,13 @@ describe('Data suite: Dphillips', function() {
 			'country': 'Canada',
 		});
 
-		// Go to page where CSRF token is available
-		cy.visit('/index.php/publicknowledge/user/profile');
-
-		let csrfToken = '';
+		cy.getCsrfToken();
 		cy.window()
-			.then((win) => {
-				csrfToken = win.pkp.currentUser.csrfToken;
-			})
 			.then(() => {
-				return cy.createSubmissionWithApi(submission, csrfToken);
+				return cy.createSubmissionWithApi(submission, this.csrfToken);
 			})
 			.then(xhr => {
-				return cy.submitSubmissionWithApi(submission.id, csrfToken);
+				return cy.submitSubmissionWithApi(submission.id, this.csrfToken);
 			});
 
 		cy.logout();

cypress/tests/data/60-content/DsokoloffSubmission.spec.js

@@ -23,15 +23,6 @@ describe('Data suite: Dsokoloff', function() {
 			authorNames: ['Domatilia Sokoloff'],
 			sectionId: 1,
 			assignedAuthorNames: ['Domatilia Sokoloff'],
-			authors: [
-				{
-					givenName: 'Domatilia',
-					familyName: 'Sokoloff',
-					email: '[email protected]',
-					country: 'Ireland',
-					affiliation: 'University College Cork'
-				}
-			],
 			files: [
 				{
 					'file': 'dummy.pdf',
@@ -57,19 +48,13 @@ describe('Data suite: Dsokoloff', function() {
 			'country': 'Ireland',
 		});
 
-		// Go to page where CSRF token is available
-		cy.visit('/index.php/publicknowledge/user/profile');
-
-		let csrfToken = '';
+		cy.getCsrfToken();
 		cy.window()
-			.then((win) => {
-				csrfToken = win.pkp.currentUser.csrfToken;
-			})
 			.then(() => {
-				return cy.createSubmissionWithApi(submission, csrfToken);
+				return cy.createSubmissionWithApi(submission, this.csrfToken);
 			})
 			.then(xhr => {
-				return cy.submitSubmissionWithApi(submission.id, csrfToken);
+				return cy.submitSubmissionWithApi(submission.id, this.csrfToken);
 			});
 
 		cy.logout();

cypress/tests/data/60-content/EostromSubmission.spec.js

@@ -23,20 +23,14 @@ describe('Data suite: Eostrom', function() {
 			authorNames: ['Elinor Ostrom'],
 			sectionId: 1,
 			assignedAuthorNames: ['Elinor Ostrom'],
-			authors: [
+			additionalAuthors: [
 				{
-					givenName: 'Elinor',
-					familyName: 'Ostrom',
-					email: '[email protected]',
-					country: 'United States',
-					affiliation: 'Indiana University'
-				},
-				{
-					givenName: 'Frank',
-					familyName: 'van Laerhoven',
+					givenName: {en_US: 'Frank'},
+					familyName: {en_US: 'van Laerhoven'},
+					country: 'US',
+					affiliation: {en_US: 'Indiana University'},
 					email: '[email protected]',
-					country: 'United States',
-					affiliation: 'Indiana University'
+					userGroupId: Cypress.env('authorUserGroupId')
 				}
 			],
 			files: [
@@ -65,19 +59,13 @@ describe('Data suite: Eostrom', function() {
 			'country': 'United States',
 		});
 
-		// Go to page where CSRF token is available
-		cy.visit('/index.php/publicknowledge/user/profile');
-
-		let csrfToken = '';
+		cy.getCsrfToken();
 		cy.window()
-			.then((win) => {
-				csrfToken = win.pkp.currentUser.csrfToken;
-			})
 			.then(() => {
-				return cy.createSubmissionWithApi(submission, csrfToken);
+				return cy.createSubmissionWithApi(submission, this.csrfToken);
 			})
 			.then(xhr => {
-				return cy.submitSubmissionWithApi(submission.id, csrfToken);
+				return cy.submitSubmissionWithApi(submission.id, this.csrfToken);
 			});
 
 		cy.logout();

cypress/tests/data/60-content/FpaglieriSubmission.spec.js

@@ -23,15 +23,6 @@ describe('Data suite: Fpaglieri', function() {
 			authorNames: ['Fabio Paglieri'],
 			sectionId: 1,
 			assignedAuthorNames: ['Fabio Paglieri'],
-			authors: [
-				{
-					givenName: 'Fabio',
-					familyName: 'Paglieri',
-					email: '[email protected]',
-					country: 'Italy',
-					affiliation: 'University of Rome'
-				}
-			],
 			files: [
 				{
 					'file': 'dummy.pdf',
@@ -52,19 +43,13 @@ describe('Data suite: Fpaglieri', function() {
 			'country': 'Italy',
 		});
 
-		// Go to page where CSRF token is available
-		cy.visit('/index.php/publicknowledge/user/profile');
-
-		let csrfToken = '';
+		cy.getCsrfToken();
 		cy.window()
-			.then((win) => {
-				csrfToken = win.pkp.currentUser.csrfToken;
-			})
 			.then(() => {
-				return cy.createSubmissionWithApi(submission, csrfToken);
+				return cy.createSubmissionWithApi(submission, this.csrfToken);
 			})
 			.then(xhr => {
-				return cy.submitSubmissionWithApi(submission.id, csrfToken);
+				return cy.submitSubmissionWithApi(submission.id, this.csrfToken);
 			});
 
 		cy.logout();