util

Documentation

Index

• Constants
• Variables
• func ApplyPorcelainLogLevel(cmd *cobra.Command, _ []string)
• func CheckVersion(cmd *cobra.Command, args []string) error
• func DownloadResultsHandler(ctx context.Context, cmd *cobra.Command, jobID string, ...) error
• func EnsureValidVersion(ctx context.Context, clientVersion, serverVersion *models.BuildVersionInfo) error
• func ExecuteJob(ctx context.Context, j *model.Job, runtimeSettings *cliflags.RunTimeSettings) (*model.Job, error)
• func FakeFatalErrorHandler(cmd *cobra.Command, msg error, code int)
• func GetAPIClient(ctx context.Context) *client.APIClient
• func GetAPIClientV2(ctx context.Context) *clientv2.Client
• func GetCleanupManager(ctx context.Context) *system.CleanupManager
• func GetDefaultJobFolder(jobID string) string
• func Logs(cmd *cobra.Command, jobID string, follow, history bool) error
• func ReadFromStdinIfAvailable(cmd *cobra.Command) ([]byte, error)
• type Msg

Constants

const AutoDownloadFolderPerm = 0755

Variables

var Fatal = fatalError

var LoggingMode = logger.LogModeDefault

var ShutdownSignals = []os.Signal{
	os.Interrupt,
	syscall.SIGTERM,
}

var SystemManagerKey = contextKey{/* contains filtered or unexported fields */}

Functions

func ApplyPorcelainLogLevel

func ApplyPorcelainLogLevel(cmd *cobra.Command, _ []string)

ApplyPorcelainLogLevel sets the log level of loggers running on user-facing "porcelain" commands to be zerolog.FatalLevel to reduce noise shown to users.

func CheckVersion

func CheckVersion(cmd *cobra.Command, args []string) error

func DownloadResultsHandler

func DownloadResultsHandler(
	ctx context.Context,
	cmd *cobra.Command,
	jobID string,
	downloadSettings *cliflags.DownloaderSettings,
) error

func EnsureValidVersion

func EnsureValidVersion(ctx context.Context, clientVersion, serverVersion *models.BuildVersionInfo) error

func ExecuteJob

func ExecuteJob(ctx context.Context,
	j *model.Job,
	runtimeSettings *cliflags.RunTimeSettings,
) (*model.Job, error)

func FakeFatalErrorHandler

func FakeFatalErrorHandler(cmd *cobra.Command, msg error, code int)

FakeFatalErrorHandler captures the error for testing, responsibility of the test to handle the exit (if any) NOTE: If your test is not idempotent, you can cause side effects (the underlying function will continue to run) Returned as text JSON to wherever RootCmd is printing.

func GetAPIClient

func GetAPIClient(ctx context.Context) *client.APIClient

func GetAPIClientV2

func GetAPIClientV2(ctx context.Context) *clientv2.Client

func GetCleanupManager

func GetCleanupManager(ctx context.Context) *system.CleanupManager

func GetDefaultJobFolder

func GetDefaultJobFolder(jobID string) string

func Logs

func Logs(cmd *cobra.Command, jobID string, follow, history bool) error

func ReadFromStdinIfAvailable

func ReadFromStdinIfAvailable(cmd *cobra.Command) ([]byte, error)

Types

type Msg

type Msg struct {
	Tag          uint8
	Data         string
	ErrorMessage string
}