x/cloudcafe
Code Issues Proposed changes
OpenStack based test automation framework. Based on OpenCAFE engine
682 Commits 1 Branch 0 Tags 8.9 MiB
Python 100%
edcd7a3aec
Go to file
Brian Cline edcd7a3aec Fixes up a few minor things in README.md 
* Properly linked all the Open CAFE and CloudRoast repos, since all
  the links were simply pointing at the full StackForge project list.

* Makes <USER_HOME>, <PRODUCT>, etc. visible when viewing readme
  on GitHub; these were being interpreted as HTML tags before, so
  paths were showing as "/.cloudcafe/logs///statistics", for instance.
  Escaping them as code shows them properly.

* Used consistent line lengths (yielded to the liberal 120 character
  convention due to some of the inline tags and so forth).

* Fixed formatting errors in the configuration section, mostly due to
  the ordered list not appearing rendered as an ordered list the way
  it appeared in plain text.

* Matched package anatomy rendered format to match Open CAFE package
  anatomy format (bulleted).

* Spaced things out consistently for the gentle plain-text reader.

Change-Id: Ia645fff897b14e0a0df1a3ccfec198b7963668ba
2014-05-04 22:43:09 -05:00
cloudcafe Merge "Minor PEP8 fixes" 2014-05-03 16:03:34 +00:00
configs Added bulk_delete method to client. 2014-05-01 13:27:41 -05:00
metatests Boot from Block version 2 support 2014-05-01 10:39:43 -05:00
.gitignore Add DS_Store to gitignore 2014-01-28 08:05:59 -06:00
.gitreview Added .gitreview 2013-04-01 02:24:14 -05:00
HISTORY.rst Initial Commit 2013-03-30 14:48:37 -05:00
LICENSE Initial Commit 2013-03-30 14:48:37 -05:00
MANIFEST.in Refactor to support changes made in engine config overhaul 2013-09-06 13:54:03 -05:00
pip-requires Moving httpretty to the test-requirements.txt file because it's 2014-01-30 11:39:16 -06:00
README.md Fixes up a few minor things in README.md 2014-05-04 22:43:09 -05:00
run_tests.sh Added a script to run the existing unit tests. 2013-12-06 10:07:12 -06:00
setup.py Changes setup.py to use cafe config installer 2013-12-09 22:03:32 -06:00
test-requirements.txt Moving httpretty to the test-requirements.txt file because it's 2014-01-30 11:39:16 -06:00
unittest.engine.config Refactor to support changes made in engine config overhaul 2013-09-06 13:54:03 -05:00

README.md

CloudCAFE, An Open CAFE Implementation for OpenStack

   _ _ _
  ( `   )_
 (    )   `)  _
(____(__.___`)__)

    ( (
       ) )
    .........
    |       |___
    |       |_  |
    |  :-)  |_| |
    |       |___|
    |_______|
=== CloudCAFE ===
= An Open CAFE Implementation =

CloudCAFE is an implementation of the Open CAFE Framework specifically designed to test deployed versions of OpenStack. It is built using the Open CAFE Core.

Supported Operating Systems

CloudCAFE has been developed primarily in Linux and Mac environments, however it supports installation and execution on Windows.

Installation

CloudCAFE can be installed with pip from the git repository after it is cloned to a local machine.

  • First follow the README instructions to install Open CAFE Core.
  • Clone this repository to your local machine.
  • CD to the cloned cloudcafe repository directory.
  • Run pip install . --upgrade so that pip will auto-install all other dependencies.

Configuration

CloudCAFE works in tandem with the Open CAFE Core cafe-runner. This installation of CloudCAFE includes a reference configuration for each of the CloudCAFE supported OpenStack products. Configurations will be installed to <USER_HOME>/.cloudcafe/configs/<PRODUCT>.

To use CloudCAFE you will need to create/install your own configurations based on the reference configs pointing to your deployment of OpenStack.

At this stage you will have the Open CAFE Core engine and the CloudCAFE Framework implementation. From this point you are ready to:

  1. Write entirely new tests using the CloudCAFE Framework,

    or...

  2. Install the CloudRoast Test Repository, an open source body of OpenStack automated tests written with CloudCAFE that can be executed or extended.

Logging

CloudCAFE leverages the logging capabilities of the CAFE Core engine. If tests are executed with the built-in cafe-runner, runtime logs will be output to <USER_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.

Basic CloudCAFE Package Anatomy

Below is a short description of the top level CloudCAFE Packages.

  • cloudcafe
    This is the root package for all things CloudCAFE.

  • common
    Contains modules that extend the CAFE Core engine specific to OpenStack. This is the primary namespace for tools, data generators, common reporting classes, etc.

  • identity
    OpenStack Identity Service plug-in based on CAFE Core extensions.

  • compute
    OpenStack Compute plug-in based on CAFE Core extensions.

  • blockstorage
    OpenStack Block Storage plug-in based on CAFE Core extensions.

  • objectstorage
    OpenStack Object Storage plug-in based on CAFE Core extensions.