From c96df58a88b60c7501b3c8a758c0277c17088371 Mon Sep 17 00:00:00 2001 From: Corentin Le Gall Date: Thu, 19 Jul 2018 15:57:30 +0200 Subject: Changed doc to GitBook format + added doc -Changed README.md to a complet GitBook doc. -Added explanations about EvtGrpReceived functions. -Corrected mistakes + reduced lines length. Change-Id: I1a077ddf6acb520a9158de658d3c09b12a2029d4 Signed-off-by: Corentin Le Gall --- docs/WriteYourTests/2_LUATestFiles.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/WriteYourTests/2_LUATestFiles.md (limited to 'docs/WriteYourTests/2_LUATestFiles.md') 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 -- cgit 1.2.3-korg