minetest-mods / qa_block Goto Github PK

Minetest mods checker mod

License: GNU General Public License v3.0

Lua 100.00%

qa_block's Introduction

QA Block to run checking scripts for better quality assurance of code

License GPL-V3: https://www.gnu.org/licenses/gpl-3.0.html

This is a developer helper mod. It allows to run any lua code for testing reason. The mod can list and run lua-scripts placed in checks subfolder. Some check scripts are provided with the mod. The second part allows to display global lua-tables variables tree for debugging.

Features

redirection of print() output to minetest chat
redirection of print() output to a log file in the world directory. The output is sorted so that it can be compared to find regressions
robust call of the scripts trough "pcall" does not crash the game in case of syntax- or runtime errors
all functionality available through chat commands and the QA-Block node
refresh and list the checks script list at runtime
edit the code before calling them
type code and run it
explore global variables/lua tables

https://forum.minetest.net/viewtopic.php?f=11&t=15759

Dependencies

none
- smartfs(provided) - GUI for check selection and manipulation. Optional, but without smartfs there is limited functionality

Provided check modules

broken_recipe - Find crafting recipes which require unknown items
empty - Empty file for your own checks
get_item_csv - Export all registered items in a .CSV file
global_variables - List suspicious global variables
graphviz_recipes_all - Make a graphviz .dot file of all items in a recipe dependency tree
is_ground_content - This checker lists all nodes for which is_ground_content == true
list_entities - Lists all the registered entities (except builtin)
list_spawning_mobs - List entities that are mobs from mobs_redo or compatible framework
no_doc_items_help - Lists all items without item usage help or long description
no_item_description - Lists all items without description
no_sounds - Find nodes that don't have any sounds associated when dug, walked on, etc.
redundant_items - Lists items which seem redundant
same_recipe - Find duplicate crafting recipes
unobtainable_items - Lists items which seem to be unobtainable
useless_items - Lists all items which are probably useless

How to use:

add the mod to the game you like to test

Using chat command /qa

/qa help - print available chat commands
/qa ls - list all available check modules
/qa set checkname - set default check
/qa ui - display and run check using the selection dialog. Browse trough globals (smartfs only)
/qa checkname - run check
/qa - run default check

Using the block

get the QA-Block from creative inventory
place the block somewhere 3a - without smartfs - wait till the default check is finished and the block disappears 3b - with smartfs - start the check using selection dialog

In all cases - check the debug.txt for test results

Minetest Configuration Parameters

qa_block.print_to_chat, bool. Output QA check messages to chat
qa_block.log_to_file: bool. Output QA check messages to a file
qa_block.overwrite_log: bool. Overwrite the file at every game launch
qa_block.log_date_time: bool. Prepend a date and time stamp to log messages
qa_block.date_and_time_format: string. Date and time stamp format

Credits

Wuzzy2 - thanks for ideas, code optimizations and most check scripts
dacmot - for adding output to log file and configuration parameters

qa_block's People

Contributors

Stargazers

Watchers

Forkers

hybriddog wuzzy2 minetest-mods-camp dacmot

qa_block's Issues

Mod does not work with developer version of Minetest

As of Minetest commit cc7c31a5bc44ab0010997e86c0a8c9f5f832b398, qa_block does not work. When I start the world, I immediately get this error:

2016-12-21 13:11:01: ERROR[Main]: ModError: Failed to load and run script from /home/wuzzy/src/minetest/git/minetest/bin/../mods/qa_block/init.lua:
2016-12-21 13:11:01: ERROR[Main]: .../src/minetest/git/minetest/bin/../mods/qa_block/init.lua:63: bad argument #1 to 'ipairs' (table expected, got string)
2016-12-21 13:11:01: ERROR[Main]: stack traceback:
2016-12-21 13:11:01: ERROR[Main]: 	[C]: in function 'ipairs'
2016-12-21 13:11:01: ERROR[Main]: 	.../src/minetest/git/minetest/bin/../mods/qa_block/init.lua:63: in function 'print'
2016-12-21 13:11:01: ERROR[Main]: 	.../src/minetest/git/minetest/bin/../mods/qa_block/init.lua:138: in main chunk

Hide core variables from Lua itself and Minetest's Lua API

In the globals tab, there are many variables which come from the core APIs.

I mean global Lua variables like:

_G
_VERSION
string
math
xpcall
dofile

And global Minetest variables like:

minetest
core
dump
dump2

It is not really useful to have these in the list as they just clutter the view IMO. I am mostly interested in the globals which come from mods.

I like to have a checkbox which allows me to filter out anything which comes from the core APIs (either Lua or Minetest).

Activating the checkbox should filter out:

Functions which have “=[C]” as the source (this automatically means they come either from Lua or Minetest)
Functions in the path of builtin (more Lua API stuff)
For the remaining variables which are not functions:
- All top-level globals defined in http://www.lua.org/manual/5.1/ (e.g. _VERSION)
- All top-level globals defined in lua_api.txt (e.g. minetest, core)

The first 2 checks can be done automatically. The non-function variables can be filtered out by a hard-coded list.

Mod does not work with enabled mod security

This mod does not work if the setting secure.enable_security is activated.

In 0.4.14, this was disabled by default, but in the next Minetest release, mod security will be activated by default. Which means in the next Minetest release this mod will break.

Read more about mod security here:
https://forum.minetest.net/viewtopic.php?f=18&t=12471

Multi-line string in globals list breaks the display

If there is a string variable with line breaks, it is displayed incorrectly in the list; the list looks broken in this case because text gets written “over” other text.

This can be easily tested by adding any global multi-line string variable in any mod.

A possible solution would be just to eliminate all newlines before they get printed on the list and by replacing them with a literal “\n”.

Add help for the QA block

I suggest to add help texts for the QA block by supporting the doc_items mod.

Support is very simple, you don't need to depend. You just need to add
_doc_items_longdesc = "<long description of what the QA block is good for goes here>"
and
_doc_items_usagehelp = "<explanation on how the QA block can be used goes here>"

to the node def. of the QA block. There is no length limit.
The QA block is quite complex now, so I (and especially other users) would appreciate a good and understandable explanation. :-)

You can test the help entry by installing the Help modpack:
https://forum.minetest.net/viewtopic.php?f=9&t=15912

minetest.chat_send_all --> log

Hi,

can you change print function minetest.chat_send_all(outsting) to minetest.log(outsting)?

The reason is, that .log is logged into the debug.txt by default. It's easier to analyze it.

Cyan for functions
Purple for strings
Yellow for numbers
White for tables
…

I don't care much about the actual colors, what is important they are easy on the eye and easy to distinguish.