client

Documentation

Index

• type Client
  • func NewClient(opts NewClientOptions) (*Client, error)
  • func (c *Client) AddBucketCluster(clusterID string, name, typ string, replicas uint) error
  • func (c *Client) CreateCluster(clusterID string) (*CreateClusterResult, error)
  • func (c *Client) EndTest(runID string) error
  • func (c *Client) EndTesting(runID string) (interface{}, error)
  • func (c *Client) Shutdown() error
  • func (c *Client) StartTest(runID, testName string) (*TestStartedSpec, error)
  • func (c *Client) StartTesting(runID string, clientName string) (string, error)
  • func (c *Client) TimeTravelCluster(clusterID string, duration time.Duration) error
  • func (c *Client) TimeTravelRun(runID string, duration time.Duration) error
• type CreateClusterResult
• type NewClientOptions
• type TestStartedSpec

Types

type Client

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

Client represents a single CAVES client instance.

func NewClient

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

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

func (*Client) AddBucketCluster

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

AddBucketCluster adds a bucket to a specific cluster

func (*Client) CreateCluster

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

CreateCluster instantiates a new CAVES test cluster.

func (*Client) EndTest

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

EndTest stops a running CAVES test suite test.

func (*Client) EndTesting

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

EndTesting stops an already running CAVES test suite.

func (*Client) Shutdown

func (c *Client) Shutdown() error

Shutdown will shutdown the CAVES client.

func (*Client) StartTest

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

StartTest begins a specific test within a CAVES test suite.

func (*Client) StartTesting

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

StartTesting begins a test suite run within CAVES.

func (*Client) TimeTravelCluster

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

TimeTravelCluster allows a specific cluster to be time-travelled.

func (*Client) TimeTravelRun

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

TimeTravelRun allows a specific run to be time-travelled.

type CreateClusterResult

type CreateClusterResult struct {
	ConnStr         string
	ManagementAddrs []string
}

type NewClientOptions

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

NewClientOptions provides options for the NewClient method.

type TestStartedSpec

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

TestStartedSpec provides information about a specific started test.