Change repositories from stackforge to openstack
Change-Id: I0f91159c49295501fb9b93fee78155d184b0d827
This commit is contained in:
parent
09c3295e52
commit
8f07837a1e
@ -1,6 +1,6 @@
|
|||||||
=================
|
================
|
||||||
Coding Standards
|
Coding Standards
|
||||||
=================
|
================
|
||||||
OpenCAFE standards are intended to allow flexability in solving coding issues,
|
OpenCAFE standards are intended to allow flexability in solving coding issues,
|
||||||
while maintaining uniformity and overall code quality.
|
while maintaining uniformity and overall code quality.
|
||||||
|
|
||||||
|
@ -25,7 +25,7 @@ be used to that end.
|
|||||||
|
|
||||||
Installation
|
Installation
|
||||||
============
|
============
|
||||||
Source code is available at https://github.com/stackforge/opencafe
|
Source code is available at https://github.com/openstack/opencafe
|
||||||
|
|
||||||
Supported Operating Systems
|
Supported Operating Systems
|
||||||
---------------------------
|
---------------------------
|
||||||
@ -45,7 +45,7 @@ From source
|
|||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
$ git clone https://github.com/stackforge/opencafe.git
|
$ git clone https://github.com/openstack/opencafe.git
|
||||||
$ cd opencafe
|
$ cd opencafe
|
||||||
$ python setup.py install
|
$ python setup.py install
|
||||||
|
|
||||||
@ -130,7 +130,7 @@ Following are some notes on Open CAFE lingo and concepts.
|
|||||||
Although the engine can serve as a basic framework for testing, it's meant to be used as the base for the implementation of a product-specific testing framework.
|
Although the engine can serve as a basic framework for testing, it's meant to be used as the base for the implementation of a product-specific testing framework.
|
||||||
|
|
||||||
* Product
|
* Product
|
||||||
Anything that's being tested by an implementation of Open CAFE Core. If you would like to see a refernce implementation, there is an `Open Source implementation <https://github.com/stackforge>`_ based on `OpenStack <http://www.openstack.org/>`_.
|
Anything that's being tested by an implementation of Open CAFE Core. If you would like to see a reference implementation, there is an `Open Source implementation <https://github.com/stackforge>`_ based on `OpenStack <http://www.openstack.org/>`_.
|
||||||
|
|
||||||
* Client / Client Method
|
* Client / Client Method
|
||||||
A **client** is an "at-least-one"-to-"at-most-one" mapping of a product's functionality to a collection of client methods. Using a `REST API <https://en.wikipedia.org/wiki/Representational_state_transfer>`_ as an example, a client that represents that API in CAFE will contain at least one (but possibly more) method(s) for every function exposed by that API. Should a call in the API prove to be too difficult or cumbersome to define via a single **client method**, then multiple client methods can be defined such that as a whole they represent the complete set of that API call's functionality. A **client method** should never be a superset of more than one call's functionality.
|
A **client** is an "at-least-one"-to-"at-most-one" mapping of a product's functionality to a collection of client methods. Using a `REST API <https://en.wikipedia.org/wiki/Representational_state_transfer>`_ as an example, a client that represents that API in CAFE will contain at least one (but possibly more) method(s) for every function exposed by that API. Should a call in the API prove to be too difficult or cumbersome to define via a single **client method**, then multiple client methods can be defined such that as a whole they represent the complete set of that API call's functionality. A **client method** should never be a superset of more than one call's functionality.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
=====================================
|
====================================
|
||||||
Setting up a Development Environment
|
Setting up a Development Environment
|
||||||
=====================================
|
====================================
|
||||||
|
|
||||||
OpenCAFE strongly recommends the use of Python virtual environments for development.
|
OpenCAFE strongly recommends the use of Python virtual environments for development.
|
||||||
|
|
||||||
@ -8,7 +8,7 @@ While not required, if you wish to manage your Python versions as well as virtua
|
|||||||
|
|
||||||
|
|
||||||
Building your virtual environment
|
Building your virtual environment
|
||||||
==================================
|
=================================
|
||||||
If you wish to run OpenCAFE in a virtual environment, then you will need to `install virtualenv <http://www.virtualenv.org/en/latest/virtualenv.html#installation>`_
|
If you wish to run OpenCAFE in a virtual environment, then you will need to `install virtualenv <http://www.virtualenv.org/en/latest/virtualenv.html#installation>`_
|
||||||
|
|
||||||
For easier management of your virtual environments, it is recommended that you install virtualenvwrapper as well.
|
For easier management of your virtual environments, it is recommended that you install virtualenvwrapper as well.
|
||||||
@ -19,7 +19,7 @@ For easier management of your virtual environments, it is recommended that you i
|
|||||||
|
|
||||||
|
|
||||||
Creating virtualenv and installing OpenCAFE
|
Creating virtualenv and installing OpenCAFE
|
||||||
---------------------------------------------
|
-------------------------------------------
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@ -27,7 +27,7 @@ Creating virtualenv and installing OpenCAFE
|
|||||||
mkvirtualenv OpenCAFE
|
mkvirtualenv OpenCAFE
|
||||||
|
|
||||||
# Clone OpenCAFE Repo
|
# Clone OpenCAFE Repo
|
||||||
git clone git@github.com:stackforge/opencafe.git
|
git clone git@github.com:openstack/opencafe.git
|
||||||
|
|
||||||
# Change directory into the newly cloned repository
|
# Change directory into the newly cloned repository
|
||||||
cd opencafe
|
cd opencafe
|
||||||
|
Loading…
x
Reference in New Issue
Block a user