middleware

Documentation

Index

• Constants
• Variables
• func AddMWToCmds(cmds []cli.Command, mw cli.BeforeFunc) []cli.Command
• func WithBeforeFns(fns ...cli.BeforeFunc) cli.BeforeFunc
• func WrongHostErrString(commandHost, actualHost string) string

Constants

const (
	OSSBuildHeader   = "OSS"
	CloudBuildHeader = "Cloud"
)

Variables

var CloudOnly cli.BeforeFunc = func(ctx *cli.Context) error {
	icontext.SetCloudOnly(ctx)
	return nil
}

var HandleExit cli.ExitErrHandlerFunc = func(ctx *cli.Context, err error) {
	if err == nil {
		return
	}

	var header string
	var genericErr api.GenericOpenAPIError
	if errors.As(err, &genericErr) {
		header = genericErr.BuildHeader()
	}

	// Replace the error message with the relevant information if a platform-specific command was used on the wrong host.
	// Otherwise, pass the error message along as-is to the CLI exit handler.
	var setErr bool
	if header == OSSBuildHeader {
		if icontext.GetCloudOnly(ctx) {
			err = cli.NewExitError(WrongHostErrString(CloudBuildHeader, OSSBuildHeader), 1)
			setErr = true
		}
	} else if header == CloudBuildHeader {
		if icontext.GetOssOnly(ctx) {
			err = cli.NewExitError(WrongHostErrString(OSSBuildHeader, CloudBuildHeader), 1)
			setErr = true
		}
	}
	if !setErr {
		err = cli.NewExitError(fmt.Sprintf("Error: %v", err.Error()), 1)
	}

	cli.HandleExitCoder(err)
}

var NoArgs cli.BeforeFunc = func(ctx *cli.Context) error {

	if ctx.NArg() > 0 && ctx.App.Command(ctx.Args()[0]) == nil {
		cmdName := ctx.Command.Name
		if cmdName == "" && ctx.App.Name != "" {
			cmdName = ctx.App.Name
		}

		return fmt.Errorf("unknown command %q for %q", ctx.Args()[0], cmdName)
	}
	return nil
}

var OSSOnly cli.BeforeFunc = func(ctx *cli.Context) error {
	icontext.SetOssOnly(ctx)
	return nil
}

Functions

func AddMWToCmds

func AddMWToCmds(cmds []cli.Command, mw cli.BeforeFunc) []cli.Command

AddMWToCmds is used to append a middleware to a list of existing commands.

func WithBeforeFns

func WithBeforeFns(fns ...cli.BeforeFunc) cli.BeforeFunc

WithBeforeFns returns a cli.BeforeFunc that calls each of the provided functions in order. NOTE: The first function to return an error will end execution and be returned as the error value of the composed function.

func WrongHostErrString

func WrongHostErrString(commandHost, actualHost string) string