test: add integration test for file recovery

abose · abose · commit 44bcfa15c8db · 2023-05-18T15:44:33.000+05:30
diff --git a/src/extensions/default/NavigationAndHistory/FileRecovery.js b/src/extensions/default/NavigationAndHistory/FileRecovery.js
@@ -65,7 +65,7 @@ define(function (require, exports, module) {
     EventManager.registerEventHandler("ph-recovery", exports);
 
     const BACKUP_INTERVAL_MS = 5000;
-    const sessionRestoreDir = FileSystem.getDirectoryForPath(
+    let sessionRestoreDir = FileSystem.getDirectoryForPath(
         path.normalize(NativeApp.getApplicationSupportDirectory() + "/sessionRestore"));
 
     const trackedProjects = {};
@@ -376,19 +376,29 @@ define(function (require, exports, module) {
         }
     }
 
+    function initWith(scanIntervalMs, restoreDir) {
+        ProjectManager.on(ProjectManager.EVENT_AFTER_PROJECT_OPEN, projectOpened);
+        ProjectManager.on(ProjectManager.EVENT_PROJECT_BEFORE_CLOSE, beforeProjectClosed);
+        exports.on("restoreProject", restoreBtnClicked);
+        sessionRestoreDir = restoreDir;
+        createDir(sessionRestoreDir);
+        setInterval(changeScanner, scanIntervalMs);
+        let currentProjectRoot = ProjectManager.getProjectRoot();
+        if(currentProjectRoot) {
+            // At boot, the startup project may be opened and we may never get the projectOpened event triggered
+            // for the startup project. So we call manually.
+            projectOpened(null, currentProjectRoot);
+        }
+    }
+
     function init() {
         if(!window.testEnvironment){
-            ProjectManager.on(ProjectManager.EVENT_AFTER_PROJECT_OPEN, projectOpened);
-            ProjectManager.on(ProjectManager.EVENT_PROJECT_BEFORE_CLOSE, beforeProjectClosed);
-            exports.on("restoreProject", restoreBtnClicked);
-            createDir(sessionRestoreDir);
-            setInterval(changeScanner, BACKUP_INTERVAL_MS);
-            let currentProjectRoot = ProjectManager.getProjectRoot();
-            if(currentProjectRoot) {
-                // At boot, the startup project may be opened and we may never get the projectOpened event triggered
-                // for the startup project. So we call manually.
-                projectOpened(null, currentProjectRoot);
-            }
+            initWith(BACKUP_INTERVAL_MS, sessionRestoreDir);
+        } else {
+            // this is a test environment, expose functions to test
+            exports.getProjectRestoreRoot = getProjectRestoreRoot;
+            exports.initWith = initWith;
+            window._FileRecoveryExtensionForTests = exports;
         }
     }
 
diff --git a/src/extensions/default/NavigationAndHistory/html/recovery-template.html b/src/extensions/default/NavigationAndHistory/html/recovery-template.html
@@ -3,7 +3,7 @@
   <br />
   <button
     style="float: right; margin-right: 6px"
-    class="btn btn-mini remove primary"
+    class="btn btn-mini remove primary file-recovery-button"
     data-project="{{PROJECT_TO_RECOVER}}"
     onclick="EventManager.triggerEvent('ph-recovery', 'restoreProject', this.getAttribute('data-project'))"
   >
diff --git a/src/extensions/default/NavigationAndHistory/integ-tests.js b/src/extensions/default/NavigationAndHistory/integ-tests.js
@@ -0,0 +1,179 @@
+/*
+ * GNU AGPL-3.0 License
+ *
+ * Copyright (c) 2021 - present core.ai . All rights reserved.
+ * Original work Copyright (c) 2012 - 2021 Adobe Systems Incorporated. All rights reserved.
+ *
+ * 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 https://opensource.org/licenses/AGPL-3.0.
+ *
+ */
+
+/*global describe, it, expect, beforeAll, afterAll, awaitsForDone, beforeEach, awaits, awaitsFor */
+
+define(function (require, exports, module) {
+    // Recommended to avoid reloading the integration test window Phoenix instance for each test.
+
+    const SpecRunnerUtils     = brackets.getModule("spec/SpecRunnerUtils");
+
+    describe("integration:FileRecovery integration tests", function () {
+
+        const testPathOriginal = SpecRunnerUtils.getTestPath("/spec/ProjectManager-test-files");
+        const testPath = SpecRunnerUtils.getTestRoot() + "/navigationTests/";
+        const tempRestorePath = SpecRunnerUtils.getTestRoot() + "/navigationTestsRestore/";
+
+        let FileViewController,     // loaded from brackets.test
+            ProjectManager,         // loaded from brackets.test;
+            CommandManager,
+            Commands,
+            testWindow,
+            EditorManager,
+            MainViewManager,
+            brackets,
+            FileSystem,
+            $;
+
+
+        async function deletePath(pathToDel) {
+            if(!pathToDel.startsWith("/")) {
+                pathToDel = testPath + pathToDel;
+            }
+            let promise = SpecRunnerUtils.deletePath(pathToDel, true);
+            await awaitsForDone(promise, "Remove " + pathToDel, 5000);
+        }
+
+        async function loadTestWindow() {
+            testWindow = await SpecRunnerUtils.createTestWindowAndRun();
+            brackets            = testWindow.brackets;
+            $                   = testWindow.$;
+            FileViewController  = brackets.test.FileViewController;
+            ProjectManager      = brackets.test.ProjectManager;
+            CommandManager      = brackets.test.CommandManager;
+            Commands            = brackets.test.Commands;
+            EditorManager       = brackets.test.EditorManager;
+            MainViewManager     = brackets.test.MainViewManager;
+            FileSystem          = brackets.test.FileSystem;
+            await awaitsForDone(SpecRunnerUtils.copyPath(testPathOriginal, testPath), "copy temp files");
+            await SpecRunnerUtils.loadProjectInTestWindow(testPath);
+        }
+
+        beforeAll(async function () {
+            await loadTestWindow();
+        }, 30000);
+
+        afterAll(async function () {
+            FileViewController  = null;
+            ProjectManager      = null;
+            testWindow = null;
+            brackets = null;
+            await deletePath(testPath);
+            await deletePath(tempRestorePath);
+            await SpecRunnerUtils.closeTestWindow();
+        });
+
+        beforeEach(async function () {
+            await deletePath(testPath);
+            await deletePath(tempRestorePath);
+            await awaitsForDone(SpecRunnerUtils.copyPath(testPathOriginal, testPath), "copy temp files");
+        });
+
+        async function closeSession() {
+            await awaitsForDone(CommandManager.execute(Commands.FILE_CLOSE_ALL, { _forceClose: true }),
+                "closing all file");
+        }
+
+        async function openFile(relativePath) {
+            await awaitsForDone(
+                FileViewController.openAndSelectDocument(
+                    testPath + relativePath,
+                    FileViewController.PROJECT_MANAGER
+                ));
+        }
+
+        function isFileOpen(relativePath) {
+            const fullPath = testPath + relativePath;
+            let allOpenFiles = MainViewManager.getAllOpenFiles();
+            for(let file of allOpenFiles){
+                if(file.fullPath === fullPath){
+                    return true;
+                }
+            }
+            return false;
+        }
+
+        async function initFileRestorer(fileToOpen) {
+            await openFile(fileToOpen);
+            expect(isFileOpen(fileToOpen)).toBeTrue();
+            expect(testWindow._FileRecoveryExtensionForTests).exists;
+            expect(await SpecRunnerUtils.pathExists(tempRestorePath, true)).toBeFalse();
+            testWindow._FileRecoveryExtensionForTests.initWith(100,
+                FileSystem.getDirectoryForPath(tempRestorePath));
+            await SpecRunnerUtils.waitTillPathExists(tempRestorePath);
+
+        }
+
+        it("Should create restore folders and backup files", async function () {
+            await initFileRestorer("file.js");
+            let projectRestorePath = testWindow._FileRecoveryExtensionForTests.getProjectRestoreRoot(testPath);
+
+            // now edit a file so that its backup is created
+            let editor = EditorManager.getActiveEditor();
+            editor.document.setText("hello");
+            await SpecRunnerUtils.waitTillPathExists(projectRestorePath.fullPath, true);
+            await SpecRunnerUtils.waitTillPathExists(projectRestorePath.fullPath + "file.js", false);
+            await closeSession();
+        });
+
+        it("Should saving files remove file restore folder", async function () {
+            await initFileRestorer("toDelete1/file.js");
+            let projectRestorePath = testWindow._FileRecoveryExtensionForTests.getProjectRestoreRoot(testPath);
+
+            // now edit a file so that its backup is created
+            let editor = EditorManager.getActiveEditor();
+            editor.document.setText("hello");
+            await SpecRunnerUtils.waitTillPathExists(projectRestorePath.fullPath + "toDelete1/file.js", false);
+            await awaitsForDone(CommandManager.execute(Commands.FILE_SAVE_ALL), "saving all file");
+            await SpecRunnerUtils.waitTillPathNotExists(projectRestorePath.fullPath + "toDelete1/file.js", false);
+            await closeSession();
+        });
+
+        it("Should show restore notification and restore if there is anything to restore", async function () {
+            await initFileRestorer("toDelete1/file.js");
+            let projectRestorePath = testWindow._FileRecoveryExtensionForTests.getProjectRestoreRoot(testPath);
+
+            // now edit a file so that its backup is created
+            const unsavedText = "hello" + Math.random();
+            let editor = EditorManager.getActiveEditor();
+            editor.document.setText(unsavedText);
+            await SpecRunnerUtils.waitTillPathExists(projectRestorePath.fullPath + "toDelete1/file.js", false);
+
+            // backup is now present, reload the project
+            await SpecRunnerUtils.closeTestWindow();
+            await loadTestWindow();
+            testWindow._FileRecoveryExtensionForTests.initWith(100,
+                FileSystem.getDirectoryForPath(tempRestorePath));
+            await awaitsFor(()=>{
+                return $(".file-recovery-button").length === 1;
+            }, "waiting for restore notification", 5000);
+
+            // now press the recover button to start the recovery
+            $(".file-recovery-button").click();
+            // check if the file is recovered
+            await awaitsFor(()=>{
+                editor = EditorManager.getActiveEditor();
+                return editor && editor.document.getText() === unsavedText;
+            }, "waiting for restore notification", 5000);
+            await closeSession();
+        }, 10000);
+    });
+});
diff --git a/src/extensions/default/NavigationAndHistory/unittests.js b/src/extensions/default/NavigationAndHistory/unittests.js
@@ -0,0 +1,26 @@
+/*
+ * GNU AGPL-3.0 License
+ *
+ * Copyright (c) 2021 - present core.ai . All rights reserved.
+ * Original work Copyright (c) 2012 - 2021 Adobe Systems Incorporated. All rights reserved.
+ *
+ * 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 https://opensource.org/licenses/AGPL-3.0.
+ *
+ */
+
+/*global describe, it, expect, beforeEach, afterEach */
+
+define(function (require, exports, module) {
+    require("integ-tests");
+});
diff --git a/test/spec/SpecRunnerUtils.js b/test/spec/SpecRunnerUtils.js
@@ -19,7 +19,7 @@
  *
  */
 
-/*global jsPromise, jasmine, expect, beforeEach, awaitsFor,awaitsForDone, spyOn, KeyboardEvent, waits */
+/*global jsPromise, jasmine, expect, beforeEach, awaitsFor,awaitsForDone, spyOn, KeyboardEvent, waits, awaits */
 
 define(function (require, exports, module) {
 
@@ -1203,6 +1203,34 @@ define(function (require, exports, module) {
         return 0;
     }
 
+    function pathExists(pathToCheck, isFolder = true) {
+        let entry = isFolder ? FileSystem.getDirectoryForPath(pathToCheck)
+            : FileSystem.getFileForPath(pathToCheck);
+        return entry.existsAsync(pathToCheck);
+    }
+
+    async function waitTillPathExists(pathToCheck, isFolder = true, timeout = 2000, pollingInterval = 10) {
+        for(let i=0; i<timeout/pollingInterval; i++){
+            let exists = await pathExists(pathToCheck, isFolder);
+            if(exists){
+                return true;
+            }
+            await awaits(pollingInterval);
+        }
+        throw "Path exist check failed: " + pathToCheck;
+    }
+
+    async function waitTillPathNotExists(pathToCheck, isFolder = true, timeout = 2000, pollingInterval = 10) {
+        for(let i=0; i<timeout/pollingInterval; i++){
+            let exists = await pathExists(pathToCheck, isFolder);
+            if(!exists){
+                return true;
+            }
+            await awaits(pollingInterval);
+        }
+        throw "Path not exist check failed: " + pathToCheck;
+    }
+
     // "global" custom matchers
     function editorHasCursorPosition(editor, line, ch, ignoreSelection) {
         let selection = editor.getSelection();
@@ -1253,6 +1281,9 @@ define(function (require, exports, module) {
     exports.copyFileEntry                   = copyFileEntry;
     exports.copyPath                        = copyPath;
     exports.deletePath                      = deletePath;
+    exports.pathExists                      = pathExists;
+    exports.waitTillPathExists              = waitTillPathExists;
+    exports.waitTillPathNotExists           = waitTillPathNotExists;
     exports.getTestWindow                   = getTestWindow;
     exports.simulateKeyEvent                = simulateKeyEvent;
     exports.setLoadExtensionsInTestWindow   = setLoadExtensionsInTestWindow;

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`<br />`
`4`	`4`	`<button`
`5`	`5`	`style="float: right; margin-right: 6px"`
`6`		`- class="btn btn-mini remove primary"`
	`6`	`+ class="btn btn-mini remove primary file-recovery-button"`
`7`	`7`	`data-project="{{PROJECT_TO_RECOVER}}"`
`8`	`8`	`onclick="EventManager.triggerEvent('ph-recovery', 'restoreProject', this.getAttribute('data-project'))"`
`9`	`9`	`>`