workspacebuild

Documentation

Index

• type CleanupRunner
  • func NewCleanupRunner(client *codersdk.Client, workspaceID uuid.UUID) *CleanupRunner
  • func (r *CleanupRunner) Run(ctx context.Context, _ string, logs io.Writer) error
• type Config
  • func (c Config) Validate() error
• type Runner
  • func NewRunner(client *codersdk.Client, cfg Config) *Runner
  • func (r *Runner) Cleanup(ctx context.Context, id string) error
  • func (r *Runner) Run(ctx context.Context, _ string, logs io.Writer) error
  • func (r *Runner) WorkspaceID() (uuid.UUID, error)

Types

type CleanupRunner

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

CleanupRunner is a runner that deletes a workspace in the Run phase.

func NewCleanupRunner

func NewCleanupRunner(client *codersdk.Client, workspaceID uuid.UUID) *CleanupRunner

func (*CleanupRunner) Run

func (r *CleanupRunner) Run(ctx context.Context, _ string, logs io.Writer) error

Run implements Runnable.

type Config

type Config struct {
	// OrganizationID is the ID of the organization to create the workspace in.
	OrganizationID uuid.UUID `json:"organization_id"`
	// UserID is the ID of the user to run the test as.
	UserID string `json:"user_id"`
	// Request is the request to send to the Coder API to create the workspace.
	// request.template_id must be set. A name will be generated if not
	// specified.
	Request codersdk.CreateWorkspaceRequest `json:"request"`
	// NoWaitForAgents determines whether the test should wait for the workspace
	// agents to connect before returning.
	NoWaitForAgents bool `json:"no_wait_for_agents"`
}

func (Config) Validate

func (c Config) Validate() error

type Runner

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

func NewRunner

func NewRunner(client *codersdk.Client, cfg Config) *Runner

func (*Runner) Cleanup

func (r *Runner) Cleanup(ctx context.Context, id string) error

Cleanup implements Cleanable by wrapping CleanupRunner.

func (*Runner) Run

func (r *Runner) Run(ctx context.Context, _ string, logs io.Writer) error

Run implements Runnable.

func (*Runner) WorkspaceID

func (r *Runner) WorkspaceID() (uuid.UUID, error)