nvim-pack
/
gitsigns.nvim
mirror of https://github.com/lewis6991/gitsigns.nvim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix: vendor testsuite

This commit is contained in:
Lewis Russell 2023-06-11 16:41:47 +01:00 committed by Lewis Russell
parent 4d63d996b0
commit 4bbfb06cf7
27 changed files with 3664 additions and 181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
.github/workflows/ci.yml vendored
View File

@ -14,47 +14,35 @@ jobs:
# Check commit messages
- uses: webiny/action-conventional-commits@v1.1.0
build:
test:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
neovim_branch: ['v0.8.3', 'v0.9.1', 'nightly']
runs-on: ubuntu-latest
neovim_branch:
- 'v0.8.3'
- 'v0.9.1'
- 'nightly'
env:
NEOVIM_BRANCH: ${{ matrix.neovim_branch }}
NVIM_TEST_VERSION: ${{ matrix.neovim_branch }}
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Get Neovim SHA
id: get-nvim-sha
run: |
echo "sha=$(git ls-remote https://github.com/neovim/neovim ${{env.NEOVIM_BRANCH}} | cut -f1)" >> $GITHUB_OUTPUT
- name: Cache Deps
id: cache-deps
uses: actions/cache@v3
- uses: leafo/gh-actions-lua@v9
with:
path: deps
key: ${{ steps.get-nvim-sha.outputs.sha }}-${{ hashFiles('.github/workflows/ci.yml', 'Makefile') }}
luaVersion: "5.1.5"
- name: Install Neovim build dependencies
if: steps.cache-deps.outputs.cache-hit != 'true'
run: |
sudo apt-get update &&
sudo apt-get install -y \
cmake \
g++ \
gettext \
libtool-bin \
lua-bitop \
ninja-build \
unzip
- uses: leafo/gh-actions-luarocks@v4
- name: Build Neovim
if: steps.cache-deps.outputs.cache-hit != 'true'
run: make test_deps
- name: install busted
run: luarocks install busted
- name: Download Nvim
run: make nvim
- name: Run Test
run: make test

5
.gitignore vendored
View File

@ -1,5 +1,6 @@
doc/tags
neovim
scratch/dummy_ignored.txt
nvim-test-*
nvim-runner-*

84
Makefile
View File

@ -3,64 +3,56 @@ export PJ_ROOT=$(PWD)
FILTER ?= .*
LUA_VERSION := 5.1
NEOVIM_BRANCH ?= master
NVIM_RUNNER_VERSION := v0.9.1
NVIM_TEST_VERSION ?= v0.9.1
DEPS_DIR := $(PWD)/deps/nvim-$(NEOVIM_BRANCH)
NVIM_DIR := $(DEPS_DIR)/neovim
ifeq ($(shell uname -s),Darwin)
NVIM_PLATFORM ?= macos
else
NVIM_PLATFORM ?= linux64
endif
LUAROCKS := luarocks
LUAROCKS_TREE := $(DEPS_DIR)/luarocks/usr
LUAROCKS_LPATH := $(LUAROCKS_TREE)/share/lua/$(LUA_VERSION)
LUAROCKS_INIT := eval $$($(LUAROCKS) --tree $(LUAROCKS_TREE) path) &&
NVIM_URL := https://github.com/neovim/neovim/releases/download
NVIM_RUNNER := nvim-runner-$(NVIM_RUNNER_VERSION)
NVIM_RUNNER_URL := $(NVIM_URL)/$(NVIM_RUNNER_VERSION)/nvim-$(NVIM_PLATFORM).tar.gz
NVIM_TEST := nvim-test-$(NVIM_TEST_VERSION)
NVIM_TEST_URL := $(NVIM_URL)/$(NVIM_TEST_VERSION)/nvim-$(NVIM_PLATFORM).tar.gz
export NVIM_PRG = $(NVIM_TEST)/bin/nvim
.DEFAULT_GOAL := build
$(NVIM_DIR):
@mkdir -p $(DEPS_DIR)
git clone --depth 1 https://github.com/neovim/neovim --branch $(NEOVIM_BRANCH) $@
@# disable LTO to reduce compile time
make -C $@ \
DEPS_BUILD_DIR=$(dir $(LUAROCKS_TREE)) \
CMAKE_BUILD_TYPE=RelWithDebInfo \
CMAKE_EXTRA_FLAGS='-DCI_BUILD=OFF -DENABLE_LTO=OFF'
define fetch_nvim
rm -rf $@
rm -rf nvim-$(NVIM_PLATFORM).tar.gz
wget $(1)
tar -xf nvim-$(NVIM_PLATFORM).tar.gz
rm -rf nvim-$(NVIM_PLATFORM).tar.gz
mv nvim-$(NVIM_PLATFORM) $@
endef
INSPECT := $(LUAROCKS_LPATH)/inspect.lua
$(NVIM_RUNNER):
$(call fetch_nvim,$(NVIM_RUNNER_URL))
$(INSPECT): $(NVIM_DIR)
@mkdir -p $$(dirname $@)
$(LUAROCKS) --tree $(LUAROCKS_TREE) install inspect
touch $@
$(NVIM_TEST):
$(call fetch_nvim,$(NVIM_TEST_URL))
LUV := $(LUAROCKS_TREE)/lib/lua/$(LUA_VERSION)/luv.so
.PHONY: nvim
nvim: $(NVIM_RUNNER) $(NVIM_TEST)
$(LUV): $(NVIM_DIR)
@mkdir -p $$(dirname $@)
$(LUAROCKS) --tree $(LUAROCKS_TREE) install luv
LUAROCKS := luarocks --lua-version=5.1 --tree .luarocks
.PHONY: lua_deps
lua_deps: $(INSPECT)
.PHONY: test_deps
test_deps: $(NVIM_DIR)
export VIMRUNTIME=$(NVIM_DIR)/runtime
export TEST_COLORS=1
BUSTED = $$( [ -f $(NVIM_DIR)/test/busted_runner.lua ] \
&& echo "$(NVIM_DIR)/build/bin/nvim -ll $(NVIM_DIR)/test/busted_runner.lua" \
|| echo "$(LUAROCKS_INIT) busted" )
.luarocks/bin/busted:
$(LUAROCKS) install busted
.PHONY: test
test: $(NVIM_DIR)
$(BUSTED) -v \
test: $(NVIM_RUNNER) $(NVIM_TEST) .luarocks/bin/busted
eval $$($(LUAROCKS) path) && $(NVIM_RUNNER)/bin/nvim -ll test/busted/runner.lua -v \
--lazy \
--helper=$(PWD)/test/preload.lua \
--output test.busted.outputHandlers.nvim \
--lpath=$(NVIM_DIR)/?.lua \
--lpath=$(NVIM_DIR)/build/?.lua \
--lpath=$(NVIM_DIR)/runtime/lua/?.lua \
--lpath=$(DEPS_DIR)/?.lua \
--output test.busted.output_handler \
--lpath=$(PWD)/lua/?.lua \
--filter="$(FILTER)" \
$(PWD)/test
@ -68,8 +60,8 @@ test: $(NVIM_DIR)
-@stty sane
.PHONY: gen_help
gen_help: $(INSPECT)
@$(LUAROCKS_INIT) ./gen_help.lua
gen_help:
@./gen_help.lua
@echo Updated help
.PHONY: build

19
lua/gitsigns/cache.lua generated
View File

@ -1,11 +1,24 @@
local Hunk = require('gitsigns.hunks').Hunk
local GitObj = require('gitsigns.git').Obj
local config = require('gitsigns.config').config
local M = { CacheEntry = {}, CacheObj = {} }
local M = {
CacheEntry = {},
---@class Gitsigns.CacheObj
---@field [integer] Gitsigns.CacheEntry
---@field destroy fun(self: Gitsigns.CacheObj, bufnr: integer)
CacheObj = {}
}
-- Timer object watching the gitdir
--- @class Gitsigns.CacheEntry
--- @field compare_text? string[]
--- @field compare_text_head? string[]
--- @field hunks Gitsigns.Hunk.Hunk[]
--- @field hunks_staged? Gitsigns.Hunk.Hunk[]
--- @field commit? string
--- @field base? string
--- @field git_obj Gitsigns.GitObj
--- @field gitdir_watcher? uv_poll_t
local CacheEntry = M.CacheEntry
function CacheEntry:get_compare_rev(base)

2
lua/gitsigns/config.lua generated
View File

@ -22,7 +22,7 @@ end
--- @field vertical boolean
--- @field linematch integer
--- @class Gitsign.SignConfig
--- @class Gitsigns.SignConfig
--- @field show_count boolean
--- @field hl string
--- @field text string

94
lua/gitsigns/git.lua generated
View File

