From 1fb1a5668a87e80c6eb7fe54e8b9fa8b1ef5851f Mon Sep 17 00:00:00 2001 From: George Roman Date: Sat, 9 Jun 2018 00:17:31 +0300 Subject: Move test/README.md to spec/README.md --- spec/README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ test/README.md | 58 --------------------------------------------------- 2 files changed, 66 insertions(+), 58 deletions(-) create mode 100644 spec/README.md delete mode 100644 test/README.md diff --git a/spec/README.md b/spec/README.md new file mode 100644 index 00000000..31e2b660 --- /dev/null +++ b/spec/README.md @@ -0,0 +1,66 @@ + +# LuaRocks testsuite + +## Overview + +Test suite for LuaRocks project with Busted unit testing framework(http://olivinelabs.com/busted/). + +* Contains unit & integration tests +* Easy setup for your purpose on command line or from configuration file + +## Dependencies + +* Lua >= 5.1 +* Busted with dependencies + +## Usage + +Running of tests is based on basic Busted usage. *-Xhelper* flag is used +for inserting arguments into testing. Flag *--tags=* or *-t* is used +for specifying which tests will run. Start tests inside +LuaRocks folder or specify with *-C* flag. + +**Arguments for Busted helper script** + +``` +env=, (default:"minimal") type what kind of environment to use ["minimal", "full"] +noreset, Don't reset environment after each test +clean, remove existing testing environment +appveyor, add just if running on TravisCI +travis, add just if running on TravisCI +os=, type your OS ["linux", "os x", "windows"] +``` +--------------------------------------------------------------------------------------------- +## _**Tags** of tests are required and are in this format:_ + +**unit** - run all unit tests + +**integration** - run all integration tests + +**ssh** - run all tests which require ssh + +**mock** - run all tests which require mock LuaRocks server (upload tests) + +**unix** - run all tests which are UNIX based, won't work on Windows systems + +## Examples + +To run all tests: + +`busted` + +To run unit tests in LuaRocks directory type : + +`busted -t "unit"` + +To run integration tests without tests which use ssh: + +`busted -t "integration" --exclude-tags=ssh` + +## To do + +Cover files that currently have 0% coverage: +* build/cmake.lua +* build/command.lua +* fetch/\*.lua except for git.lua +* tools/tar.lua diff --git a/test/README.md b/test/README.md deleted file mode 100644 index 770d7083..00000000 --- a/test/README.md +++ /dev/null @@ -1,58 +0,0 @@ - -# LuaRocks testsuite - -## Overview - -Test suite for LuaRocks project with Busted unit testing framework(http://olivinelabs.com/busted/). - -* Contains unit & integration tests -* Easy setup for your purpose on command line or from configuration file - -## Dependencies - -* Lua >= 5.1 -* Busted with dependencies - -## Usage - -Running of tests is based on basic Busted usage. *-Xhelper* flag is used -for inserting arguments into testing. Flag *--tags=* or *-t* is used -for specifying which tests will run. Start tests inside -LuaRocks folder or specify with *-C* flag. - -**Arguments for Busted helper script** - -``` -env=, (default:"minimal") type what kind of environment to use ["minimal", "full"] -noreset, Don't reset environment after each test -clean, remove existing testing environment -appveyor, add just if running on TravisCI -travis, add just if running on TravisCI -os=, type your OS ["linux", "os x", "windows"] -``` ---------------------------------------------------------------------------------------------- -####_**Tags** of tests are required and are in this format:_ - -**unit** - run all unit tests - -**integration** - run all integration tests - -**ssh** - run all tests which require ssh - -**mock** - run all tests which require mock LuaRocks server (upload tests) - -**unix** - run all tests which are UNIX based, won't work on Windows systems - -## Examples - -To run all tests: - -`busted` - -To run unit tests in LuaRocks directory type : - -`busted -t "unit"` - -To run integration tests without tests which use ssh: - -`busted -t "integration" --exclude-tags=ssh` -- cgit v1.2.3-55-g6feb