OpenStack based test automation framework. Based on OpenCAFE engine
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
OpenDev Sysadmins b08ada7fd0 OpenDev Migration Patch 2 months ago
cloudcafe Changes to fix issue with data driven method names with slashes 6 months ago
configs Small fixes in reference config: 3 years ago
metatests Replace assertEquals with assertEqual 2 years ago
.gitignore Add DS_Store to gitignore 5 years ago
.gitreview OpenDev Migration Patch 2 months ago
HISTORY.rst Initial Commit 6 years ago
LICENSE Initial Commit 6 years ago Refactor to support changes made in engine config overhaul 5 years ago Change 'cloudcafe' stackforge url to openstack url 3 years ago
pip-requires Initial commit for a Networking Proxy Manager 3 years ago Added a script to run the existing unit tests. 5 years ago Removes distutils code, old aliases, and bad url from 5 years ago
test-requirements.txt Replaced all imports of unittest2 with unitest imports 4 years ago
unittest.engine.config Refactor to support changes made in engine config overhaul 5 years ago

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.


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.


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,


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


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.

Join us