Refactor dmenu to be instantiable + add luassert for assertions

5 files changed, 192 insertions, 61 deletions

diff --git a/spec/lua/dmenu_spec.lua b/spec/lua/dmenu_spec.lua
new file mode 100644
index 0000000..3f405e6
--- /dev/null
+++ b/spec/lua/dmenu_spec.lua
@@ -0,0 +1,128 @@
+local Dmenu = require 'null-browser.extras.dmenu'
+local t = require 'null-browser.test-utils'
+
+describe('class: extras.dmenu', function()
+  t.before_each(function()
+    stub(web.uv, 'spawn')
+    stub(web.uv, 'new_pipe', 0)
+    stub(web.uv, 'close')
+    stub(web.uv, 'read_start')
+    stub(web.uv, 'shutdown')
+    stub(web.uv, 'write')
+  end)
+
+  describe('#select', function()
+    context('with default options', function()
+      it('spawns the dmenu process', function()
+        local dmenu = Dmenu:new {}
+        local spawn_proccess_stub = stub(web.uv, 'spawn')
+
+        dmenu:select({}, {}, function() end)
+
+        assert.stub(spawn_proccess_stub).was.called_with(
+          'dmenu',
+          match.shape({ args = {}, stdio = match.table() }),
+          match.is_function()
+        )
+      end)
+    end)
+
+    context('with custom command options', function()
+      it('spawns the custom dmenu process', function()
+        local dmenu = Dmenu:new { command = 'some-other-dmenu', args = { 'my-arg' } }
+        local spawn_proccess_stub = stub(web.uv, 'spawn')
+
+        dmenu:select({}, {}, function() end)
+
+        assert.stub(spawn_proccess_stub).was.called_with(
+          'some-other-dmenu',
+          match.shape({ args = { 'my-arg' }, stdio = match.table() }),
+          match.is_function()
+        )
+      end)
+    end)
+
+    context('when a list is provided', function()
+      it('writes the list to stdin of process', function()
+        local dmenu = Dmenu:new {}
+        local write_data_spy = stub(web.uv, 'write')
+
+        dmenu:select({ 'hello', 'world', 'testing' }, {}, function() end)
+
+        assert.stub(write_data_spy).was.called_with(0, 'hello\n')
+        assert.stub(write_data_spy).was.called_with(0, 'world\n')
+        assert.stub(write_data_spy).was.called_with(0, 'testing\n')
+      end)
+    end)
+
+    context('when process exits with status code 0', function()
+      context('when process outputs to stdout', function()
+        it('calls result callback with output line and no error', function()
+          local dmenu = Dmenu:new {}
+          local invoke_process_exit = nil
+          local on_result = spy.new()
+          stub(web.uv, 'spawn').invokes(function(_, _, callback)
+            invoke_process_exit = callback
+          end)
+          stub(web.uv, 'read_start').invokes(function(_, callback)
+            callback(nil, 'user input')
+            if invoke_process_exit then invoke_process_exit(0) end
+          end)
+
+          dmenu:select({}, {}, on_result)
+
+          assert.stub(on_result).was.called_with(nil, 'user input')
+        end)
+      end)
+
+      context('when process does not output to stdout', function()
+        it('calls result callback with nil and no error', function()
+          local dmenu = Dmenu:new {}
+          local on_result = spy.new()
+          stub(web.uv, 'spawn').invokes(function(_, _, callback)
+            callback(0)
+          end)
+
+          dmenu:select({}, {}, on_result)
+
+          assert.stub(on_result).was.called_with(nil, nil)
+        end)
+      end)
+    end)
+
+    context('when process exits with non-zero status code', function()
+      context('when process outputs to stdout', function()
+        it('calls result callback with an error and output line', function()
+          local dmenu = Dmenu:new {}
+          local invoke_process_exit = nil
+          local on_result = spy.new()
+          stub(web.uv, 'spawn').invokes(function(_, _, callback)
+            invoke_process_exit = callback
+          end)
+          stub(web.uv, 'read_start').invokes(function(_, callback)
+            callback(nil, 'user input')
+            if invoke_process_exit then invoke_process_exit(42) end
+          end)
+
+          dmenu:select({}, {}, on_result)
+
+          assert.stub(on_result).was.called_with(match.string(), 'user input')
+        end)
+      end)
+
+      context('when process does not output to stdout', function()
+        it('calls result callback with an error and nil', function()
+          local dmenu = Dmenu:new {}
+          local on_result = spy.new()
+          stub(web.uv, 'spawn').invokes(function(_, _, callback)
+            callback(42)
+          end)
+
+          dmenu:select({}, {}, on_result)
+
+          assert.stub(on_result).was.called_with(match.string(), nil)
+        end)
+      end)
+    end)
+  end)
+end)
diff --git a/spec/lua/utils_spec.lua b/spec/lua/utils_spec.lua
index 5ea2d78..de90ef5 100644
--- a/spec/lua/utils_spec.lua
+++ b/spec/lua/utils_spec.lua
@@ -1,36 +1,36 @@
 describe('web.utils.string_trim', function()
   it('trims whitespace from the start and end of string', function()
-    expect(web.utils.string_trim('  hello')).to_equal 'hello'
-    expect(web.utils.string_trim('hello  ')).to_equal 'hello'
-    expect(web.utils.string_trim('  hello  ')).to_equal 'hello'
+    assert.are.equal(web.utils.string_trim('  hello'), 'hello')
+    assert.are.equal(web.utils.string_trim('hello  '), 'hello')
+    assert.are.equal(web.utils.string_trim('  hello  '), 'hello')
   end)
 end)
 
 describe('web.utils.table_merge', function()
   context('when both tables have integer keys', function()
     it('returns merged table', function()
-      expect(web.utils.table_merge({ a = 0 }, { b = 1 }, { c = 2 }))
-          .to_equal { a = 0, b = 1, c = 2 }
+      local result = web.utils.table_merge({ a = 0 }, { b = 1 }, { c = 2 })
+      assert.are.same(result, { a = 0, b = 1, c = 2 })
     end)
   end)
 
   context('when both tables unique keys', function()
     it('returns merged table', function()
-      expect(web.utils.table_merge({ a = 0 }, { b = 1 }, { c = 2 }))
-          .to_equal { a = 0, b = 1, c = 2 }
+      local result = web.utils.table_merge({ a = 0 }, { b = 1 }, { c = 2 })
+      assert.are.same(result, { a = 0, b = 1, c = 2 })
     end)
   end)
 
   context('when both tables have a key in common', function()
     it('returns merged table', function()
-      expect(web.utils.table_merge({ foo = 1, a = 0 }, { foo = 2 }, { foo = 3 }))
-          .to_equal { foo = 3, a = 0 }
+      local result = web.utils.table_merge({ foo = 1, a = 0 }, { foo = 2 }, { foo = 3 })
+      assert.are.same(result, { foo = 3, a = 0 })
     end)
 
     it('mutates the first table', function()
       local tbl = { foo = 1, a = 0 }
       web.utils.table_merge(tbl, { foo = 2 })
-      expect(tbl).to_equal { foo = 2, a = 0 }
+      assert.are.same(tbl, { foo = 2, a = 0 })
     end)
   end)
 end)
