Add coverage using luacov with pause/resume patch

Author: mpeterv

.gitignore

@@ -4,3 +4,5 @@ docsrc/_build
 docsrc/_static
 docsrc/_templates
 .luacheckcache
+luacov.stats.out
+luacov.report.out

.luacov

@@ -0,0 +1 @@
+return require "spec.helper".luacov_config("")

spec/cli_spec.lua

@@ -1,15 +1,20 @@
 local utils = require "luacheck.utils"
 local multithreading = require "luacheck.multithreading"
+local helper = require "spec.helper"
+local luacheck_cmd = helper.luacheck_command()
+
+setup(helper.before_command)
+teardown(helper.after_command)
 
 local function get_output(command, color, config)
-   local handler = io.popen("luacheck "..(config or "--no-config").." "..command.." 2>&1")
+   local handler = io.popen(luacheck_cmd.." "..(config or "--no-config").." "..command.." 2>&1")
    local output = handler:read("*a"):gsub("\27.-\109", color and "#" or "")
    handler:close()
    return output
 end
 
 local function get_exitcode(command)
-   local code51, _, code52 = os.execute("luacheck --no-config "..command.." > /dev/null 2>&1")
+   local code51, _, code52 = os.execute(luacheck_cmd.." --no-config "..command.." > /dev/null 2>&1")
    return _VERSION:find "5.1" and code51/256 or code52
 end
 

spec/config_spec.lua

@@ -1,9 +1,11 @@
-local function get_output(command, wd)
-   command = ("luacheck %s 2>&1"):format(command)
+local helper = require "spec.helper"
+local luacheck_cmd = helper.luacheck_command()
+
+setup(helper.before_command)
+teardown(helper.after_command)
 
-   if wd then
-      command = ("cd %s && %s"):format(wd, command)
-   end
+local function get_output(command, wd)
+   command = ("%s %s 2>&1"):format(helper.luacheck_command(wd), command)
 
    local handler = io.popen(command)
    local output = handler:read("*a"):gsub("\27.-\109", "")
@@ -12,7 +14,7 @@ local function get_output(command, wd)
 end
 
 local function get_exitcode(command)
-   local code51, _, code52 = os.execute("luacheck "..command.." > /dev/null 2>&1")
+   local code51, _, code52 = os.execute(luacheck_cmd.." "..command.." > /dev/null 2>&1")
    return _VERSION:find "5.1" and code51/256 or code52
 end
 
@@ -30,7 +32,7 @@ Checking nested/nested/abc.lua                    Failure
     nested/nested/abc.lua:1:13: accessing undefined variable c
 
 Total: 3 warnings / 0 errors in 2 files
-]], get_output("nested", "spec/configs/project"))
+]], get_output("nested", "spec/configs/project/"))
       end)
 
       it("does not use .luacheckrc in current directory with --no-config", function()
@@ -47,7 +49,7 @@ Checking nested/nested/abc.lua                    Failure
     nested/nested/abc.lua:1:13: accessing undefined variable c
 
 Total: 5 warnings / 0 errors in 2 files
-]], get_output("nested --no-config", "spec/configs/project"))
+]], get_output("nested --no-config", "spec/configs/project/"))
       end)
 
       it("uses .luacheckrc in upper directory", function()
@@ -62,7 +64,7 @@ Checking nested/abc.lua                           Failure
     nested/abc.lua:1:13: accessing undefined variable c
 
 Total: 3 warnings / 0 errors in 2 files
-]], get_output("ab.lua nested", "spec/configs/project/nested"))
+]], get_output("ab.lua nested", "spec/configs/project/nested/"))
       end)
 
       it("uses config provided with --config=path", function()

spec/helper.lua

@@ -0,0 +1,81 @@
+local helper = {}
+
+local dir_sep = package.config:sub(1, 1)
+
+-- Return path to root directory when run from `path`.
+local function antipath(path)
+   local _, level = path:gsub(dir_sep, "")
+   return (".."..dir_sep):rep(level)
+end
+
+-- Try to load a lua module from `file_path` when run from `loc_path`.
+local function try_load(loc_path, file_path)
+   local real_path = antipath(loc_path)..file_path
+   local fd = io.open(real_path, "rb")
+
+   if not fd then
+      return
+   end
+
+   local src = fd:read("*a")
+   fd:close()
+   local func, err = (loadstring or load)(src, "@"..file_path) -- luacheck: compat
+   return err or func
+end
+
+-- Return a package searcher which, when run from `loc_path`,
+-- loads lua libraries from `lib_path`.
+function helper.prefix_searcher(loc_path, lib_path)
+   return function(package_name)
+      local package_path = lib_path..package_name:gsub("%.", dir_sep)
+      return try_load(loc_path, package_path..".lua") or
+         try_load(loc_path, package_path..dir_sep.."init.lua"), package_name
+   end
+end
+
+function helper.luacov_config(prefix)
+   return {
+      statsfile = prefix.."luacov.stats.out",
+      reportfile = prefix.."luacov.report.out",
+      deletestats = false,
+      runreport = false,
+      include = {"luacheck/.+$"},
+      exclude = {}
+   }
+end
+
+local luacov = package.loaded.luacov or package.loaded["luacov.runner"]
+
+-- Returns command that runs `luacheck` executable from `loc_path`.
+function helper.luacheck_command(loc_path)
+   loc_path = loc_path or "."
+   local prefix = antipath(loc_path)
+   local cmd = ("cd %s && lua"):format(loc_path)
+
+   -- Extend package.path to allow loading this helper.
+   cmd = cmd..(" -e 'package.path=[[%s?.lua;]]..package.path'"):format(prefix)
+   -- Add searcher for luacheck modules.
+   cmd = cmd..(" -e 'table.insert(package.loaders or package.searchers,1,"..
+      "require[[spec.helper]].prefix_searcher([[%s]],[[./src%s]]))'"):format(loc_path, dir_sep)
+
+   if luacov then
+      -- Launch luacov.
+      cmd = cmd..(" -e 'require[[luacov.runner]](require[[spec.helper]].luacov_config([[%s]]))'"):format(prefix)
+   end
+
+   return ("%s %sbin%sluacheck.lua"):format(cmd, prefix, dir_sep)
+end
+
+function helper.before_command()
+   if luacov then
+      luacov.pause()
+   end
+end
+
+function helper.after_command()
+   if luacov then
+      luacov.resume()
+   end
+end
+
+return helper