Feat: Add Basic Lua Test Suite (#115)

This MR adds a Lua test suite to the project, run via busted, and introduces tests for a number of the utility functions. Subsequent work will have to be done to test functions that use the `vim.api` scope and external packages to the plugin.

Author: harrisoncramer

.busted

@@ -0,0 +1,13 @@
+return {
+  _all = {
+    pattern = "_spec",
+    lpath = "lua/?.lua;lua/?/init.lua",
+    ROOT = {"lua/gitlab"},
+  },
+  default = {
+    verbose = true
+  },
+  tests = {
+    verbose = true,
+  },
+}

.github/workflows/go.yaml

@@ -4,7 +4,23 @@ on:
     branches:
       - main
 jobs:
-  build:
+  go_lint:
+    name: Lint Go 💅 
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.19'
+          cache: false
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.54
+          only-new-issues: true
+  go_test:
+    name: Test Go 🧪 
+    needs: [go_lint]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3

.github/workflows/lua-tests.yaml

@@ -0,0 +1,15 @@
+name: Lua Tests
+on:
+  pull_request:
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Run Busted
+        uses: lunarmodules/[email protected]
+        # with:
+        #     args: --run=api

.github/workflows/lint-and-format.yaml renamed to .github/workflows/lua.yaml

@@ -1,10 +1,11 @@
-name: Linting and Formatting
+name: Lua
 on:
   pull_request:
     branches:
       - main
 jobs:
-  luacheck:
+  lua_lint:
+    name: Lint Lua 💅 
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -13,7 +14,8 @@ jobs:
         uses: lunarmodules/luacheck@v1
         with:
           args: --globals vim --no-max-line-length -- .
-  stylua:
+  lua_format:
+    name: Formatting Lua 💅 
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -24,16 +26,12 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           version: latest
           args: --check .
-  golangci:
+  lua_test:
+    name: Test Lua 🧪 
+    needs: [lua_format,lua_lint]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v4
-        with:
-          go-version: '1.19'
-          cache: false
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
-        with:
-          version: v1.54
-          only-new-issues: true
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Run Busted
+        uses: lunarmodules/[email protected]

.gitignore

@@ -1,2 +1,5 @@
 bin
 .luarc.json
+/luarocks
+/lua_modules
+/.luarocks

logs

@@ -892,7 +892,7 @@ end
 ---@param note Note
 ---@return string
 M.build_note_header = function(note)
-  return "@" .. note.author.username .. " " .. u.format_date(note.created_at)
+  return "@" .. note.author.username .. " " .. u.time_since(note.created_at)
 end
 
 M.build_note_body = function(note, resolve_info)
@@ -977,7 +977,7 @@ M.add_discussions_to_table = function(items)
     end
 
     -- Creates the first node in the discussion, and attaches children
-    local body = u.join_tables(root_text_nodes, discussion_children)
+    local body = u.spread(root_text_nodes, discussion_children)
     local root_node = NuiTree.Node({
       text = root_text,
       is_note = true,

lua/gitlab/actions/discussions.lua

@@ -46,7 +46,7 @@ M.open = function()
     u.switch_can_edit_buf(bufnr, true)
     table.insert(lines, string.format("Status: %s (%s)", state.settings.pipeline[pipeline.status], pipeline.status))
     table.insert(lines, "")
-    table.insert(lines, string.format("Last Run: %s", u.format_date(pipeline.created_at)))
+    table.insert(lines, string.format("Last Run: %s", u.time_since(pipeline.created_at)))
     table.insert(lines, string.format("Url: %s", pipeline.web_url))
     table.insert(lines, string.format("Triggered By: %s", pipeline.source))
 
@@ -99,7 +99,7 @@ M.see_logs = function()
   local bufnr = vim.api.nvim_get_current_buf()
   local linnr = vim.api.nvim_win_get_cursor(0)[1]
   local text = u.get_line_content(bufnr, linnr)
-  local last_word = u.get_last_chunk(text)
+  local last_word = u.get_last_word(text)
   if last_word == nil then
     u.notify("Cannot find job name", vim.log.levels.ERROR)
     return

lua/gitlab/actions/pipeline.lua

@@ -0,0 +1,181 @@
+describe("utils/init.lua", function()
+  it("Loads package", function()
+    local utils_ok, _ = pcall(require, "gitlab.utils")
+    assert._is_true(utils_ok)
+  end)
+
+  local _, u = pcall(require, "gitlab.utils")
+  describe("extract", function()
+    it("Extracts a single value", function()
+      local t = { { one = 1, two = 2 }, { three = 3, four = 4 } }
+      local got = u.extract(t, "one")
+      local want = { 1 }
+      assert.are.same(want, got)
+    end)
+    it("Returns nothing with empty table", function()
+      local t = {}
+      local got = u.extract(t, "one")
+      local want = {}
+      assert.are.same(want, got)
+    end)
+  end)
+
+  describe("get_last_word", function()
+    it("Returns the last word in a sentence", function()
+      local sentence = "Hello world!"
+      local got = u.get_last_word(sentence)
+      local want = "world!"
+      assert.are.same(want, got)
+    end)
+    it("Returns an empty string without text", function()
+      local sentence = ""
+      local got = u.get_last_word(sentence)
+      local want = ""
+      assert.are.same(want, got)
+    end)
+    it("Returns whole string w/out divider", function()
+      local sentence = "Thisdoesnothavebreaks"
+      local got = u.get_last_word(sentence)
+      assert.are.same(sentence, got)
+    end)
+    it("Returns correct word w/ different divider", function()
+      local sentence = "this|uses|a|different|divider"
+      local got = u.get_last_word(sentence, "|")
+      local want = "divider"
+      assert.are.same(want, got)
+    end)
+  end)
+
+  describe("format_date", function()
+    local current_date = {
+      day = 19,
+      hour = 22,
+      isdst = false,
+      min = 0,
+      month = 11,
+      sec = 44,
+      wday = 1,
+      yday = 323,
+      year = 2023,
+    }
+    it("Returns days since a valid UTC timestamp", function()
+      local stamp = "2023-11-16T19:52:36.946Z"
+      local got = u.time_since(stamp, current_date)
+      local want = "3 days ago"
+      assert.are.same(want, got)
+    end)
+
+    it("Returns hours since a valid UTC timestamp", function()
+      local stamp = "2023-11-19T19:52:36.946Z"
+      local got = u.time_since(stamp, current_date)
+      local want = "2 hours ago"
+      assert.are.same(want, got)
+    end)
+    it("Returns readable time if > 1 year", function()
+      local stamp = "2011-11-19T19:52:36.946Z"
+      local got = u.time_since(stamp, current_date)
+      local want = "November 19, 2011"
+      assert.are.same(want, got)
+    end)
+  end)
+
+  describe("remove_first_value", function()
+    it("Removes the first value correctly", function()
+      local got = u.remove_first_value({ 1, 2 })
+      local want = { 2 }
+      assert.are.same(want, got)
+    end)
+    it("Handles a one-length list", function()
+      local got = u.remove_first_value({ 1 })
+      local want = {}
+      assert.are.same(want, got)
+    end)
+    it("Handles a zero-length list", function()
+      local got = u.remove_first_value({})
+      local want = {}
+      assert.are.same(want, got)
+    end)
+  end)
+
+  describe("table_size", function()
+    it("Works for associative tables", function()
+      local got = u.remove_first_value({ 1, 2 })
+      local want = { 2 }
+      assert.are.same(want, got)
+    end)
+    it("Handles a one-length list", function()
+      local got = u.remove_first_value({ 1 })
+      local want = {}
+      assert.are.same(want, got)
+    end)
+    it("Handles a zero-length list", function()
+      local got = u.remove_first_value({})
+      local want = {}
+      assert.are.same(want, got)
+    end)
+  end)
+
+  describe("contains", function()
+    it("Finds a value in a list", function()
+      local got = u.contains({ 1, 2 }, 1)
+      assert._is_true(got)
+    end)
+    it("Handles missing values", function()
+      local got = u.contains({ 1, 3, 4 }, 2)
+      assert._is_false(got)
+    end)
+    it("Handles empty lists", function()
+      local got = u.contains({}, 1)
+      assert._is_false(got)
+    end)
+  end)
+
+  describe("reverse", function()
+    it("Reverses the values in a list", function()
+      local got = u.reverse({ 1, 2, 3, 4 })
+      local want = { 4, 3, 2, 1 }
+      assert.are.same(got, want)
+    end)
+    it("Handles single value", function()
+      local got = u.reverse({ 1 })
+      local want = { 1 }
+      assert.are.same(got, want)
+    end)
+    it("Handles empty list", function()
+      local got = u.reverse({})
+      local want = {}
+      assert.are.same(got, want)
+    end)
+  end)
+
+  describe("spread", function()
+    it("Spreads the values", function()
+      local t1 = { 1, 2, 3 }
+      local t2 = { 4, 5, 6 }
+      local got = u.spread(t1, t2)
+      local want = { 1, 2, 3, 4, 5, 6 }
+      assert.are.same(got, want)
+    end)
+    it("Handles an empty t1 table", function()
+      local t1 = {}
+      local t2 = { 4, 5, 6 }
+      local got = u.spread(t1, t2)
+      local want = { 4, 5, 6 }
+      assert.are.same(got, want)
+    end)
+    it("Handles an empty t2 table", function()
+      local t1 = { 1, 2, 3 }
+      local t2 = {}
+      local got = u.spread(t1, t2)
+      local want = { 1, 2, 3 }
+      assert.are.same(got, want)
+    end)
+    it("Handles both empty tables", function()
+      local t1 = {}
+      local t2 = {}
+      local got = u.spread(t1, t2)
+      local want = {}
+      assert.are.same(got, want)
+    end)
+  end)
+end)

lua/gitlab/spec/util_spec.lua

@@ -122,7 +122,7 @@ M.merge_settings = function(args)
 end
 
 M.print_settings = function()
-  u.P(M.settings)
+  vim.print(M.settings)
 end
 
 -- First reads environment variables into the settings module,