diff options
| author |   spisarski <s.pisarski@cablelabs.com> | 2017-02-15 12:07:07 -0700 |
|---|---|---|
| committer | spisarski <s.pisarski@cablelabs.com> | 2017-02-15 15:23:39 -0700 |
| commit | c5301a7a2e890fed97ffe04b40ccbe331e7f4a0b (patch) | |
| tree | 72e5715cb7496d5826e6b0fea9652c969bf75f2b /docs/how-to-use/Testing.rst | |
| parent | 57777f3df521553a06cd01a3861b415d2905ceca (diff) | |
Converted existing markdown documentation to RST format.
Removed MD versions.
Moved examples directory up one under repo root
Moved RST files under docs/how-to-use
Change-Id: I4137b8591e4ae63e40674a7f5f8243d928efee0c
Signed-off-by: spisarski <s.pisarski@cablelabs.com>
Diffstat (limited to 'docs/how-to-use/Testing.rst')
| -rw-r--r-- | docs/how-to-use/Testing.rst | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/how-to-use/Testing.rst b/docs/how-to-use/Testing.rst new file mode 100644 index 0000000..586974a --- /dev/null +++ b/docs/how-to-use/Testing.rst @@ -0,0 +1,44 @@ +Running Unit Test Suite +======================= + +These tests are written in Python and require an that it is setup before running the tests. +See `install directions <index.md>`__ for Python installation instructions. + +Start by cloning the snaps-provisioning repository +-------------------------------------------------- + +``git clone https://gerrit.cablelabs.com/snaps-provisioning`` + +Install Library +--------------- + +``pip install -e <path to repo>/`` + +Execute the tests +----------------- + +| ``cd <path to repo> python snaps/unit_test_suite.py -e [path to RC file] -n [external network name]`` +| \* All Supported Arguments +| \* -e [required - The path to the OpenStack RC file] +| \* -n [required - The name of the external network to use for routers + and floating IPs] +| \* -p [optional - the proxy settings if required. Format : +| \* -s [optional - the proxy command used for SSH connections] +| \* -l [(default INFO) The log level] +| \* -k [optional - When set, tests project and user creation. Use only + if host running tests has access to the cloud's admin network] +| \* -f [optional - When set, will not execute tests requiring Floating + IPS] +| \* -u [optional - When set, the unit tests will be executed] + +Test descriptions +================= + +`Unit Testing <UnitTests.rst>`__ - Tests that do not require a connection to OpenStack +-------------------------------------------------------------------------------------- + +`OpenStack API Tests <APITests.rst>`__ - Tests many individual OpenStack API calls +---------------------------------------------------------------------------------- + +`Integration Tests <IntegrationTests.rst>`__ - Tests OpenStack object creation in a context. These tests will be run within a custom project as a specific user. +---------------------------------------------------------------------------------------------------------------------------------------------------------------- |