summaryrefslogtreecommitdiffstats
path: root/docs/WriteYourTests/2_LUATestFiles.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/WriteYourTests/2_LUATestFiles.md')
-rw-r--r--docs/WriteYourTests/2_LUATestFiles.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/WriteYourTests/2_LUATestFiles.md b/docs/WriteYourTests/2_LUATestFiles.md
new file mode 100644
index 0000000..377b8f2
--- /dev/null
+++ b/docs/WriteYourTests/2_LUATestFiles.md
@@ -0,0 +1,17 @@
+# LUA Test files
+
+First, ensure that you put your LUA tests files in the `lua.d` directory.
+
+You have two differents things to take in account when you'll write your tests
+using this framework: *test* and *assertions*.
+
+*Assertions* are functions meant to test an atomic operation result.
+(ie: `1+1 = 2` is an assertion)
+
+*Test* functions represent a test (Unbelievable), they represent a set of one or
+several *assertions* which are all needed to succeed to valid the test.
+
+The framework came with several *test* and *assertion* functions to simply be
+able to test verb calls and events receiving. Use the simple one as often as
+possible and if you need more use the one that calls a callback. Specifying a
+callback let you add assertions and enrich the test. \ No newline at end of file