Add UI tests for nano and vim commands (#60)

* Add UI tests for nano and vim commands

* Linting

* Update visual image snapshot

Author: ianthomas23

ui-tests/cockle-config-in.json

@@ -0,0 +1,6 @@
+{
+  "packages": {
+    "nano": {},
+    "vim": {}
+  }
+}

ui-tests/tests/command.spec.ts

@@ -0,0 +1,129 @@
+import { expect, test } from '@jupyterlab/galata';
+
+import { ContentsHelper } from './utils/contents';
+import { TERMINAL_SELECTOR, WAIT_MS, inputLine } from './utils/misc';
+
+// Long wait such as for starting/stopping a complex WebAssembly command.
+export const LONG_WAIT_MS = 300;
+
+test.describe('individual command', () => {
+  test.beforeEach(async ({ page }) => {
+    await page.goto();
+    await page.waitForTimeout(WAIT_MS);
+
+    // Overwrite the (read-only) page.contents with our own ContentsHelper.
+    // @ts-ignore
+    page.contents = new ContentsHelper(page);
+
+    await page.menu.clickMenuItem('File>New>Terminal');
+    await page.locator(TERMINAL_SELECTOR).waitFor();
+    await page.locator('div.xterm-screen').click(); // sets focus for keyboard input
+    await page.waitForTimeout(WAIT_MS);
+  });
+
+  test.describe('nano', () => {
+    const stdinOptions = ['sab', 'sw'];
+    stdinOptions.forEach(stdinOption => {
+      test(`should create new file using ${stdinOption} for stdin`, async ({
+        page
+      }) => {
+        await inputLine(page, `cockle-config -s ${stdinOption}`);
+        await page.waitForTimeout(WAIT_MS);
+
+        await inputLine(page, 'nano a.txt');
+        await page.waitForTimeout(LONG_WAIT_MS);
+
+        // Insert new characters.
+        await page.keyboard.type('mnopqrst');
+
+        // Save and quit.
+        await page.keyboard.press('Control+x');
+        await page.keyboard.type('y');
+        await page.keyboard.press('Enter');
+        await page.waitForTimeout(LONG_WAIT_MS);
+
+        const outputFile = await page.contents.getContentMetadata('a.txt');
+        expect(outputFile?.content).toEqual('mnopqrst\n');
+      });
+
+      test(`should delete data from file using ${stdinOption} for stdin`, async ({
+        page
+      }) => {
+        await inputLine(page, `cockle-config -s ${stdinOption}`);
+        await page.waitForTimeout(WAIT_MS);
+
+        // Prepare file to delete from.
+        await inputLine(page, 'echo mnopqrst > b.txt');
+        await page.waitForTimeout(WAIT_MS);
+
+        await inputLine(page, 'nano b.txt');
+        await page.waitForTimeout(LONG_WAIT_MS);
+
+        // Delete first 4 characters.
+        for (let i = 0; i < 4; i++) {
+          await page.keyboard.press('Delete');
+        }
+
+        // Save and quit.
+        await page.keyboard.press('Control+x');
+        await page.keyboard.type('y');
+        await page.keyboard.press('Enter');
+        await page.waitForTimeout(LONG_WAIT_MS);
+
+        const outputFile = await page.contents.getContentMetadata('b.txt');
+        expect(outputFile?.content).toEqual('qrst\n');
+      });
+    });
+  });
+
+  test.describe('vim', () => {
+    const stdinOptions = ['sab', 'sw'];
+    stdinOptions.forEach(stdinOption => {
+      test(`should create new file using ${stdinOption} for stdin`, async ({
+        page
+      }) => {
+        await inputLine(page, `cockle-config -s ${stdinOption}`);
+        await page.waitForTimeout(WAIT_MS);
+
+        await inputLine(page, 'vim c.txt');
+        await page.waitForTimeout(LONG_WAIT_MS);
+
+        // Insert new characters.
+        await page.keyboard.type('iabcdefgh');
+
+        // Save and quit.
+        await page.keyboard.press('Escape');
+        await inputLine(page, ':wq');
+        await page.waitForTimeout(LONG_WAIT_MS);
+
+        const outputFile = await page.contents.getContentMetadata('c.txt');
+        expect(outputFile?.content).toEqual('abcdefgh\n');
+      });
+
+      test(`should delete data from file using ${stdinOption} for stdin`, async ({
+        page
+      }) => {
+        await inputLine(page, `cockle-config -s ${stdinOption}`);
+        await page.waitForTimeout(WAIT_MS);
+
+        // Prepare file to delete from.
+        await inputLine(page, 'echo abcdefgh > d.txt');
+        await page.waitForTimeout(WAIT_MS);
+
+        await inputLine(page, 'vim d.txt');
+        await page.waitForTimeout(LONG_WAIT_MS);
+
+        // Delete first 4 characters.
+        await page.keyboard.type('d4l');
+
+        // Save and quit.
+        await page.keyboard.press('Escape');
+        await inputLine(page, ':wq');
+        await page.waitForTimeout(LONG_WAIT_MS);
+
+        const outputFile = await page.contents.getContentMetadata('d.txt');
+        expect(outputFile?.content).toEqual('efgh\n');
+      });
+    });
+  });
+});