@@ -38,29 +38,29 @@ end)
 describe('web.utils.equals', function()
   context('when values are primitives', function()
     it('checks for equality', function()
-      expect(web.utils.equals(1, 1)).to_be_true()
-      expect(web.utils.equals(3, 1)).to_be_false()
-      expect(web.utils.equals(nil, 1)).to_be_false()
-      expect(web.utils.equals(1, nil)).to_be_false()
-      expect(web.utils.equals(nil, nil)).to_be_true()
+      assert.is_true(web.utils.equals(1, 1))
+      assert.is_false(web.utils.equals(3, 1))
+      assert.is_false(web.utils.equals(nil, 1))
+      assert.is_false(web.utils.equals(1, nil))
+      assert.is_true(web.utils.equals(nil, nil))
     end)
   end)
 
   context('when values are tables', function()
     it('checks for equality', function()
-      expect(web.utils.equals({}, 0)).to_be_false()
-      expect(web.utils.equals(0, {})).to_be_false()
-      expect(web.utils.equals({}, {})).to_be_true()
-      expect(web.utils.equals({ a = 1 }, { a = 1 })).to_be_true()
-      expect(web.utils.equals({ a = 2 }, { a = 1 })).to_be_false()
-      expect(web.utils.equals({}, { a = 1 })).to_be_false()
-      expect(web.utils.equals({ a = 1 }, {})).to_be_false()
+      assert.is_false(web.utils.equals({}, 0))
+      assert.is_false(web.utils.equals(0, {}))
+      assert.is_true(web.utils.equals({}, {}))
+      assert.is_true(web.utils.equals({ a = 1 }, { a = 1 }))
+      assert.is_false(web.utils.equals({ a = 2 }, { a = 1 }))
+      assert.is_false(web.utils.equals({}, { a = 1 }))
+      assert.is_false(web.utils.equals({ a = 1 }, {}))
     end)
 
     context('when tables are deeply nested', function()
       it('checks for equality', function()
-        expect(web.utils.equals({ a = { b = 2 } }, { a = { b = 2 } })).to_be_true()
-        expect(web.utils.equals({ a = { b = 3 } }, { a = { b = 2 } })).to_be_false()
+        assert.is_true(web.utils.equals({ a = { b = 2 } }, { a = { b = 2 } }))
+        assert.is_false(web.utils.equals({ a = { b = 3 } }, { a = { b = 2 } }))
       end)
     end)
   end)
@@ -70,21 +70,21 @@ describe('web.utils.table_keys', function()
   it('returns keys of given table', function()
     local result = web.utils.table_keys({ a = 1, b = 2 })
     table.sort(result) -- Sort for deterministic ordering
-    expect(result).to_equal({ 'a', 'b' })
+    assert.are.same(result, { 'a', 'b' })
   end)
 
   context('with index keys', function()
     it('returns indexes of given table', function()
-      expect(web.utils.table_keys({ 'hello', 'world' })).to_equal({ 1, 2 })
-      expect(web.utils.table_keys({ 'hello', a = 1, 'world' })).to_equal({ 1, 2, 'a' })
+      assert.are.same(web.utils.table_keys({ 'hello', 'world' }), { 1, 2 })
+      assert.are.same(web.utils.table_keys({ 'hello', a = 1, 'world' }), { 1, 2, 'a' })
     end)
   end)
 end)
 
 describe('web.inspect', function()
   it('returns string representation of value', function()
-    expect(web.inspect('hello')).to_equal '"hello"'
-    expect(web.inspect(5)).to_equal '5'
-    expect(web.inspect({ a = '200', b = 5 })).to_equal '{\n  a = "200",\n  b = 5\n}'
+    assert.are.equal(web.inspect('hello'), '"hello"')
+    assert.are.equal(web.inspect(5), '5')
+    assert.are.equal(web.inspect({ a = '200', b = 5 }), '{\n  a = "200",\n  b = 5\n}')
   end)
 end)
diff --git a/spec/main.cpp b/spec/main.cpp
index 1f60aea..6de21e2 100644
--- a/spec/main.cpp
+++ b/spec/main.cpp
@@ -1,37 +1,7 @@
 #include <QtCore>
 
-#include "LuaRuntime.hpp"
 #include "testUtils.h"
 
-int run_lua_tests() {
-  QString test_name = getenv("TEST_NAME");
-  if (test_name.startsWith("lua ")) {
-    test_name = test_name.remove(0, 4);
-  } else if (!test_name.isEmpty())
-    return 0;
-
-  QDir dir("../spec/lua"); // TODO: relative to root instead of build/?
-  QStringList spec_files = dir.entryList(QDir::Files);
-  auto &lua = LuaRuntime::instance();
-
-  lua.start_event_loop();
-  lua.require_module("null-browser.test-utils");
-
-  for (auto &file : spec_files) {
-    auto is_spec = file.endsWith("_spec.lua");
-    auto should_run_spec = test_name.isEmpty() || file.contains(test_name);
-    if (is_spec && should_run_spec) {
-      qDebug() << "Running suite: " << file;
-      lua.load_file_sync(dir.filePath(file));
-    }
-  }
-
-  lua.stop_event_loop();
-
-  qDebug() << "Tests ran successfully";
-  return 0;
-}
-
 int main(int argc, char **argv) {
   QApplication app(argc, argv);
 
diff --git a/spec/testUtils.cpp b/spec/testUtils.cpp
index 661f6a3..c359e91 100644
--- a/spec/testUtils.cpp
+++ b/spec/testUtils.cpp
@@ -1,8 +1,9 @@
-#include "LuaRuntime.hpp"
 #include <QtTest/QtTest>
 #include <QtTest/qtestcase.h>
 #include <cstdio>
 
+#include "LuaRuntime.hpp"
+
 std::vector<std::function<QObject *()>> &get_qtest_registry() {
   static std::vector<std::function<QObject *()>> registry;
   return registry;
@@ -12,6 +13,8 @@ int run_app_tests() {
   int exit_code = 0;
 
   QString test_name = getenv("TEST_NAME");
+  if (test_name.startsWith("lua:"))
+    return 0;
 
   for (const auto &run_test : get_qtest_registry()) {
     auto *test = run_test();
@@ -24,6 +27,35 @@ int run_app_tests() {
   return exit_code;
 }
 
+int run_lua_tests() {
+  QString test_name = getenv("TEST_NAME");
+  if (test_name.startsWith("lua:")) {
+    test_name = test_name.remove(0, 4);
+  } else if (!test_name.isEmpty())
+    return 0;
+
+  QDir dir("../spec/lua"); // TODO: relative to root instead of build/?
+  QStringList spec_files = dir.entryList(QDir::Files);
+  auto &lua = LuaRuntime::instance();
+
+  lua.start_event_loop();
+  lua.require_module("null-browser.test-utils");
+
+  for (auto &file : spec_files) {
+    auto is_spec = file.endsWith("_spec.lua");
+    auto should_run_spec = test_name.isEmpty() || file.contains(test_name);
+    if (is_spec && should_run_spec) {
+      qDebug() << "Running suite: " << file;
+      lua.load_file_sync(dir.filePath(file));
+    }
+  }
+
+  lua.stop_event_loop();
+
+  qDebug() << "Tests ran successfully";
+  return 0;
+}
+
 bool wait_for_lua_to_be_true(QString lua_code) {
   return QTest::qWaitFor([&lua_code]() {
     auto &lua = LuaRuntime::instance();
diff --git a/spec/testUtils.h b/spec/testUtils.h
index bfc7374..392f0bb 100644
--- a/spec/testUtils.h
+++ b/spec/testUtils.h
@@ -35,6 +35,7 @@
 
 std::vector<std::function<QObject *()>> &get_qtest_registry();
 int run_app_tests();
+int run_lua_tests();
 
 #define QTEST_REGISTER(klass)                                                                      \
   namespace {                                                                                      \