test(cy): introduce cy.sessionUsers() for users endpoint

Signed-off-by: Max <max@nextcloud.com>
nextcloud · May 28, 2024 · 615c4b3 · 615c4b3
1 parent 169b803
commit 615c4b3
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 33 deletions.
diff --git a/cypress/e2e/api/UsersApi.spec.js b/cypress/e2e/api/UsersApi.spec.js
@@ -37,7 +37,7 @@ describe('The user mention API', function() {
 		cy.login(user)
 		cy.uploadTestFile('test.md').as('fileId')
 			.then(cy.createTextSession).as('connection')
-		cy.getRequestToken().as('requesttoken')
+		cy.getRequestToken()
 	})
 
 	afterEach(function() {
@@ -51,53 +51,29 @@ describe('The user mention API', function() {
 	})
 
 	it('fetches users with valid session', function() {
-		const body = {
-			documentId: this.connection.document.id,
-			sessionId: this.connection.session.id,
-			sessionToken: this.connection.session.token,
-			requesttoken: this.requesttoken,
-		}
-		const requestData = {
-			method: 'POST',
-			url: '/apps/text/api/v1/users',
-			body,
-			failOnStatusCode: false,
-		}
-		const invalidRequestData = { ...requestData }
 
-		cy.request(requestData).then(({ status }) => {
+		cy.sessionUsers(this.connection).then(({ status }) => {
 			expect(status).to.eq(200)
-
-			invalidRequestData.body = {
-				...requestData.body,
-				sessionToken: 'invalid',
-			}
 		})
 
-		cy.request(invalidRequestData).then(({ status }) => {
+		cy.sessionUsers(this.connection, { sessionToken: 'invalid' })
+			.then(({ status }) => {
 			expect(status).to.eq(403)
-			invalidRequestData.body = {
-				...requestData.body,
-				sessionId: 0,
-			}
 		})
 
-		cy.request(invalidRequestData).then(({ status }) => {
+		cy.sessionUsers(this.connection, { sessionId: 0 })
+			.then(({ status }) => {
 			expect(status).to.eq(403)
-
-			invalidRequestData.body = {
-				...requestData.body,
-				documentId: 0,
-			}
 		})
 
-		cy.request(invalidRequestData).then(({ status }) => {
+		cy.sessionUsers(this.connection, { documentId: 0 })
+			.then(({ status }) => {
 			expect(status).to.eq(403)
 		})
 
 		cy.then(() => this.connection.close())
 
-		cy.request(requestData).then(({ status, body }) => {
+		cy.sessionUsers(this.connection).then(({ status }) => {
 			expect(status).to.eq(403)
 		})
 	})

diff --git a/cypress/support/sessions.js b/cypress/support/sessions.js
@@ -88,6 +88,22 @@ Cypress.Commands.add('failToSave', (connection, options = { version: 0 }) => {
 		}, (err) => err.response)
 })
 
+Cypress.Commands.add('sessionUsers', function(connection, bodyOptions = {}) {
+	const body = {
+		documentId: connection.document.id,
+		sessionId: connection.session.id,
+		sessionToken: connection.session.token,
+		requesttoken: this.requesttoken,
+		...bodyOptions,
+	}
+	cy.request({
+		method: 'POST',
+		url: '/apps/text/api/v1/users',
+		body,
+		failOnStatusCode: false,
+	})
+})
+
 // Used to test for race conditions between the last push and the close request
 Cypress.Commands.add('pushAndClose', ({ connection, steps, version, awareness = '' }) => {
 	cy.log('Race between push and close')