check that Undo for latest backup restoration works

Author: VladBrok

src/test/suite/restoreBackups.test.ts

@@ -1,5 +1,4 @@
 import * as assert from "assert";
-import { randomUUID } from "crypto";
 import { afterEach } from "mocha";
 import * as sinon from "sinon";
 import * as vscode from "vscode";
@@ -15,9 +14,9 @@ suite("snippet.restoreBackups", () => {
   });
 
   test("No backups initially", async () => {
-    await getBackups(async (backups: BackupItem[]) => {
-      assert.strictEqual(backups.length, 0);
-    });
+    const backups = await getBackups();
+
+    assert.strictEqual(backups.length, 0);
   });
 
   test("Creates a backup after rename", async () => {
@@ -30,14 +29,13 @@ suite("snippet.restoreBackups", () => {
     await vscode.commands.executeCommand("snippet.renameSnippet", {
       id: snippet.data.id,
     });
+    const backups = await getBackups();
 
-    await getBackups(async (backups: BackupItem[]) => {
-      assert.strictEqual(backups.length, 1);
-      assert.strictEqual(
-        JSON.stringify(backups[0].item.elements),
-        originalElementsJson
-      );
-    });
+    assert.strictEqual(backups.length, 1);
+    assert.strictEqual(
+      JSON.stringify(backups[0].item.elements),
+      originalElementsJson
+    );
   });
 
   test("Creates a backup after delete", async () => {
@@ -50,14 +48,13 @@ suite("snippet.restoreBackups", () => {
     await vscode.commands.executeCommand("snippet.deleteSnippet", {
       id: snippet.data.id,
     });
+    const backups = await getBackups();
 
-    await getBackups(async (backups: BackupItem[]) => {
-      assert.strictEqual(backups.length, 2);
-      assert.strictEqual(
-        JSON.stringify(backups[0].item.elements),
-        originalElementsJson
-      );
-    });
+    assert.strictEqual(backups.length, 2);
+    assert.strictEqual(
+      JSON.stringify(backups[0].item.elements),
+      originalElementsJson
+    );
   });
 
   test("Creates a backup after save", async () => {
@@ -76,16 +73,14 @@ suite("snippet.restoreBackups", () => {
 
     await vscode.commands.executeCommand("snippet.saveSnippet");
     sinon.restore();
+    const backups = await getBackups();
+    await closeAllEditors();
 
-    await getBackups(async (backups: BackupItem[]) => {
-      await closeAllEditors();
-
-      assert.strictEqual(backups.length, 3);
-      assert.strictEqual(
-        JSON.stringify(backups[0].item.elements),
-        originalElementsJson
-      );
-    });
+    assert.strictEqual(backups.length, 3);
+    assert.strictEqual(
+      JSON.stringify(backups[0].item.elements),
+      originalElementsJson
+    );
   });
 
   test("Creates a backup after move", async () => {
@@ -97,19 +92,18 @@ suite("snippet.restoreBackups", () => {
       elements[2].data.id,
       elements[1].data.id
     );
+    const backups = await getBackups();
 
-    await getBackups(async (backups: BackupItem[]) => {
-      assert.strictEqual(backups.length, 4);
-      assert.strictEqual(
-        JSON.stringify(backups[0].item.elements),
-        originalElementsJson
-      );
-    });
+    assert.strictEqual(backups.length, 4);
+    assert.strictEqual(
+      JSON.stringify(backups[0].item.elements),
+      originalElementsJson
+    );
   });
 
   test("Restores backup", async () => {
     sinon.stub(vscode.window, "showInputBox").callsFake(() => {
-      return Promise.resolve(randomUUID());
+      return Promise.resolve("new name");
     });
     sinon.stub(vscode.window, "showInformationMessage").callsFake(() => {
       return Promise.resolve("Ok" as unknown as MessageItem);
@@ -120,19 +114,36 @@ suite("snippet.restoreBackups", () => {
     await vscode.commands.executeCommand("snippet.renameSnippet", {
       id: snippet.data.id,
     });
-
-    let backups: BackupItem[] = [];
-    await getBackups(async (b: BackupItem[]) => {
-      backups = b;
-    }, true);
+    const backups = await getBackups(true);
 
     assert.strictEqual(backups.length, 5);
     assert.strictEqual(getElementsJson(), originalElementsJson);
   });
 
+  test("Undoes backup restoration", async () => {
+    sinon.stub(vscode.window, "showInformationMessage").callsFake(() => {
+      return Promise.resolve("Undo" as unknown as MessageItem);
+    });
+    sinon.stub(vscode.window, "showInputBox").callsFake(() => {
+      return Promise.resolve("new name");
+    });
+    const originalElementsJson = getElementsJson();
+    const snippet = getAnySnippet(originalElementsJson);
+
+    await vscode.commands.executeCommand("snippet.renameSnippet", {
+      id: snippet.data.id,
+    });
+    const elementsAfterChange = getElementsJson();
+    const backups = await getBackups(true);
+
+    assert.strictEqual(backups.length, 6);
+    assert.notStrictEqual(getElementsJson(), originalElementsJson);
+    assert.strictEqual(getElementsJson(), elementsAfterChange);
+  });
+
   test("Saves up to 10 backups", async () => {
     sinon.stub(vscode.window, "showInputBox").callsFake(() => {
-      return Promise.resolve(randomUUID());
+      return Promise.resolve("new name");
     });
     const originalElementsJson = getElementsJson();
     const snippet = getAnySnippet(originalElementsJson);
@@ -142,25 +153,26 @@ suite("snippet.restoreBackups", () => {
         id: snippet.data.id,
       });
     }
+    const backups = await getBackups();
 
-    await getBackups(async (backups: BackupItem[]) => {
-      assert.strictEqual(backups.length, 10);
-    });
+    assert.strictEqual(backups.length, 10);
   });
 });
 
-async function getBackups(
-  callback: (backups: BackupItem[]) => Promise<void>,
-  restoreLatest = false
-): Promise<void> {
-  const showQuickPickStub = sinon.stub(vscode.window, "showQuickPick");
+async function getBackups(restoreLatest = false): Promise<BackupItem[]> {
+  return new Promise((resolve) => {
+    const showQuickPickStub = sinon.stub(vscode.window, "showQuickPick");
 
-  showQuickPickStub.callsFake(async (backups: BackupItem[]) => {
-    await callback(backups);
-    return restoreLatest && backups[0] ? backups[0] : null;
-  });
+    let result: BackupItem[] = [];
+    showQuickPickStub.callsFake(async (backups: BackupItem[]) => {
+      result = backups;
+      return restoreLatest && backups[0] ? backups[0] : null;
+    });
 
-  await vscode.commands.executeCommand("snippet.restoreBackups");
+    vscode.commands.executeCommand("snippet.restoreBackups").then(() => {
+      resolve(result);
+    });
+  });
 }
 
 function getElementsJson(): string {