diff options
author | roboo <robo.karasek@gmail.com> | 2016-08-21 22:36:23 +0200 |
---|---|---|
committer | roboo <robo.karasek@gmail.com> | 2016-08-21 22:36:23 +0200 |
commit | cb212b167b120490d872cc9e1b8548a0770dd4c4 (patch) | |
tree | 6251f3ed0f844b5bd0d9f9105f039b61709a9a39 | |
parent | 3dd43e885f1d273bd3b51f4f9e7e7d20a1beb146 (diff) | |
download | luarocks-cb212b167b120490d872cc9e1b8548a0770dd4c4.tar.gz luarocks-cb212b167b120490d872cc9e1b8548a0770dd4c4.tar.bz2 luarocks-cb212b167b120490d872cc9e1b8548a0770dd4c4.zip |
Update of README
-rw-r--r-- | test/README.md | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/test/README.md b/test/README.md index c374438f..5deaa175 100644 --- a/test/README.md +++ b/test/README.md | |||
@@ -12,7 +12,7 @@ Test suite for LuaRocks project with Busted unit testing framework(http://olivin | |||
12 | 12 | ||
13 | 13 | ||
14 | ##Usage | 14 | ##Usage |
15 | Running of tests is based on basic Busted usage. *-Xhelper* flag is mandatory for inserting arguments into testing (primary black-box). Flag *--tags=* or *-t* is mandatory for specifying which tests will run. Mandatory *-Xhelper* flag always needs version of Lua or LuaJIT (e.g. *lua=5.2.4* or *luajit=2.0.3*). Start tests inside LuaRocks folder or specify with *-C* flag. | 15 | Running of tests is based on basic Busted usage. *-Xhelper* flag is mandatory for inserting arguments into testing (primary black-box). Flag *--tags=* or *-t* is mandatory for specifying which tests will run. Start tests inside LuaRocks folder or specify with *-C* flag. |
16 | 16 | ||
17 | **Arguments for Busted helper script** | 17 | **Arguments for Busted helper script** |
18 | 18 | ||
@@ -22,7 +22,9 @@ OR | |||
22 | luajit=<version>, !mandatory! type your full version of LuaJIT (e.g. luajit=5.2.4) | 22 | luajit=<version>, !mandatory! type your full version of LuaJIT (e.g. luajit=5.2.4) |
23 | 23 | ||
24 | env=<type>, (default:"minimal") type what kind of environment to use ["minimal", "full"] | 24 | env=<type>, (default:"minimal") type what kind of environment to use ["minimal", "full"] |
25 | noreset, Don't reset environment after each test | ||
25 | clean, remove existing testing environment | 26 | clean, remove existing testing environment |
27 | appveyor, add just if running on TravisCI | ||
26 | travis, add just if running on TravisCI | 28 | travis, add just if running on TravisCI |
27 | os=<version>, type your OS ["linux", "os x", "windows"] | 29 | os=<version>, type your OS ["linux", "os x", "windows"] |
28 | ``` | 30 | ``` |
@@ -35,6 +37,10 @@ os=<version>, type your OS ["linux", "os x", "windows"] | |||
35 | 37 | ||
36 | **ssh** - run all tests which require ssh | 38 | **ssh** - run all tests which require ssh |
37 | 39 | ||
40 | **mock** - run all tests which require mock LuaRocks server (upload tests) | ||
41 | |||
42 | **unix** - run all tests which are UNIX based, won't work on Windows systems | ||
43 | |||
38 | **w**\_*name-of-command* - whitebox testing of command | 44 | **w**\_*name-of-command* - whitebox testing of command |
39 | 45 | ||
40 | **b**\_*name-of-command* - blackbox testing of command | 46 | **b**\_*name-of-command* - blackbox testing of command |
@@ -42,6 +48,9 @@ os=<version>, type your OS ["linux", "os x", "windows"] | |||
42 | for example: `b_install` or `w_help` | 48 | for example: `b_install` or `w_help` |
43 | 49 | ||
44 | ###Examples | 50 | ###Examples |
51 | To run all tests: | ||
52 | `busted` | ||
53 | |||
45 | To run white-box tests in LuaRocks directory type : | 54 | To run white-box tests in LuaRocks directory type : |
46 | 55 | ||
47 | `busted -t "whitebox"` | 56 | `busted -t "whitebox"` |