Switch branches/tags
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Gophercloud Acceptance tests

The purpose of these acceptance tests is to validate that SDK features meet the requirements of a contract - to consumers, other parts of the library, and to a remote API.

Note: Because every test will be run against a real API endpoint, you may incur bandwidth and service charges for all the resource usage. These tests should remove their remote products automatically. However, there may be certain cases where this does not happen; always double-check to make sure you have no stragglers left behind.

Step 1. Creating a Testing Environment

Running tests on an existing OpenStack cloud can be risky. Malformed tests, especially ones which require Admin privileges, can cause damage to the environment. Additionally, you may incur bandwidth and service charges for the resources used, as mentioned in the note above.

Therefore, it is usually best to first practice running acceptance tests in an isolated test environment. Two options to easily create a testing environment are DevStack and PackStack.

The following blog posts detail how to create reusable PackStack environments. These posts were written with Gophercloud in mind:

Step 2. Set environment variables

A lot of tests rely on environment variables for configuration - so you will need to set them before running the suite. If you're testing against pure OpenStack APIs, you can download a file that contains all of these variables for you: just visit the project/access_and_security page in your control panel and click the "Download OpenStack RC File" button at the top right. For all other providers, you will need to set them manually.


Name Description
OS_USERNAME Your API username
OS_PASSWORD Your API password
OS_AUTH_URL The identity URL you need to authenticate
OS_TENANT_NAME Your API tenant name


Name Description
OS_REGION_NAME The region you want your resources to reside in


Name Description
OS_IMAGE_ID The ID of the image your want your server to be based on
OS_FLAVOR_ID The ID of the flavor you want your server to be based on
OS_FLAVOR_ID_RESIZE The ID of the flavor you want your server to be resized to
OS_POOL_NAME The Pool from where to obtain Floating IPs
OS_NETWORK_NAME The internal/private network to launch instances on
OS_EXTGW_ID The external/public network


Name Description
OS_DB_DATASTORE_TYPE The Datastore type to use. Example: mariadb
OS_DB_DATASTORE_VERSION The Datastore version to use. Example: mariadb-10

Shared file systems

Name Description
OS_SHARE_NETWORK_ID The share network ID to use when creating shares

3. Run the test suite

From the root directory, run:


Alternatively, add the following to your .bashrc:

gophercloudtest() {
  if [[ -n $1 ]] && [[ -n $2 ]]; then
    pushd  $GOPATH/src/github.com/gophercloud/gophercloud
    go test -v -tags "fixtures acceptance" -run "$1" github.com/gophercloud/gophercloud/acceptance/openstack/$2 | tee ~/gophercloud.log

Then run either groups or individual tests by doing:

$ gophercloudtest TestFlavorsList compute/v2
$ gophercloudtest TestFlavors compute/v2
$ gophercloudtest Test compute/v2

4. Notes

Compute Tests

  • In order to run the TestBootFromVolumeMultiEphemeral test, a flavor with ephemeral disk space must be used.
  • The TestDefSecRules tests require a compatible network driver and admin privileges.