feat: Add save/restore state commands

Signed-off-by: Louis Chemineau <[email protected]>

Author: artonge

lib/commands/index.ts

@@ -23,3 +23,4 @@
 export * from './getNc'
 export * from './sessions'
 export * from './users'
+export * from './state'

lib/commands/state.ts

@@ -0,0 +1,47 @@
+/**
+ * @copyright 2024 Louis Chmn <[email protected]>
+ *
+ * @author Louis Chmn <[email protected]>
+ *
+ * @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/>.
+ *
+ */
+
+export function saveState(): Cypress.Chainable<string> {
+	const snapshot = Math.random().toString(36).substring(7)
+
+	// DB
+	cy.exec(`docker exec --user www-data nextcloud-cypress-tests_groupfolders 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 nextcloud-cypress-tests_groupfolders tar cf /var/www/html/data/data-${snapshot}.tar .`)
+
+	cy.log(`Created snapshot ${snapshot}`)
+
+	return cy.wrap(snapshot)
+}
+
+export function restoreState(snapshot: string = 'init') {
+	// DB
+	cy.exec(`docker exec --user www-data nextcloud-cypress-tests_groupfolders 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 nextcloud-cypress-tests_groupfolders rm -vfr $(tar --exclude='*/*' -tf '/var/www/html/data/data-${snapshot}.tar')`)
+	cy.exec(`docker exec --user www-data --workdir /var/www/html/data nextcloud-cypress-tests_groupfolders tar -xf '/var/www/html/data/data-${snapshot}.tar'`)
+
+	cy.log(`Restored snapshot ${snapshot}`)
+}

lib/index.ts

@@ -19,7 +19,7 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
-import { getNc } from "./commands"
+import { getNc, restoreState, saveState } from "./commands"
 import { login, logout } from "./commands/sessions"
 import { User, createRandomUser, createUser, deleteUser, modifyUser, listUsers, getUserData, enableUser } from "./commands/users"
 import type { Selector } from "./selectors"
@@ -69,7 +69,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)
 			 */
@@ -87,18 +87,35 @@ 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>>
+			getUserData(user: User): Cypress.Chainable<Cypress.Response<any>>
+
+			/**
+			 *
+			 * Saves the DB and data folder state.
+			 *
+			 * @return string the ID of the snapshot
+			 */
+			saveState(): Cypress.Chainable<string>
+
+			/**
+			 *
+			 * Restores the DB and data folder state.
+			 *
+			 * @param snapshot string the ID of the snapshot
+			 */
+			restoreState(snapshot: string): Cypress.Chainable<void>
 		}
 	}
 }
@@ -121,6 +138,8 @@ export const addCommands = function() {
 	Cypress.Commands.add('modifyUser', modifyUser)
 	Cypress.Commands.add('enableUser', enableUser)
 	Cypress.Commands.add('getUserData', getUserData)
+	Cypress.Commands.add('saveState', saveState)
+	Cypress.Commands.add('restoreState', restoreState)
 }
 
 export { User }