feat(test): Added Windows support for running tests

Author: crwebb85

run_tests.ps1

@@ -0,0 +1,46 @@
+#!/usr/bin/env pwsh
+$ErrorActionPreference = "Stop"
+
+# Create required directories
+$dirs = @(
+    ".testenv/config/nvim",
+    ".testenv/data/nvim",
+    ".testenv/state/nvim",
+    ".testenv/run/nvim",
+    ".testenv/cache/nvim"
+)
+foreach ($dir in $dirs) {
+    New-Item -ItemType Directory -Force -Path $dir | Out-Null
+}
+
+# Plugin directory
+$PLUGINS = ".testenv/data/nvim-data/site/pack/plugins/start"
+
+# Ensure plenary.nvim is present
+$plenaryPath = Join-Path $PLUGINS "plenary.nvim"
+if (-Not (Test-Path $plenaryPath)) {
+    git clone --depth=1 https://github.com/nvim-lua/plenary.nvim.git $plenaryPath
+} else {
+    Push-Location $plenaryPath
+    git pull
+    Pop-Location
+}
+
+# Set environment variables
+$env:XDG_CONFIG_HOME = ".testenv/config"
+$env:XDG_DATA_HOME   = ".testenv/data"
+$env:XDG_STATE_HOME  = ".testenv/state"
+$env:XDG_RUNTIME_DIR = ".testenv/run"
+$env:XDG_CACHE_HOME  = ".testenv/cache"
+
+# Run Neovim tests
+$nvimArgs = @(
+    "--headless",
+    "-u", "./tests/minimal_init.lua",
+    "-c", "PlenaryBustedDirectory $($args[0] ?? 'tests') { minimal_init = './tests/minimal_init.lua' }"
+)
+
+nvim @nvimArgs
+
+Write-Host "Success"
+

tests/files_spec.lua

@@ -1,6 +1,7 @@
 require("plenary.async").tests.add_to_env()
 local TmpDir = require("tests.tmpdir")
 local files = require("oil.adapters.files")
+local fs = require("oil.fs")
 local test_util = require("tests.test_util")
 
 a.describe("files adapter", function()
@@ -15,13 +16,25 @@ a.describe("files adapter", function()
     test_util.reset_editor()
   end)
 
-  a.it("tmpdir creates files and asserts they exist", function()
-    tmpdir:create({ "a.txt", "foo/b.txt", "foo/c.txt", "bar/" })
+  a.it("tmpdir creates file and asserts it exists", function()
+    tmpdir:create({ "a.txt" })
     tmpdir:assert_fs({
       ["a.txt"] = "a.txt",
+    })
+  end)
+
+  a.it("tmpdir creates directory and asserts it exists", function()
+    tmpdir:create({ "bar/" })
+    tmpdir:assert_fs({
+      ["bar/"] = true,
+    })
+  end)
+
+  a.it("tmpdir creates directory and files and asserts they exist", function()
+    tmpdir:create({ "foo/b.txt", "foo/c.txt" })
+    tmpdir:assert_fs({
       ["foo/b.txt"] = "foo/b.txt",
       ["foo/c.txt"] = "foo/c.txt",
-      ["bar/"] = true,
     })
   end)
 
@@ -147,16 +160,32 @@ a.describe("files adapter", function()
     })
   end)
 
