clients

Documentation

Overview

Package clients contains functions for creating OpenStack service clients for use in acceptance tests. It also manages the required environment variables to run the tests.

Index

• Variables
• func NewBlockStorageV1Client() (*golangsdk.ServiceClient, error)
• func NewBlockStorageV2Client() (*golangsdk.ServiceClient, error)
• func NewBlockStorageV3Client() (*golangsdk.ServiceClient, error)
• func NewComputeV2Client() (*golangsdk.ServiceClient, error)
• func NewCsbsV1Client() (*golangsdk.ServiceClient, error)
• func NewDNSV2Client() (*golangsdk.ServiceClient, error)
• func NewDdsV3Client() (*golangsdk.ServiceClient, error)
• func NewIdentityV3Client() (*golangsdk.ServiceClient, error)
• func NewIdentityV3UnauthenticatedClient() (*golangsdk.ServiceClient, error)
• func NewImageServiceV2Client() (*golangsdk.ServiceClient, error)
• func NewNetworkV1Client() (*golangsdk.ServiceClient, error)
• func NewNetworkV2Client() (*golangsdk.ServiceClient, error)
• func NewObjectStorageV1Client() (*golangsdk.ServiceClient, error)
• func NewPeerNetworkV1Client() (*golangsdk.ServiceClient, error)
• func NewPeerNetworkV2Client() (*golangsdk.ServiceClient, error)
• func NewRdsV3() (*golangsdk.ServiceClient, error)
• func NewSharedFileSystemV2Client() (*golangsdk.ServiceClient, error)
• func NewWafV1Client() (*golangsdk.ServiceClient, error)
• func UpdatePeerTenantDetails(ao *golangsdk.AuthOptions) error
• type AcceptanceTestChoices
  • func AcceptanceTestChoicesFromEnv() (*AcceptanceTestChoices, error)

Variables

var (
	OS_FLAVOR_ID         = os.Getenv("OS_FLAVOR_ID")
	OS_FLAVOR_NAME       = os.Getenv("OS_FLAVOR_NAME")
	OS_IMAGE_ID          = os.Getenv("OS_IMAGE_ID")
	OS_IMAGE_NAME        = os.Getenv("OS_IMAGE_NAME")
	OS_NETWORK_ID        = os.Getenv("OS_NETWORK_ID")
	OS_POOL_NAME         = os.Getenv("OS_POOL_NAME")
	OS_REGION_NAME       = os.Getenv("OS_REGION_NAME")
	OS_ACCESS_KEY        = os.Getenv("OS_ACCESS_KEY")
	OS_SECRET_KEY        = os.Getenv("OS_SECRET_KEY")
	OS_AVAILABILITY_ZONE = os.Getenv("OS_AVAILABILITY_ZONE")
	OS_VPC_ID            = os.Getenv("OS_VPC_ID")
	OS_SUBNET_ID         = os.Getenv("OS_SUBNET_ID")
	OS_TENANT_ID         = os.Getenv("OS_TENANT_ID")
	OS_KEYPAIR_NAME      = os.Getenv("OS_KEYPAIR_NAME")
	OS_TENANT_NAME       = getTenantName()
	OS_USER_ID           = os.Getenv("OS_USER_ID")
)

Functions

func NewBlockStorageV1Client

func NewBlockStorageV1Client() (*golangsdk.ServiceClient, error)

NewBlockStorageV1Client returns a *ServiceClient for making calls to the OpenStack Block Storage v1 API. An error will be returned if authentication or client creation was not possible.

func NewBlockStorageV2Client

func NewBlockStorageV2Client() (*golangsdk.ServiceClient, error)

NewBlockStorageV2Client returns a *ServiceClient for making calls to the OpenStack Block Storage v2 API. An error will be returned if authentication or client creation was not possible.

func NewBlockStorageV3Client

func NewBlockStorageV3Client() (*golangsdk.ServiceClient, error)

NewBlockStorageV3Client returns a *ServiceClient for making calls to the OpenStack Block Storage v3 API. An error will be returned if authentication or client creation was not possible.

func NewComputeV2Client

func NewComputeV2Client() (*golangsdk.ServiceClient, error)

NewComputeV2Client returns a *ServiceClient for making calls to the OpenStack Compute v2 API. An error will be returned if authentication or client creation was not possible.

func NewCsbsV1Client

func NewCsbsV1Client() (*golangsdk.ServiceClient, error)

NewCsbsV1Client returns authenticated CSBS v1 client

func NewDNSV2Client

