Merge pull request #2 from taigrr/cd/ci-and-test-coverage

test: re-enable CI tests and add coverage for highlight, locations, terminal, commands

Author: taigrr

.github/workflows/ci.yml

@@ -1,44 +1,52 @@
-name: Tests
+name: CI
 
 on: [push, pull_request]
 
 jobs:
-  # unit_tests:
-  #   name: unit tests
-  #   runs-on: ${{ matrix.os }}
-  #   strategy:
-  #     fail-fast: false
-  #     matrix:
-  #       os: [ubuntu-22.04]
-  #       rev: [nightly, v0.10.0]
-  #
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #
-  #     - uses: rhysd/action-setup-vim@v1
-  #       with:
-  #         neovim: true
-  #         version: ${{ matrix.rev }}
-  #
-  #     - name: Prepare plenary.nvim
-  #       run: |
-  #         git clone --depth 1 https://github.com/nvim-lua/plenary.nvim ../plenary.nvim
-  #
-  #     - name: Run tests
-  #       run: |
-  #         nvim --version
-  #         make test
+  unit_tests:
+    name: tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        rev: [stable, nightly]
 
-  lint:
-    name: stylua
-    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install stylua
+      - uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: ${{ matrix.rev }}
+
+      - name: Prepare plenary.nvim
         run: |
-          cargo install stylua
+          git clone --depth 1 https://github.com/nvim-lua/plenary.nvim ../plenary.nvim
+
+      - name: Update minimal_init for CI
+        run: |
+          cat > scripts/minimal_init.vim <<'EOF'
+          set rtp+=.
+          set rtp+=../plenary.nvim/
+
+          runtime! plugin/plenary.vim
+          runtime! plugin/neocrush.lua
+          EOF
 
-      - name: Check formatting
+      - name: Run tests
         run: |
-          make lint
+          nvim --version
+          make test
+
+  lint:
+    name: stylua
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: JohnnyMorganz/stylua-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: latest
+          args: --check lua/ tests/

tests/commands_spec.lua

@@ -0,0 +1,71 @@
+---@diagnostic disable: undefined-field
+
+local neocrush = require 'neocrush'
+
+describe('neocrush.commands', function()
+  before_each(function()
+    neocrush.setup {}
+  end)
+
+  describe('user commands', function()
+    it('should register CrushToggle command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushToggle)
+    end)
+
+    it('should register CrushOpen command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushOpen)
+    end)
+
+    it('should register CrushClose command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushClose)
+    end)
+
+    it('should register CrushFocus command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushFocus)
+    end)
+
+    it('should register CrushWidth command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushWidth)
+    end)
+
+    it('should register CrushFocusToggle command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushFocusToggle)
+    end)
+
+    it('should register CrushLogs command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushLogs)
+    end)
+
+    it('should register CrushCancel command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushCancel)
+    end)
+
+    it('should register CrushRestart command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushRestart)
+    end)
+
+    it('should register CrushPaste command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushPaste)
+    end)
+
+    it('should register CrushCvmReleases command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushCvmReleases)
+    end)
+
+    it('should register CrushCvmLocal command', function()
+      local cmds = vim.api.nvim_get_commands {}
+      assert.is_not_nil(cmds.CrushCvmLocal)
+    end)
+  end)
+end)

tests/highlight_spec.lua

@@ -0,0 +1,73 @@
+---@diagnostic disable: undefined-field
+
+local highlight = require 'neocrush.highlight'
+
+describe('neocrush.highlight', function()
+  local test_buf
+
+  before_each(function()
+    test_buf = vim.api.nvim_create_buf(false, true)
+    vim.api.nvim_buf_set_lines(test_buf, 0, -1, false, {
+      'line one',
+      'line two',
+      'line three',
+      'line four',
+      'line five',
+    })
+
+    highlight.setup {
+      highlight_group = 'IncSearch',
+      highlight_duration = 100,
+      auto_focus = true,
+      terminal_width = 80,
+      terminal_cmd = 'crush',
+    }
+  end)
+
+  after_each(function()
+    if test_buf and vim.api.nvim_buf_is_valid(test_buf) then
+      vim.api.nvim_buf_delete(test_buf, { force = true })
+    end
+  end)
+
+  describe('flash_range', function()
+    it('should not error on valid range', function()
+      assert.has_no.errors(function()
+        highlight.flash_range(test_buf, 0, 3)
+      end)
+    end)
+
+    it('should not error on empty range', function()
+      assert.has_no.errors(function()
+        highlight.flash_range(test_buf, 2, 2)
+      end)
+    end)
+
+    it('should clamp end_line to buffer length', function()
+      assert.has_no.errors(function()
+        highlight.flash_range(test_buf, 0, 100)
+      end)
+    end)
+
+    it('should handle invalid buffer gracefully before setup', function()
+      local h2 = require 'neocrush.highlight'
+      -- flash_range checks config; with config set it should still not error on invalid buf
+      assert.has_no.errors(function()
+        pcall(h2.flash_range, 99999, 0, 1)
+      end)
+    end)
+  end)
+
+  describe('install', function()
+    it('should install the handler', function()
+      highlight.install()
+      assert.is_true(highlight.is_installed())
+    end)
+
+    it('should be idempotent', function()
+      highlight.install()
+      highlight.install()
+      assert.is_true(highlight.is_installed())
+    end)
+  end)
+end)