-  a.it("Editing a new oil://path/ creates an oil buffer", function()
+  a.it("Editing a new unnormalized oil://path/ creates an oil buffer", function()
     local tmpdir_url = "oil://" .. vim.fn.fnamemodify(tmpdir.path, ":p") .. "/"
     vim.cmd.edit({ args = { tmpdir_url } })
     test_util.wait_oil_ready()
-    local new_url = "oil://" .. vim.fn.fnamemodify(tmpdir.path, ":p") .. "newdir"
-    vim.cmd.edit({ args = { new_url } })
+    local unnormalized_url = "oil://" .. vim.fn.fnamemodify(tmpdir.path, ":p") .. "newdir"
+    local normalized_url = "oil://"
+      .. fs.os_to_posix_path(vim.fn.fnamemodify(tmpdir.path, ":p"))
+      .. "newdir/"
+    vim.cmd.edit({ args = { unnormalized_url } })
     test_util.wait_oil_ready()
     assert.equals("oil", vim.bo.filetype)
     -- The normalization will add a '/'
-    assert.equals(new_url .. "/", vim.api.nvim_buf_get_name(0))
+    assert.equals(normalized_url, vim.api.nvim_buf_get_name(0))
+  end)
+
+  a.it("Editing a new normalized oil://path/ creates an oil buffer", function()
+    local tmpdir_url = "oil://" .. vim.fn.fnamemodify(tmpdir.path, ":p") .. "/"
+    vim.cmd.edit({ args = { tmpdir_url } })
+    test_util.wait_oil_ready()
+    local new_url = "oil://"
+      .. fs.os_to_posix_path(vim.fn.fnamemodify(tmpdir.path, ":p"))
+      .. "newdir/"
+    vim.cmd.edit({ args = { new_url } })
+    test_util.wait_oil_ready()
+    assert.equals("oil", vim.bo.filetype)
+    assert.equals(new_url, vim.api.nvim_buf_get_name(0))
   end)
 
   a.it("Editing a new oil://file.rb creates a normal buffer", function()

tests/tmpdir.lua

@@ -41,11 +41,15 @@ end
 ---@param paths string[]
 function TmpDir:create(paths)
   for _, path in ipairs(paths) do
-    local pieces = vim.split(path, fs.sep)
+    local pieces = vim.split(path, "[\\/]")
     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
+      if
+        i == #pieces
+        and not vim.endswith(partial_path, "/")
+        and not vim.endswith(partial_path, "\\")
+      then
         await(touch, 2, partial_path)
       elseif not exists(partial_path) then
         vim.loop.fs_mkdir(partial_path, 493)
@@ -90,7 +94,7 @@ end
 local assert_fs = function(root, paths)
   local unlisted_dirs = {}
   for k in pairs(paths) do
-    local pieces = vim.split(k, "/")
+    local pieces = vim.split(k, "[/\\]")
     local partial_path = ""
     for i, piece in ipairs(pieces) do
       partial_path = partial_path .. piece .. "/"
@@ -110,11 +114,15 @@ local assert_fs = function(root, paths)
     if entry.type == "directory" then
       shortpath = shortpath .. "/"
     end
+    shortpath = shortpath:gsub("\\", "/")
     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)
+      if data ~= nil then
+        data = data:gsub("\\", "/")
+      end
       assert.equals(
         expected_content,
         data,

tests/url_spec.lua

@@ -4,39 +4,49 @@ local util = require("oil.util")
 local uv = vim.uv or vim.loop
 
 describe("url", function()
-  if not uv.os_uname().version:match("Windows") then
-    --These tests rely on functions like vim.fn.getcwd and vim.loop.os_homedir
-    --returning unix style paths so these test don't make sense to run on Windows
-    it("get parent url for empty string path", function()
-      local input = ""
-      local expected = "oil://" .. util.addslash(vim.fn.getcwd())
+  it("get parent url for empty string path", function()
+    if uv.os_uname().version:match("Windows") then
+      pending("Skipping this test on Windows because it relies on a unix styled current directory")
+      return
+    end
+    local input = ""
+    local expected = "oil://" .. util.addslash(vim.fn.getcwd())
 
-      local output, basename = oil.get_buffer_parent_url(input, true)
-      assert.equals(expected, output, string.format('Parent url for path "%s" failed', input))
-      assert.equals(nil, basename, string.format('Basename for path "%s" failed', input))
-    end)
-
-    it("get parent url for term name", function()
-      local input = "term://~/oil.nvim//52953:/bin/sh"
-      local expected = "oil://" .. vim.loop.os_homedir() .. "/oil.nvim/"
-      local output, basename = oil.get_buffer_parent_url(input, true)
-      assert.equals(expected, output, string.format('Parent url for path "%s" failed', input))
-      assert.equals(nil, basename, string.format('Basename for path "%s" failed', input))
-    end)
+    local output, basename = oil.get_buffer_parent_url(input, true)
+    assert.equals(expected, output, string.format('Parent url for path "%s" failed', input))
+    assert.equals(nil, basename, string.format('Basename for path "%s" failed', input))
+  end)
 
-    it("get parent url for unix path", function()
-      local input = "/foo/bar.txt"
-      local expected = "oil:///foo/"
-      local expected_basename = "bar.txt"
-      local output, basename = oil.get_buffer_parent_url(input, true)
-      assert.equals(expected, output, string.format('Parent url for path "%s" failed', input))
-      assert.equals(
-        expected_basename,
-        basename,
-        string.format('Basename for path "%s" failed', input)
+  it("get parent url for term name", function()
+    if uv.os_uname().version:match("Windows") then
+      pending(
+        "Skipping this test on Windows because it relies on a unix styled current home directory"
       )
-    end)
-  end
+      return
+    end
+    local input = "term://~/oil.nvim//52953:/bin/sh"
+    local expected = "oil://" .. vim.loop.os_homedir() .. "/oil.nvim/"
+    local output, basename = oil.get_buffer_parent_url(input, true)
+    assert.equals(expected, output, string.format('Parent url for path "%s" failed', input))
+    assert.equals(nil, basename, string.format('Basename for path "%s" failed', input))
+  end)
+
+  it("get parent url for unix path", function()
+    if uv.os_uname().version:match("Windows") then
+      pending("Skipping this test on Windows because it relies on a unix styled absolute path")
+      return
+    end
+    local input = "/foo/bar.txt"
+    local expected = "oil:///foo/"
+    local expected_basename = "bar.txt"
+    local output, basename = oil.get_buffer_parent_url(input, true)
+    assert.equals(expected, output, string.format('Parent url for path "%s" failed', input))
+    assert.equals(
+      expected_basename,
+      basename,
+      string.format('Basename for path "%s" failed', input)
+    )
+  end)
 
   it("get parent url for oil path", function()
     local input = "oil:///foo/bar.txt"