client

package module

v0.0.0-...-05e3ba4 Latest Latest Go to latest Published: Apr 4, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	// contains filtered or unexported fields
}

Client represents a single CAVES client instance.

func NewClient(opts NewClientOptions) (*Client, error)

NewClient instantiates a new CAVES instance and returns an interface to control it.

func (c *Client) AddBucketCluster(clusterID string, name, typ string, replicas uint) error

AddBucketCluster adds a bucket to a specific cluster

func (c *Client) CreateCluster(clusterID string) (*CreateClusterResult, error)

CreateCluster instantiates a new CAVES test cluster.

func (c *Client) EndTest(runID string) error

EndTest stops a running CAVES test suite test.

func (c *Client) EndTesting(runID string) (interface{}, error)

EndTesting stops an already running CAVES test suite.

func (c *Client) Shutdown() error

Shutdown will shutdown the CAVES client.

func (c *Client) StartTest(runID, testName string) (*TestStartedSpec, error)

StartTest begins a specific test within a CAVES test suite.

func (c *Client) StartTesting(runID string, clientName string) (string, error)

StartTesting begins a test suite run within CAVES.

func (c *Client) TimeTravelCluster(clusterID string, duration time.Duration) error

TimeTravelCluster allows a specific cluster to be time-travelled.

func (c *Client) TimeTravelRun(runID string, duration time.Duration) error

TimeTravelRun allows a specific run to be time-travelled.

type CreateClusterResult struct {
	ConnStr         string
	ManagementAddrs []string
}

type NewClientOptions struct {
	Path          string
	Version       string
	CavesAddr     string
	ReportingAddr string
	Quiet         bool
}

NewClientOptions provides options for the NewClient method.

type TestStartedSpec struct {
	ConnStr        string
	BucketName     string
	ScopeName      string
	CollectionName string
}

TestStartedSpec provides information about a specific started test.