func NewDNSV2Client() (*golangsdk.ServiceClient, error)

NewDNSV2Client returns a *ServiceClient for making calls to the OpenStack Compute v2 API. An error will be returned if authentication or client creation was not possible.

func NewDdsV3Client

func NewDdsV3Client() (*golangsdk.ServiceClient, error)

NewDdsV3Client returns authenticated DDS v3 client

func NewIdentityV3Client

func NewIdentityV3Client() (*golangsdk.ServiceClient, error)

NewIdentityV3Client returns a *ServiceClient for making calls to the OpenStack Identity v3 API. An error will be returned if authentication or client creation was not possible.

func NewIdentityV3UnauthenticatedClient

func NewIdentityV3UnauthenticatedClient() (*golangsdk.ServiceClient, error)

NewIdentityV3UnauthenticatedClient returns an unauthenticated *ServiceClient for the OpenStack Identity v3 API. An error will be returned if authentication or client creation was not possible.

func NewImageServiceV2Client

func NewImageServiceV2Client() (*golangsdk.ServiceClient, error)

NewImageServiceV2Client returns a *ServiceClient for making calls to the OpenStack Image v2 API. An error will be returned if authentication or client creation was not possible.

func NewNetworkV1Client

func NewNetworkV1Client() (*golangsdk.ServiceClient, error)

NewNetworkV1Client returns a *ServiceClient for making calls to the OpenStack Networking v1 API. An error will be returned if authentication or client creation was not possible.

func NewNetworkV2Client

func NewNetworkV2Client() (*golangsdk.ServiceClient, error)

NewNetworkV2Client returns a *ServiceClient for making calls to the OpenStack Networking v2 API. An error will be returned if authentication or client creation was not possible.

func NewObjectStorageV1Client

func NewObjectStorageV1Client() (*golangsdk.ServiceClient, error)

NewObjectStorageV1Client returns a *ServiceClient for making calls to the OpenStack Object Storage v1 API. An error will be returned if authentication or client creation was not possible.

func NewPeerNetworkV1Client

func NewPeerNetworkV1Client() (*golangsdk.ServiceClient, error)

NewPeerNetworkV1Client returns a *ServiceClient for making calls to the OpenStack Networking v1 API for VPC peer. An error will be returned if authentication or client creation was not possible.

func NewPeerNetworkV2Client

func NewPeerNetworkV2Client() (*golangsdk.ServiceClient, error)

NewPeerNetworkV2Client returns a *ServiceClient for making calls to the OpenStack Networking v2 API for Peer. An error will be returned if authentication or client creation was not possible.

func NewRdsV3

func NewRdsV3() (*golangsdk.ServiceClient, error)

NewRdsV3 returns authenticated RDS v3 client

func NewSharedFileSystemV2Client

func NewSharedFileSystemV2Client() (*golangsdk.ServiceClient, error)

NewSharedFileSystemV2Client returns a *ServiceClient for making calls to the OpenStack Shared File System v2 API. An error will be returned if authentication or client creation was not possible.

func NewWafV1Client

func NewWafV1Client() (*golangsdk.ServiceClient, error)

NewWafV1Client returns authenticated WAF v1 client

func UpdatePeerTenantDetails

func UpdatePeerTenantDetails(ao *golangsdk.AuthOptions) error

Types

type AcceptanceTestChoices

type AcceptanceTestChoices struct {
	// ImageID contains the ID of a valid image.
	ImageID string

	// FlavorID contains the ID of a valid flavor.
	FlavorID string

	// FlavorIDResize contains the ID of a different flavor available on the same OpenStack installation, that is distinct
	// from FlavorID.
	FlavorIDResize string

	// FloatingIPPool contains the name of the pool from where to obtain floating IPs.
	FloatingIPPoolName string

	// NetworkName is the name of a network to launch the instance on.
	NetworkName string

	// ExternalNetworkID is the network ID of the external network.
	ExternalNetworkID string

	// ShareNetworkID is the Manila Share network ID
	ShareNetworkID string

	// DBDatastoreType is the datastore type for DB tests.
	DBDatastoreType string

	// DBDatastoreTypeID is the datastore type version for DB tests.
	DBDatastoreVersion string
}

AcceptanceTestChoices contains image and flavor selections for use by the acceptance tests.

func AcceptanceTestChoicesFromEnv

func AcceptanceTestChoicesFromEnv() (*AcceptanceTestChoices, error)

AcceptanceTestChoicesFromEnv populates a ComputeChoices struct from environment variables. If any required state is missing, an `error` will be returned that enumerates the missing properties.