add luacheck and integration test workflows / fix luacheck errors

partially attends to https://github.com/pandorabox-io/pandorabox.io/issues/444 (the ObjectRef issue)

.github/workflows/integration-test.yml

@@ -0,0 +1,14 @@
+name: integration-test
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: integration-test
+      run: ./integration-test.sh

.github/workflows/luacheck.yml

@@ -0,0 +1,17 @@
+name: luacheck
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: apt
+      run: sudo apt-get install -y luarocks
+    - name: luacheck install
+      run: luarocks install --local luacheck
+    - name: luacheck run
+      run: $HOME/.luarocks/bin/luacheck ./

.gitignore

@@ -4,6 +4,7 @@
 *bak*
 tags
 *.vim
+armor.conf
 
 ## Eclipse project files & directories
 .project

.luacheckrc

@@ -0,0 +1,34 @@
+
+unused_args = false
+
+globals = {
+	"wieldview",
+	"armor",
+	"armor_i18n",
+	"inventory_plus"
+}
+
+read_globals = {
+	-- Stdlib
+	string = {fields = {"split"}},
+	table = {fields = {"copy", "getn"}},
+
+	-- Minetest
+	"vector", "ItemStack",
+	"dump", "VoxelArea",
+
+	-- deps
+	"default",
+	"minetest",
+	"unified_inventory",
+	"intllib",
+	"wardrobe",
+	"player_monoids",
+	"armor_monoid",
+	"sfinv",
+	"ARMOR_MATERIALS",
+	"ARMOR_FIRE_NODES",
+	"pova",
+	"skins",
+	"u_skins"
+}

3d_armor/api.lua

@@ -185,7 +185,6 @@ armor.set_player_armor = function(self, player)
 	local material = {count=1}
 	local preview = armor:get_preview(name)
 	local texture = "3d_armor_trans.png"
-	local textures = {}
 	local physics = {}
 	local attributes = {}
 	local levels = {}
@@ -279,6 +278,11 @@ armor.set_player_armor = function(self, player)
 	if use_armor_monoid then
 		armor_monoid.monoid:add_change(player, change, "3d_armor:armor")
 	else
+		-- Preserve immortal group (damage disabled for player)
+		local immortal = player:get_armor_groups().immortal
+		if immortal and immortal ~= 0 then
+			groups.immortal = 1
+		end
 		player:set_armor_groups(groups)
 	end
 	if use_player_monoids then
