test: add tests for ZClean and registered plugins cache

- ZClean detects orphan plugins not in spec
- ZClean does not delete plugins that are in spec
- ZClean detects multiple orphan plugins
- registered_plugin_names is alphabetically sorted
- registered_plugins orders startup before lazy
- registered_plugins sorts by priority within each category
- registered_plugins has orphans after lazy plugins
- registered_plugin_names includes orphan plugins

Author: zuqini

tests/run_all.lua

@@ -25,6 +25,7 @@ local test_modules = {
   'dependencies_test',
   'module_loader_test',
   'zdelete_test',
+  'zclean_test',
 }
 
 print("\n" .. string.rep("=", 60))

tests/zclean_test.lua

@@ -0,0 +1,251 @@
+local helpers = require('helpers')
+
+return function()
+  helpers.describe("ZClean Command", function()
+    helpers.test("ZClean detects orphan plugins not in spec", function()
+      helpers.setup_test_env()
+
+      require('zpack').setup({
+        spec = {
+          { 'test/plugin-a' },
+          { 'test/plugin-b' },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      _G.test_state.registered_pack_specs['orphan-plugin'] = {
+        src = 'test/orphan-plugin',
+        name = 'orphan-plugin',
+      }
+
+      require('zpack.commands').update_registered_plugins_cache()
+
+      vim.cmd('ZClean')
+      helpers.flush_pending()
+
+      helpers.assert_equal(#_G.test_state.vim_pack_del_calls, 1, "vim.pack.del should be called")
+      local call = _G.test_state.vim_pack_del_calls[1]
+      helpers.assert_table_contains(call.names, 'orphan-plugin', "orphan plugin should be in delete list")
+      helpers.assert_equal(#call.names, 1, "only orphan plugin should be deleted")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+
+    helpers.test("ZClean does not delete plugins in spec", function()
+      helpers.setup_test_env()
+
+      require('zpack').setup({
+        spec = {
+          { 'test/plugin-a' },
+          { 'test/plugin-b' },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      vim.cmd('ZClean')
+      helpers.flush_pending()
+
+      helpers.assert_equal(#_G.test_state.vim_pack_del_calls, 0, "vim.pack.del should not be called")
+
+      local found_info = false
+      for _, notif in ipairs(_G.test_state.notifications) do
+        if notif.msg:find('No unused plugins') and notif.level == vim.log.levels.INFO then
+          found_info = true
+          break
+        end
+      end
+      helpers.assert_true(found_info, "Should show info that no unused plugins exist")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+
+    helpers.test("ZClean detects multiple orphan plugins", function()
+      helpers.setup_test_env()
+
+      require('zpack').setup({
+        spec = {
+          { 'test/plugin-a' },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      _G.test_state.registered_pack_specs['orphan-1'] = {
+        src = 'test/orphan-1',
+        name = 'orphan-1',
+      }
+      _G.test_state.registered_pack_specs['orphan-2'] = {
+        src = 'test/orphan-2',
+        name = 'orphan-2',
+      }
+
+      require('zpack.commands').update_registered_plugins_cache()
+
+      vim.cmd('ZClean')
+      helpers.flush_pending()
+
+      helpers.assert_equal(#_G.test_state.vim_pack_del_calls, 1, "vim.pack.del should be called once")
+      local call = _G.test_state.vim_pack_del_calls[1]
+      helpers.assert_equal(#call.names, 2, "both orphan plugins should be deleted")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+  end)
+
+  helpers.describe("Registered Plugins Cache", function()
+    helpers.test("registered_plugin_names is alphabetically sorted", function()
+      helpers.setup_test_env()
+      local state = require('zpack.state')
+
+      require('zpack').setup({
+        spec = {
+          { 'test/zebra-plugin' },
+          { 'test/alpha-plugin' },
+          { 'test/middle-plugin' },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      helpers.assert_equal(state.registered_plugin_names[1], 'alpha-plugin', "first should be alpha")
+      helpers.assert_equal(state.registered_plugin_names[2], 'middle-plugin', "second should be middle")
+      helpers.assert_equal(state.registered_plugin_names[3], 'zebra-plugin', "third should be zebra")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+
+    helpers.test("registered_plugins has startup before lazy", function()
+      helpers.setup_test_env()
+      local state = require('zpack.state')
+
+      require('zpack').setup({
+        spec = {
+          { 'test/lazy-plugin', cmd = 'LazyCmd' },
+          { 'test/startup-plugin', config = function() end },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      helpers.assert_equal(#state.registered_plugins, 2, "should have 2 plugins")
+      helpers.assert_equal(state.registered_plugins[1].name, 'startup-plugin', "startup should be first")
+      helpers.assert_equal(state.registered_plugins[2].name, 'lazy-plugin', "lazy should be second")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+
+    helpers.test("registered_plugins sorts startup by priority", function()
+      helpers.setup_test_env()
+      local state = require('zpack.state')
+
+      require('zpack').setup({
+        spec = {
+          { 'test/low-priority', priority = 10, config = function() end },
+          { 'test/high-priority', priority = 100, config = function() end },
+          { 'test/default-priority', config = function() end },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      helpers.assert_equal(state.registered_plugins[1].name, 'high-priority', "high priority should be first")
+      helpers.assert_equal(state.registered_plugins[2].name, 'default-priority', "default (50) should be second")
+      helpers.assert_equal(state.registered_plugins[3].name, 'low-priority', "low priority should be third")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+
+    helpers.test("registered_plugins sorts lazy by priority", function()
+      helpers.setup_test_env()
+      local state = require('zpack.state')
+
+      require('zpack').setup({
+        spec = {
+          { 'test/lazy-low', priority = 10, cmd = 'LowCmd' },
+          { 'test/lazy-high', priority = 100, cmd = 'HighCmd' },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      helpers.assert_equal(state.registered_plugins[1].name, 'lazy-high', "high priority lazy should be first")
+      helpers.assert_equal(state.registered_plugins[2].name, 'lazy-low', "low priority lazy should be second")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+
+    helpers.test("registered_plugins has orphans after lazy", function()
+      helpers.setup_test_env()
+      local state = require('zpack.state')
+
+      require('zpack').setup({
+        spec = {
+          { 'test/startup-plugin', config = function() end },
+          { 'test/lazy-plugin', cmd = 'LazyCmd' },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      _G.test_state.registered_pack_specs['orphan-plugin'] = {
+        src = 'test/orphan-plugin',
+        name = 'orphan-plugin',
+      }
+
+      require('zpack.commands').update_registered_plugins_cache()
+
+      helpers.assert_equal(#state.registered_plugins, 3, "should have 3 plugins")
+      helpers.assert_equal(state.registered_plugins[1].name, 'startup-plugin', "startup should be first")
+      helpers.assert_equal(state.registered_plugins[2].name, 'lazy-plugin', "lazy should be second")
+      helpers.assert_equal(state.registered_plugins[3].name, 'orphan-plugin', "orphan should be last")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+
+    helpers.test("registered_plugin_names includes orphans", function()
+      helpers.setup_test_env()
+      local state = require('zpack.state')
+
+      require('zpack').setup({
+        spec = {
+          { 'test/plugin-a' },
+        },
+        defaults = { confirm = false },
+      })
+
+      helpers.flush_pending()
+
+      _G.test_state.registered_pack_specs['orphan-plugin'] = {
+        src = 'test/orphan-plugin',
+        name = 'orphan-plugin',
+      }
+
+      require('zpack.commands').update_registered_plugins_cache()
+
+      helpers.assert_equal(#state.registered_plugin_names, 2, "should have 2 names")
+      helpers.assert_table_contains(state.registered_plugin_names, 'orphan-plugin', "orphan should be in names")
+      helpers.assert_table_contains(state.registered_plugin_names, 'plugin-a', "spec plugin should be in names")
+
+      helpers.cleanup_test_env()
+      helpers.delete_zpack_commands()
+    end)
+  end)
+end