Fix CI (#34)

* LuaCheck: Fixed new warnings.

* LuaCheck: Fixed warning 211 - Unused local variable.

* LuaCheck: Fixed warning 421 - Shadowing a local variable.

* LuaCheck: Fixed warning 432 - Shadowing an upvalue argument.

* LuaCheck: Fixed warning 511 - Unreachable code.

* LuaCheck: Ignore warning 143 - Accessing undefined field of a table.

Ignoring the specific occurence through inline comments.

Author: madmaxoft

.luacheckrc

@@ -10,15 +10,15 @@ allow_defined = true
 -- Ignore files / directories
 exclude_files =
 {
-	"tests/",  -- CuberitePluginChecker
+	"tests/",
+
+	-- Not present in git, but used locally for on-the-fly checking:
+	"InfoReg.lua",
+	"AutoAPI/",
 }
 
 -- Ignore variables, warning codes
 ignore =
 {
-	"113",  -- Accessing an undefined global variable.
-	"211",  -- Unused local variable.
-	"421",  -- Shadowing a local variable.
-	"432",  -- Shadowing an upvalue argument.
-	"511",  -- Unreachable code.
+	"631",  -- Line too long.
 }

APIImpl/File.lua

@@ -54,27 +54,27 @@ return
 	end,
 
 	["<static> cFile:DeleteFile(string)"] = function(a_Simulator, a_ThisClass, a_Path)
-		if not(cFile:IsFile(a_Path)) then
+		a_Path = a_Simulator:redirectPath(a_Path)
+		if not(utils.isFile(a_Path)) then
 			return false
 		end
-		a_Path = a_Simulator:redirectPath(a_Path)
 		return (os.remove(a_Path) ~= nil)
 	end,
 
 	["<static> cFile:DeleteFolder(string)"] = function(a_Simulator, a_ThisClass, a_Path)
-		if not(cFile:IsFolder(a_Path)) then
+		a_Path = a_Simulator:redirectPath(a_Path)
+		if not(utils.isFolder(a_Path)) then
 			return false
 		end
-		a_Path = a_Simulator:redirectPath(a_Path)
 		return (os.remove(a_Path) ~= nil)
 	end,
 
 	["<static> cFile:DeleteFolderContents(string)"] = function(a_Simulator, a_ThisClass, a_Path)
-		if not(cFile:IsFolder(a_Path)) then
+		if not(utils.isFolder(a_Path)) then
 			return false
 		end
 		a_Path = a_Simulator:redirectPath(a_Path)
-		return deleteFolderContents(a_Path)
+		return utils.deleteFolderContents(a_Path)
 	end,
 
 	["<static> cFile:Exists(string)"] = function(a_Simulator, a_ThisClass, a_Path)
@@ -111,14 +111,12 @@ return
 
 	["<static> cFile:IsFile(string)"] = function(a_Simulator, a_ThisClass, a_FileName)
 		a_FileName = a_Simulator:redirectPath(a_FileName)
-		local mode = lfs.attributes(a_FileName, "mode")
-		return (mode == "file")
+		return utils.isFile(a_FileName)
 	end,
 
 	["<static> cFile:IsFolder(string)"] = function(a_Simulator, a_ThisClass, a_Path)
 		a_Path = a_Simulator:redirectPath(a_Path)
-		local mode = lfs.attributes(a_Path, "mode")
-		return (mode == "directory")
+		return utils.isFolder(a_Path)
 	end,
 
 	["<static> cFile:ReadWholeFile(string)"] = function(a_Simulator, a_ThisClass, a_Path)

APIImpl/Misc.lua

@@ -40,13 +40,13 @@ return
 
 	["cRoot:DoWithPlayerByUUID(cUUID, function)"] = function(a_Simulator, a_Root, a_PlayerUUID, a_Callback)
 		for playerName, player in pairs(a_Simulator.players) do
-			if (player.uuid == a_Uuid) then
+			if (player.uuid == a_PlayerUUID) then
 				local res = a_Simulator:processCallbackRequest({
 					Function = a_Callback,
 					ParamValues = { a_Simulator:getPlayerByName(playerName) },
 					Notes = string.format("cRoot:DoWithPlayerByUUID() for player %s", playerName),
 				})
-				return true
+				return not(not(res)) -- Convert to bool
 			end
 		end
 		return false  -- player not found

APIImpl/Network.lua

@@ -6,7 +6,7 @@
 
 
 
-local socket = require("socket")
+-- local socket = require("socket")
 local http = require("socket.http")
 local https = require("ssl.https")
 local ltn12 = require("ltn12")

APIImpl/PluginManager.lua

@@ -19,6 +19,18 @@ end
 
 
 
+--- Returns a cPluginLua instance that acts as the current plugin
+local function getCurrentPlugin(a_Simulator, a_Self)
+		local res = a_Simulator:createInstance({Type = "cPluginLua"})
+		-- Save the path to the plugin folder in the self variable
+		getmetatable(res).simulatorInternal_pluginPath = a_Simulator.options.pluginPath
+		return res
+end
+
+
+
+
+
 --- Implementation of the cPluginManager:BindCommand function
 -- There are two separate API endpoints for the same implementation, so the implementation is pulled into a common function
 local function BindCommand(a_Simulator, a_Self, a_Command, a_Permission, a_Callback, a_HelpString)
@@ -106,7 +118,7 @@ return
 
 	["<static> cPluginManager:DoWithPlugin(string, function) -> (boolean)"] = function(a_Simulator, a_Class, a_PluginName, a_Callback)
 		-- The currently tested plugin is the only one present, if the name matches, call with "self":
-		local currPlugin = cPluginManager:GetCurrentPlugin()
+		local currPlugin = getCurrentPlugin(a_Simulator)
 		if (a_PluginName == currPlugin:GetName()) then
 			local res = a_Simulator:processCallbackRequest({
 				Function = a_Callback,
@@ -154,12 +166,7 @@ return
 
 	["cPluginManager:ForEachPlugin(function) -> (boolean)"] = ForEachPlugin,
 
-	["cPluginManager:GetCurrentPlugin()"] = function (a_Simulator, a_Self)
-		local res = a_Simulator:createInstance({Type = "cPluginLua"})
-		-- Save the path to the plugin folder in the self variable
-		getmetatable(res).simulatorInternal_pluginPath = a_Simulator.options.pluginPath
-		return res
-	end,
+	["cPluginManager:GetCurrentPlugin()"] = getCurrentPlugin,
 
 	["<static> cPluginManager:GetPluginsPath()"] = function (a_Simulator)
 		return a_Simulator.options.pluginPath .. "/.."

APIImpl/World.lua

@@ -134,7 +134,7 @@ return
 					ParamValues = { a_Simulator:getPlayerByName(playerName) },
 					Notes = string.format("cWorld:DoWithEntityByID() for player %s", playerName),
 				})
-				return true
+				return not(not(res)) -- Convert to bool
 			end
 		end
 		return false  -- player not found
@@ -175,7 +175,7 @@ return
 				ParamValues = { a_Simulator:getPlayerByName(a_PlayerName) },
 				Notes = string.format("cWorld:DoWithPlayer() for player %s", a_PlayerName),
 			})
