client

Documentation

Overview

Package client implements a client for a build service

Index

• Variables
• func NewBuildServiceClient(config BuildServiceClientConfig) (k6build.BuildService, error)
• type BuildClient
  • func (r *BuildClient) Build(ctx context.Context, platform string, k6Constrains string, ...) (k6build.Artifact, error)
• type BuildServiceClientConfig

Variables

var (
	ErrBuildFailed   = errors.New("build failed")   //nolint:revive
	ErrRequestFailed = errors.New("request failed") //nolint:revive
)

Functions

func NewBuildServiceClient

func NewBuildServiceClient(config BuildServiceClientConfig) (k6build.BuildService, error)

NewBuildServiceClient returns a new client for a remote build service

Types

type BuildClient

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

BuildClient defines a client of a build service

func (*BuildClient) Build

func (r *BuildClient) Build(
	ctx context.Context,
	platform string,
	k6Constrains string,
	deps []k6build.Dependency,
) (k6build.Artifact, error)

Build request building an artidact to a build service

type BuildServiceClientConfig

type BuildServiceClientConfig struct {
	// URL to build service
	URL string
	// Authorization credentials passed in the Authorization: <type> <credentials> header
	// See AuthorizationType
	Authorization string
	// AuthorizationType type of credentials in the Authorization: <type> <credentials> header
	// For example, "Bearer", "Token", "Basic". Defaults to "Bearer"
	AuthorizationType string
	// Headers custom request headers
	Headers map[string]string
}

BuildServiceClientConfig defines the configuration for accessing a remote build service