diff options
author | Alexander Shorin <kxepal@apache.org> | 2015-10-18 00:36:02 +0300 |
---|---|---|
committer | Alexander Shorin <kxepal@apache.org> | 2015-10-18 00:36:02 +0300 |
commit | c071df98e64cd38ca1d4255f64b618906beb1e8e (patch) | |
tree | 5c9d3ef3f365c6815c838304d9e080a8a18d4777 | |
parent | d4ac4c42efcf225dfd6686954e9973d6f6072f30 (diff) | |
download | couchdb-c071df98e64cd38ca1d4255f64b618906beb1e8e.tar.gz |
Improve testing instructions
-rw-r--r-- | README-DEV.md | 59 |
1 files changed, 56 insertions, 3 deletions
diff --git a/README-DEV.md b/README-DEV.md index 81cfc4a7d..66e30c34d 100644 --- a/README-DEV.md +++ b/README-DEV.md @@ -119,16 +119,69 @@ If you want to build it into different destination than `/usr/local`. ./configure --prefix=/<your directory path> +If you don't want to build Fauxton or documentation specify `--disable-fauxton` +and/or `--disable-docs` arguments for `configure` to ignore their build and +avoid any issues with their dependencies. + +See `./configure --help` for more information. + Testing ------- -Check the test suite by running: +To run all the tests use run: make check -Generate a coverage report by running: +You can also run each test suite individually via `eunit` and `javascript` +targets: + + make eunit + make javascript + +If you need to run specific Erlang tests, you can pass special "options" +to make targets: + + # Run tests only for couch and chttpd apps + make eunit apps=couch,chttpd + + # Run only tests from couch_btree_tests suite + make eunit suites=couch_btree_tests + + # Run only only specific tests + make eunit tests=btree_open_test,reductions_test + + # Ignore tests for specified apps + make eunit skip_deps=couch_log,couch_epi + +The `apps`, `suites`, `tests` and `skip_deps` could be combined in any way. +These are mimics to `rebar eunit` arguments. If you're not satisfied by these, +you can use EUNIT_OPT environment variable to specify exact `rebar eunit` +options: + + make eunit EUNIT_OPTS="apps=couch,chttpd" + +JavaScript tests accepts only `suites` option, but in the same way + + # Run all JavaScript tests + make javascript + + # Run only basic and design_options tests + make javascript suites="basic design_options" + +Note that tests are delimited here by whitespace, not by comma. You can get list +of all possible test targets with the following command: + + make list-js-suites + +Code analyzer could be run by: + + make dialyze + +If you need to analyze only specific apps, you can specify them in familiar way: + + make dialyze apps=couch,couch_epi - make cover +See `make help` for more info and useful commands. Please report any problems to the developer's mailing list. |