tunnel

Documentation

Index

• func ValidateTunnel(service Service, name string, owner string, filter Filter, dryRun bool) error
• type Filter
• type Service

Functions

func ValidateTunnel

func ValidateTunnel(service Service, name string, owner string, filter Filter, dryRun bool) error

Types

type Filter

type Filter string

Filter filters tunnels by type when fetching a user's tunnels.

const (
	// NoneFilter is a noop and does no filtering.
	NoneFilter Filter = ""
	// V2AlphaFilter filters down to only tunnels with vm-version: v2alpha when requesting a user's tunnels.
	// NOTE: We use this filter when checking tunnel readiness for api tests. The response when
	// requesting a user's tunnel does not include vm-version metadata so we need to use the
	// filter to ensure the correct type of tunnel has been started for an api test.
	V2AlphaFilter Filter = "v2alpha"
)

type Service

type Service interface {
	IsTunnelRunning(ctx context.Context, id, parent string, filter Filter, wait time.Duration) error
}

Service represents an interface for interacting with Sauce Connect tunnels.