Skip to content

Commit

Permalink
Merge pull request #36 from gregoil/feature/cli_and_config_documentation
Browse files Browse the repository at this point in the history
Feature/cli and config documentation
  • Loading branch information
osherdp committed Feb 4, 2018
2 parents 7bc2068 + 019df9b commit 7b68242
Show file tree
Hide file tree
Showing 38 changed files with 1,521 additions and 1,102 deletions.
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Rotest
------
.. image:: https://travis-ci.org/gregoil/rotest.svg?branch=travis_ci
.. image:: https://travis-ci.org/gregoil/rotest.svg?branch=master
:target: https://travis-ci.org/gregoil/rotest

.. image:: https://ci.appveyor.com/api/projects/status/uy9grwc52wkpaaq9?svg=true
.. image:: https://ci.appveyor.com/api/projects/status/uy9grwc52wkpaaq9/branch/master?svg=true
:target: https://ci.appveyor.com/project/gregoil/rotest

Rotest is a resource oriented testing framework, for writing system or
Expand All @@ -19,14 +19,14 @@ Why Use Rotest?
===============
- Allowing teams to share resources without interfering with one another.
- Easily abstracting automated components in the system.
- Lots of useful features: multiprocess, filtering tests, variety of result
handlers (and the ability to define custom ones), and much more.
- Lots of useful features: multiprocess, filtering tests, variety of output
handlers (and the ability to create custom ones), and much more.

Examples
========
For a complete step-by-step explanation about the framework, you can read
our documentation in the tutorial. If you just want to see how it looks,
read further.
our documentation at `ReadTheDocs <http://rotest.rtfd.io>`_. If you just want
to see how it looks, read further.

For our example, let's look at an example for a `Calculator` resource:

Expand Down Expand Up @@ -110,14 +110,14 @@ Following, those are the options exposed when running the test:
Tests' configuration file path
-s, --save-state Enable save state
-d DELTA_ITERATIONS, --delta-iterations=DELTA_ITERATIONS
Enable run of failed tests only, enter the number of
times the failed tests should run
Enable run of unsuccessful tests only, enter the
number of times the failed tests should run
-p PROCESSES, --processes=PROCESSES
Use multiprocess test runner
-o OUTPUTS, --outputs=OUTPUTS
Output handlers separated by comma, options "['dots',
'xml', 'full', 'remote', 'db', 'excel', 'tree',
'artifact', 'signature', 'loginfo', 'logdebug']"
Output handlers separated by comma. Options: dots,
xml, full, remote, tree, excel, db, artifact,
signature, loginfo, logdebug
-f FILTER, --filter=FILTER
Run only tests that match the filter expression, e.g
"Tag1* and not Tag13"
Expand Down

0 comments on commit 7b68242

Please sign in to comment.