@@ -319,8 +323,8 @@ armor.punch = function(self, player, hitter, time_from_last_punch, tool_capabili
 	local list = armor_inv:get_list("armor")
 	for i, stack in pairs(list) do
 		if stack:get_count() == 1 then
-			local name = stack:get_name()
-			local use = minetest.get_item_group(name, "armor_use") or 0
+			local itemname = stack:get_name()
+			local use = minetest.get_item_group(itemname, "armor_use") or 0
 			local damage = use > 0
 			local def = stack:get_definition() or {}
 			if type(def.on_punched) == "function" then
@@ -368,7 +372,7 @@ armor.punch = function(self, player, hitter, time_from_last_punch, tool_capabili
 				end
 			end
 			if damage == true and hitter == "fire" then
-				damage = minetest.get_item_group(name, "flammable") > 0
+				damage = minetest.get_item_group(itemname, "flammable") > 0
 			end
 			if damage == true then
 				self:damage(player, i, stack, use)

3d_armor/armor.conf

@@ -1,37 +0,0 @@
--- Armor Configuration (defaults)
-
--- Increase this if you get initialization glitches when a player first joins.
-ARMOR_INIT_DELAY = 3
-
--- Number of initialization attempts.
--- Use in conjunction with ARMOR_INIT_DELAY if initialization problems persist.
-ARMOR_INIT_TIMES = 3
-
--- Increase this if armor is not getting into bones due to server lag.
-ARMOR_BONES_DELAY = 3
-
--- How often player armor/wield items are updated.
-ARMOR_UPDATE_TIME = 1
-
--- Drop armor when a player dies.
--- Uses bones mod if present, otherwise items are dropped around the player.
-ARMOR_DROP = true
-
--- Pulverise armor when a player dies, overrides ARMOR_DROP.
-ARMOR_DESTROY = false
-
--- You can use this to increase or decrease overall armor effectiveness,
--- eg: ARMOR_LEVEL_MULTIPLIER = 0.5 will reduce armor level by half.
-ARMOR_LEVEL_MULTIPLIER = 1
-
--- You can use this to increase or decrease overall armor healing,
--- eg: ARMOR_HEAL_MULTIPLIER = 0 will disable healing altogether.
-ARMOR_HEAL_MULTIPLIER = 1
-
--- You can also use this file to execute arbitary lua code
--- eg: Dumb the armor down if using Simple Mobs
---if minetest.get_modpath("mobs") then
---	ARMOR_LEVEL_MULTIPLIER = 1
---	ARMOR_HEAL_MULTIPLIER = 0
---end
-

3d_armor/init.lua

@@ -15,19 +15,23 @@ local F = minetest.formspec_escape
 
 dofile(modpath.."/api.lua")
 
+-- integration test
+if minetest.settings:get_bool("enable_3d_armor_integration_test") then
+        dofile(modpath.."/integration_test.lua")
+end
+
+
 -- Legacy Config Support
 
 local input = io.open(modpath.."/armor.conf", "r")
 if input then
 	dofile(modpath.."/armor.conf")
 	input:close()
-	input = nil
 end
 input = io.open(worldpath.."/armor.conf", "r")
 if input then
 	dofile(worldpath.."/armor.conf")
 	input:close()
-	input = nil
 end
 for name, _ in pairs(armor.config) do
 	local global = "ARMOR_"..name:upper()
@@ -99,17 +103,27 @@ armor.formspec = armor.formspec..
 if armor.config.fire_protect then
 	armor.formspec = armor.formspec.."label[5,2;"..F(S("Fire"))..":  armor_attr_fire]"
 end
+armor:register_on_damage(function(player, index, stack)
+	local name = player:get_player_name()
+	local def = stack:get_definition()
+	if name and def and def.description and stack:get_wear() > 60100 then
+		minetest.chat_send_player(name, S("Your @1 is almost broken!", def.description))
+		minetest.sound_play("default_tool_breaks", {to_player = name, gain = 2.0})
+	end
+end)
 armor:register_on_destroy(function(player, index, stack)
 	local name = player:get_player_name()
 	local def = stack:get_definition()
 	if name and def and def.description then
 		minetest.chat_send_player(name, S("Your @1 got destroyed!", def.description))
+		minetest.sound_play("default_tool_breaks", {to_player = name, gain = 2.0})
 	end
 end)
 
 local function validate_armor_inventory(player)
 	-- Workaround for detached inventory swap exploit
 	local _, inv = armor:get_valid_player(player, "[validate_armor_inventory]")
+	local pos = player:get_pos()
 	if not inv then
 		return
 	end
@@ -140,6 +154,7 @@ local function validate_armor_inventory(player)
 				elements[element] = true;
 			else
 				inv:remove_item("armor", stack)
+				minetest.item_drop(stack, player, pos)
 				-- The following code returns invalid items to the player's main
 				-- inventory but could open up the possibity for a hacked client
 				-- to receive items back they never really had. I am not certain
@@ -158,9 +173,9 @@ local function validate_armor_inventory(player)
 	end
 end
 
-local function init_player_armor(player)
-	local name = player:get_player_name()
-	local pos = player:get_pos()
+local function init_player_armor(initplayer)
+	local name = initplayer:get_player_name()
+	local pos = initplayer:get_pos()
 	if not name or not pos then
 		return false
 	end
@@ -203,20 +218,20 @@ local function init_player_armor(player)
 		end,
 	}, name)
 	armor_inv:set_size("armor", 6)
