Use the tests.RunLuaTestFile in a few more places including preload - where the "shellescape" was also added. (#26)

* Use the tests.RunLuaTestFile in a few more places including preload - where the "shellescape" was also added.

Using this splits each group of assertions into a separate test case reported by the go test runner.

* Remove tab.

* Remove test object (old style)

* Update go versions in build matrix

Co-authored-by: Sheridan C Rawlins <scr@yahooinc.com>

Author: scr-oath

.github/workflows/ci.yaml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go: ['1.14', '1.15']
+        go: ['1.14', '1.15', '1.16', '1.17', '1.18']
 
     services: {}
     steps:

json/api_test.go

@@ -1,17 +1,14 @@
 package json
 
 import (
+	"github.com/stretchr/testify/assert"
+	"github.com/vadv/gopher-lua-libs/tests"
 	"testing"
 
 	inspect "github.com/vadv/gopher-lua-libs/inspect"
-	lua "github.com/yuin/gopher-lua"
 )
 
 func TestApi(t *testing.T) {
-	state := lua.NewState()
-	Preload(state)
-	inspect.Preload(state)
-	if err := state.DoFile("./test/test_api.lua"); err != nil {
-		t.Fatalf("execute test: %s\n", err.Error())
-	}
+	preload := tests.SeveralPreloadFuncs(Preload, inspect.Preload)
+	assert.NotZero(t, tests.RunLuaTestFile(t, preload, "./test/test_api.lua"))
 }

json/test/test_api.lua

@@ -1,15 +1,22 @@
 local json = require("json")
 local inspect = require("inspect")
 
-local jsonStringWithNull = [[{"a":{"b":1, "c":null}}]]
-local jsonString = [[{"a":{"b":1}}]]
+function TestJson(t)
+    local jsonStringWithNull = [[{"a":{"b":1, "c":null}}]]
+    local jsonString = [[{"a":{"b":1}}]]
 
-local result, err = json.decode(jsonStringWithNull)
-if err then error(err) end
-if not(result["a"]["b"] == 1) then error("must be decode") end
-print("done: json.decode()")
+    local result, err = json.decode(jsonStringWithNull)
+    t:Run("decode", function(t)
+        if err then error(err) end
+        if result["a"]["b"] ~= 1 then error("must be decode") end
+        if result["a"]["c"] ~= nil then error("c is not nil") end
+        print("done: json.decode()")
+    end)
 
-local result, err = json.encode(result)
-if err then error(err) end
-if not(result==jsonString) then error("must be encode "..inspect(result)) end
-print("done: json.encode()")
+    local result, err = json.encode(result)
+    t:Run("encode omits null values", function(t)
+        if err then error(err) end
+        if result ~= jsonString then error("must be encode "..inspect(result)) end
+        print("done: json.encode()")
+    end)
+end

preload.lua

@@ -1,30 +1,41 @@
-require("cert_util")
-require("db")
-require("filepath")
-require("inspect")
-require("ioutil")
-require("json")
-require("regexp")
-require("strings")
-require("tac")
-require("tcp")
-require("time")
-require("xmlpath")
-require("yaml")
-require("plugin")
-require("runtime")
-require("cmd")
-require("telegram")
-require("zabbix")
-require("storage")
-require("crypto")
-require("goos")
-require("humanize")
-require("chef")
-require("template")
-require("pprof")
-require("cloudwatch")
-require("log")
-require("prometheus")
-require("pb")
-require("stats")
+function TestRequireModule(t)
+    modules = {
+        "cert_util",
+        "chef",
+        "cloudwatch",
+        "cmd",
+        "crypto",
+        "db",
+        "filepath",
+        "goos",
+        "humanize",
+        "inspect",
+        "ioutil",
+        "json",
+        "log",
+        "pb",
+        "plugin",
+        "pprof",
+        "prometheus",
+        "regexp",
+        "runtime",
+        "shellescape",
+        "stats",
+        "storage",
+        "strings",
+        "tac",
+        "tcp",
+        "telegram",
+        "template",
+        "time",
+        "xmlpath",
+        "yaml",
+        "zabbix",
+    }
+    for _, module in ipairs(modules) do
+        t:Run(module, function(t)
+            require(module)
+        end)
+    end
+end
+

preload_test.go

@@ -1,15 +1,11 @@
 package libs
 
 import (
+	"github.com/stretchr/testify/assert"
+	"github.com/vadv/gopher-lua-libs/tests"
 	"testing"
-
-	lua "github.com/yuin/gopher-lua"
 )
 
 func TestPreload(t *testing.T) {
-	state := lua.NewState()
-	Preload(state)
-	if err := state.DoFile("./preload.lua"); err != nil {
-		t.Fatalf("execute test: %s\n", err.Error())
-	}
+	assert.NotZero(t, tests.RunLuaTestFile(t, Preload, "./preload.lua"))
 }

shellescape/api_test.go

@@ -1,16 +1,13 @@
 package shellescape
 
 import (
+	"github.com/stretchr/testify/assert"
 	"github.com/vadv/gopher-lua-libs/inspect"
 	"github.com/vadv/gopher-lua-libs/tests"
-	lua "github.com/yuin/gopher-lua"
 	"testing"
 )
 
 func TestApi(t *testing.T) {
-	preloadForTest := func(L *lua.LState) {
-		Preload(L)
-		inspect.Preload(L)
-	}
-	tests.RunLuaTestFile(t, preloadForTest, "test/test_api.lua")
+	preload := tests.SeveralPreloadFuncs(Preload, inspect.Preload)
+	assert.NotZero(t, tests.RunLuaTestFile(t, preload, "test/test_api.lua"))
 }

strings/api_test.go

@@ -1,15 +1,11 @@
 package strings
 
 import (
+	"github.com/stretchr/testify/assert"
+	"github.com/vadv/gopher-lua-libs/tests"
 	"testing"
-
-	lua "github.com/yuin/gopher-lua"
 )
 
 func TestApi(t *testing.T) {
-	state := lua.NewState()
-	Preload(state)
-	if err := state.DoFile("./test/test_api.lua"); err != nil {
-		t.Fatalf("execute test: %s\n", err.Error())
-	}
+	assert.NotZero(t, tests.RunLuaTestFile(t, Preload, "./test/test_api.lua"))
 }

strings/test/test_api.lua

@@ -2,25 +2,29 @@ local strings = require("strings")
 
 local str = "hello world"
 
-local t = strings.split(str, " ")
-local count_t = 0
-for k, v in pairs(t) do
-    count_t = count_t + 1
-    if k == 1 then if not(v == "hello") then error("strings.split()") end end
-    if k == 2 then if not(v == "world") then error("strings.split()") end end
+function TestSplit(t)
+    local str_parts = strings.split(str, " ")
+    assert(type(str_parts) == 'table')
+    assert(#str_parts == 2, string.format("%d ~= 2", #str_parts))
+    assert(str_parts[1] == "hello", string.format("%s ~= hello", str_parts[1]))
+    assert(str_parts[2] == "world", string.format("%s ~= world", str_parts[2]))
 end
-if not(count_t == 2) then error("string.split()") end
-print("done: strings.split()")
 
-if not(strings.has_prefix(str, "hello")) then error("strings.has_prefix()") end
-if not(strings.has_suffix(str, "world")) then error("strings.has_suffix()") end
-print("done: strings.has_suffix, strings.has_prefix")
+function TestHasPrefix(t)
+    assert(strings.has_prefix(str, "hello"), [[not strings.has_prefix("hello")]])
+end
+
+function TestHasSuffix(t)
+    assert(strings.has_suffix(str, "world"), [[not strings.has_suffix("world")]])
+end
 
-if not(strings.trim(str, "world") == "hello ") then error("strings.trim()") end
-if not(strings.trim(str, "hello ") == "world") then error("strings.trim()") end
-if not(strings.trim_prefix(str, "hello ") == "world") then error("strings.trim()") end
-if not(strings.trim_suffix(str, "hello ") == "hello world") then error("strings.trim()") end
-print("done: strings.trim()")
+function TestTrim(t)
+    assert(strings.trim(str, "world") == "hello ", "strings.trim()")
+    assert(strings.trim(str, "hello ") == "world", "strings.trim()")
+    assert(strings.trim_prefix(str, "hello ") == "world", "strings.trim()")
+    assert(strings.trim_suffix(str, "hello ") == "hello world", "strings.trim()")
+end
 
-if not(strings.contains(str, "hello ") == true) then error("strings.contains()") end
-print("done: strings.contains()")
+function TestContains(t)
+    assert(strings.contains(str, "hello ") == true, "strings.contains()")
+end

tests/assertions.go

@@ -0,0 +1 @@
+package tests

tests/testutil.go

@@ -56,7 +56,7 @@ func registerTType(L *lua.LState) {
 
 //RunLuaTestFile fires up a new state, registers the *testing.T and invokes all methods starting with Test.
 // This allows the lua test files to operate similar to go tests - see shellescape/test/test_api.lua
-func RunLuaTestFile(t *testing.T, preload PreloadFunc, filename string) {
+func RunLuaTestFile(t *testing.T, preload PreloadFunc, filename string) (numTests int) {
 	L := lua.NewState()
 	registerTType(L)
 	require.NotNil(t, preload)
@@ -65,13 +65,24 @@ func RunLuaTestFile(t *testing.T, preload PreloadFunc, filename string) {
 
 	require.NoError(t, L.DoFile(filename))
 	L.G.Global.ForEach(func(key lua.LValue, value lua.LValue) {
-		key_str := lua.LVAsString(key)
-		if strings.HasPrefix(key_str, "Test") && value.Type() == lua.LTFunction {
-			t.Run(key_str, func(t *testing.T) {
+		keyStr := lua.LVAsString(key)
+		if strings.HasPrefix(keyStr, "Test") && value.Type() == lua.LTFunction {
+			t.Run(keyStr, func(t *testing.T) {
+				numTests++
 				L.Push(value)
 				L.Push(tLua(L, t))
 				assert.NoError(t, L.PCall(1, 0, nil))
 			})
 		}
 	})
+	return
+}
+
+//SeveralPreloadFuncs combines several PreloadFuncs to one such as when tests want to preload theirs + inspect
+func SeveralPreloadFuncs(preloadFuncs ...PreloadFunc) PreloadFunc {
+	return func(L *lua.LState) {
+		for _, preloadFunc := range preloadFuncs {
+			preloadFunc(L)
+		}
+	}
 }