Merge pull request #627 from nextcloud-libraries/artonge/feat/save_re…

…store_state

feat: Add save/restore state commands

cypress/e2e/snapshots.cy.ts

@@ -9,7 +9,7 @@ describe('Create a snapshot and a user', function() {
 	let snapshot: string
 
 	it('Create a snapshot', function() {
-		cy.createDBSnapshot().then(_snapshot => {
+		cy.saveState().then(_snapshot => {
 			snapshot = _snapshot
 		})
 	})
@@ -30,7 +30,7 @@ describe('Create a snapshot and a user', function() {
 	})
 
 	it('Restore the snapshot', function() {
-		cy.restoreDBSnapshot(snapshot)
+		cy.restoreState(snapshot)
 	})
 
 	it('Fail login with the user', function() {

lib/commands/index.ts

@@ -6,4 +6,4 @@
 export * from './getNc'
 export * from './sessions'
 export * from './users'
-export * from './snapshots'
+export * from './state'

lib/commands/state.ts

@@ -0,0 +1,42 @@
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import { basename } from 'path'
+
+const getContainerName = function(): Cypress.Chainable<string> {
+	return cy.exec('pwd').then(({ stdout }) => {
+		const app = basename(stdout).replace(' ', '')
+		return cy.wrap(`nextcloud-cypress-tests_${app}`)
+	})
+}
+
+export function saveState(): Cypress.Chainable<string> {
+	const snapshot = Math.random().toString(36).substring(7)
+
+	getContainerName().then(name => {
+		// DB
+		cy.exec(`docker exec --user www-data ${name} cp /var/www/html/data/owncloud.db /var/www/html/data/owncloud.db-${snapshot}`)
+
+		// Data
+		cy.exec(`docker exec --user www-data rm /var/www/html/data/data-${snapshot}.tar`, { failOnNonZeroExit: false })
+		cy.exec(`docker exec --user www-data --workdir /var/www/html/data ${name} tar cf /var/www/html/data/data-${snapshot}.tar .`)
+	})
+
+	cy.log(`Created snapshot ${snapshot}`)
+
+	return cy.wrap(snapshot)
+}
+
+export function restoreState(snapshot: string = 'init') {
+	getContainerName().then(name => {
+		// DB
+		cy.exec(`docker exec --user www-data ${name} cp /var/www/html/data/owncloud.db-${snapshot} /var/www/html/data/owncloud.db`)
+
+		// Data
+		cy.exec(`docker exec --user www-data --workdir /var/www/html/data ${name} rm -vfr $(tar --exclude='*/*' -tf '/var/www/html/data/data-${snapshot}.tar')`)
+		cy.exec(`docker exec --user www-data --workdir /var/www/html/data ${name} tar -xf '/var/www/html/data/data-${snapshot}.tar'`)
+	})
+
+	cy.log(`Restored snapshot ${snapshot}`)
+}

lib/index.ts

@@ -2,9 +2,8 @@
  * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
-import { getNc } from "./commands"
+import { getNc, restoreState, saveState } from "./commands"
 import { login, logout } from "./commands/sessions"
-import { createDBSnapshot, restoreDBSnapshot } from "./commands/snapshots"
 import { User, createRandomUser, createUser, deleteUser, modifyUser, listUsers, getUserData, enableUser } from "./commands/users"
 import type { Selector } from "./selectors"
 
@@ -53,7 +52,7 @@ declare global {
 			 * Query list of users on the Nextcloud instance
 			 *
 			 * **Warning**: Using this function will reset the previous session
-			 * 
+			 *
 			 * @param details Set to true to fetch users with detailed information (default false)
 			 * @return List of user IDs or list of Users (if details was set to true)
 			 */
@@ -71,30 +70,34 @@ declare global {
 
 			/**
 			 * Enable or disable a given user
-			 * 
+			 *
 			 * @param user user whom to enable or disable
 			 * @param enable True to enable, false to disable (default is enable)
 			 */
 			enableUser(user: User, enable?: boolean): Cypress.Chainable<Cypress.Response<any>>
 
 			/**
-			 * 
+			 *
 			 * Query metadata for, and in behalf, of a given user
 			 *
 			 * @param user User whom metadata to query
 			 */
 			getUserData(user: User): Cypress.Chainable<Cypress.Response<any>>
 
 			/**
-			* Create a snapshot of the current database
-			*/
-			createDBSnapshot(snapshot?: string): Cypress.Chainable<string>,
+			 * Create a snapshot of the current DB and data folder state.
+			 *
+			 * @return string the ID of the snapshot
+			 */
+			saveState(): Cypress.Chainable<string>
 
 			/**
-			* Restore a snapshot of the database
-			* Default is the post-setup state
-			*/
-			restoreDBSnapshot(snapshot?: string): Cypress.Chainable,
+			 * Restore a snapshot of the database
+			 * Default is the post-setup state
+			 *
+			 * @param snapshot string the ID of the snapshot
+			 */
+			restoreState(snapshot: string): Cypress.Chainable<void>
 		}
 	}
 }
@@ -117,8 +120,8 @@ export const addCommands = function() {
 	Cypress.Commands.add('modifyUser', modifyUser)
 	Cypress.Commands.add('enableUser', enableUser)
 	Cypress.Commands.add('getUserData', getUserData)
-	Cypress.Commands.add('createDBSnapshot', createDBSnapshot)
-	Cypress.Commands.add('restoreDBSnapshot', restoreDBSnapshot)
+	Cypress.Commands.add('saveState', saveState)
+	Cypress.Commands.add('restoreState', restoreState)
 }
 
 export { User }