Extra changes on Flavor Config
[snaps.git] / docs / how-to-use / Testing.rst
index 586974a..8e08abb 100644 (file)
@@ -1,23 +1,14 @@
 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]``
+::
+
+    cd <path to repo>
+    python snaps/test_runner.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
@@ -25,20 +16,18 @@ Execute the tests
 | \* -p [optional - the proxy settings if required. Format :
 | \* -s [optional - the proxy command used for SSH connections]
 | \* -l [(default INFO) The log level]
+| \* -u [optional - When set, the unit tests will be executed]
+| \* -st [optional - When set, the staging tests will be executed]
+| \* -c [optional - When set, the connection tests will be executed]
+| \* -a [optional - When set, the API tests will be executed]
+| \* -i [optional - When set, the integration tests will be executed]
 | \* -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
+| \* -f [optional - When set, will 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.
-----------------------------------------------------------------------------------------------------------------------------------------------------------------
+| \* -im [optional - File containing image endpoints to override
+| \* -fm [optional - JSON string containing a dict(): - for flavor metadata default='{\"hw:mem_page_size\": \"any\"}'
+                                                      - for values of basic elements (e.g. ram, vcpu, disk, etc) could be added.
+                                                        As result the hard coded values of those elements will be overwritten by the new ones]
+| \* -ci [optional - runs the tests required by SNAPS-OO CI]
+| \* -r [optional with default value of '1' - The number of test iterations to execute]