Jump to: navigation, search

Difference between revisions of "Solum/Testing"

(→‎Configure Tempest)
(Add steps to run specific unit/functional test and pep8 checks)
Line 1: Line 1:
 
= Solum Testing =
 
= Solum Testing =
  
−
Currently Solum depends on OpenStack Keystone, Nova, Heat, Glance, and Swift. Additional dependencies may be added in the future. We recommend using Devstack to set up Solum with its various low level services. See the [https://solum.readthedocs.org/en/latest/getting_started/ Getting Started Guide] for information about how to set up your Devstack environment. You can use the provided Vagrant setup, or you can configure Devstack on your own.
+
Currently Solum depends on OpenStack Keystone, Nova, Heat, Glance, Swift, Barbican, Mistral and Marconi. Additional dependencies may be added in the future. We recommend using Devstack to set up Solum with its various low level services. See the [https://solum.readthedocs.org/en/latest/getting_started/ Getting Started Guide] for information about how to set up your Devstack environment. You can use the provided Vagrant setup, or you can configure Devstack on your own.
 +
 
 +
Functional tests, Unit tests and PEP8 ([http://docs.openstack.org/developer/hacking/ OpenStack Style Guidelines]) checks are automatically run for Solum through our Stackforge gate jobs when new code is submitted for review in the [https://github.com/stackforge/solum git repository], and are automatically tested again prior to merge. To run these tests on your local Solum Vagrant/Devstack box, follow these below steps.
  
 
== Tempest Setup ==
 
== Tempest Setup ==
Line 8: Line 10:
 
=== Checkout tempest code ===
 
=== Checkout tempest code ===
  
−
  cd ${DEVSTACK_DIR}
+
cd ${DEVSTACK_DIR}
−
  git clone https://github.com/openstack/tempest.git
+
git clone https://github.com/openstack/tempest.git
  
 
=== Create tempest configuration file ===
 
=== Create tempest configuration file ===
  
−
  cd ${DEVSTACK_DIR}/tempest/etc
+
cd ${DEVSTACK_DIR}/tempest/etc
−
  cp tempest.conf.sample tempest.conf
+
cp tempest.conf.sample tempest.conf
  
 
=== Configure Tempest ===
 
=== Configure Tempest ===
 
Add the following text to etc/tempest.conf
 
Add the following text to etc/tempest.conf
−
  [DEFAULT]
+
[DEFAULT]
−
  debug=True
+
debug=True
−
  use_stderr=False
+
use_stderr=False
−
  log_file=tempest.log
+
log_file=tempest.log
 
   
 
   
−
  [identity]
+
[identity]
−
  auth_version = v2
+
auth_version = v2
−
  admin_domain_name = Default
+
admin_domain_name = Default
−
  admin_tenant_name = admin
+
admin_tenant_name = admin
−
  admin_password = solum
+
admin_password = solum
−
  admin_username = admin
+
admin_username = admin
−
  alt_tenant_name = alt_demo
+
alt_tenant_name = alt_demo
−
  alt_password = solum
+
alt_password = solum
−
  alt_username = alt_demo
+
alt_username = alt_demo
−
  tenant_name = demo
+
tenant_name = demo
−
  password = solum
+
password = solum
−
  username = demo
+
username = demo
−
  uri_v3 = http://10.0.2.15:5000/v3/
+
uri_v3 = http://10.0.2.15:5000/v3/
−
  uri = http://10.0.2.15:5000/v2.0/
+
uri = http://10.0.2.15:5000/v2.0/
  
 
NOTE: The uri_v3 and uri setting should correspond to where you are running your Keystone instance.
 
NOTE: The uri_v3 and uri setting should correspond to where you are running your Keystone instance.
Line 43: Line 45:
 
Once you have Tempest set up, you may execute your functional tests:
 
Once you have Tempest set up, you may execute your functional tests:
  
−
  cd ${DEVSTACK_DIR}/solum/functionaltests
+
cd ${DEVSTACK_DIR}/solum/functionaltests
−
  export TEMPEST_DIR=${DEVSTACK_DIR}/tempest
+
export TEMPEST_DIR=${DEVSTACK_DIR}/tempest
−
  ./run_tests.sh
+
./run_tests.sh
 +
 
 +
You can optionally run specifc functional test:
 +
 
 +
cd ${DEVSTACK_DIR}/solum
 +
export PYTHONPATH=$PYTHONPATH:${DEVSTACK_DIR}/tempest
 +
nosetests --tests dir_name1[.dir_name2...dir_nameN].test_file_name:TestClassName.test_method_name
 +
Example: nosetests --tests functionaltests.api.v1.test_plan:TestPlanController.test_plans_create
  
 
== Running Unit Tests ==
 
== Running Unit Tests ==
−
Unit tests are automatically run for Solum through our Stackforge gate jobs when new code is submitted for review in the [https://github.com/stackforge/solum git repository], and are automatically tested again prior to merge. To run tests locally in your development environment, you can use <code>tox</code> with your local version of python (example is for Python 2.6):
+
You can use <code>tox</code> with your local version of python (example is for Python 2.6):
  
 +
cd ${DEVSTACK_DIR}/solum
 
  tox -e py26
 
  tox -e py26
 +
 +
You can optionally run specifc unit test:
 +
 +
cd ${DEVSTACK_DIR}/solum
 +
python -m subunit.run dir_name1[.dir_name2...dir_nameN].test_file_name.TestClassName.test_method_name
 +
Example: python -m subunit.run solum.tests.common.test_clients.ClientsTest.test_clients_heat
  
 
On CentOS 6.5, the following additional packages may be needed:
 
On CentOS 6.5, the following additional packages may be needed:
Line 57: Line 73:
 
On Ubuntu:
 
On Ubuntu:
 
  sudo apt-get install libxml2-dev libxslt-dev
 
  sudo apt-get install libxml2-dev libxslt-dev
 +
 +
== Running PEP8 Checks ==
 +
You can use <code>tox</code>:
 +
 +
cd ${DEVSTACK_DIR}/solum
 +
tox -e pep8

Revision as of 21:31, 31 July 2014

Solum Testing

Currently Solum depends on OpenStack Keystone, Nova, Heat, Glance, Swift, Barbican, Mistral and Marconi. Additional dependencies may be added in the future. We recommend using Devstack to set up Solum with its various low level services. See the Getting Started Guide for information about how to set up your Devstack environment. You can use the provided Vagrant setup, or you can configure Devstack on your own.

Functional tests, Unit tests and PEP8 (OpenStack Style Guidelines) checks are automatically run for Solum through our Stackforge gate jobs when new code is submitted for review in the git repository, and are automatically tested again prior to merge. To run these tests on your local Solum Vagrant/Devstack box, follow these below steps.

Tempest Setup

Solum uses the tempest functional testing framework. To manually set up tempest:

Checkout tempest code

cd ${DEVSTACK_DIR}
git clone https://github.com/openstack/tempest.git

Create tempest configuration file

cd ${DEVSTACK_DIR}/tempest/etc
cp tempest.conf.sample tempest.conf

Configure Tempest

Add the following text to etc/tempest.conf 

[DEFAULT]
debug=True
use_stderr=False
log_file=tempest.log

[identity]
auth_version = v2
admin_domain_name = Default
admin_tenant_name = admin
admin_password = solum
admin_username = admin
alt_tenant_name = alt_demo
alt_password = solum
alt_username = alt_demo
tenant_name = demo
password = solum
username = demo
uri_v3 = http://10.0.2.15:5000/v3/
uri = http://10.0.2.15:5000/v2.0/

NOTE: The uri_v3 and uri setting should correspond to where you are running your Keystone instance.

Running Functional Tests

Once you have Tempest set up, you may execute your functional tests: 

cd ${DEVSTACK_DIR}/solum/functionaltests
export TEMPEST_DIR=${DEVSTACK_DIR}/tempest
./run_tests.sh

You can optionally run specifc functional test: 

cd ${DEVSTACK_DIR}/solum
export PYTHONPATH=$PYTHONPATH:${DEVSTACK_DIR}/tempest
nosetests --tests dir_name1[.dir_name2...dir_nameN].test_file_name:TestClassName.test_method_name
Example: nosetests --tests functionaltests.api.v1.test_plan:TestPlanController.test_plans_create

Running Unit Tests

You can use tox with your local version of python (example is for Python 2.6): 

cd ${DEVSTACK_DIR}/solum
tox -e py26

You can optionally run specifc unit test: 

cd ${DEVSTACK_DIR}/solum
python -m subunit.run dir_name1[.dir_name2...dir_nameN].test_file_name.TestClassName.test_method_name
Example: python -m subunit.run solum.tests.common.test_clients.ClientsTest.test_clients_heat

On CentOS 6.5, the following additional packages may be needed: 

sudo yum -y install openssl-devel python-devel libffi-devel python-lxml libxml2-devel libxslt-devel

On Ubuntu: 

sudo apt-get install libxml2-dev libxslt-dev

Running PEP8 Checks

You can use tox: 

cd ${DEVSTACK_DIR}/solum
tox -e pep8
Retrieved from "https://wiki.openstack.org/w/index.php?title=Solum/Testing&oldid=59520"