test: add clear_all_state() method for use in test cases, part of #77

Author: cseickel

lua/neo-tree/sources/manager.lua

@@ -8,9 +8,11 @@ local renderer = require("neo-tree.ui.renderer")
 local inputs = require("neo-tree.ui.inputs")
 local events = require("neo-tree.events")
 local log = require("neo-tree.log")
+local fs_watch = require("neo-tree.sources.filesystem.lib.fs_watch")
 
 local M = {}
 local source_data = {}
+local default_configs = {}
 
 local get_source_data = function(source_name)
   if source_name == nil then
@@ -22,7 +24,6 @@ local get_source_data = function(source_name)
   end
   sd = {
     name = source_name,
-    default_config = {},
     state_by_tab = {},
     subscriptions = {},
   }
@@ -31,7 +32,8 @@ local get_source_data = function(source_name)
 end
 
 local function create_state(tabnr, sd)
-  local state = utils.table_copy(sd.default_config)
+  local default_config = default_configs[sd.name]
+  local state = utils.table_copy(default_config)
   state.tabnr = tabnr
   state.dirty = true
   state.position = {
@@ -68,12 +70,25 @@ local function create_state(tabnr, sd)
   return state
 end
 
+---For use in tests only, completely resets the state of all sources.
+---This closes all windows as well since they would be broken by this action.
+M._clear_state = function()
+  fs_watch.unwatch_all()
+  renderer.close_all_floating_windows()
+  for _, data in pairs(source_data) do
+    for _, state in pairs(data.state_by_tab) do
+      renderer.close(state)
+    end
+  end
+  source_data = {}
+end
+
 M.set_default_config = function(source_name, config)
   if source_name == nil then
     error("set_default_config: source_name cannot be nil")
   end
+  default_configs[source_name] = config
   local sd = get_source_data(source_name)
-  sd.default_config = config
   for tabnr, tab_config in pairs(sd.state_by_tab) do
     sd.state_by_tab[tabnr] = utils.table_merge(tab_config, config)
   end

lua/neo-tree/ui/renderer.lua

@@ -376,7 +376,6 @@ create_window = function(state)
     local sourceTitle = state.name:gsub("^%l", string.upper)
     win_options = popups.popup_options("Neo-tree " .. sourceTitle, 40, win_options)
     win_options.win_options = nil
-    print(vim.inspect(win_options))
     win_options.zindex = 40
     local size = { width = 60, height = "80%" }
 

tests/helpers/util.lua

@@ -55,9 +55,12 @@ utils.teardown_test_fs = function()
 end
 
 utils.clear_test_state = function()
-  -- TODO: Clear internal state?
+  -- Create fresh window
   vim.cmd("top new | wincmd o")
   local keepbufnr = vim.api.nvim_get_current_buf()
+  -- Clear ALL neo-tree state
+  require("neo-tree.sources.manager")._clear_state()
+  -- Cleanup any remaining buffers
   for _, bufnr in ipairs(vim.api.nvim_list_bufs()) do
     if bufnr ~= keepbufnr then
       vim.api.nvim_buf_delete(bufnr, { force = true })
@@ -69,7 +72,10 @@ end
 
 utils.editfile = function(testfile)
   vim.cmd("e " .. testfile)
-  assert.are.same(vim.fn.fnamemodify(vim.api.nvim_buf_get_name(0), ":p"), vim.fn.fnamemodify(testfile, ":p"))
+  assert.are.same(
+    vim.fn.fnamemodify(vim.api.nvim_buf_get_name(0), ":p"),
+    vim.fn.fnamemodify(testfile, ":p")
+  )
 end
 
 return utils

tests/neo-tree/neo-tree_spec.lua

@@ -0,0 +1,43 @@
+local util = require("tests.helpers.util")
+local verify = require("tests.helpers.verify")
+
+describe("Filesystem source command", function()
+  local fs = util.setup_test_fs()
+
+  after_each(function()
+    util.clear_test_state()
+  end)
+
+  it("should reveal the current file in the tree", function()
+    local testfile = fs.content[3].abspath
+    util.editfile(testfile)
+
+    local start_bufnr = vim.api.nvim_get_current_buf()
+
+    vim.cmd("NeoTreeReveal")
+    verify.bufnr_is_not(start_bufnr)
+    verify.tree_focused()
+    verify.tree_node_is(testfile)
+  end)
+
+  it("should toggle the reveal-state of the tree", function()
+    local testfile = fs.content[3].abspath
+    util.editfile(testfile)
+
+    local start_bufnr = vim.api.nvim_get_current_buf()
+
+    vim.cmd("NeoTreeRevealToggle")
+    verify.bufnr_is_not(start_bufnr)
+    verify.tree_focused()
+    verify.tree_node_is(testfile)
+
+    -- Wait long enough such that the tree _should have_ closed, then assert it is not focused anymore
+    vim.cmd("NeoTreeRevealToggle")
+    verify.after(250, function()
+      return #vim.api.nvim_tabpage_list_wins(0) == 1
+        and start_bufnr == vim.api.nvim_get_current_buf()
+    end, "Failed to toggle the tree to a closed state with 'action=reveal'")
+  end)
+
+  util.teardown_test_fs()
+end)