feat(cypress): Add tests for files sidebar

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

apps/files/src/views/Sidebar.vue

@@ -23,6 +23,7 @@
 <template>
 	<NcAppSidebar v-if="file"
 		ref="sidebar"
+		data-cy-sidebar
 		v-bind="appSidebar"
 		:force-menu="true"
 		@close="close"

cypress/e2e/files/FilesUtils.ts

@@ -28,7 +28,9 @@ export const getActionButtonForFile = (filename: string) => getActionsForFile(fi
 
 export const triggerActionForFile = (filename: string, actionId: string) => {
 	getActionButtonForFile(filename).click({ force: true })
-	cy.get(`[data-cy-files-list-row-action="${CSS.escape(actionId)}"] > button`).should('be.visible').click({ force: true })
+	cy.get(`[data-cy-files-list-row-action="${CSS.escape(actionId)}"] > button`).should('exist')
+	cy.get(`[data-cy-files-list-row-action="${CSS.escape(actionId)}"] > button`).scrollIntoView()
+	cy.get(`[data-cy-files-list-row-action="${CSS.escape(actionId)}"] > button`).click({ force: true })
 }
 
 export const moveFile = (fileName: string, dirPath: string) => {

cypress/e2e/files/files-sidebar.cy.ts

@@ -0,0 +1,98 @@
+/**
+ * @copyright Copyright (c) 2024 Ferdinand Thiessen <opensource@fthiessen.de>
+ *
+ * @author Ferdinand Thiessen <opensource@fthiessen.de>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+import type { User } from '@nextcloud/cypress'
+import { getRowForFile, navigateToFolder, triggerActionForFile } from './FilesUtils'
+
+describe('Files: Sidebar', { testIsolation: true }, () => {
+	let user: User
+	let fileId: number = 0
+
+	beforeEach(() => cy.createRandomUser().then(($user) => {
+		user = $user
+
+		cy.mkdir(user, '/folder')
+		cy.uploadContent(user, new Blob([]), 'text/plain', '/file').then((response) => {
+			fileId = Number.parseInt(response.headers['oc-fileid'] ?? '0')
+		})
+		cy.login(user)
+	}))
+
+	it('opens the sidebar', () => {
+		cy.visit('/apps/files')
+		getRowForFile('file').should('be.visible')
+
+		triggerActionForFile('file', 'details')
+
+		cy.get('[data-cy-sidebar]').should('be.visible')
+	})
+
+	it('changes the current fileid', () => {
+		cy.visit('/apps/files')
+		getRowForFile('file').should('be.visible')
+
+		triggerActionForFile('file', 'details')
+
+		cy.get('[data-cy-sidebar]').should('be.visible')
+		cy.url().should('contain', `apps/files/files/${fileId}`)
+	})
+
+	it('closes the sidebar on delete', () => {
+		cy.visit('/apps/files')
+		getRowForFile('file').should('be.visible')
+
+		// open the sidebar
+		triggerActionForFile('file', 'details')
+		// validate it is open
+		cy.get('[data-cy-sidebar]').should('be.visible')
+		// wait for the sidebar to be settled
+		cy.wait(500)
+
+		triggerActionForFile('file', 'delete')
+		cy.get('[data-cy-sidebar]').should('not.exist')
+	})
+
+	it('changes the fileid on delete', () => {
+		cy.uploadContent(user, new Blob([]), 'text/plain', '/folder/other').then((response) => {
+			const otherFileId = Number.parseInt(response.headers['oc-fileid'] ?? '0')
+			cy.login(user)
+			cy.visit('/apps/files')
+
+			getRowForFile('folder').should('be.visible')
+			navigateToFolder('folder')
+			getRowForFile('other').should('be.visible')
+
+			// open the sidebar
+			triggerActionForFile('other', 'details')
+			// validate it is open
+			cy.get('[data-cy-sidebar]').should('be.visible')
+			cy.url().should('contain', `apps/files/files/${otherFileId}`)
+			// wait for the sidebar to be settled
+			cy.wait(500)
+
+			triggerActionForFile('other', 'delete')
+			cy.get('[data-cy-sidebar]').should('not.exist')
+			// Ensure the URL is changed
+			cy.url().should('not.contain', `apps/files/files/${otherFileId}`)
+		})
+	})
+})

cypress/support/commands.ts

@@ -19,7 +19,9 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
-/* eslint-disable n/no-unpublished-import */
+// eslint-disable-next-line n/no-extraneous-import
+import type { AxiosResponse } from 'axios'
+
 import axios from '@nextcloud/axios'
 import { addCommands, User } from '@nextcloud/cypress'
 import { basename } from 'path'
@@ -33,10 +35,12 @@ addCommands()
 declare global {
 	// eslint-disable-next-line @typescript-eslint/no-namespace
 	namespace Cypress {
+		// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
 		interface Chainable<Subject = any> {
 			/**
 			 * Enable or disable a given user
 			 */
+			// eslint-disable-next-line @typescript-eslint/no-explicit-any
 			enableUser(user: User, enable?: boolean): Cypress.Chainable<Cypress.Response<any>>,
 
 			/**
@@ -49,7 +53,7 @@ declare global {
 			 * Upload a raw content to a given user storage.
 			 * **Warning**: Using this function will reset the previous session
 			 */
-			uploadContent(user: User, content: Blob, mimeType: string, target: string, mtime?: number): Cypress.Chainable<void>,
+			uploadContent(user: User, content: Blob, mimeType: string, target: string, mtime?: number): Cypress.Chainable<AxiosResponse>,
 
 			/**
 			 * Create a new directory
@@ -223,6 +227,7 @@ Cypress.Commands.add('uploadContent', (user, blob, mimeType, target, mtime = und
 					},
 				})
 				cy.log(`Uploaded content as ${fileName}`, response)
+				return response
 			} catch (error) {
 				cy.log('error', error)
 				throw new Error('Unable to process fixture')