utils

Documentation

Overview

Package utils provides utility functions and helpers for batch-tool.

Index

• Variables
• func BindBoolFlags(cmd *cobra.Command, key, yesName, noName string) error
• func BuildBoolFlags(cmd *cobra.Command, yesName, yesShort, noName, noShort, description string)
• func BuildBoolFlagsDefault(cmd *cobra.Command, yesName, yesShort, noName, noShort string, ...)
• func CheckMutuallyExclusiveFlags(cmd *cobra.Command, flags ...string) error
• func CleanFilter(ctx context.Context, input string) string
• func Cmd(ctx context.Context, repo, command string, arguments ...string) (*exec.Cmd, error)
• func Env(ctx context.Context, repo string) ([]string, error)
• func LookupBranch(ctx context.Context, name string) (string, error)
• func ParseRepo(ctx context.Context, repo string) (host, project, name string)
• func RepoPath(ctx context.Context, repo string) string
• func RepoURL(ctx context.Context, repo string) string
• func ValidateEnumConfig(cmd *cobra.Command, key string, validChoices []string) error
• func ValidateRequiredConfig(ctx context.Context, opts ...string) error

Variables

var (
	// CatalogProjectLookup is a function type for looking up project from catalog
	CatalogProjectLookup = defaultProjectLookup
	// CatalogBranchLookup is a function type for looking up branch from catalog
	CatalogBranchLookup = defaultBranchLookup
)

functions initialized in catalog package to avoid circular import

Functions

func BindBoolFlags

func BindBoolFlags(cmd *cobra.Command, key, yesName, noName string) error

BindBoolFlags binds a pair of mutually exclusive boolean flags to the current viper context.

func BuildBoolFlags

func BuildBoolFlags(cmd *cobra.Command, yesName, yesShort, noName, noShort, description string)

BuildBoolFlags adds a pair of mutually exclusive boolean flags to the given command. The "yes" flag enables the feature (default true), and the "no" flag disables it.

func BuildBoolFlagsDefault

func BuildBoolFlagsDefault(cmd *cobra.Command, yesName, yesShort, noName, noShort string, defaultValue bool, description string)

BuildBoolFlagsDefault adds a pair of mutually exclusive boolean flags to the given command with a specified default value.

func CheckMutuallyExclusiveFlags

func CheckMutuallyExclusiveFlags(cmd *cobra.Command, flags ...string) error

CheckMutuallyExclusiveFlags validates that at most one flag from each set of mutually exclusive flags is set. Each argument is a slice of flag names that are mutually exclusive with each other. Returns an error if more than one flag in any set is explicitly set.

func CleanFilter

func CleanFilter(ctx context.Context, input string) string

CleanFilter standardizes the formatting of an imput argument by removing all configured signal tokens

func Cmd

func Cmd(ctx context.Context, repo, command string, arguments ...string) (*exec.Cmd, error)

Cmd creates an exec.Cmd configured for the given repository context, to facilitate consistent environment and working directory setup.

func Env

func Env(ctx context.Context, repo string) ([]string, error)

Env constructs the environment variables for an Exec call. It processes the CmdEnv config which can contain either: - key=value pairs (used as-is) - file paths to .env files (read and all values added to environment) If a file path is provided but cannot be read, an error is returned.

func LookupBranch

func LookupBranch(ctx context.Context, name string) (string, error)

LookupBranch returns the target branch for the given repository

func ParseRepo

func ParseRepo(ctx context.Context, repo string) (host, project, name string)

ParseRepo splits a repo identifier into its component parts

func RepoPath

func RepoPath(ctx context.Context, repo string) string

RepoPath returns the full repository path for the given name

func RepoURL

func RepoURL(ctx context.Context, repo string) string

RepoURL returns the repository remote url for the given name

func ValidateEnumConfig

func ValidateEnumConfig(cmd *cobra.Command, key string, validChoices []string) error

ValidateEnumConfig validates that a config value is one of the allowed choices.

func ValidateRequiredConfig

func ValidateRequiredConfig(ctx context.Context, opts ...string) error

ValidateRequiredConfig checks viper and returns an error if a key isn't set