acceptance/

directory
v0.0.0-...-cd80d89 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2023 License: Apache-2.0

README

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.

Authentication
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
OS_TENANT_ID Your API tenant ID
General
Name Description
OS_REGION_NAME The region you want your resources to reside in
Compute
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
Database
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_NETWORK_ID The network ID to use when creating shared network
OS_SUBNET_ID The subnet ID to use when creating shared network
3. Run the test suite

From the root directory, run:

./script/acceptancetest

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
    popd
fi
}

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.

Directories

Path Synopsis
Package clients contains functions for creating OpenStack service clients for use in acceptance tests.
Package clients contains functions for creating OpenStack service clients for use in acceptance tests.
Package openstack contains common functions that can be used across all OpenStack components for acceptance testing.
Package openstack contains common functions that can be used across all OpenStack components for acceptance testing.
blockstorage/extensions
Package extensions contains common functions for creating block storage resources that are extensions of the block storage API.
Package extensions contains common functions for creating block storage resources that are extensions of the block storage API.
blockstorage/noauth
Package noauth contains common functions for creating block storage based resources for use in acceptance tests.
Package noauth contains common functions for creating block storage based resources for use in acceptance tests.
blockstorage/v1
Package v1 contains common functions for creating block storage based resources for use in acceptance tests.
Package v1 contains common functions for creating block storage based resources for use in acceptance tests.
blockstorage/v2
Package v2 contains common functions for creating block storage based resources for use in acceptance tests.
Package v2 contains common functions for creating block storage based resources for use in acceptance tests.
blockstorage/v3
Package v3 contains common functions for creating block storage based resources for use in acceptance tests.
Package v3 contains common functions for creating block storage based resources for use in acceptance tests.
clustering/v1
Package v1 package contains acceptance tests for the Openstack Clustering V1 service.
Package v1 package contains acceptance tests for the Openstack Clustering V1 service.
compute/v2
Package v2 contains common functions for creating compute-based resources for use in acceptance tests.
Package v2 contains common functions for creating compute-based resources for use in acceptance tests.
db/v1
Package v2 contains common functions for creating db resources for use in acceptance tests.
Package v2 contains common functions for creating db resources for use in acceptance tests.
identity/v2
Package v2 contains common functions for creating identity-based resources for use in acceptance tests.
Package v2 contains common functions for creating identity-based resources for use in acceptance tests.
imageservice/v2
Package v2 contains common functions for creating imageservice resources for use in acceptance tests.
Package v2 contains common functions for creating imageservice resources for use in acceptance tests.
networking/v2/extensions/agents
agents acceptance tests
agents acceptance tests
placement/v1
Package placement contains acceptance tests for the Openstack Placement service.
Package placement contains acceptance tests for the Openstack Placement service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL