canola.nvim/tests/tmpdir.lua
Steven Arcangeli 6175bd6462
feat: trash support for linux and mac (#165)
* wip: skeleton code for trash adapter

* refactor: split trash implementation for mac and linux

* fix: ensure we create the .Trash/$uid dir

* feat: code complete linux trash implementation

* doc: write up trash features

* feat: code complete mac trash implementation

* cleanup: remove previous, terrible, undocumented trash feature

* fix: always disabled trash

* feat: show original path of trashed files

* doc: add a note about calling actions directly

* fix: bugs in trash implementation

* fix: schedule_wrap in mac trash

* doc: fix typo and line wrapping

* fix: parsing of arguments to :Oil command

* doc: small documentation tweaks

* doc: fix awkward wording in the toggle_trash action

* fix: warning on Windows when delete_to_trash = true

* feat: :Oil --trash can open specific trash directories

* fix: show all trash files in device root

* fix: trash mtime should be sortable

* fix: shorten_path handles optional trailing slash

* refactor: overhaul the UI

* fix: keep trash original path vtext from stacking

* refactor: replace disable_changes with an error filter

* fix: shorten path names in home directory relative to root

* doc: small README format changes

* cleanup: remove unnecessary preserve_undo logic

* test: add a functional test for the freedesktop trash adapter

* test: more functional tests for trash

* fix: schedule a callback to avoid main loop error

* refactor: clean up mutator logic

* doc: some comments and type annotations
2023-11-05 12:40:58 -08:00

168 lines
4.1 KiB
Lua

local fs = require("oil.fs")
local test_util = require("tests.test_util")
local await = test_util.await
---@param path string
---@param cb fun(err: nil|string)
local function touch(path, cb)
vim.loop.fs_open(path, "w", 420, function(err, fd) -- 0644
if err then
cb(err)
else
local shortpath = path:gsub("^[^" .. fs.sep .. "]*" .. fs.sep, "")
vim.loop.fs_write(fd, shortpath, nil, function(err2)
if err2 then
cb(err2)
else
vim.loop.fs_close(fd, cb)
end
end)
end
end)
end
---@param filepath string
---@return boolean
local function exists(filepath)
local stat = vim.loop.fs_stat(filepath)
return stat ~= nil and stat.type ~= nil
end
local TmpDir = {}
TmpDir.new = function()
local path = await(vim.loop.fs_mkdtemp, 2, "oil_test_XXXXXXXXX")
a.util.scheduler()
return setmetatable({ path = path }, {
__index = TmpDir,
})
end
---@param paths string[]
function TmpDir:create(paths)
for _, path in ipairs(paths) do
local pieces = vim.split(path, fs.sep)
local partial_path = self.path
for i, piece in ipairs(pieces) do
partial_path = fs.join(partial_path, piece)
if i == #pieces and not vim.endswith(partial_path, fs.sep) then
await(touch, 2, partial_path)
elseif not exists(partial_path) then
vim.loop.fs_mkdir(partial_path, 493)
end
end
end
a.util.scheduler()
end
---@param filepath string
---@return string?
local read_file = function(filepath)
local fd = vim.loop.fs_open(filepath, "r", 420)
if not fd then
return nil
end
local stat = vim.loop.fs_fstat(fd)
local content = vim.loop.fs_read(fd, stat.size)
vim.loop.fs_close(fd)
a.util.scheduler()
return content
end
---@param dir string
---@param cb fun(err: nil|string, entry: {type: oil.EntryType, name: string, root: string}
local function walk(dir)
local ret = {}
for name, type in vim.fs.dir(dir) do
table.insert(ret, {
name = name,
type = type,
root = dir,
})
if type == "directory" then
vim.list_extend(ret, walk(fs.join(dir, name)))
end
end
return ret
end
---@param paths table<string, string>
local assert_fs = function(root, paths)
local unlisted_dirs = {}
for k in pairs(paths) do
local pieces = vim.split(k, "/")
local partial_path = ""
for i, piece in ipairs(pieces) do
partial_path = partial_path .. piece .. "/"
if i ~= #pieces then
unlisted_dirs[partial_path] = true
end
end
end
for k in pairs(unlisted_dirs) do
paths[k] = true
end
local entries = walk(root)
for _, entry in ipairs(entries) do
local fullpath = fs.join(entry.root, entry.name)
local shortpath = fullpath:sub(root:len() + 2)
if entry.type == "directory" then
shortpath = shortpath .. "/"
end
local expected_content = paths[shortpath]
paths[shortpath] = nil
assert.truthy(expected_content, string.format("Unexpected entry '%s'", shortpath))
if entry.type == "file" then
local data = read_file(fullpath)
assert.equals(
expected_content,
data,
string.format(
"File '%s' expected content '%s' received '%s'",
shortpath,
expected_content,
data
)
)
end
end
for k, v in pairs(paths) do
assert.falsy(
k,
string.format(
"Expected %s '%s', but it was not found",
v == true and "directory" or "file",
k
)
)
end
end
---@param paths table<string, string>
function TmpDir:assert_fs(paths)
a.util.scheduler()
assert_fs(self.path, paths)
end
function TmpDir:assert_exists(path)
a.util.scheduler()
path = fs.join(self.path, path)
local stat = vim.loop.fs_stat(path)
assert.truthy(stat, string.format("Expected path '%s' to exist", path))
end
function TmpDir:assert_not_exists(path)
a.util.scheduler()
path = fs.join(self.path, path)
local stat = vim.loop.fs_stat(path)
assert.falsy(stat, string.format("Expected path '%s' to not exist", path))
end
function TmpDir:dispose()
await(fs.recursive_delete, 3, "directory", self.path)
a.util.scheduler()
end
return TmpDir