tests/locations_spec.lua

@@ -0,0 +1,105 @@
+---@diagnostic disable: undefined-field
+
+local locations = require 'neocrush.locations'
+
+describe('neocrush.locations', function()
+  describe('show_quickfix', function()
+    it('should set quickfix list with items', function()
+      local items = {
+        { filename = 'test.lua', lnum = 10, text = 'some code', note = 'relevant because X' },
+        { filename = 'other.lua', lnum = 20, col = 5, text = 'other code' },
+      }
+
+      locations.show_quickfix('Test Locations', items)
+
+      local qf = vim.fn.getqflist { title = true, items = true }
+      assert.are.same('Test Locations', qf.title)
+      assert.are.same(2, #qf.items)
+
+      vim.cmd 'cclose'
+    end)
+
+    it('should use default title when nil', function()
+      locations.show_quickfix(nil, {
+        { filename = 'a.lua', lnum = 1 },
+      })
+
+      local qf = vim.fn.getqflist { title = true }
+      assert.are.same('AI Locations', qf.title)
+
+      vim.cmd 'cclose'
+    end)
+
+    it('should combine note and text in quickfix text field', function()
+      locations.show_quickfix('Test', {
+        { filename = 'a.lua', lnum = 1, text = 'code here', note = 'because reasons' },
+      })
+
+      local qf = vim.fn.getqflist { items = true }
+      local text = qf.items[1].text
+      assert.truthy(text:find 'because reasons')
+      assert.truthy(text:find 'code here')
+
+      vim.cmd 'cclose'
+    end)
+
+    it('should handle items with only note', function()
+      locations.show_quickfix('Test', {
+        { filename = 'a.lua', lnum = 1, note = 'just a note' },
+      })
+
+      local qf = vim.fn.getqflist { items = true }
+      assert.are.same('just a note', qf.items[1].text)
+
+      vim.cmd 'cclose'
+    end)
+
+    it('should handle items with only text', function()
+      locations.show_quickfix('Test', {
+        { filename = 'a.lua', lnum = 1, text = 'just text' },
+      })
+
+      local qf = vim.fn.getqflist { items = true }
+      assert.are.same('just text', qf.items[1].text)
+
+      vim.cmd 'cclose'
+    end)
+  end)
+
+  describe('handler', function()
+    it('should handle error parameter', function()
+      -- Should not crash when called with error
+      assert.has_no.errors(function()
+        locations.handler('some error', nil, nil, nil)
+      end)
+    end)
+
+    it('should handle nil params', function()
+      assert.has_no.errors(function()
+        locations.handler(nil, nil, nil, nil)
+      end)
+    end)
+
+    it('should handle empty items', function()
+      assert.has_no.errors(function()
+        locations.handler(nil, { items = {} }, nil, nil)
+      end)
+    end)
+
+    it('should fall back to quickfix when telescope is not available', function()
+      -- In test env telescope is not available, so it should use quickfix
+      locations.handler(nil, {
+        title = 'Handler Test',
+        items = {
+          { filename = 'test.lua', lnum = 5, text = 'hello' },
+        },
+      }, nil, nil)
+
+      local qf = vim.fn.getqflist { title = true, items = true }
+      assert.are.same('Handler Test', qf.title)
+      assert.are.same(1, #qf.items)
+
+      vim.cmd 'cclose'
+    end)
+  end)
+end)