-			return true
+			return not(not(res))  -- Convert to bool
 		end
 		return false  -- player not found
 	end,
@@ -195,7 +195,7 @@ return
 					ParamValues = { a_Simulator:getPlayerByName(playerName) },
 					Notes = string.format("cWorld:DoWithPlayerByUUID() for player %s", playerName),
 				})
-				return true
+				return not(not(res))  -- Convert to bool
 			end
 		end
 		return false  -- player not found
@@ -293,7 +293,7 @@ return
 		-- If there is an exact match, use that:
 		local exactMatch = a_Simulator.players[a_PlayerName]
 		if (exactMatch and (exactMatch.worldName == worldName)) then
-			local res = a_Simulator:processCallbackRequest({
+			a_Simulator:processCallbackRequest({
 				Function = a_Callback,
 				ParamValues = { a_Simulator:getPlayerByName(a_PlayerName) },
 				Notes = string.format("cWorld:FindAndDoWithPlayer() for player %s", a_PlayerName),
@@ -304,7 +304,7 @@ return
 		-- If no exact match, use the first player in the world:
 		for playerName, player in pairs(a_Simulator.players) do
 			if (player.worldName == worldName) then
-				local res = a_Simulator:processCallbackRequest({
+				a_Simulator:processCallbackRequest({
 					Function = a_Callback,
 					ParamValues = { a_Simulator:getPlayerByName(playerName) },
 					Notes = string.format("cWorld:FindAndDoWithPlayer() for player %s", playerName),

Logger.lua

@@ -9,16 +9,16 @@
 local Logger =
 {
 	-- The various log levels:
-	ERROR   = 9,  -- Emitting this log also terminates the entire program
+	ERROR   = 9,  -- Emitting this log also prints stacktrace and terminates the entire program
 	WARNING = 5,
 	INFO    = 4,
 	DEBUG   = 3,
 	TRACE   = 1,
-
-	-- If currentLogLevel is higher than message's loglevel, the message won't be output
-	currentLogLevel = DEBUG,
 }
 
+-- If currentLogLevel is higher than message's loglevel, the message won't be output
+Logger.currentLogLevel = Logger.DEBUG
+
 
 
 

Scenario.lua

@@ -159,6 +159,33 @@ end
 
 
 
+--- Recursively fuzzes a single command
+-- To be used only inside fuzzCommand!
+-- a_CurrentIndex is the index into the a_Split array specifying the index that this recursion level should modify
+-- a_Split is the command params split array
+-- The recursion is called "backwards", the last param is chosen first and then the previous param is recursed
+-- When a_CurrentIndex is zero, the actual command handlers are invoked
+local function fuzzSingleCommand(a_Simulator, a_Command, a_PlayerName, a_Choices, a_NumChoices, a_CurrentIndex, a_Split)
+	if (a_CurrentIndex == 0) then
+		-- We've built the whole command, serialize the params into a string and execute it:
+		a_Simulator.logger:info("Scenario: fuzzing command \"%s\".", a_Command .. " " .. table.concat(a_Split, " "))
+		a_Simulator:executePlayerCommand(a_PlayerName, a_Command .. " " .. table.concat(a_Split, " "))
+		-- Process all queued callbacks:
+		a_Simulator:processAllQueuedCallbackRequests()
+		return
+	end
+
+	-- Try all choices on position <a_CurrentIndex> and recurse:
+	for ch = 1, a_NumChoices do
+		a_Split[a_CurrentIndex] = a_Choices[ch]
+		fuzzSingleCommand(a_Simulator, a_Command, a_PlayerName, a_Choices, a_NumChoices, a_CurrentIndex - 1, a_Split)
+	end
+end
+
+
+
+
+
 --- Fuzzes a single command
 -- a_Simulator is the simulator instance on which to fuzz the commands
 -- a_Command is the registered command (string) being fuzzed
@@ -167,28 +194,6 @@ end
 -- a_MinLen is the minimum length of the fuzzed command parameter array
 -- a_MaxLen is the maximum length of the fuzzed command parameter array
 local function fuzzCommand(a_Simulator, a_Command, a_PlayerName, a_Choices, a_MinLen, a_MaxLen)
-	-- Recursively fuzzes a single command
-	-- a_CurrentIndex is the index into the a_Split array specifying the index that this recursion level should modify
-	-- a_Split is the command params split array
-	-- The recursion is called "backwards", the last param is chosen first and then the previous param is recursed
-	-- When a_CurrentIndex is zero, the actual command handlers are invoked
-	local function fuzzSingleCommand(a_Simulator, a_Command, a_PlayerName, a_Choices, a_NumChoices, a_CurrentIndex, a_Split)
-		if (a_CurrentIndex == 0) then
-			-- We've built the whole command, serialize the params into a string and execute it:
-			a_Simulator.logger:info("Scenario: fuzzing command \"%s\".", a_Command .. " " .. table.concat(a_Split, " "))
-			a_Simulator:executePlayerCommand(a_PlayerName, a_Command .. " " .. table.concat(a_Split, " "))
-			-- Process all queued callbacks:
-			a_Simulator:processAllQueuedCallbackRequests()
-			return
-		end
-
-		-- Try all choices on position <a_CurrentIndex> and recurse:
-		for ch = 1, a_NumChoices do
-			a_Split[a_CurrentIndex] = a_Choices[ch]
-			fuzzSingleCommand(a_Simulator, a_Command, a_PlayerName, a_Choices, a_NumChoices, a_CurrentIndex - 1, a_Split)
-		end
-	end
-
 	-- Start the fuzzing:
 	for len = a_MinLen, a_MaxLen do
 		fuzzSingleCommand(a_Simulator, a_Command, a_PlayerName, a_Choices, #a_Choices, len, {})
@@ -199,38 +204,43 @@ end
 
 
 
+--- Recursively fuzzes a single console command
+-- To be used only inside FuzzConsoleCommand!
+-- a_CurrentIndex is the index into the a_Split array specifying the index that this recursion level should modify
+-- a_Split is the command params split array
+-- The recursion is called "backwards", the last param is chosen first and then the previous param is recursed
+-- When a_CurrentIndex is zero, the actual command handlers are invoked
+local function fuzzSingleConsoleCommand(a_Simulator, a_Command, a_Choices, a_NumChoices, a_CurrentIndex, a_Split)
+	if (a_CurrentIndex == 0) then
+		-- We've built the whole command, serialize the params into a string and execute it:
+		a_Simulator.logger:info("Scenario: fuzzing console command \"%s\".", a_Command .. " " .. table.concat(a_Split, " "))
+		a_Simulator:executeConsoleCommand(a_Command .. " " .. table.concat(a_Split, " "))
+		-- Process all queued callbacks:
+		a_Simulator:processAllQueuedCallbackRequests()
+		return
+	end
+
+	-- Try all choices on position <a_CurrentIndex> and recurse:
+	for ch = 1, a_NumChoices do
+		a_Split[a_CurrentIndex] = a_Choices[ch]
+		fuzzSingleConsoleCommand(a_Simulator, a_Command, a_Choices, a_NumChoices, a_CurrentIndex - 1, a_Split)
+	end
+end
+
+
+
+
+
 --- Fuzzes a single console command
 -- a_Simulator is the simulator instance on which to fuzz the commands
 -- a_Command is the registered command (string) being fuzzed
 -- a_Choices is the array-table of choices for the command parameters
 -- a_MinLen is the minimum length of the fuzzed command parameter array
 -- a_MaxLen is the maximum length of the fuzzed command parameter array
 local function fuzzConsoleCommand(a_Simulator, a_Command, a_Choices, a_MinLen, a_MaxLen)
-	-- Recursively fuzzes a single console command
-	-- a_CurrentIndex is the index into the a_Split array specifying the index that this recursion level should modify
-	-- a_Split is the command params split array
-	-- The recursion is called "backwards", the last param is chosen first and then the previous param is recursed
-	-- When a_CurrentIndex is zero, the actual command handlers are invoked
-	local function fuzzSingleCommand(a_Simulator, a_Command, a_Choices, a_NumChoices, a_CurrentIndex, a_Split)
-		if (a_CurrentIndex == 0) then
-			-- We've built the whole command, serialize the params into a string and execute it:
-			a_Simulator.logger:info("Scenario: fuzzing console command \"%s\".", a_Command .. " " .. table.concat(a_Split, " "))
-			a_Simulator:executeConsoleCommand(a_Command .. " " .. table.concat(a_Split, " "))
-			-- Process all queued callbacks:
-			a_Simulator:processAllQueuedCallbackRequests()
-			return
-		end
-
-		-- Try all choices on position <a_CurrentIndex> and recurse:
-		for ch = 1, a_NumChoices do
-			a_Split[a_CurrentIndex] = a_Choices[ch]
-			fuzzSingleCommand(a_Simulator, a_Command, a_Choices, a_NumChoices, a_CurrentIndex - 1, a_Split)
-		end
-	end
-
 	-- Start the fuzzing:
 	for len = a_MinLen, a_MaxLen do
-		fuzzSingleCommand(a_Simulator, a_Command, a_Choices, #a_Choices, len, {})
+		fuzzSingleConsoleCommand(a_Simulator, a_Command, a_Choices, #a_Choices, len, {})
 	end  -- for len - number of chosen params
 end