util

Documentation

Index

• Constants
• Variables
• func DownloadResultsHandler(ctx context.Context, cmd *cobra.Command, cfg types.BacalhauConfig, ...) error
• func EnsureValidVersion(ctx context.Context, clientVersion, serverVersion *models.BuildVersionInfo) error
• func ExecuteJob(ctx context.Context, j *model.Job, api client.APIClient) (*model.Job, error)
• func FakeFatalErrorHandler(cmd *cobra.Command, msg error, code int)
• func GetAPIClient(cfg types.BacalhauConfig) (*client.APIClient, error)
• func GetAPIClientV2(cmd *cobra.Command, cfg types.BacalhauConfig) (clientv2.API, error)
• func GetCleanupManager(ctx context.Context) *system.CleanupManager
• func GetDefaultJobFolder(jobID string) string
• func Logs(cmd *cobra.Command, api clientv2.API, options LogOptions) error
• func ReadFromFile(path string) ([]byte, error)
• func ReadFromStdinIfAvailable(cmd *cobra.Command) ([]byte, error)
• func ReadJobFromUser(cmd *cobra.Command, args []string) ([]byte, error)
• func ReadToken(path string, apiURL string) (*apimodels.HTTPCredential, error)
• func SetupRepoConfig(cmd *cobra.Command) (types.BacalhauConfig, error)
• func WriteToken(path, apiURL string, cred *apimodels.HTTPCredential) error
• type LogOptions
• type Versions
  • func GetAllVersions(ctx context.Context, cfg types.BacalhauConfig, api *client.APIClient) (Versions, error)

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 */}

var TestError error

Functions

func DownloadResultsHandler

func DownloadResultsHandler(
	ctx context.Context,
	cmd *cobra.Command,
	cfg types.BacalhauConfig,
	apiV2 clientv2.API,
	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, api client.APIClient) (*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(cfg types.BacalhauConfig) (*client.APIClient, error)

func GetAPIClientV2

func GetAPIClientV2(cmd *cobra.Command, cfg types.BacalhauConfig) (clientv2.API, error)

func GetCleanupManager

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

func GetDefaultJobFolder

func GetDefaultJobFolder(jobID string) string

func Logs

func Logs(cmd *cobra.Command, api clientv2.API, options LogOptions) error

func ReadFromFile

func ReadFromFile(path string) ([]byte, error)

func ReadFromStdinIfAvailable

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

func ReadJobFromUser

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

func ReadToken

func ReadToken(path string, apiURL string) (*apimodels.HTTPCredential, error)

Read the authorization crdential associated with the passed API base URL. If there is no credential currently stored, ReadToken will return nil with no error.

func SetupRepoConfig

func SetupRepoConfig(cmd *cobra.Command) (types.BacalhauConfig, error)

func WriteToken

func WriteToken(path, apiURL string, cred *apimodels.HTTPCredential) error

Persistently store the authorization token against the passed API base URL. Callers may pass nil for the credential which will delete any existing stored token.

Types

type LogOptions

type LogOptions struct {
	JobID       string
	ExecutionID string
	Follow      bool
	Tail        bool
}

type Versions

type Versions struct {
	ClientVersion *models.BuildVersionInfo `json:"clientVersion,omitempty"`
	ServerVersion *models.BuildVersionInfo `json:"serverVersion,omitempty"`
	LatestVersion *models.BuildVersionInfo `json:"latestVersion,omitempty"`
	UpdateMessage string                   `json:"updateMessage,omitempty"`
}

func GetAllVersions

func GetAllVersions(ctx context.Context, cfg types.BacalhauConfig, api *client.APIClient) (Versions, error)