x/cloudroast
Code Issues Proposed changes

Fix README formatting

Browse Source 
Change-Id: I315688607b59dcece54596566b1210e87ae9f873
This commit is contained in:
Chris Lee 2015-05-21 01:31:26 -07:00
parent 14da32968d
commit 8b1234d3a9
1 changed files with 28 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -1,22 +1,21 @@
CloudRoast, CloudCAFE Test Repo
================================
<pre>
(----) (----)--)
(--(----) (----) --)
(----) (--(----) (----)
-----------------------
\ /
\ /
\_________________/
)\ ` `(` `
( ) ` )' ) \_
( ) _) \ )
) ) (_ ) , (
( , ) ( (
( ( ) )
=== CloudRoast ===
= A CloudCAFE Test Repository =
</pre>
(----) (----)--)
(--(----) (----) --)
(----) (--(----) (----)
-----------------------
\ /
\ /
\_________________/
)\ ` `(` `
( ) ` )' ) \_
( ) _) \ )
) ) (_ ) , (
( , ) ( (
( ( ) )
=== CloudRoast ===
= A CloudCAFE Test Repository =
CloudRoast is a rich, full bodied blend of premium roasted automated test cases. CloudRoast tests are based on the expanded unittest driver in the
[Open CAFE Core](https://github.com/stackforge) and built using the [CloudCAFE Framework](https://github.com/stackforge).
@ -31,38 +30,35 @@ CloudRoast can be [installed with pip](https://pypi.python.org/pypi/pip) from th
* First follow the README instructions to install the [CloudCAFE Framework](https://github.com/stackforge)
* Clone this repository to your local machine
* CD to the root directory in your cloned repository.
* Run "pip install . --upgrade" and pip will auto install all other dependencies.
* `cd` to the root directory in your cloned repository.
* Run `pip install . --upgrade` and pip will auto install all other dependencies.
Configuration
--------------
CloudRoast runs on the [CloudCAFE Framework](https://github.com/stackforge) using the cafe-runner. It relies on the configurations installed to:
<USER_HOME>/.cloudcafe/configs/<PRODUCT> by CloudCAFE.
`${HOME}/.cloudcafe/configs/${PRODUCT}` by CloudCAFE.
At this stage you will have the Open CAFE Core engine, the CloudCAFE Framework implementation and the Open Source automated test cases. You are now
ready to:
1) Execute the test cases against a deployed Open Stack.
or
2) Write entirely new tests in this repository using the CloudCAFE Framework.
1. Execute the test cases against a deployed Open Stack. *or*
2. Write entirely new tests in this repository using the CloudCAFE Framework.
Logging
-------
If tests are executed with the built-in cafe-runner, runtime logs will be output to
<USER_HOME>/.cloudcafe/logs/<PRODUCT>/<CONFIGURATION>/<TIME_STAMP>.
If tests are executed with the built-in cafe-runner, runtime logs will be output to `$HOME/.cloudcafe/logs/$PRODUCT/$CONFIGURATION/$TIME_STAMP`
In addition, tests built from the built-in CAFE unittest driver will generate
csv statistics files in <USER_HOME>/.cloudcafe/logs/<PRODUCT>/<CONFIGURATION>/statistics for each and ever execution of each and every test case that
provides metrics of execution over time for elapsed time, pass/fail rates, etc...
In addition, tests built from the built-in CAFE unittest driver will generate csv statistics files in `$HOME/.cloudcafe/logs/$PRODUCT/$CONFIGURATION/statistics` for each and every execution of each and every test case that provides metrics of execution over time for elapsed time, pass/fail rates, etc...
Basic CloudRoast Package Anatomy
-------------------------------
Below is a short description of the top level CloudRoast Packages.
##cloudroast
This is the root package for all automated tests. This is namespace is currently **required** by the cafe-runner for any Test Repository plug-in.
## cloudroast
This is the root package for all automated tests. This namespace is currently **required** by the cafe-runner for any Test Repository plug-in.
##identity
## identity
OpenStack Identity Service cafe-runner plug-in test cases.
##compute
## compute
OpenStack Compute Service cafe-runner plug-in test cases.