testcomposer

Documentation

Index

• Variables
• type Client
  • func (c *Client) Frameworks(ctx context.Context) ([]framework.Framework, error)
  • func (c *Client) GetSlackToken(ctx context.Context) (string, error)
  • func (c *Client) Search(ctx context.Context, opts framework.SearchOptions) (framework.Metadata, error)
  • func (c *Client) StartJob(ctx context.Context, opts job.StartOptions) (jobID string, isRDC bool, err error)
  • func (c *Client) UploadAsset(jobID string, realDevice bool, fileName string, contentType string, ...) error
  • func (c *Client) Versions(ctx context.Context, frameworkName string) ([]framework.Metadata, error)
• type FrameworkResponse
• type Job
• type TokenResponse

Variables

var (
	// ErrServerError is returned when the server was not able to correctly handle our request (status code >= 500).
	ErrServerError = errors.New(msg.InternalServerError)
	// ErrJobNotFound is returned when the requested job was not found.
	ErrJobNotFound = errors.New(msg.JobNotFound)
)

Types

type Client

type Client struct {
	HTTPClient  *http.Client
	URL         string // e.g.) https://api.<region>.saucelabs.net
	Credentials credentials.Credentials
}

Client service

func (*Client) Frameworks

func (c *Client) Frameworks(ctx context.Context) ([]framework.Framework, error)

Frameworks returns the list of available frameworks.

func (*Client) GetSlackToken

func (c *Client) GetSlackToken(ctx context.Context) (string, error)

GetSlackToken gets slack token.

func (*Client) Search

func (c *Client) Search(ctx context.Context, opts framework.SearchOptions) (framework.Metadata, error)

Search returns metadata for the given search options opts.

func (*Client) StartJob

func (c *Client) StartJob(ctx context.Context, opts job.StartOptions) (jobID string, isRDC bool, err error)

StartJob creates a new job in Sauce Labs.

func (*Client) UploadAsset

func (c *Client) UploadAsset(jobID string, realDevice bool, fileName string, contentType string, content []byte) error

UploadAsset uploads an asset to the specified jobID.

func (*Client) Versions

func (c *Client) Versions(ctx context.Context, frameworkName string) ([]framework.Metadata, error)

Versions return the list of available versions for a specific framework and region.

type FrameworkResponse

type FrameworkResponse struct {
	Name            string            `json:"name"`
	Version         string            `json:"version"`
	EOLDate         time.Time         `json:"eolDate"`
	RemovalDate     time.Time         `json:"removalDate"`
	Runner          runner            `json:"runner"`
	Platforms       []platform        `json:"platforms"`
	BrowserDefaults map[string]string `json:"browserDefaults"`
}

FrameworkResponse represents the response body for framework information.

type Job

type Job struct {
	ID    string `json:"id"`
	Owner string `json:"owner"`
}

Job represents the sauce labs test job.

type TokenResponse

type TokenResponse struct {
	Token string `json:"token"`
}

TokenResponse represents the response body for slack token.