-	if not armor:load_armor_inventory(player) and armor.migrate_old_inventory then
-		local player_inv = player:get_inventory()
+	if not armor:load_armor_inventory(initplayer) and armor.migrate_old_inventory then
+		local player_inv = initplayer:get_inventory()
 		player_inv:set_size("armor", 6)
 		for i=1, 6 do
 			local stack = player_inv:get_stack("armor", i)
 			armor_inv:set_stack("armor", i, stack)
 		end
-		armor:save_armor_inventory(player)
+		armor:save_armor_inventory(initplayer)
 		player_inv:set_size("armor", 0)
 	end
 	for i=1, 6 do
 		local stack = armor_inv:get_stack("armor", i)
 		if stack:get_count() > 0 then
-			armor:run_callbacks("on_equip", player, i, stack)
+			armor:run_callbacks("on_equip", initplayer, i, stack)
 		end
 	end
 	armor.def[name] = {
@@ -252,7 +267,7 @@ local function init_player_armor(player)
 			end
 		end
 	end
-	armor:set_player_armor(player)
+	armor:set_player_armor(initplayer)
 	return true
 end
 
@@ -280,24 +295,31 @@ minetest.register_on_player_receive_fields(function(player, formname, fields)
 	if not name then
 		return
 	end
+  local player_name = player:get_player_name()
 	for field, _ in pairs(fields) do
 		if string.find(field, "skins_set") then
-			minetest.after(0, function(player)
-				local skin = armor:get_player_skin(name)
-				armor.textures[name].skin = skin
-				armor:set_player_armor(player)
-			end, player)
+			minetest.after(0, function()
+        local pplayer = minetest.get_player_by_name(player_name)
+        if player then
+          local skin = armor:get_player_skin(name)
+          armor.textures[name].skin = skin
+          armor:set_player_armor(pplayer)
+        end
+			end)
 		end
 	end
 end)
 
 minetest.register_on_joinplayer(function(player)
 	default.player_set_model(player, "3d_armor_character.b3d")
-	minetest.after(0, function(player)
-		if init_player_armor(player) == false then
-			pending_players[player] = 0
+  local player_name = player:get_player_name()
+
+	minetest.after(0, function()
+    local pplayer = minetest.get_player_by_name(player_name)
+		if pplayer and init_player_armor(pplayer) == false then
+			pending_players[pplayer] = 0
 		end
-	end, player)
+	end)
 end)
 
 minetest.register_on_leaveplayer(function(player)
@@ -330,8 +352,8 @@ if armor.config.drop == true or armor.config.destroy == true then
 		if pos and armor.config.destroy == false then
 			minetest.after(armor.config.bones_delay, function()
 				local meta = nil
-				local maxp = vector.add(pos, 8)
-				local minp = vector.subtract(pos, 8)
+				local maxp = vector.add(pos, 16)
+				local minp = vector.subtract(pos, 16)
 				local bones = minetest.find_nodes_in_area(minp, maxp, {"bones:bones"})
 				for _, p in pairs(bones) do
 					local m = minetest.get_meta(p)
@@ -467,5 +489,3 @@ if armor.config.water_protect == true or armor.config.fire_protect == true then
 		armor.timer = 0
 	end)
 end
-
-minetest.log("action", "[3d_armor] loaded.")

3d_armor/integration_test.lua

@@ -0,0 +1,25 @@
+
+minetest.log("warning", "[TEST] integration-test enabled!")
+
+minetest.register_on_mods_loaded(function()
+	minetest.after(1, function()
+
+		local data = minetest.write_json({ success = true }, true);
+		local file = io.open(minetest.get_worldpath().."/integration_test.json", "w" );
+		if file then
+			file:write(data)
+			file:close()
+		end
+
+		file = io.open(minetest.get_worldpath().."/registered_nodes.txt", "w" );
+		if file then
+			for name in pairs(minetest.registered_nodes) do
+				file:write(name .. '\n')
+			end
+			file:close()
+		end
+
+		minetest.log("warning", "[TEST] integration tests done!")
+		minetest.request_shutdown("success")
+	end)
+end)