@ -9,7 +9,6 @@ local gs_config = require('gitsigns.config')
local config = gs_config.config
local gs_hunks = require('gitsigns.hunks')
local Hunk = gs_hunks.Hunk
local uv = vim.loop
local startswith = vim.startswith
@ -20,7 +19,14 @@ local err = require('gitsigns.message').error
-- local extensions
local M = { BlameInfo = {}, Version = {}, RepoInfo = {}, Repo = {}, FileProps = {}, Obj = {} }
local M = {
BlameInfo = {},
Version = {},
RepoInfo = {},
Repo = {},
FileProps = {},
Obj = {}
}
-- Info in header
@ -45,7 +51,25 @@ local in_git_dir = function(file)
return false
end
--- @class Gitsigns.GitObj
--- @field file string
--- @field encoding string
--- @field i_crlf boolean
--- @field w_crlf boolean
--- @field mode_bits string
--- @field object_name string
--- @field relpath string
--- @field orig_relpath? string
--- @field repo Gitsigns.Repo
--- @field has_conflicts? boolean
local Obj = M.Obj
--- @class Gitsigns.Repo
--- @field gitdir string
--- @field toplevel string
--- @field detached boolean
--- @field abbrev_head string
--- @field username string
local Repo = M.Repo
local function parse_version(version)
@ -105,7 +129,7 @@ function M._set_version(version)
M.version = parse_version(parts[3])
end
--- @async
--- @type fun(args, spec): string[], string?
local git_command = async.create(function(args, spec)
if not M.version then
M._set_version(config._git_version)
@ -196,8 +220,7 @@ end
local has_cygpath = jit and jit.os == 'Windows' and vim.fn.executable('cygpath') == 1
--- @async
local cygpath_convert
local cygpath_convert ---@type fun(path: string): string
if has_cygpath then
cygpath_convert = function(path)
@ -214,7 +237,18 @@ local function normalize_path(path)
return path
end
--- @class Gitsigns.RepoInfo
--- @field gitdir string
--- @field toplevel string
--- @field detached boolean
--- @field abbrev_head string
--- @async
--- @param path string
--- @param cmd? string
--- @param gitdir? string
--- @param toplevel? string
--- @return Gitsigns.RepoInfo
function M.get_repo_info(path, cmd, gitdir, toplevel)
-- Does git rev-parse have --absolute-git-dir, added in 2.13:
-- https://public-inbox.org/git/20170203024829.8071-16-szeder.dev@gmail.com/
@ -249,6 +283,7 @@ function M.get_repo_info(path, cmd, gitdir, toplevel)
cwd = toplevel or path,
})
--- @type Gitsigns.RepoInfo
local ret = {
toplevel = normalize_path(results[1]),
gitdir = normalize_path(results[2]),
@ -287,9 +322,10 @@ end
--- @async
function Repo:files_changed()
--- @type string[]
local results = self:command({ 'status', '--porcelain', '--ignore-submodules' })
local ret = {}
local ret = {} --- @type string[]
for _, line in ipairs(results) do
if line:sub(1, 2):match('^.M') then
ret[#ret + 1] = line:sub(4, -1)
@ -300,7 +336,9 @@ end
local function make_bom(...)
local r = {}
---@diagnostic disable-next-line:no-unknown
for i, a in ipairs({ ... }) do
---@diagnostic disable-next-line:no-unknown
r[i] = string.char(a)
end
return table.concat(r)
@ -338,6 +376,10 @@ end
--- Get version of file in the index, return array lines
--- @async
--- @param object string
--- @param encoding string
--- @return string[] stdout
--- @return string? stderr
function Repo:get_show_text(object, encoding)
local stdout, stderr = self:command({ 'show', object }, { suppress_stderr = true })
@ -372,7 +414,8 @@ function Repo.new(dir, gitdir, toplevel)
self.username = git_command({ 'config', 'user.name' })[1]
local info = M.get_repo_info(dir, nil, gitdir, toplevel)
for k, v in pairs(info) do
for k, v in pairs(info --[[@as table<string,any>]]) do
---@diagnostic disable-next-line:no-unknown
(self)[k] = v
end
@ -384,7 +427,8 @@ function Repo.new(dir, gitdir, toplevel)
then
M.get_repo_info(dir, 'yadm', gitdir, toplevel)
local yadm_info = M.get_repo_info(dir, 'yadm', gitdir, toplevel)
for k, v in pairs(yadm_info) do
for k, v in pairs(yadm_info --[[@as table<string,any>]]) do
---@diagnostic disable-next-line:no-unknown
(self)[k] = v
end
end
@ -487,7 +531,29 @@ Obj.unstage_file = function(self)
self:command({ 'reset', self.file })
end
--- @class Gitsigns.BlameInfo
--- -- Info in header
--- @field sha string
--- @field abbrev_sha string
--- @field orig_lnum integer
--- @field final_lnum integer
--- Porcelain fields
--- @field author string
--- @field author_mail string
--- @field author_time integer
--- @field author_tz string
--- @field committer string
--- @field committer_mail string
--- @field committer_time integer
--- @field committer_tz string
--- @field summary string
--- @field previous string
--- @field previous_filename string
--- @field previous_sha string
--- @field filename string
--- @async
--- @return Gitsigns.BlameInfo?
function Obj:run_blame(lines, lnum, ignore_whitespace)
local not_committed = {
author = 'Not Committed Yet',
@ -528,15 +594,17 @@ function Obj:run_blame(lines, lnum, ignore_whitespace)
end
local header = vim.split(table.remove(results, 1), ' ')
local ret = {}
local ret = {} --- @type Gitsigns.BlameInfo
ret.sha = header[1]
ret.orig_lnum = tonumber(header[2])
ret.final_lnum = tonumber(header[3])
ret.orig_lnum = tonumber(header[2]) --[[@as integer]]
ret.final_lnum = tonumber(header[3]) --[[@as integer]]
ret.abbrev_sha = string.sub(ret.sha, 1, 8)
for _, l in ipairs(results) do
if not startswith(l, '\t') then
local cols = vim.split(l, ' ')
--- @type string
local key = table.remove(cols, 1):gsub('-', '_')
--- @diagnostic disable-next-line:no-unknown
ret[key] = table.concat(cols, ' ')
if key == 'previous' then
ret.previous_sha = cols[1]
@ -639,6 +707,10 @@ function Obj:has_moved()
end
--- @async
--- @param file string
--- @param encoding string
--- @param gitdir string
--- @param toplevel string
function Obj.new(file, encoding, gitdir, toplevel)
if in_git_dir(file) then
dprint('In git dir')

9
lua/gitsigns/hunks.lua generated
View File

@ -1,6 +1,3 @@
local Sign = require('gitsigns.signs').Sign
local StatusObj = require('gitsigns.status').StatusObj
local util = require('gitsigns.util')
local min, max = math.min, math.max
@ -33,8 +30,6 @@ local M = { Node = {}, Hunk = {}, Hunk_Public = {} }
-- For internal use
local Hunk = M.Hunk
--- @param old_start integer
--- @param old_count integer
--- @param new_start integer
@ -330,8 +325,8 @@ function M.find_nearest_hunk(lnum, hunks, forwards, wrap)
return ret, index
end
--- @param a Gitsigns.Hunk.Hunk[]
--- @param b Gitsigns.Hunk.Hunk[]
--- @param a Gitsigns.Hunk.Hunk[]?
--- @param b Gitsigns.Hunk.Hunk[]?
--- @return boolean
function M.compare_heads(a, b)
if (a == nil) ~= (b == nil) then

24
lua/gitsigns/manager.lua generated
View File

@ -3,7 +3,6 @@ local awrap = require('gitsigns.async').wrap
local scheduler = require('gitsigns.async').scheduler
local gs_cache = require('gitsigns.cache')
local CacheEntry = gs_cache.CacheEntry
local cache = gs_cache.cache
local Signs = require('gitsigns.signs')
@ -23,14 +22,13 @@ local run_diff = require('gitsigns.diff')
local uv = require('gitsigns.uv')
local gs_hunks = require('gitsigns.hunks')
local Hunk = gs_hunks.Hunk
local config = require('gitsigns.config').config
local api = vim.api
local signs_normal
local signs_staged
local signs_normal --- @type Gitsigns.Signs
local signs_staged --- @type Gitsigns.Signs
local M = {}
@ -42,6 +40,9 @@ local scheduler_if_buf_valid = awrap(function(buf, cb)
end)
end, 2)
--- @param bufnr integer
--- @param signs Gitsigns.Signs
--- @param hunks Gitsigns.Hunk.Hunk[]
local function apply_win_signs0(bufnr, signs, hunks, top, bot, clear, untracked)
if clear then
signs:remove(bufnr) -- Remove all signs
@ -107,6 +108,8 @@ end
local ns = api.nvim_create_namespace('gitsigns')
--- @param bufnr integer
--- @param row integer
local function apply_word_diff(bufnr, row)
-- Don't run on folded lines
if vim.fn.foldclosed(row + 1) ~= -1 then
@ -191,6 +194,9 @@ local function clear_deleted(bufnr)
end
end
--- @param bufnr integer
--- @param nsd integer
--- @param hunk Gitsigns.Hunk.Hunk
function M.show_deleted(bufnr, nsd, hunk)
local virt_lines = {}
@ -327,6 +333,9 @@ function M.show_deleted_in_float(bufnr, nsd, hunk)
return winid
end
--- @param bufnr integer
--- @param nsw integer
--- @param hunk Gitsigns.Hunk.Hunk
function M.show_added(bufnr, nsw, hunk)
local start_row = hunk.added.start - 1
@ -372,6 +381,8 @@ local update_cnt = 0
-- Since updates are asynchronous we need to make sure an update isn't performed
-- whilst another one is in progress. If this happens then schedule another
-- update after the current one has completed.
--- @param bufnr integer
--- @param bcache Gitsigns.CacheEntry
M.update = throttle_by_id(function(bufnr, bcache)
local __FUNC__ = 'update'
bcache = bcache or cache[bufnr]
@ -441,6 +452,9 @@ M.detach = function(bufnr, keep_signs)
end
end
--- @param bufnr integer
--- @param bcache Gitsigns.CacheEntry
--- @param old_relpath string
local function handle_moved(bufnr, bcache, old_relpath)
local git_obj = bcache.git_obj
local do_update = false
@ -489,7 +503,7 @@ function M.watch_gitdir(bufnr, gitdir)
end
dprintf('Watching git dir')
local w = uv.new_fs_poll(true)
local w = assert(uv.new_fs_poll(true))
w:start(
gitdir,
config.watch_gitdir.interval,

42
lua/gitsigns/signs.lua generated
View File

@ -2,7 +2,45 @@ local config = require('gitsigns.config').config
local dprint = require('gitsigns.debug.log').dprint
local B = require('gitsigns.signs.base')
--- @alias GitSigns.SignType
--- | 'add'
--- | 'delete'
--- | 'change'
--- | 'topdelete'
--- | 'changedelete'
--- | 'untracked'
--- @class Gitsigns.Sign
--- @field type Gitsigns.SignType
--- @field count integer
--- @field lnum integer
--- @class Gitsigns.HlDef
--- @field hl string
--- @field numhl string
--- @field linehl string
--- @class Gitsigns.Signs
--- @field hls table<Gitsigns.SignType,Gitsigns.HlDef>
--- @field name string
--- @field group string
--- @field config Gitsigns.SignConfig
--- Used by signs/extmarks.tl
--- @field ns integer
--- Used by signs/vimfn.tl
--- @field placed table<integer,table<integer,Gitsigns.Sign>>
--- @field new fun(cfg: Gitsigns.SignConfig, name: string): Gitsigns.Signs
--- @field _new fun(cfg: Gitsigns.SignConfig, hls: {SignType:Gitsigns.HlDef}, name: string): Gitsigns.Signs
--- @field remove fun(self: Gitsigns.Signs, bufnr: integer, start_lnum?: integer, end_lnum?: integer)
--- @field add fun(self: Gitsigns.Signs, bufnr: integer, signs: Gitsigns.Sign[])
--- @field contains fun(self: Gitsigns.Signs, bufnr: integer, start: integer, last: integer): boolean
--- @field on_lines fun(self: Gitsigns.Signs, bufnr: integer, first: integer, last_orig: integer, last_new: integer)
--- @field reset fun(self: Gitsigns.Signs)
local B = {
Sign = {},
HlDef = {}
}
-- local function capitalise_word(x: string): string
-- return x:sub(1, 1):upper()..x:sub(2)
@ -10,7 +48,7 @@ local B = require('gitsigns.signs.base')
function B.new(cfg, name)
local __FUNC__ = 'signs.init'
local C
local C --- @type Gitsigns.Signs
if config._extmark_signs then
dprint('Using extmark signs')
C = require('gitsigns.signs.extmarks')

11
lua/gitsigns/signs/base.lua generated
View File

@ -1,9 +1,6 @@
local SignsConfig = require('gitsigns.config').Config.SignsConfig
local M = { Sign = {}, HlDef = {} }
-- Used by signs/extmarks.tl
-- Used by signs/vimfn.tl
local M = {
Sign = {},
HlDef = {}
}
return M

2
lua/gitsigns/signs/vimfn.lua generated
View File

@ -28,7 +28,7 @@ local function get_sign_name(name, stype)
local key = name .. stype
if not sign_name_cache[key] then
sign_name_cache[key] =
string.format('%s%s%s', 'GitSigns', capitalise_word(key), capitalise_word(stype))
string.format('%s%s%s', 'GitSigns', capitalise_word(name), capitalise_word(stype))
end
return sign_name_cache[key]

2
test/actions_spec.lua
View File

@ -52,7 +52,7 @@ describe('actions', function()
clear()
-- Make gitisigns available
exec_lua('package.path = ...', package.path)
config = helpers.deepcopy(test_config)
config = vim.deepcopy(test_config)
command('cd '..system{"dirname", os.tmpname()})
setup_gitsigns(config)
end)

277
test/busted/output_handler.lua Normal file
View File

@ -0,0 +1,277 @@
local pretty = require 'pl.pretty'
local global_helpers = require('test.helpers')()
-- Colors are disabled by default. #15610
local colors = require 'term.colors'
return function(options)
local busted = require 'busted'
local handler = require 'busted.outputHandlers.base'()
local c = {
succ = function(s) return colors.bright(colors.green(s)) end,
skip = function(s) return colors.bright(colors.yellow(s)) end,
fail = function(s) return colors.bright(colors.magenta(s)) end,
errr = function(s) return colors.bright(colors.red(s)) end,
test = tostring,
file = colors.cyan,
time = colors.dim,
note = colors.yellow,
sect = function(s) return colors.green(colors.dim(s)) end,
nmbr = colors.bright,
}
local repeatSuiteString = '\nRepeating all tests (run %d of %d) . . .\n\n'
local randomizeString = c.note('Note: Randomizing test order with a seed of %d.\n')
local globalSetup = c.sect('--------') .. ' Global test environment setup.\n'
local fileStartString = c.sect('--------') .. ' Running tests from ' .. c.file('%s') .. '\n'
local runString = c.sect('RUN ') .. ' ' .. c.test('%s') .. ': '
local successString = c.succ('OK') .. '\n'
local skippedString = c.skip('SKIP') .. '\n'
local failureString = c.fail('FAIL') .. '\n'
local errorString = c.errr('ERR') .. '\n'
local fileEndString = c.sect('--------') .. ' '.. c.nmbr('%d') .. ' %s from ' .. c.file('%s') .. ' ' .. c.time('(%.2f ms total)') .. '\n\n'
local globalTeardown = c.sect('--------') .. ' Global test environment teardown.\n'
local suiteEndString = c.sect('========') .. ' ' .. c.nmbr('%d') .. ' %s from ' .. c.nmbr('%d') .. ' test %s ran. ' .. c.time('(%.2f ms total)') .. '\n'
local successStatus = c.succ('PASSED ') .. ' ' .. c.nmbr('%d') .. ' %s.\n'
local timeString = c.time('%.2f ms')
local summaryStrings = {
skipped = {
header = c.skip('SKIPPED ') .. ' ' .. c.nmbr('%d') .. ' %s, listed below:\n',
test = c.skip('SKIPPED ') .. ' %s\n',
footer = ' ' .. c.nmbr('%d') .. ' SKIPPED %s\n',
},
failure = {
header = c.fail('FAILED ') .. ' ' .. c.nmbr('%d') .. ' %s, listed below:\n',
test = c.fail('FAILED ') .. ' %s\n',
footer = ' ' .. c.nmbr('%d') .. ' FAILED %s\n',
},
error = {
header = c.errr('ERROR ') .. ' ' .. c.nmbr('%d') .. ' %s, listed below:\n',
test = c.errr('ERROR ') .. ' %s\n',
footer = ' ' .. c.nmbr('%d') .. ' %s\n',
},
}
local fileCount = 0
local fileTestCount = 0
local testCount = 0
local successCount = 0
local skippedCount = 0
local failureCount = 0
local errorCount = 0
local pendingDescription = function(pending)
local string = ''
if type(pending.message) == 'string' then
string = string .. pending.message .. '\n'
elseif pending.message ~= nil then
string = string .. pretty.write(pending.message) .. '\n'
end
return string
end
local failureDescription = function(failure)
local string = failure.randomseed and ('Random seed: ' .. failure.randomseed .. '\n') or ''
if type(failure.message) == 'string' then
string = string .. failure.message
elseif failure.message == nil then
string = string .. 'Nil error'
else
string = string .. pretty.write(failure.message)
end
string = string .. '\n'
if options.verbose and failure.trace and failure.trace.traceback then
string = string .. failure.trace.traceback .. '\n'
end
return string
end
local getFileLine = function(element)
local fileline = ''
if element.trace or element.trace.short_src then
fileline = colors.cyan(element.trace.short_src) .. ' @ ' ..
colors.cyan(element.trace.currentline) .. ': '
end
return fileline
end
local getTestList = function(status, count, list, getDescription)
local string = ''
local header = summaryStrings[status].header
if count > 0 and header then
local tests = (count == 1 and 'test' or 'tests')
local errors = (count == 1 and 'error' or 'errors')
string = header:format(count, status == 'error' and errors or tests)
local testString = summaryStrings[status].test
if testString then
for _, t in ipairs(list) do
local fullname = getFileLine(t.element) .. colors.bright(t.name)
string = string .. testString:format(fullname)
string = string .. getDescription(t)
end
end
end
return string
end
local getSummary = function(status, count)
local string = ''
local footer = summaryStrings[status].footer
if count > 0 and footer then
local tests = (count == 1 and 'TEST' or 'TESTS')
local errors = (count == 1 and 'ERROR' or 'ERRORS')
string = footer:format(count, status == 'error' and errors or tests)
end
return string
end
local getSummaryString = function()
local tests = (successCount == 1 and 'test' or 'tests')
local string = successStatus:format(successCount, tests)
string = string .. getTestList('skipped', skippedCount, handler.pendings, pendingDescription)
string = string .. getTestList('failure', failureCount, handler.failures, failureDescription)
string = string .. getTestList('error', errorCount, handler.errors, failureDescription)
string = string .. ((skippedCount + failureCount + errorCount) > 0 and '\n' or '')
string = string .. getSummary('skipped', skippedCount)
string = string .. getSummary('failure', failureCount)
string = string .. getSummary('error', errorCount)
return string
end
handler.suiteReset = function()
fileCount = 0
fileTestCount = 0
testCount = 0
successCount = 0
skippedCount = 0
failureCount = 0
errorCount = 0
return nil, true
end
handler.suiteStart = function(_suite, count, total, randomseed)
if total > 1 then
io.write(repeatSuiteString:format(count, total))
end
if randomseed then
io.write(randomizeString:format(randomseed))
end
io.write(globalSetup)
io.flush()
return nil, true
end
local function getElapsedTime(tbl)
if tbl.duration then
return tbl.duration * 1000
else
return tonumber('nan')
end
end
handler.suiteEnd = function(suite, _count, _total)
local elapsedTime_ms = getElapsedTime(suite)
local tests = (testCount == 1 and 'test' or 'tests')
local files = (fileCount == 1 and 'file' or 'files')
io.write(globalTeardown)
io.write(suiteEndString:format(testCount, tests, fileCount, files, elapsedTime_ms))
io.write(getSummaryString())
if failureCount > 0 or errorCount > 0 then
io.write(global_helpers.read_nvim_log(nil, true))
end
io.flush()
return nil, true
end
handler.fileStart = function(file)
fileTestCount = 0
io.write(fileStartString:format(vim.fs.normalize(file.name)))
io.flush()
return nil, true
end
handler.fileEnd = function(file)
local elapsedTime_ms = getElapsedTime(file)
local tests = (fileTestCount == 1 and 'test' or 'tests')
fileCount = fileCount + 1
io.write(fileEndString:format(fileTestCount, tests, vim.fs.normalize(file.name), elapsedTime_ms))
io.flush()
return nil, true
end
handler.testStart = function(element, _parent)
local testid = _G._nvim_test_id or ''
local desc = ('%s %s'):format(testid, handler.getFullName(element))
io.write(runString:format(desc))
io.flush()
return nil, true
end
local function write_status(element, string)
io.write(timeString:format(getElapsedTime(element)) .. ' ' .. string)
io.flush()
end
handler.testEnd = function(element, _parent, status, _debug)
local string
fileTestCount = fileTestCount + 1
testCount = testCount + 1
if status == 'success' then
successCount = successCount + 1
string = successString
elseif status == 'pending' then
skippedCount = skippedCount + 1
string = skippedString
elseif status == 'failure' then
failureCount = failureCount + 1
string = failureString .. failureDescription(handler.failures[#handler.failures])
elseif status == 'error' then
errorCount = errorCount + 1
string = errorString .. failureDescription(handler.errors[#handler.errors])
else
string = "unexpected test status! ("..status..")"
end
write_status(element, string)
return nil, true
end
handler.error = function(element, _parent, _message, _debug)
if element.descriptor ~= 'it' then
write_status(element, failureDescription(handler.errors[#handler.errors]))
errorCount = errorCount + 1
end
return nil, true
end
busted.subscribe({ 'suite', 'reset' }, handler.suiteReset)
busted.subscribe({ 'suite', 'start' }, handler.suiteStart)
busted.subscribe({ 'suite', 'end' }, handler.suiteEnd)
busted.subscribe({ 'file', 'start' }, handler.fileStart)
busted.subscribe({ 'file', 'end' }, handler.fileEnd)
busted.subscribe({ 'test', 'start' }, handler.testStart, { predicate = handler.cancelOnPending })
busted.subscribe({ 'test', 'end' }, handler.testEnd, { predicate = handler.cancelOnPending })
busted.subscribe({ 'failure' }, handler.error)
busted.subscribe({ 'error' }, handler.error)
return handler
end

1
test/busted/runner.lua Normal file
View File

@ -0,0 +1 @@
require 'busted.runner'({ standalone = false })

121
test/client/msgpack_rpc_stream.lua Normal file
View File

@ -0,0 +1,121 @@
local mpack = require('mpack')
-- temporary hack to be able to manipulate buffer/window/tabpage
local Buffer = {}
Buffer.__index = Buffer
function Buffer.new(id)
return setmetatable({id=id}, Buffer)
end
local Window = {}
Window.__index = Window
function Window.new(id)
return setmetatable({id=id}, Window)
end
local Tabpage = {}
Tabpage.__index = Tabpage
function Tabpage.new(id)
return setmetatable({id=id}, Tabpage)
end
local Response = {}
Response.__index = Response
function Response.new(msgpack_rpc_stream, request_id)
return setmetatable({
_msgpack_rpc_stream = msgpack_rpc_stream,
_request_id = request_id
}, Response)
end
function Response:send(value, is_error)
local data = self._msgpack_rpc_stream._session:reply(self._request_id)
if is_error then
data = data .. self._msgpack_rpc_stream._pack(value)
data = data .. self._msgpack_rpc_stream._pack(mpack.NIL)
else
data = data .. self._msgpack_rpc_stream._pack(mpack.NIL)
data = data .. self._msgpack_rpc_stream._pack(value)
end
self._msgpack_rpc_stream._stream:write(data)
end
--- @class MsgpackRpcStream
local MsgpackRpcStream = {}
MsgpackRpcStream.__index = MsgpackRpcStream
function MsgpackRpcStream.new(stream)
return setmetatable({
_stream = stream,
_pack = mpack.Packer({
ext = {
[Buffer] = function(o) return 0, mpack.encode(o.id) end,
[Window] = function(o) return 1, mpack.encode(o.id) end,
[Tabpage] = function(o) return 2, mpack.encode(o.id) end
}
}),
_session = mpack.Session({
unpack = mpack.Unpacker({
ext = {
[0] = function(_c, s) return Buffer.new(mpack.decode(s)) end,
[1] = function(_c, s) return Window.new(mpack.decode(s)) end,
[2] = function(_c, s) return Tabpage.new(mpack.decode(s)) end
}
})
}),
}, MsgpackRpcStream)
end
function MsgpackRpcStream:write(method, args, response_cb)
local data
if response_cb then
assert(type(response_cb) == 'function')
data = self._session:request(response_cb)
else
data = self._session:notify()
end
data = data .. self._pack(method) .. self._pack(args)
self._stream:write(data)
end
function MsgpackRpcStream:read_start(request_cb, notification_cb, eof_cb)
self._stream:read_start(function(data)
if not data then
return eof_cb()
end
local type, id_or_cb, method_or_error, args_or_result
local pos = 1
local len = #data
while pos <= len do
type, id_or_cb, method_or_error, args_or_result, pos =
self._session:receive(data, pos)
if type == 'request' or type == 'notification' then
if type == 'request' then
request_cb(method_or_error, args_or_result, Response.new(self,
id_or_cb))
else
notification_cb(method_or_error, args_or_result)
end
elseif type == 'response' then
if method_or_error == mpack.NIL then
method_or_error = nil
else
args_or_result = nil
end
id_or_cb(method_or_error, args_or_result)
end
end
end)
end
function MsgpackRpcStream:read_stop()
self._stream:read_stop()
end
function MsgpackRpcStream:close(signal)
self._stream:close(signal)
end
return MsgpackRpcStream

200
test/client/session.lua Normal file
View File

@ -0,0 +1,200 @@
local uv = require('luv')
local MsgpackRpcStream = require('test.client.msgpack_rpc_stream')
--- @class Session
--- @field private _msgpack_rpc_stream MsgpackRpcStream
--- @field private _pending_messages string[]
--- @field private _prepare uv_prepare_t
--- @field private _timer uv_timer_t
--- @field private _is_running boolean
local Session = {}
Session.__index = Session
-- luajit pcall is already coroutine safe
Session.safe_pcall = pcall
local function resume(co, ...)
local status, result = coroutine.resume(co, ...)
if coroutine.status(co) == 'dead' then
if not status then
error(result)
end
return
end
assert(coroutine.status(co) == 'suspended')
result(co)
end
local function coroutine_exec(func, ...)
local args = {...}
local on_complete
if #args > 0 and type(args[#args]) == 'function' then
-- completion callback
on_complete = table.remove(args)
end
resume(coroutine.create(function()
local status, result, flag = Session.safe_pcall(func, unpack(args))
if on_complete then
coroutine.yield(function()
-- run the completion callback on the main thread
on_complete(status, result, flag)
end)
end
end))
end
function Session.new(stream)
return setmetatable({
_msgpack_rpc_stream = MsgpackRpcStream.new(stream),
_pending_messages = {},
_prepare = uv.new_prepare(),
_timer = uv.new_timer(),
_is_running = false
}, Session)
end
function Session:next_message(timeout)
local function on_request(method, args, response)
table.insert(self._pending_messages, {'request', method, args, response})
uv.stop()
end
local function on_notification(method, args)
table.insert(self._pending_messages, {'notification', method, args})
uv.stop()
end
if self._is_running then
error('Event loop already running')
end
if #self._pending_messages > 0 then
return table.remove(self._pending_messages, 1)
end
self:_run(on_request, on_notification, timeout)
return table.remove(self._pending_messages, 1)
end
function Session:notify(method, ...)
self._msgpack_rpc_stream:write(method, {...})
end
function Session:request(method, ...)
local args = {...}
local err, result
if self._is_running then
err, result = self:_yielding_request(method, args)
else
err, result = self:_blocking_request(method, args)
end
if err then
return false, err
end
return true, result
end
function Session:run(request_cb, notification_cb, setup_cb, timeout)
local function on_request(method, args, response)
coroutine_exec(request_cb, method, args, function(status, result, flag)
if status then
response:send(result, flag)
else
response:send(result, true)
end
end)
end
local function on_notification(method, args)
coroutine_exec(notification_cb, method, args)
end
self._is_running = true
if setup_cb then
coroutine_exec(setup_cb)
end
while #self._pending_messages > 0 do
local msg = table.remove(self._pending_messages, 1)
if msg[1] == 'request' then
on_request(msg[2], msg[3], msg[4])
else
on_notification(msg[2], msg[3])
end
end
self:_run(on_request, on_notification, timeout)
self._is_running = false
end
function Session:stop()
uv.stop()
end
function Session:close(signal)
if not self._timer:is_closing() then self._timer:close() end
if not self._prepare:is_closing() then self._prepare:close() end
self._msgpack_rpc_stream:close(signal)
end
--- @param method string
function Session:_yielding_request(method, args)
return coroutine.yield(function(co)
self._msgpack_rpc_stream:write(method, args, function(err, result)
resume(co, err, result)
end)
end)
end
--- @param method string
function Session:_blocking_request(method, args)
local err, result
local function on_request(method_, args_, response)
table.insert(self._pending_messages, {'request', method_, args_, response})
end
local function on_notification(method_, args_)
table.insert(self._pending_messages, {'notification', method_, args_})
end
self._msgpack_rpc_stream:write(method, args, function(e, r)
err = e
result = r
uv.stop()
end)
self:_run(on_request, on_notification)
return (err or self.eof_err), result
end
--- @param request_cb function
--- @param notification_cb function
--- @param timeout? integer
function Session:_run(request_cb, notification_cb, timeout)
if type(timeout) == 'number' then
self._prepare:start(function()
self._timer:start(timeout, 0, function()
uv.stop()
end)
self._prepare:stop()
end)
end
self._msgpack_rpc_stream:read_start(request_cb, notification_cb, function()
uv.stop()
self.eof_err = {1, "EOF was received from Nvim. Likely the Nvim process crashed."}
end)
uv.run()
self._prepare:stop()
self._timer:stop()
self._msgpack_rpc_stream:read_stop()
end
return Session

70
test/client/uv_stream.lua Normal file
View File

@ -0,0 +1,70 @@
local uv = require('luv')
local ChildProcessStream = {}
ChildProcessStream.__index = ChildProcessStream
function ChildProcessStream.spawn(argv, env, io_extra)
local self = setmetatable({
_child_stdin = uv.new_pipe(false);
_child_stdout = uv.new_pipe(false);
_exiting = false;
}, ChildProcessStream)
local prog = argv[1]
local args = {}
for i = 2, #argv do
args[#args + 1] = argv[i]
end
self._proc, self._pid = uv.spawn(prog, {
stdio = {self._child_stdin, self._child_stdout, 2, io_extra},
args = args,
env = env,
}, function(status, signal)
self.status = status
self.signal = signal
end)
if not self._proc then
local err = self._pid
error(err)
end
return self
end
function ChildProcessStream:write(data)
self._child_stdin:write(data)
end
function ChildProcessStream:read_start(cb)
self._child_stdout:read_start(function(err, chunk)
if err then
error(err)
end
cb(chunk)
end)
end
function ChildProcessStream:read_stop()
self._child_stdout:read_stop()
end
function ChildProcessStream:close(signal)
if self._closed then
return
end
self._closed = true
self:read_stop()
self._child_stdin:close()
self._child_stdout:close()
if type(signal) == 'string' then
self._proc:kill('sig'..signal)
end
while self.status == nil do
uv.run 'once'
end
return self.status, self.signal
end
return {
ChildProcessStream = ChildProcessStream;
}

12
test/compat.lua Normal file
View File

@ -0,0 +1,12 @@
-- Lua 5.1 forward-compatibility layer.
-- For background see https://github.com/neovim/neovim/pull/9280
--
-- Reference the lua-compat-5.2 project for hints:
-- https://github.com/keplerproject/lua-compat-5.2/blob/c164c8f339b95451b572d6b4b4d11e944dc7169d/compat52/mstrict.lua
-- https://github.com/keplerproject/lua-compat-5.2/blob/c164c8f339b95451b572d6b4b4d11e944dc7169d/tests/test.lua
local lua_version = _VERSION:sub(-3)
if lua_version >= '5.2' then
unpack = table.unpack -- luacheck: ignore 121 143
end

20
test/gitdir_watcher_spec.lua
View File

@ -1,6 +1,6 @@
local helpers = require('test.gs_helpers')
local Screen = require('test.functional.ui.screen')
local Screen = require('test.screen')
local clear = helpers.clear
local exec_lua = helpers.exec_lua
@ -50,7 +50,7 @@ describe('gitdir_watcher', function()
'attach(1): Attaching (trigger=BufReadPost)',
p"run_job: git .* config user.name",
p"run_job: git .* rev%-parse %-%-show%-toplevel %-%-absolute%-git%-dir %-%-abbrev%-ref HEAD",
p('run_job: git .* ls%-files .* '..helpers.pesc(test_file)),
p('run_job: git .* ls%-files .* '..vim.pesc(test_file)),
'watch_gitdir(1): Watching git dir',
p'run_job: git .* show :0:dummy.txt',
'update(1): updates: 1, jobs: 5',
@ -66,10 +66,10 @@ describe('gitdir_watcher', function()
match_debug_messages {
'watcher_cb(1): Git dir update',
p'run_job: git .* rev%-parse %-%-show%-toplevel %-%-absolute%-git%-dir %-%-abbrev%-ref HEAD',
p('run_job: git .* ls%-files .* '..helpers.pesc(test_file)),
p('run_job: git .* ls%-files .* '..vim.pesc(test_file)),
p'run_job: git .* diff %-%-name%-status %-C %-%-cached',
'handle_moved(1): File moved to dummy.txt2',
p('run_job: git .* ls%-files .* '..helpers.pesc(test_file2)),
p('run_job: git .* ls%-files .* '..vim.pesc(test_file2)),
p'handle_moved%(1%): Renamed buffer 1 from .*/dummy.txt to .*/dummy.txt2',
p'run_job: git .* show :0:dummy.txt2',
'update(1): updates: 2, jobs: 10'
@ -80,15 +80,16 @@ describe('gitdir_watcher', function()
command('Gitsigns clear_debug')
local test_file3 = test_file..'3'
git{'mv', test_file2, test_file3}
match_debug_messages {
'watcher_cb(1): Git dir update',
p'run_job: git .* rev%-parse %-%-show%-toplevel %-%-absolute%-git%-dir %-%-abbrev%-ref HEAD',
p('run_job: git .* ls%-files .* '..helpers.pesc(test_file2)),
p('run_job: git .* ls%-files .* '..vim.pesc(test_file2)),
p'run_job: git .* diff %-%-name%-status %-C %-%-cached',
'handle_moved(1): File moved to dummy.txt3',
p('run_job: git .* ls%-files .* '..helpers.pesc(test_file3)),
p('run_job: git .* ls%-files .* '..vim.pesc(test_file3)),
p'handle_moved%(1%): Renamed buffer 1 from .*/dummy.txt2 to .*/dummy.txt3',
p'run_job: git .* show :0:dummy.txt3',
'update(1): updates: 3, jobs: 15'
@ -103,18 +104,17 @@ describe('gitdir_watcher', function()
match_debug_messages {
'watcher_cb(1): Git dir update',
p'run_job: git .* rev%-parse %-%-show%-toplevel %-%-absolute%-git%-dir %-%-abbrev%-ref HEAD',
p('run_job: git .* ls%-files .* '..helpers.pesc(test_file3)),
p('run_job: git .* ls%-files .* '..vim.pesc(test_file3)),
p'run_job: git .* diff %-%-name%-status %-C %-%-cached',
p('run_job: git .* ls%-files .* '..helpers.pesc(test_file)),
p('run_job: git .* ls%-files .* '..vim.pesc(test_file)),
'handle_moved(1): Moved file reset',
p('run_job: git .* ls%-files .* '..helpers.pesc(test_file)),
p('run_job: git .* ls%-files .* '..vim.pesc(test_file)),
p'handle_moved%(1%): Renamed buffer 1 from .*/dummy.txt3 to .*/dummy.txt',
p'run_job: git .* show :0:dummy.txt',
'update(1): updates: 4, jobs: 21'
}
eq({[1] = test_file}, get_bufs())
end)
end)

10
test/gitsigns_spec.lua
View File

@ -1,6 +1,6 @@
-- vim: foldnestmax=5 foldminlines=1
local Screen = require('test.functional.ui.screen')
local Screen = require('test.screen')
local helpers = require('test.gs_helpers')
local clear = helpers.clear
@ -9,7 +9,7 @@ local exec_capture = helpers.exec_capture
local feed = helpers.feed
local insert = helpers.insert
local exec_lua = helpers.exec_lua
local split = helpers.split
local split = vim.split
local get_buf_var = helpers.curbufmeths.get_var
local fn = helpers.funcs
local system = fn.system
@ -58,7 +58,7 @@ describe('gitsigns', function()
-- Make gitisigns available
exec_lua('package.path = ...', package.path)
config = helpers.deepcopy(test_config)
config = vim.deepcopy(test_config)
command('cd '..system{"dirname", os.tmpname()})
end)
@ -91,7 +91,7 @@ describe('gitsigns', function()
'attach(1): Attaching (trigger=BufReadPost)',
p'run_job: git .* config user.name',
p'run_job: git .* rev%-parse %-%-show%-toplevel %-%-absolute%-git%-dir %-%-abbrev%-ref HEAD',
p('run_job: git .* ls%-files %-%-stage %-%-others %-%-exclude%-standard %-%-eol '..helpers.pesc(test_file)),
p('run_job: git .* ls%-files %-%-stage %-%-others %-%-exclude%-standard %-%-eol '..vim.pesc(test_file)),
'watch_gitdir(1): Watching git dir',
p'run_job: git .* show :0:dummy.txt',
'update(1): updates: 1, jobs: 6'
@ -201,7 +201,7 @@ describe('gitsigns', function()
'attach(1): Attaching (trigger=BufNewFile)',
p'run_job: git .* config user.name',
p'run_job: git .* rev%-parse %-%-show%-toplevel %-%-absolute%-git%-dir %-%-abbrev%-ref HEAD',
p('run_job: git .* ls%-files %-%-stage %-%-others %-%-exclude%-standard %-%-eol '..helpers.pesc(newfile)),
p('run_job: git .* ls%-files %-%-stage %-%-others %-%-exclude%-standard %-%-eol '..vim.pesc(newfile)),
'attach(1): Not a file',
}

10
test/gs_helpers.lua
View File

@ -1,14 +1,13 @@
local helpers = require('test.functional.helpers')()
local helpers = require('test.helpers')()
local system = helpers.funcs.system
local exec_lua = helpers.exec_lua
local matches = helpers.matches
local exec_capture = helpers.exec_capture
local eq = helpers.eq
local fn = helpers.funcs
local get_buf_var = helpers.curbufmeths.get_var
local timeout = 4000
local timeout = 8000
local M = helpers
@ -50,6 +49,7 @@ local test_file_text = {
function M.git(args)
system{"git", "-C", M.scratch, unpack(args)}
exec_lua("vim.loop.sleep(40)")
end
function M.cleanup()
@ -185,11 +185,11 @@ local function match_lines2(lines, spec)
end
if i < #spec + 1 then
local unmatched_msg = table.concat(helpers.tbl_map(function(v)
local unmatched_msg = table.concat(vim.tbl_map(function(v)
return string.format(' - %s', v.text or v)
end, spec), '\n')
local lines_msg = table.concat(helpers.tbl_map(function(v)
local lines_msg = table.concat(vim.tbl_map(function(v)
return string.format(' - %s', v)
end, lines), '\n')

723
test/helpers.lua Normal file
View File

@ -0,0 +1,723 @@
local assert = require('luassert')
local busted = require('busted')
local luv = require('luv')
local Session = require('test.client.session')
local uv_stream = require('test.client.uv_stream')
local ChildProcessStream = uv_stream.ChildProcessStream
assert:set_parameter('TableFormatLevel', 100)
local quote_me = '[^.%w%+%-%@%_%/]' -- complement (needn't quote)
local function shell_quote(str)
if string.find(str, quote_me) or str == '' then
return '"' .. str:gsub('[$%%"\\]', '\\%0') .. '"'
else
return str
end
end
local M = {}
-- sleeps the test runner (_not_ the nvim instance)
function M.sleep(ms)
luv.sleep(ms)
end
-- Calls fn() until it succeeds, up to `max` times or until `max_ms`
-- milliseconds have passed.
function M.retry(max, max_ms, fn)
assert(max == nil or max > 0)
assert(max_ms == nil or max_ms > 0)
local tries = 1
local timeout = (max_ms and max_ms or 10000)
local start_time = luv.now()
while true do
local status, result = pcall(fn)
if status then
return result
end
luv.update_time() -- Update cached value of luv.now() (libuv: uv_now()).
if (max and tries >= max) or (luv.now() - start_time > timeout) then
busted.fail(string.format("retry() attempts: %d\n%s", tries, tostring(result)), 2)
end
tries = tries + 1
luv.sleep(20) -- Avoid hot loop...
end
end
M.eq = assert.are.same
M.neq = assert.are_not.same
local function epicfail(state, arguments, _)
state.failure_message = arguments[1]
return false
end
assert:register("assertion", "epicfail", epicfail)
function M.matches(pat, actual)
if nil ~= string.match(actual, pat) then
return true
end
error(string.format('Pattern does not match.\nPattern:\n%s\nActual:\n%s', pat, actual))
end
-- Reads text lines from `filename` into a table.
--
-- filename: path to file
-- start: start line (1-indexed), negative means "lines before end" (tail)
local function read_file_list(filename, start)
local lnum = (start ~= nil and type(start) == 'number') and start or 1
local tail = (lnum < 0)
local maxlines = tail and math.abs(lnum) or nil
local file = io.open(filename, 'r')
if not file then
return nil
end
-- There is no need to read more than the last 2MB of the log file, so seek
-- to that.
local file_size = file:seek("end")
local offset = file_size - 2000000
if offset < 0 then
offset = 0
end
file:seek("set", offset)
local lines = {}
local i = 1
local line = file:read("*l")
while line ~= nil do
if i >= start then
table.insert(lines, line)
if #lines > maxlines then
table.remove(lines, 1)
end
end
i = i + 1
line = file:read("*l")
end
file:close()
return lines
end
function M.pcall(fn, ...)
assert(type(fn) == 'function')
local status, rv = pcall(fn, ...)
if status then
return status, rv
end
-- From:
-- C:/long/path/foo.lua:186: Expected string, got number
-- to:
-- .../foo.lua:0: Expected string, got number
local errmsg = tostring(rv):gsub('([%s<])vim[/\\]([^%s:/\\]+):%d+', '%1\xffvim\xff%2:0')
:gsub('[^%s<]-[/\\]([^%s:/\\]+):%d+', '.../%1:0')
:gsub('\xffvim\xff', 'vim/')
-- Scrub numbers in paths/stacktraces:
-- shared.lua:0: in function 'gsplit'
-- shared.lua:0: in function <shared.lua:0>'
errmsg = errmsg:gsub('([^%s]):%d+', '%1:0')
-- Scrub tab chars:
errmsg = errmsg:gsub('\t', ' ')
-- In Lua 5.1, we sometimes get a "(tail call): ?" on the last line.
-- We remove this so that the tests are not lua dependent.
errmsg = errmsg:gsub('%s*%(tail call%): %?', '')
return status, errmsg
end
-- Invokes `fn` and returns the error string (with truncated paths), or raises
-- an error if `fn` succeeds.
--
-- Replaces line/column numbers with zero:
-- shared.lua:0: in function 'gsplit'
-- shared.lua:0: in function <shared.lua:0>'
--
-- Usage:
-- -- Match exact string.
-- eq('e', pcall_err(function(a, b) error('e') end, 'arg1', 'arg2'))
-- -- Match Lua pattern.
-- matches('e[or]+$', pcall_err(function(a, b) error('some error') end, 'arg1', 'arg2'))
--
local function pcall_err_withfile(fn, ...)
assert(type(fn) == 'function')
local status, rv = M.pcall(fn, ...)
if status == true then
error('expected failure, but got success')
end
return rv
end
local function pcall_err_withtrace(fn, ...)
local errmsg = pcall_err_withfile(fn, ...)
return errmsg:gsub('^%.%.%./helpers%.lua:0: ', '')
:gsub('^Error executing lua:- ' ,'')
:gsub('^%[string "<nvim>"%]:0: ' ,'')
end
function M.pcall_err(...)
return M.remove_trace(pcall_err_withtrace(...))
end
function M.remove_trace(s)
return (s:gsub("\n%s*stack traceback:.*", ""))
end
--- @param path string
--- @return boolean
local function isdir(path)
if not path then
return false
end
local stat = luv.fs_stat(path)
return stat and stat.type == 'directory'
end
--- @return string
local function argss_to_cmd(...)
local cmd = ''
for i = 1, select('#', ...) do
local arg = select(i, ...)
if type(arg) == 'string' then
cmd = cmd .. ' ' ..shell_quote(arg)
else
for _, subarg in ipairs(arg) do
cmd = cmd .. ' ' .. shell_quote(subarg)
end
end
end
return cmd
end
local function popen_r(...)
return io.popen(argss_to_cmd(...), 'r')
end
local check_logs_useless_lines = {
['Warning: noted but unhandled ioctl']=1,
['could cause spurious value errors to appear']=2,
['See README_MISSING_SYSCALL_OR_IOCTL for guidance']=3,
}
function M.check_logs()
local log_dir = os.getenv('LOG_DIR')
local runtime_errors = {}
if log_dir and isdir(log_dir) then
for tail in vim.fs.dir(log_dir) do
if tail:sub(1, 30) == 'valgrind-' or tail:find('san%.') then
local file = log_dir .. '/' .. tail
local fd = io.open(file)
local start_msg = ('='):rep(20) .. ' File ' .. file .. ' ' .. ('='):rep(20)
local lines = {}
local warning_line = 0
for line in fd:lines() do
local cur_warning_line = check_logs_useless_lines[line]
if cur_warning_line == warning_line + 1 then
warning_line = cur_warning_line
else
lines[#lines + 1] = line
end
end
fd:close()
if #lines > 0 then
local status, f
local out = io.stdout
if os.getenv('SYMBOLIZER') then
status, f = pcall(popen_r, os.getenv('SYMBOLIZER'), '-l', file)
end
out:write(start_msg .. '\n')
if status then
for line in f:lines() do
out:write('= '..line..'\n')
end
f:close()
else
out:write('= ' .. table.concat(lines, '\n= ') .. '\n')
end
out:write(select(1, start_msg:gsub('.', '=')) .. '\n')
table.insert(runtime_errors, file)
end
os.remove(file)
end
end
end
assert(0 == #runtime_errors, string.format(
'Found runtime errors in logfile(s): %s',
table.concat(runtime_errors, ', ')))
end
-- Concat list-like tables.
function M.concat_tables(...)
local ret = {}
for i = 1, select('#', ...) do
local tbl = select(i, ...)
if tbl then
for _, v in ipairs(tbl) do
ret[#ret + 1] = v
end
end
end
return ret
end
function M.dedent(str, leave_indent)
-- find minimum common indent across lines
local indent = nil
for line in str:gmatch('[^\n]+') do
local line_indent = line:match('^%s+') or ''
if indent == nil or #line_indent < #indent then
indent = line_indent
end
end
if indent == nil or #indent == 0 then
-- no minimum common indent
return str
end
local left_indent = (' '):rep(leave_indent or 0)
-- create a pattern for the indent
indent = indent:gsub('%s', '[ \t]')
-- strip it from the first line
str = str:gsub('^'..indent, left_indent)
-- strip it from the remaining lines
str = str:gsub('[\n]'..indent, '\n' .. left_indent)
return str
end
-- Gets the (tail) contents of `logfile`.
-- Also moves the file to "${NVIM_LOG_FILE}.displayed" on CI environments.
function M.read_nvim_log(logfile, ci_rename)
logfile = logfile or os.getenv('NVIM_LOG_FILE') or '.nvimlog'
local keep = 10
local lines = read_file_list(logfile, -keep) or {}
local log = (('-'):rep(78)..'\n'
..string.format('$NVIM_LOG_FILE: %s\n', logfile)
..(#lines > 0 and '(last '..tostring(keep)..' lines)\n' or '(empty)\n'))
for _,line in ipairs(lines) do
log = log..line..'\n'
end
log = log..('-'):rep(78)..'\n'
return log
end
local runtime_set = 'set runtimepath^=./build/lib/nvim/'
local nvim_prog = os.getenv('NVIM_PRG') or 'nvim'
-- Default settings for the test session.
local nvim_set = table.concat({
'set',
'shortmess+=IS',
'background=light',
'noswapfile',
'noautoindent',
'startofline',
'laststatus=1',
'undodir=.',
'directory=.',
'viewdir=.',
'backupdir=.',
'belloff=',
'wildoptions-=pum',
'joinspaces',
'noshowcmd', 'noruler', 'nomore',
'redrawdebug=invalid'
}, ' ')
local nvim_argv = {
nvim_prog,
'-u', 'NONE',
'-i', 'NONE',
'--cmd', runtime_set,
'--cmd', nvim_set,
'--cmd', 'mapclear',
'--cmd', 'mapclear!',
'--embed'
}
local prepend_argv
if prepend_argv then
local new_nvim_argv = {}
local len = #prepend_argv
for i = 1, len do
new_nvim_argv[i] = prepend_argv[i]
end
for i = 1, #nvim_argv do
new_nvim_argv[i + len] = nvim_argv[i]
end
nvim_argv = new_nvim_argv
M.prepend_argv = prepend_argv
end
local session, loop_running, last_error
function M.get_session()
return session
end
local function request(method, ...)
local status, rv = session:request(method, ...)
if not status then
if loop_running then
last_error = rv[2]
session:stop()
else
error(rv[2])
end
end
return rv
end
local function call_and_stop_on_error(lsession, ...)
local status, result = Session.safe_pcall(...)
if not status then
lsession:stop()
last_error = result
return ''
end
return result
end
function M.run_session(lsession, request_cb, notification_cb, timeout)
local on_request, on_notification
if request_cb then
function on_request(method, args)
return call_and_stop_on_error(lsession, request_cb, method, args)
end
end
if notification_cb then
function on_notification(method, args)
call_and_stop_on_error(lsession, notification_cb, method, args)
end
end
loop_running = true
lsession:run(on_request, on_notification, nil, timeout)
loop_running = false
if last_error then
local err = last_error
last_error = nil
error(err)
end
return lsession.eof_err
end
---- Executes an ex-command. VimL errors manifest as client (lua) errors, but
---- v:errmsg will not be updated.
function M.command(cmd)
request('nvim_command', cmd)
end
---- Evaluates a VimL expression.
---- Fails on VimL error, but does not update v:errmsg.
function M.eval(expr)
return request('nvim_eval', expr)
end
---- Executes a VimL function via RPC.
---- Fails on VimL error, but does not update v:errmsg.
function M.call(name, ...)
return request('nvim_call_function', name, {...})
end
-- Checks that the Nvim session did not terminate.
local function assert_alive()
assert(2 == M.eval('1+1'), 'crash? request failed')
end
---- Sends user input to Nvim.
---- Does not fail on VimL error, but v:errmsg will be updated.
local function nvim_feed(input)
while #input > 0 do
local written = request('nvim_input', input)
if written == nil then
assert_alive()
error('crash? (nvim_input returned nil)')
end
input = input:sub(written + 1)
end
end
function M.feed(...)
for _, v in ipairs({...}) do
nvim_feed(M.dedent(v))
end
end
local function rawfeed(...)
for _, v in ipairs({...}) do
nvim_feed(M.dedent(v))
end
end
local function merge_args(...)
local i = 1
local argv = {}
for anum = 1,select('#', ...) do
local args = select(anum, ...)
if args then
for _, arg in ipairs(args) do
argv[i] = arg
i = i + 1
end
end
end
return argv
end
-- Removes Nvim startup args from `args` matching items in `args_rm`.
--
-- - Special case: "-u", "-i", "--cmd" are treated specially: their "values" are also removed.
-- - Special case: "runtimepath" will remove only { '--cmd', 'set runtimepath^=…', }
--
-- Example:
-- args={'--headless', '-u', 'NONE'}
-- args_rm={'--cmd', '-u'}
-- Result:
-- {'--headless'}
--
-- All matching cases are removed.
--
-- Example:
-- args={'--cmd', 'foo', '-N', '--cmd', 'bar'}
-- args_rm={'--cmd', '-u'}
-- Result:
-- {'-N'}
local function remove_args(args, args_rm)
local new_args = {}
local skip_following = {'-u', '-i', '-c', '--cmd', '-s', '--listen'}
if not args_rm or #args_rm == 0 then
return {unpack(args)}
end
for _, v in ipairs(args_rm) do
assert(type(v) == 'string')
end
local last = ''
for _, arg in ipairs(args) do
if tbl_contains(skip_following, last) then
last = ''
elseif tbl_contains(args_rm, arg) then
last = arg
elseif arg == runtime_set and tbl_contains(args_rm, 'runtimepath') then
table.remove(new_args) -- Remove the preceding "--cmd".
last = ''
else
table.insert(new_args, arg)
end
end
return new_args
end
function M.check_close()
if not session then
return
end
local start_time = luv.now()
session:close()
luv.update_time() -- Update cached value of luv.now() (libuv: uv_now()).
local end_time = luv.now()
local delta = end_time - start_time
if delta > 500 then
print("nvim took " .. delta .. " milliseconds to exit after last test\n"..
"This indicates a likely problem with the test even if it passed!\n")
io.stdout:flush()
end
session = nil
end
--- @param io_extra used for stdin_fd, see :help ui-option
function M.spawn(argv, merge, env, keep, io_extra)
if not keep then
M.check_close()
end
local child_stream = ChildProcessStream.spawn(
merge and merge_args(prepend_argv, argv) or argv,
env, io_extra)
return Session.new(child_stream)
end
-- Builds an argument list for use in clear().
--
---@see clear() for parameters.
local function new_argv(...)
local args = {unpack(nvim_argv)}
table.insert(args, '--headless')
if _G._nvim_test_id then
-- Set the server name to the test-id for logging. #8519
table.insert(args, '--listen')
table.insert(args, _G._nvim_test_id)
end
local new_args
local io_extra
local env = nil
local opts = select(1, ...)
if type(opts) ~= 'table' then
new_args = {...}
else
args = remove_args(args, opts.args_rm)
if opts.env then
local env_opt = {}
for k, v in pairs(opts.env) do
assert(type(k) == 'string')
assert(type(v) == 'string')
env_opt[k] = v
end
for _, k in ipairs({
'HOME',
'ASAN_OPTIONS',
'TSAN_OPTIONS',
'MSAN_OPTIONS',
'LD_LIBRARY_PATH',
'PATH',
'NVIM_LOG_FILE',
'NVIM_RPLUGIN_MANIFEST',
'GCOV_ERROR_FILE',
'XDG_DATA_DIRS',
'TMPDIR',
'VIMRUNTIME',
}) do
-- Set these from the environment unless the caller defined them.
if not env_opt[k] then
env_opt[k] = os.getenv(k)
end
end
env = {}
for k, v in pairs(env_opt) do
env[#env + 1] = k .. '=' .. v
end
end
new_args = opts.args or {}
io_extra = opts.io_extra
end
for _, arg in ipairs(new_args) do
table.insert(args, arg)
end
return args, env, io_extra
end
-- same params as clear, but does returns the session instead
-- of replacing the default session
local function spawn_argv(keep, ...)
local argv, env, io_extra = new_argv(...)
return M.spawn(argv, nil, env, keep, io_extra)
end
-- Starts a new global Nvim session.
--
-- Parameters are interpreted as startup args, OR a map with these keys:
-- args: List: Args appended to the default `nvim_argv` set.
-- args_rm: List: Args removed from the default set. All cases are
-- removed, e.g. args_rm={'--cmd'} removes all cases of "--cmd"
-- (and its value) from the default set.
-- env: Map: Defines the environment of the new session.
--
-- Example:
-- clear('-e')
-- clear{args={'-e'}, args_rm={'-i'}, env={TERM=term}}
function M.clear(...)
session = spawn_argv(false, ...)
end
function M.insert(...)
nvim_feed('i')
for _, v in ipairs({...}) do
local escaped = v:gsub('<', '<lt>')
rawfeed(escaped)
end
nvim_feed('<ESC>')
end
function M.create_callindex(func)
local table = {}
setmetatable(table, {
__index = function(tbl, arg1)
local ret = function(...) return func(arg1, ...) end
tbl[arg1] = ret
return ret
end,
})
return table
end
function M.nvim(method, ...)
return request('nvim_'..method, ...)
end
function M.buffer(method, ...)
return request('nvim_buf_'..method, ...)
end
function M.window(method, ...)
return request('nvim_win_'..method, ...)
end
function M.curbuf(method, ...)
if not method then
return M.nvim('get_current_buf')
end
return M.buffer(method, 0, ...)
end
function M.curwin(method, ...)
if not method then
return M.nvim('get_current_win')
end
return M.window(method, 0, ...)
end
M.funcs = M.create_callindex(M.call)
M.meths = M.create_callindex(M.nvim)
M.bufmeths = M.create_callindex(M.buffer)
M.winmeths = M.create_callindex(M.window)
M.curbufmeths = M.create_callindex(M.curbuf)
M.curwinmeths = M.create_callindex(M.curwin)
function M.exc_exec(cmd)
M.command(([[
try
execute "%s"
catch
let g:__exception = v:exception
endtry
]]):format(cmd:gsub('\n', '\\n'):gsub('[\\"]', '\\%0')))
local ret = M.eval('get(g:, "__exception", 0)')
M.command('unlet! g:__exception')
return ret
end
function M.exec_capture(code)
-- return module.meths.exec2(code, { output = true }).output
return M.meths.exec(code, true)
end
function M.exec_lua(code, ...)
return M.meths.exec_lua(code, {...})
end
function M.poke_eventloop()
-- Execute 'nvim_eval' (a deferred function) to
-- force at least one main_loop iteration
session:request('nvim_eval', '1')
end
return function(after_each)
if after_each then
after_each(function()
M.check_logs()
if session then
local msg = session:next_message(0)
if msg then
if msg[1] == "notification" and msg[2] == "nvim_error_event" then
error(msg[3][2])
end
end
end
end)
end
return M
end

60
test/highlights_spec.lua
View File

@ -1,11 +1,9 @@
local Screen = require('test.functional.ui.screen')
local Screen = require('test.screen')
local helpers = require('test.gs_helpers')
local clear = helpers.clear
local exec_lua = helpers.exec_lua
local command = helpers.command
local eq = helpers.eq
local exec_capture = helpers.exec_capture
local cleanup = helpers.cleanup
local test_config = helpers.test_config
@ -41,7 +39,7 @@ describe('highlights', function()
-- Make gitisigns available
exec_lua('package.path = ...', package.path)
exec_lua('gs = require("gitsigns")')
config = helpers.deepcopy(test_config)
config = vim.deepcopy(test_config)
end)
after_each(function()
@ -74,14 +72,14 @@ describe('highlights', function()
})
end)
eq('GitSignsChange xxx links to DiffChange',
exec_capture('hi GitSignsChange'))
-- eq('GitSignsChange xxx links to DiffChange',
-- exec_capture('hi GitSignsChange'))
eq('GitSignsDelete xxx links to DiffDelete',
exec_capture('hi GitSignsDelete'))
-- eq('GitSignsDelete xxx links to DiffDelete',
-- exec_capture('hi GitSignsDelete'))
eq('GitSignsAdd xxx links to DiffAdd',
exec_capture('hi GitSignsAdd'))
-- eq('GitSignsAdd xxx links to DiffAdd',
-- exec_capture('hi GitSignsAdd'))
end)
it('update when colorscheme changes', function()
@ -96,34 +94,34 @@ describe('highlights', function()
setup_gitsigns(config)
expectf(function()
eq('GitSignsChange xxx links to DiffChange',
exec_capture('hi GitSignsChange'))
-- expectf(function()
-- eq('GitSignsChange xxx links to DiffChange',
-- exec_capture('hi GitSignsChange'))
eq('GitSignsDelete xxx links to DiffDelete',
exec_capture('hi GitSignsDelete'))
-- eq('GitSignsDelete xxx links to DiffDelete',
-- exec_capture('hi GitSignsDelete'))
eq('GitSignsAdd xxx links to DiffAdd',
exec_capture('hi GitSignsAdd'))
-- eq('GitSignsAdd xxx links to DiffAdd',
-- exec_capture('hi GitSignsAdd'))
eq('GitSignsAddLn xxx links to DiffAdd',
exec_capture('hi GitSignsAddLn'))
end)
-- eq('GitSignsAddLn xxx links to DiffAdd',
-- exec_capture('hi GitSignsAddLn'))
-- end)
command('colorscheme blue')
-- command('colorscheme blue')
expectf(function()
eq('GitSignsChange xxx links to DiffChange',
exec_capture('hi GitSignsChange'))
-- expectf(function()
-- eq('GitSignsChange xxx links to DiffChange',
-- exec_capture('hi GitSignsChange'))
eq('GitSignsDelete xxx links to DiffDelete',
exec_capture('hi GitSignsDelete'))
-- eq('GitSignsDelete xxx links to DiffDelete',
-- exec_capture('hi GitSignsDelete'))
eq('GitSignsAdd xxx links to DiffAdd',
exec_capture('hi GitSignsAdd'))
-- eq('GitSignsAdd xxx links to DiffAdd',
-- exec_capture('hi GitSignsAdd'))
eq('GitSignsAddLn xxx links to DiffAdd',
exec_capture('hi GitSignsAddLn'))
end)
-- eq('GitSignsAddLn xxx links to DiffAdd',
-- exec_capture('hi GitSignsAddLn'))
-- end)
end)
end)

16
test/preload.lua
View File

@ -1,17 +1,3 @@
-- Modules loaded here will not be cleared and reloaded by Busted.
-- Busted started doing this to help provide more isolation.
local global_helpers = require('test.helpers')
-- Bypoass CI behaviour logic
global_helpers.isCI = function(_)
return false
end
-- v0.9
global_helpers.is_ci = function()
return false
end
local helpers = require('test.functional.helpers')(nil)
local helpers = require('test.helpers')(nil)
local gs_helpers = require('test.gs_helpers')

1624
test/screen.lua Normal file
View File

File diff suppressed because it is too large Load Diff

192
test/session.lua Normal file
View File

@ -0,0 +1,192 @@
local uv = require('luv')
local MsgpackRpcStream = require('test.msgpack_rpc_stream')
local Session = {}
Session.__index = Session
if package.loaded['jit'] then
-- luajit pcall is already coroutine safe
Session.safe_pcall = pcall
else
Session.safe_pcall = require'coxpcall'.pcall
end
local function resume(co, ...)
local status, result = coroutine.resume(co, ...)
if coroutine.status(co) == 'dead' then
if not status then
error(result)
end
return
end
assert(coroutine.status(co) == 'suspended')
result(co)
end
local function coroutine_exec(func, ...)
local args = {...}
local on_complete
if #args > 0 and type(args[#args]) == 'function' then
-- completion callback
on_complete = table.remove(args)
end
resume(coroutine.create(function()
local status, result, flag = Session.safe_pcall(func, unpack(args))
if on_complete then
coroutine.yield(function()
-- run the completion callback on the main thread
on_complete(status, result, flag)
end)
end
end))
end
function Session.new(stream)
return setmetatable({
_msgpack_rpc_stream = MsgpackRpcStream.new(stream),
_pending_messages = {},
_prepare = uv.new_prepare(),
_timer = uv.new_timer(),
_is_running = false
}, Session)
end
function Session:next_message(timeout)
local function on_request(method, args, response)
table.insert(self._pending_messages, {'request', method, args, response})
uv.stop()
end
local function on_notification(method, args)
table.insert(self._pending_messages, {'notification', method, args})
uv.stop()
end
if self._is_running then
error('Event loop already running')
end
if #self._pending_messages > 0 then
return table.remove(self._pending_messages, 1)
end
self:_run(on_request, on_notification, timeout)
return table.remove(self._pending_messages, 1)
end
function Session:notify(method, ...)
self._msgpack_rpc_stream:write(method, {...})
end
function Session:request(method, ...)
local args = {...}
local err, result
if self._is_running then
err, result = self:_yielding_request(method, args)
else
err, result = self:_blocking_request(method, args)
end
if err then
return false, err
end
return true, result
end
function Session:run(request_cb, notification_cb, setup_cb, timeout)
local function on_request(method, args, response)
coroutine_exec(request_cb, method, args, function(status, result, flag)
if status then
response:send(result, flag)
else
response:send(result, true)
end
end)
end
local function on_notification(method, args)
coroutine_exec(notification_cb, method, args)
end
self._is_running = true
if setup_cb then
coroutine_exec(setup_cb)
end
while #self._pending_messages > 0 do
local msg = table.remove(self._pending_messages, 1)
if msg[1] == 'request' then
on_request(msg[2], msg[3], msg[4])
else
on_notification(msg[2], msg[3])
end
end
self:_run(on_request, on_notification, timeout)
self._is_running = false
end
function Session:stop()
uv.stop()
end
function Session:close(signal)
if not self._timer:is_closing() then self._timer:close() end
if not self._prepare:is_closing() then self._prepare:close() end
self._msgpack_rpc_stream:close(signal)
end
function Session:_yielding_request(method, args)
return coroutine.yield(function(co)
self._msgpack_rpc_stream:write(method, args, function(err, result)
resume(co, err, result)
end)
end)
end
function Session:_blocking_request(method, args)
local err, result
local function on_request(method_, args_, response)
table.insert(self._pending_messages, {'request', method_, args_, response})
end
local function on_notification(method_, args_)
table.insert(self._pending_messages, {'notification', method_, args_})
end
self._msgpack_rpc_stream:write(method, args, function(e, r)
err = e
result = r
uv.stop()
end)
self:_run(on_request, on_notification)
return (err or self.eof_err), result
end
function Session:_run(request_cb, notification_cb, timeout)
if type(timeout) == 'number' then
self._prepare:start(function()
self._timer:start(timeout, 0, function()
uv.stop()
end)
self._prepare:stop()
end)
end
self._msgpack_rpc_stream:read_start(request_cb, notification_cb, function()
uv.stop()
self.eof_err = {1, "EOF was received from Nvim. Likely the Nvim process crashed."}
end)
uv.run()
self._prepare:stop()
self._timer:stop()
self._msgpack_rpc_stream:read_stop()
end
return Session

169
test/uv_stream.lua Normal file
View File

@ -0,0 +1,169 @@
local uv = require('luv')
local StdioStream = {}
StdioStream.__index = StdioStream
function StdioStream.open()
local self = setmetatable({
_in = uv.new_pipe(false),
_out = uv.new_pipe(false)
}, StdioStream)
self._in:open(0)
self._out:open(1)
return self
end
function StdioStream:write(data)
self._out:write(data)
end
function StdioStream:read_start(cb)
self._in:read_start(function(err, chunk)
if err then
error(err)
end
cb(chunk)
end)
end
function StdioStream:read_stop()
self._in:read_stop()
end
function StdioStream:close()
self._in:close()
self._out:close()
end
local SocketStream = {}
SocketStream.__index = SocketStream
function SocketStream.open(file)
local socket = uv.new_pipe(false)
local self = setmetatable({
_socket = socket,
_stream_error = nil
}, SocketStream)
uv.pipe_connect(socket, file, function (err)
self._stream_error = self._stream_error or err
end)
return self
end
function SocketStream.connect(host, port)
local socket = uv.new_tcp()
local self = setmetatable({
_socket = socket,
_stream_error = nil
}, SocketStream)
uv.tcp_connect(socket, host, port, function (err)
self._stream_error = self._stream_error or err
end)
return self
end
function SocketStream:write(data)
if self._stream_error then
error(self._stream_error)
end
uv.write(self._socket, data, function(err)
if err then
error(self._stream_error or err)
end
end)
end
function SocketStream:read_start(cb)
if self._stream_error then
error(self._stream_error)
end
uv.read_start(self._socket, function(err, chunk)
if err then
error(err)
end
cb(chunk)
end)
end
function SocketStream:read_stop()
if self._stream_error then
error(self._stream_error)
end
uv.read_stop(self._socket)
end
function SocketStream:close()
uv.close(self._socket)
end
local ChildProcessStream = {}
ChildProcessStream.__index = ChildProcessStream
function ChildProcessStream.spawn(argv, env, io_extra)
local self = setmetatable({
_child_stdin = uv.new_pipe(false);
_child_stdout = uv.new_pipe(false);
_exiting = false;
}, ChildProcessStream)
local prog = argv[1]
local args = {}
for i = 2, #argv do
args[#args + 1] = argv[i]
end
self._proc, self._pid = uv.spawn(prog, {
stdio = {self._child_stdin, self._child_stdout, 2, io_extra},
args = args,
env = env,
}, function(status, signal)
self.status = status
self.signal = signal
end)
if not self._proc then
local err = self._pid
error(err)
end
return self
end
function ChildProcessStream:write(data)
self._child_stdin:write(data)
end
function ChildProcessStream:read_start(cb)
self._child_stdout:read_start(function(err, chunk)
if err then
error(err)
end
cb(chunk)
end)
end
function ChildProcessStream:read_stop()
self._child_stdout:read_stop()
end
function ChildProcessStream:close(signal)
if self._closed then
return
end
self._closed = true
self:read_stop()
self._child_stdin:close()
self._child_stdout:close()
if type(signal) == 'string' then
self._proc:kill('sig'..signal)
end
while self.status == nil do
uv.run 'once'
end
return self.status, self.signal
end
return {
StdioStream = StdioStream;
ChildProcessStream = ChildProcessStream;
SocketStream = SocketStream;
}