openinfra/refstack-client
Code Issues Proposed changes

Update README file with the latest information.

Browse Source 
Add instruction for  newly added "list" command.  Remove outdated
example (tempest.api.identity.admin.test_roles is no longer
existing).

Change-Id: I398bca4461396c213bb451c8c1b5912ed0e6a227
This commit is contained in:
cdiep
2015-05-03 12:33:28 -07:00
parent a84af82925
commit a5059305a9
1 changed files with 23 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.rst
View File

@@ -18,8 +18,10 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe.
a. -c option allows to specify SHA of commit or branch in Tempest repository a. -c option allows to specify SHA of commit or branch in Tempest repository
which will be installed. which will be installed.
b. -t option allows to specify tag in Tempest repository
which will be installed. b. -t option allows to specify tag in Tempest repository which will be installed.
For example: execute ./setup_env -t tags/3 to install Tempest tag-3.
c. By default, Tempest will be installed from commit c. By default, Tempest will be installed from commit
7c8fcc67343fc6e968213fddadb8e0e1ea58cbcb (10 Apr 2015). 7c8fcc67343fc6e968213fddadb8e0e1ea58cbcb (10 Apr 2015).
@@ -38,7 +40,13 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe.
4. Validate your setup by running a short test. 4. Validate your setup by running a short test.
`./refstack-client test -c <Path of the tempest configuration file to use>` `./refstack-client test -c <Path of the tempest configuration file to use>`
`-vv -t "tempest.api.identity.admin.test_roles"` `-vv -t "tempest.api.identity.admin.v2.test_roles"`
or
`./refstack-client test -c <Path of the tempest configuration file to use>`
`-vv -t "tempest.api.identity.v2.test_token"`
5. Run a full API test set. 5. Run a full API test set.
@@ -59,13 +67,14 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe.
given string (e.g. '-r my-test' will yield a result file like given string (e.g. '-r my-test' will yield a result file like
'my-test-0.json'). 'my-test-0.json').
**Upload:**
6. Upload test set.
If you previously ran a test with refstack-client without the --upload If you previously ran a test with refstack-client without the --upload
option, you can upload your results to a Refstack API server by using the option, you can upload your results to a Refstack API server by using the
following command: following command:
./refstack-client upload <Path of results file> `./refstack-client upload <Path of results file>`
The results file is a JSON file generated by refstack-client when a test has The results file is a JSON file generated by refstack-client when a test has
completed. This is saved in .tempest/.testrepository. When you use the completed. This is saved in .tempest/.testrepository. When you use the
@@ -80,6 +89,15 @@ We've created an "easy button" for Ubuntu, Centos, RHEL and openSuSe.
'~/.ssh/id-rsa' or generate a new one with 'ssh-keygen -b 4096'. '~/.ssh/id-rsa' or generate a new one with 'ssh-keygen -b 4096'.
For now, signed test results can be considereded as private. For now, signed test results can be considereded as private.
7. List uploaded test set.
You can list previously uploaded data from a Refstack API server by using
the following command:
`./refstack-client list --url <URL of the Refstack API server>`
**Tempest Hacking** **Tempest Hacking**
By default, refstack-client installs Tempest into the `.tempest` directory. By default, refstack-client installs Tempest into the `.tempest` directory.
@@ -93,5 +111,3 @@ switching to that directory and using the installed dependencies.
This will make the entire Tempest environment available for you to run, This will make the entire Tempest environment available for you to run,
including the `run_tempest` script and `testr`. including the `run_tempest` script and `testr`.