From e4760a04163c8e403bfb321a1da33ff37228dc4e Mon Sep 17 00:00:00 2001
From: Shin'ya Ueoka <ueokande@i-beam.org>
Date: Tue, 16 Apr 2019 21:16:47 +0900
Subject: [PATCH] Add e2e tests for completions

---
 QA.md                          |  21 +---
 e2e/completion_buffers.test.js | 214 +++++++++++++++++++++++++++++++++
 e2e/completion_open.test.js    | 132 ++++++++++++++++++++
 e2e/lib/Console.js             |  33 +++++
 4 files changed, 381 insertions(+), 19 deletions(-)
 create mode 100644 e2e/completion_buffers.test.js
 create mode 100644 e2e/completion_open.test.js
 create mode 100644 e2e/lib/Console.js
diff --git a/QA.md b/QA.md
index ec20811..5272597 100644
--- a/QA.md
+++ b/QA.md
@@ -16,6 +16,7 @@ The behaviors of the console are tested in [Console section](#consoles).
 - [ ] Add-on is enabled and disabled by clicking the indicator on the tool bar.
 - [ ] The indicator changed on selected tab changed (changes add-on enabled)
 - [ ] Notify to users on add-on updated at first time.
+- [ ] Reopen tab on *only current window* by <kbd>u</kbd>
 
 ### Following links
 
@@ -26,6 +27,7 @@ The behaviors of the console are tested in [Console section](#consoles).
 - [ ] Select link and open it in new tab in `<iframe>`/`<frame`> on following by <kbd>F</kbd>
 - [ ] Select link and open it in `<area>` tags, for <kbd>f</kbd> and <kbd>F</kbd>
 - [ ] Open new tab in background by `"background": true`
+- [ ] Opened tabs is in child on Tree Style Tab
 
 ### Consoles
 
@@ -37,36 +39,17 @@ The behaviors of the console are tested in [Console section](#consoles).
 
 #### History and search engines
 
-- [ ] `open<SP>`: show all engines and some history items
-- [ ] `open g`: complete search engines starts with `g` and matched with keywords `g`
-- [ ] `open foo bar`: complete history items matched with keywords `foo` and `bar`
 - [ ] `set `: show prperties starts with keywords
-- [ ] The completions shows histories, search engines, and bookmarks.
-- [ ] also `tabopen` and `winopen`
-- shortening commands such as `o` are not test in this release
 - [ ] Complete commands matched with input keywords in the prefix.
 
-#### Buffer command
-
-- [ ] `buffer<SP>`: show all opened tabs in completion
-- [ ] `buffer x`: show tabs which has title and URL matches with `x`
-- [ ] shows tab index and marks
-
-#### Buffer command
-
-- [ ] `bdelete`, `bdeletes`: show tabs excluding pinned tabs
-- [ ] `bdelete!`, `bdeletes!`: show tabs including pinned tabs
-
 #### Misc
 
 - [ ] Select next item by <kbd>Tab</kbd> and previous item by <kbd>Shift</kbd>+<kbd>Tab</kbd>
-- [ ] Reopen tab on *only current window* by <kbd>u</kbd>
 
 ### Properties
 
 - [ ] Configure custom hint character by `:set hintchars=012345678`
 - [ ] Configure custom hint character by settings `"hintchars": "012345678"` in add-on preferences
-- [ ] Opened tabs is in child on Tree Style Tab
 
 - [ ] Smooth scroll by `:set smoothscroll`
 - [ ] Non-smooth scroll by `:set nosmoothscroll`
diff --git a/e2e/completion_buffers.test.js b/e2e/completion_buffers.test.js
new file mode 100644
index 0000000..de26747
--- /dev/null
+++ b/e2e/completion_buffers.test.js
@@ -0,0 +1,214 @@
+const express = require('express');
+const lanthan = require('lanthan');
+const path = require('path');
+const assert = require('assert');
+const eventually = require('./eventually');
+const settings = require('./settings');
+const Console = require('./lib/Console');
+
+const Key = lanthan.Key;
+
+const newApp = () => {
+
+  let app = express();
+  app.get('/*', (req, res) => {
+    res.send(`<!DOCTYPEhtml>
+<html lang="en">
+  <head>
+    <title>title_${req.path.slice(1)}</title>
+  </head>
+  <body><h1>home</h1></body>
+</html">`);
+  });
+  return app;
+};
+
+describe("completion on buffer/bdelete/bdeletes", () => {
+  const port = 12321;
+  let http;
+  let firefox;
+  let session;
+  let browser;
+  let body;
+
+  before(async() => {
+    firefox = await lanthan.firefox({
+      spy: path.join(__dirname, '..'),
+      builderf: (builder) => {
+        builder.addFile('build/settings.js');
+      },
+    });
+    session = firefox.session;
+    browser = firefox.browser;
+    http = newApp().listen(port);
+
+    await browser.storage.local.set({
+      settings,
+    });
+  });
+
+  after(async() => {
+    http.close();
+    if (firefox) {
+      await firefox.close();
+    }
+  });
+
+  beforeEach(async() => {
+    let tabs = await browser.tabs.query({});
+    for (let tab of tabs.slice(1)) {
+      await browser.tabs.remove(tab.id);
+    }
+
+    await browser.tabs.update(tabs[0].id, { url: `http://127.0.0.1:${port}/site1`, pinned: true });
+    await browser.tabs.create({ url: `http://127.0.0.1:${port}/site2`, pinned: true })
+    for (let i = 3; i <= 5; ++i) {
+      await browser.tabs.create({ url: `http://127.0.0.1:${port}/site${i}` })
+    }
+
+    await eventually(async() => {
+      let handles = await session.getWindowHandles();
+      assert.equal(handles.length, 5);
+      await session.switchToWindow(handles[2]);
+      await session.findElementByCSS('iframe');
+    });
+    body = await session.findElementByCSS('body');
+
+    await new Promise((resolve) => setTimeout(resolve, 100));
+  });
+
+  it('should all tabs by "buffer" command with empty params', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('buffer ');
+
+    await eventually(async() => {
+      let items = await c.getCompletions();
+      assert.equal(items.length, 6);
+      assert.deepEqual(items[0], { type: 'title', text: 'Buffers' });
+      assert(items[1].text.startsWith('1:'));
+      assert(items[2].text.startsWith('2:'));
+      assert(items[3].text.startsWith('3:'));
+      assert(items[4].text.startsWith('4:'));
+      assert(items[5].text.startsWith('5:'));
+
+      assert(items[3].text.includes('%'));
+      assert(items[5].text.includes('#'));
+    });
+  })
+
+  it('should filter items with URLs by keywords on "buffer" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('buffer title_site2');
+
+    await eventually(async() => {
+      let items = await c.getCompletions();
+      assert.deepEqual(items[0], { type: 'title', text: 'Buffers' });
+      assert(items[1].text.startsWith('2:'));
+      assert(items[1].text.includes('title_site2'));
+      assert(items[1].text.includes(`http://127.0.0.1:${port}/site2`));
+    });
+  })
+
+  it('should filter items with titles by keywords on "buffer" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('buffer /site2');
+
+    await eventually(async() => {
+      let items = await c.getCompletions();
+      assert.deepEqual(items[0], { type: 'title', text: 'Buffers' });
+      assert(items[1].text.startsWith('2:'));
+    });
+  })
+
+  it('should show one item by number on "buffer" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('buffer 2');
+
+    await eventually(async() => {
+      let items = await c.getCompletions();
+      assert.equal(items.length, 2);
+      assert.deepEqual(items[0], { type: 'title', text: 'Buffers' });
+      assert(items[1].text.startsWith('2:'));
+    });
+  })
+
+  it('should show unpinned tabs "bdelete" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('bdelete site');
+
+    await eventually(async() => {
+      let items = await c.getCompletions();
+      assert.equal(items.length, 4);
+      assert(items[1].text.includes('site3'));
+      assert(items[2].text.includes('site4'));
+      assert(items[3].text.includes('site5'));
+    });
+  })
+
+  it('should show unpinned tabs "bdeletes" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('bdelete site');
+
+    await eventually(async() => {
+      let items = await c.getCompletions();
+      assert.equal(items.length, 4);
+      assert(items[1].text.includes('site3'));
+      assert(items[2].text.includes('site4'));
+      assert(items[3].text.includes('site5'));
+    });
+  })
+
+  it('should show both pinned and unpinned tabs "bdelete!" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('bdelete! site');
+
+    await eventually(async() => {
+      let items = await c.getCompletions();
+      assert.equal(items.length, 6);
+      assert(items[1].text.includes('site1'));
+      assert(items[2].text.includes('site2'));
+      assert(items[3].text.includes('site3'));
+      assert(items[4].text.includes('site4'));
+      assert(items[5].text.includes('site5'));
+    });
+  })
+
+  it('should show both pinned and unpinned tabs "bdeletes!" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('bdeletes! site');
+
+    await eventually(async() => {
+      let items = await c.getCompletions();
+      assert.equal(items.length, 6);
+      assert(items[1].text.includes('site1'));
+      assert(items[2].text.includes('site2'));
+      assert(items[3].text.includes('site3'));
+      assert(items[4].text.includes('site4'));
+      assert(items[5].text.includes('site5'));
+    });
+  })
+});
diff --git a/e2e/completion_open.test.js b/e2e/completion_open.test.js
new file mode 100644
index 0000000..59d6b83
--- /dev/null
+++ b/e2e/completion_open.test.js
@@ -0,0 +1,132 @@
+const express = require('express');
+const lanthan = require('lanthan');
+const path = require('path');
+const assert = require('assert');
+const eventually = require('./eventually');
+const settings = require('./settings');
+const Console = require('./lib/Console');
+
+const Key = lanthan.Key;
+
+const newApp = () => {
+
+  let app = express();
+  app.get('/', (req, res) => {
+    res.send(`<!DOCTYPEhtml>
+<html lang="en">
+  <body>ok</body>
+</html">`);
+  });
+  return app;
+};
+
+describe("completion on open/tabopen/winopen commands", () => {
+  const port = 12321;
+  let http;
+  let firefox;
+  let session;
+  let browser;
+  let body;
+
+  before(async() => {
+    firefox = await lanthan.firefox({
+      spy: path.join(__dirname, '..'),
+      builderf: (builder) => {
+        builder.addFile('build/settings.js');
+      },
+    });
+    session = firefox.session;
+    browser = firefox.browser;
+    http = newApp().listen(port);
+
+    await browser.storage.local.set({
+      settings,
+    });
+    
+    // Add item into hitories
+    await session.navigateTo(`https://i-beam.org`);
+  });
+
+  after(async() => {
+    http.close();
+    if (firefox) {
+      await firefox.close();
+    }
+  });
+
+  beforeEach(async() => {
+    await session.navigateTo(`http://127.0.0.1:${port}`);
+    body = await session.findElementByCSS('body');
+  });
+
+  it('should show completions from search engines, bookmarks, and histories by "open" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('open ');
+
+    await eventually(async() => {
+      let completions = await c.getCompletions();
+      assert(completions.find(x => x.type === 'title' && x.text === 'Search Engines'));
+      assert(completions.find(x => x.type === 'title' && x.text === 'Bookmarks'));
+      assert(completions.find(x => x.type === 'title' && x.text === 'History'));
+    });
+  });
+
+  it('should filter items with URLs by keywords on "open" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('open https://');
+
+    await eventually(async() => {
+      let completions = await c.getCompletions();
+      let items = completions.filter(x => x.type === 'item').map(x => x.text);
+      assert(items.every(x => x.includes('https://')));
+    });
+  })
+
+  it('should filter items with titles by keywords on "open" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('open getting');
+
+    await eventually(async() => {
+      let completions = await c.getCompletions();
+      let items = completions.filter(x => x.type === 'item').map(x => x.text);
+      assert(items.every(x => x.toLowerCase().includes('getting')));
+    });
+  })
+
+  it('should filter items with titles by keywords on "tabopen" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('tabopen https://');
+
+    await eventually(async() => {
+      let completions = await c.getCompletions();
+      let items = completions.filter(x => x.type === 'item').map(x => x.text);
+      assert(items.every(x => x.includes('https://')));
+    });
+  })
+
+  it('should filter items with titles by keywords on "winopen" command', async() => {
+    await body.sendKeys(':');
+
+    await session.switchToFrame(0);
+    let c = new Console(session);
+    await c.sendKeys('winopen https://');
+
+    await eventually(async() => {
+      let completions = await c.getCompletions();
+      let items = completions.filter(x => x.type === 'item').map(x => x.text);
+      assert(items.every(x => x.includes('https://')));
+    });
+  })
+});
diff --git a/e2e/lib/Console.js b/e2e/lib/Console.js
new file mode 100644
index 0000000..a3391ee
--- /dev/null
+++ b/e2e/lib/Console.js
@@ -0,0 +1,33 @@
+class Console {
+  constructor(session) {
+    this.session = session;
+  }
+
+  async sendKeys(...keys) {
+    let input = await this.session.findElementByCSS('input');
+    input.sendKeys(...keys);
+  }
+
+  async getCompletions() {
+    return await this.session.executeScript(() => {
+      let items = document.querySelectorAll('.vimvixen-console-completion > li');
+      if (items.length === 0) {
+        throw new Error('completion items not found');
+      }
+
+      let objs = [];
+      for (let li of items) {
+        if (li.classList.contains('vimvixen-console-completion-title')) {
+          objs.push({ type: 'title', text: li.textContent.trim() });
+        } else if ('vimvixen-console-completion-item') {
+          objs.push({ type: 'item', text: li.textContent.trim() });
+        } else {
+          throw new Error(`unexpected class: ${li.className}`);
+        }
+      }
+      return objs;
+    });
+  }
+}
+
+module.exports = Console;
