refactor(test): cleanup test utilities (#2132)

4 files changed, 190 insertions, 0 deletions

diff --git a/tests/specs/bootstrap_spec.lua b/tests/specs/bootstrap_spec.lua
new file mode 100644
index 00000000..c86d22d4
--- /dev/null
+++ b/tests/specs/bootstrap_spec.lua
@@ -0,0 +1,36 @@
+local a = require "plenary.async_lib.tests"
+
+a.describe("initial start", function()
+  local uv = vim.loop
+  local home_dir = uv.os_homedir()
+  local lvim_config_path = get_config_dir() or home_dir .. "/.config/lvim"
+  local lvim_runtime_path = get_runtime_dir() or home_dir .. "/.local/share/lunarvim"
+
+  a.it("shoud be able to detect test environment", function()
+    assert.truthy(os.getenv "LVIM_TEST_ENV")
+    assert.falsy(package.loaded["lvim.impatient"])
+  end)
+
+  a.it("should not be reading default neovim directories in the home directoies", function()
+    local rtp_list = vim.opt.rtp:get()
+    assert.falsy(vim.tbl_contains(rtp_list, vim.fn.stdpath "config"))
+  end)
+
+  a.it("should be able to read lunarvim directories", function()
+    local rtp_list = vim.opt.rtp:get()
+    assert.truthy(vim.tbl_contains(rtp_list, lvim_runtime_path .. "/lvim"))
+    assert.truthy(vim.tbl_contains(rtp_list, lvim_config_path))
+  end)
+
+  a.it("should be able to run treesitter without errors", function()
+    assert.truthy(vim.treesitter.highlighter.active)
+  end)
+
+  a.it("should be able to pass basic checkhealth without errors", function()
+    vim.cmd "checkhealth nvim"
+    local errmsg = vim.fn.eval "v:errmsg"
+    local exception = vim.fn.eval "v:exception"
+    assert.equal("", errmsg) -- v:errmsg was not updated.
+    assert.equal("", exception)
+  end)
+end)
diff --git a/tests/specs/config_loader_spec.lua b/tests/specs/config_loader_spec.lua
new file mode 100644
index 00000000..1aef0974
--- /dev/null
+++ b/tests/specs/config_loader_spec.lua
@@ -0,0 +1,39 @@
+local a = require "plenary.async_lib.tests"
+local config = require "lvim.config"
+local utils = require "lvim.utils"
+
+a.describe("config-loader", function()
+  local user_config_path = config:get_user_config_path()
+
+  a.it("should be able to find user-config", function()
+    assert.equal(user_config_path, get_config_dir() .. "/config.lua")
+  end)
+
+  a.it("should be able to load user-config without errors", function()
+    config:load(user_config_path)
+    local errmsg = vim.fn.eval "v:errmsg"
+    local exception = vim.fn.eval "v:exception"
+    assert.equal("", errmsg) -- v:errmsg was not updated.
+    assert.equal("", exception)
+  end)
+
+  a.it("should be able to reload user-config without errors", function()
+    vim.opt.undodir = "/tmp"
+    assert.equal(vim.opt.undodir:get()[1], "/tmp")
+    config:reload()
+    assert.equal(vim.opt.undodir:get()[1], utils.join_paths(get_cache_dir(), "undo"))
+  end)
+
+  a.it("should not get interrupted by errors in user-config", function()
+    vim.opt.undodir = "/tmp"
+    assert.equal(vim.opt.undodir:get()[1], "/tmp")
+    os.execute(string.format("echo 'bad_string_test' >> %s", user_config_path))
+    local error_handler = function(msg)
+      return msg
+    end
+    local err = xpcall(config:reload(), error_handler)
+    assert.falsy(err)
+    assert.equal(vim.opt.undodir:get()[1], utils.join_paths(get_cache_dir(), "undo"))
+    os.execute(string.format("echo '' > %s", user_config_path))
+  end)
+end)
diff --git a/tests/specs/lsp_spec.lua b/tests/specs/lsp_spec.lua
new file mode 100644
index 00000000..633aa17c
--- /dev/null
+++ b/tests/specs/lsp_spec.lua
@@ -0,0 +1,80 @@
+local a = require "plenary.async_lib.tests"
+local utils = require "lvim.utils"
+local helpers = require "tests.helpers"
+local temp_dir = vim.loop.os_getenv "TEMP" or "/tmp"
+lvim.lsp.templates_dir = join_paths(temp_dir, "lvim", "tests", "artifacts")
+
+a.describe("lsp workflow", function()
+  local Log = require "lvim.core.log"
+  local logfile = Log:get_path()
+
+  a.it("shoud be able to delete ftplugin templates", function()
+    if utils.is_directory(lvim.lsp.templates_dir) then
+      assert.equal(vim.fn.delete(lvim.lsp.templates_dir, "rf"), 0)
+    end
+    assert.False(utils.is_directory(lvim.lsp.templates_dir))
+  end)
+
+  a.it("shoud be able to generate ftplugin templates", function()
+    if utils.is_directory(lvim.lsp.templates_dir) then
+      assert.equal(vim.fn.delete(lvim.lsp.templates_dir, "rf"), 0)
+    end
+    require("lvim.lsp").setup()
+
+    -- we need to delay this check until the generation is completed
+    vim.schedule(function()
+      assert.True(utils.is_directory(lvim.lsp.templates_dir))
+    end)
+  end)
+
+  a.it("shoud not attempt to re-generate ftplugin templates", function()
+    lvim.log.level = "debug"
+
+    local plugins = require "lvim.plugins"
+    require("lvim.plugin-loader"):load { plugins, lvim.plugins }
+
+    if utils.is_file(logfile) then
+      assert.equal(vim.fn.delete(logfile), 0)
+    end
+
+    assert.True(utils.is_directory(lvim.lsp.templates_dir))
+    require("lvim.lsp").setup()
+
+    -- we need to delay this check until the log gets populated
+    vim.schedule(function()
+      assert.False(helpers.log_contains "templates")
+    end)
+  end)
+
+  a.it("shoud not include blacklisted servers in the generated templates", function()
+    assert.True(utils.is_directory(lvim.lsp.templates_dir))
+    require("lvim.lsp").setup()
+
+    for _, file in ipairs(vim.fn.glob(lvim.lsp.templates_dir .. "/*.lua", 1, 1)) do
+      for _, server in ipairs(lvim.lsp.override) do
+        assert.False(helpers.file_contains(file, server))
+      end
+    end
+  end)
+
+  a.it("shoud only include one server per generated template", function()
+    assert.True(utils.is_directory(lvim.lsp.templates_dir))
+    require("lvim.lsp").setup()
+
+    for _, file in ipairs(vim.fn.glob(lvim.lsp.templates_dir .. "/*.lua", 1, 1)) do
+      local content = {}
+      for entry in io.lines(file) do
+        table.insert(content, entry)
+      end
+      local err_msg = ""
+      if #content > 1 then
+        err_msg = string.format(
+          "found more than one server for [%q]: \n{\n %q \n}",
+          file:match "[^/]*.lua$",
+          table.concat(content, ", ")
+        )
+      end
+      assert.equal(err_msg, "")
+    end
+  end)
+end)
diff --git a/tests/specs/plugins_load_spec.lua b/tests/specs/plugins_load_spec.lua
new file mode 100644
index 00000000..08c96c12
--- /dev/null
+++ b/tests/specs/plugins_load_spec.lua
@@ -0,0 +1,35 @@
+local a = require "plenary.async_lib.tests"
+
+a.describe("plugin-loader", function()
+  local plugins = require "lvim.plugins"
+  local loader = require "lvim.plugin-loader"
+
+  a.it("should be able to load default packages without errors", function()
+    loader:load { plugins, lvim.plugins }
+
+    -- TODO: maybe there's a way to avoid hard-coding the names of the modules?
+    local startup_plugins = {
+      "packer",
+    }
+
+    for _, plugin in ipairs(startup_plugins) do
+      assert.truthy(package.loaded[plugin])
+    end
+  end)
+
+  a.it("should be able to load lsp packages without errors", function()
+    loader:load { plugins, lvim.plugins }
+
+    require("lvim.lsp").setup()
+
+    local lsp_packages = {
+      "lspconfig",
+      "nlspsettings",
+      "null-ls",
+    }
+
+    for _, plugin in ipairs(lsp_packages) do
+      assert.truthy(package.loaded[plugin])
+    end
+  end)
+end)