coreutils

package
v2.34.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 21, 2023 License: Apache-2.0 Imports: 25 Imported by: 38

Documentation

Index

Constants

View Source 
const (

	// General core constants
	OnErrorPanic OnError = "panic"

	// Common
	TokenRefreshDisabled        = 0
	TokenRefreshDefaultInterval = 60

	// Home Dir
	JfrogBackupDirName                  = "backup"
	JfrogCertsDirName                   = "certs"
	JfrogConfigFile                     = "jfrog-cli.conf"
	JfrogDependenciesDirName            = "dependencies"
	JfrogLocksDirName                   = "locks"
	JfrogLogsDirName                    = "logs"
	JfrogPluginsDirName                 = "plugins"
	JfrogPluginsFileName                = "plugins.yml"
	JfrogSecurityConfFile               = "security.yaml"
	JfrogSecurityDirName                = "security"
	JfrogTransferDelaysDirName          = "delays"
	JfrogTransferDirName                = "transfer"
	JfrogTransferErrorsDirName          = "errors"
	JfrogTransferRepoSnapshotFileName   = "repo-snapshot.json"
	JfrogTransferRepoStateFileName      = "repo-state.json"
	JfrogTransferRepositoriesDirName    = "repositories"
	JfrogTransferRetryableErrorsDirName = "retryable"
	JfrogTransferRunStatusFileName      = "run-status.json"
	JfrogTransferSkippedErrorsDirName   = "skipped"
	JfrogTransferSnapshotDirName        = "snapshot"
	JfrogTransferStateFileName          = "state.json"
	PluginsExecDirName                  = "bin"
	PluginsResourcesDirName             = "resources"

	// Env
	ErrorHandling      = "JFROG_CLI_ERROR_HANDLING"
	TempDir            = "JFROG_CLI_TEMP_DIR"
	LogLevel           = "JFROG_CLI_LOG_LEVEL"
	LogTimestamp       = "JFROG_CLI_LOG_TIMESTAMP"
	ReportUsage        = "JFROG_CLI_REPORT_USAGE"
	DependenciesDir    = "JFROG_CLI_DEPENDENCIES_DIR"
	TransitiveDownload = "JFROG_CLI_TRANSITIVE_DOWNLOAD_EXPERIMENTAL"
	FailNoOp           = "JFROG_CLI_FAIL_NO_OP"
	CI                 = "CI"
	ServerID           = "JFROG_CLI_SERVER_ID"
)
View Source 
const (
	GettingStartedGuideUrl = "https://github.com/jfrog/jfrog-cli/blob/v2/guides/getting-started-with-jfrog-using-the-cli.md"
	JFrogComUrl            = "https://jfrog.com/"
	JFrogHelpUrl           = JFrogComUrl + "help/r/"
)
View Source 
const (
	// ReleasesRemoteEnv should be used for downloading the extractor jars through an Artifactory remote
	// repository, instead of downloading directly from releases.jfrog.io. The remote repository should be
	// configured to proxy releases.jfrog.io.
	// This env var should store a server ID and a remote repository in form of '<ServerID>/<RemoteRepo>'
	ReleasesRemoteEnv = "JFROG_CLI_RELEASES_REPO"
	// ExtractorsRemoteEnv is deprecated, it is replaced with ReleasesRemoteEnv.
	// Its functionality was similar to ReleasesRemoteEnv, but it proxies releases.jfrog.io/artifactory/oss-release-local instead.
	ExtractorsRemoteEnv = "JFROG_CLI_EXTRACTORS_REMOTE"
)
View Source 
const Pypi = "pypi"

Variables

View Source 
var (
	HomeDir       = "JFROG_CLI_HOME_DIR"
	BuildName     = "JFROG_CLI_BUILD_NAME"
	BuildNumber   = "JFROG_CLI_BUILD_NUMBER"
	Project       = "JFROG_CLI_BUILD_PROJECT"
	EncryptionKey = "JFROG_CLI_ENCRYPTION_KEY"
)

Although these vars are constant, they are defined inside a vars section and not a constants section because the tests modify these values.

View Source 
var DefaultMaxColWidth = 25

Controls the max col width when printing to a non-terminal. See the PrintTable description for more info.

View Source 
var ExitCodeError = ExitCode{1}
View Source 
var ExitCodeFailNoOp = ExitCode{2}
View Source 
var ExitCodeNoError = ExitCode{0}
View Source 
var ExitCodeVulnerableBuild = ExitCode{3}

Functions

func AskYesNo 

func AskYesNo(promptPrefix string, defaultValue bool) bool

Ask a yes or no question, with a default answer.

func ChmodPluginsDirectoryContent added in v2.13.0 

func ChmodPluginsDirectoryContent() error

func ConvertExitCodeError added in v2.1.0 

func ConvertExitCodeError(err error) error

When running a command in an external process, if the command fails to run or doesn't complete successfully ExitError is returned. We would like to return a regular error instead of ExitError, because some frameworks (such as codegangsta used by JFrog CLI) automatically exit when this error is returned.

func CreateDirInJfrogHome 

func CreateDirInJfrogHome(dirName string) (string, error)

func DetectTechnologies added in v2.7.0 

func DetectTechnologies(path string, isCiSetup, recursive bool) (map[Technology]bool, error)

DetectTechnologies tries to detect all technologies types according to the files in the given path. 'isCiSetup' will limit the search of possible techs to Maven, Gradle, and npm. 'recursive' will determine if the search will be limited to files in the root path or not.

func DetectedTechnologiesToSlice added in v2.12.0 

func DetectedTechnologiesToSlice(detected map[Technology]bool) []string

DetectedTechnologiesToSlice returns a string slice that includes all the names of the detected technologies.

func DetectedTechnologiesToString added in v2.10.0 

func DetectedTechnologiesToString(detected map[Technology]bool) string

DetectTechnologiesToString returns a string that includes all the names of the detected technologies separated by a comma.

func ExitOnErr 

func ExitOnErr(err error)

func ExtractDetailedSummaryFromArgs 

func ExtractDetailedSummaryFromArgs(args []string) (cleanArgs []string, detailedSummary bool, err error)

func ExtractFailFromArgs added in v2.10.0 

func ExtractFailFromArgs(args []string) (cleanArgs []string, fail bool, err error)

Used by docker

func ExtractInsecureTlsFromArgs 

func ExtractInsecureTlsFromArgs(args []string) (cleanArgs []string, insecureTls bool, err error)

func ExtractLicensesFromArgs added in v2.10.0 

func ExtractLicensesFromArgs(args []string) (cleanArgs []string, licenses bool, err error)

Used by docker scan (Xray)

func ExtractRepoPathFromArgs added in v2.10.0 

func ExtractRepoPathFromArgs(args []string) (cleanArgs []string, repoPath string, err error)

Used by docker scan (Xray)

func ExtractServerIdFromCommand added in v2.10.0 

func ExtractServerIdFromCommand(args []string) (cleanArgs []string, serverId string, err error)

func ExtractSkipLoginFromArgs added in v2.10.0 

func ExtractSkipLoginFromArgs(args []string) (cleanArgs []string, skipLogin bool, err error)

Used by docker

func ExtractThreadsFromArgs added in v2.10.0 

func ExtractThreadsFromArgs(args []string, defaultValue int) (cleanArgs []string, threads int, err error)

func ExtractWatchesFromArgs added in v2.10.0 

func ExtractWatchesFromArgs(args []string) (cleanArgs []string, watches string, err error)

Used by docker scan (Xray)

func ExtractXrayOutputFormatFromArgs added in v2.4.1 

func ExtractXrayOutputFormatFromArgs(args []string) (cleanArgs []string, format string, err error)

func ExtractXrayScanFromArgs 

func ExtractXrayScanFromArgs(args []string) (cleanArgs []string, xrayScan bool, err error)

func FindBooleanFlag 

func FindBooleanFlag(flagName string, args []string) (flagIndex int, flagValue bool, err error)

Boolean flag can be provided in one of the following forms: 1. --flag=value, where value can be true/false 2. --flag, here the value is true Return values: flagIndex - index of flagName in args. flagValue - value of flagName. err - error if flag exists, but we failed to extract its value. If flag does not exist flagIndex = -1 with false value and nil error.

func FindFlag 

func FindFlag(flagName string, args []string) (flagIndex, flagValueIndex int, flagValue string, err error)

Find value of required CLI flag in Command. If flag does not exist, the returned index is -1 and nil is returned as the error. Return values: err - error if flag exists but failed to extract its value. flagIndex - index of flagName in Command. flagValueIndex - index in Command in which the value of the flag exists. flagValue - value of flagName.

func FindFlagFirstMatch 

func FindFlagFirstMatch(flags, args []string) (flagIndex, flagValueIndex int, flagValue string, err error)

Find the first match of the provided flags in args. Return same values as FindFlag.

func GetCliConfigVersion added in v2.13.0 

func GetCliConfigVersion() int

GetCliConfigVersion returns the latest version of the config.yml file on the file system at '.jfrog'.

func GetCliExecutableName added in v2.5.0 

func GetCliExecutableName() string

func GetCliPersistentTempDirPath 

func GetCliPersistentTempDirPath() string

Return the path of CLI temp dir. This path should be persistent, meaning - should not be cleared at the end of a CLI run.

func GetCliUserAgent 

func GetCliUserAgent() string

func GetCliUserAgentName 

func GetCliUserAgentName() string

func GetCliUserAgentVersion 

func GetCliUserAgentVersion() string

func GetClientAgentName 

func GetClientAgentName() string

func GetClientAgentVersion 

func GetClientAgentVersion() string

func GetJfrogBackupDir 

func GetJfrogBackupDir() (string, error)

func GetJfrogCertsDir 

func GetJfrogCertsDir() (string, error)

func GetJfrogConfigLockDir added in v2.2.0 

func GetJfrogConfigLockDir() (string, error)

func GetJfrogHomeDir 

func GetJfrogHomeDir() (string, error)

func GetJfrogLocksDir added in v2.2.0 

func GetJfrogLocksDir() (string, error)

func GetJfrogPluginsDir 

func GetJfrogPluginsDir() (string, error)

func GetJfrogPluginsLockDir added in v2.13.0 

func GetJfrogPluginsLockDir() (string, error)

func GetJfrogPluginsResourcesDir added in v2.13.0 

func GetJfrogPluginsResourcesDir(pluginsName string) (string, error)

func GetJfrogSecurityConfFilePath 

func GetJfrogSecurityConfFilePath() (string, error)

func GetJfrogSecurityDir 

func GetJfrogSecurityDir() (string, error)

func GetJfrogTransferDir added in v2.17.0 

func GetJfrogTransferDir() (string, error)

func GetJfrogTransferLockDir added in v2.23.0 

func GetJfrogTransferLockDir() (string, error)

func GetJfrogTransferRepositoriesDir added in v2.25.0 

func GetJfrogTransferRepositoriesDir() (string, error)

func GetJfrogTransferRunStatusFilePath added in v2.23.0 

func GetJfrogTransferRunStatusFilePath() (string, error)

func GetPluginsConfigVersion added in v2.13.0 

func GetPluginsConfigVersion() int

GetPluginsConfigVersion returns the latest plugins layout version on the file system (at '.jfrog/plugins').

func GetPluginsDirContent added in v2.13.0 

func GetPluginsDirContent() ([]os.DirEntry, error)

func GetServerIdAndRepo added in v2.32.0 

func GetServerIdAndRepo(remoteEnv string) (serverID string, repoName string, err error)

func GetWorkingDirectory 

func GetWorkingDirectory() (string, error)

func IsAnyEmpty 

func IsAnyEmpty(strings ...string) bool

func IsLinux 

func IsLinux() bool

func IsWindows 

func IsWindows() bool

func ListToText added in v2.11.3 

func ListToText(list []string) string

Turn a list of strings into a sentence. For example, turn ["one", "two", "three"] into "one, two and three". For a single element: "one".

func PanicOnError 

func PanicOnError(err error) error

func PrepareTable added in v2.11.3 

func PrepareTable(rows interface{}, emptyTableMessage string, printExtended bool) (table.Writer, error)

Creates table following the logic described in PrintTable. Returns: Table Writer (table.Writer) - Can be used to adjust style, output mirror, render type, etc. Error if occurred.

func PrintBold added in v2.7.2 

func PrintBold(str string) string

Print the test to the console with bold style.

func PrintBoldTitle added in v2.28.0 

func PrintBoldTitle(str string) string

Print the test to the console with bold style.

func PrintComment added in v2.7.2 

func PrintComment(str string) string

Print the test to the console in gray color. 

func PrintLink(str string) string

Print the test to the console in cyan color.

func PrintMessage added in v2.1.0 

func PrintMessage(message string)

PrintMessage prints message in a frame (which is actually a table with a single table). For example: ┌─────────────────────────────────────────┐ │ An example of a message in a nice frame │ └─────────────────────────────────────────┘

func PrintTable added in v2.1.0 

func PrintTable(rows interface{}, title string, emptyTableMessage string, printExtended bool) (err error)

PrintTable prints a slice of rows in a table. The parameter rows MUST be a slice, otherwise the method panics. How to use this method (with an example): The fields of the struct must have one of the tags: 'col-name' or 'embed-table' in order to be printed. Fields without any of these tags will be skipped. The tag 'col-name' can be set on string fields only. The column name is the 'col-name' tag value. On terminal, the maximum column width is calculated (terminal width equally divided between columns), while on non-terminal the value of the DefaultMaxColWidth variable is used. If the cell content exceeds the defined max column width, the content will be broken into two (or more) lines. In case the struct you want to print contains a field that is a slice of other structs, you can print it in the table too with the 'embed-table' tag which can be set on slices of structs only. Fields with the 'extended' tag will be printed iff the 'printExtended' bool input is true.

Example: These are the structs Customer and Product: 

type Customer struct {
    name     string    `col-name:"Name"`
    age      string    `col-name:"Age"`
    products []Product `embed-table:"true"`
}

type Product struct {
    title string `col-name:"Product Title"`
    CatNumber string `col-name:"Product\nCatalog #"`
    Color string `col-name:"Color" extended:"true"`
}

We'll use it, and run these commands (var DefaultMaxColWidth = 25): 

customersSlice := []Customer{
    {name: "Gai", age: "350", products: []Product{{title: "SpiderFrog Shirt - Medium", CatNumber: "123456", Color: "Green"}, {title: "Floral Bottle", CatNumber: "147585", Color: "Blue"}}},
    {name: "Noah", age: "21", products: []Product{{title: "Pouch", CatNumber: "456789", Color: "Red"}, {title: "Ching Ching", CatNumber: "963852", Color: "Gold"}}},
}

err := coreutils.PrintTable(customersSlice, "Customers", "No customers were found", false)

That's the table printed:

Customers ┌──────┬─────┬─────────────────────────┬───────────┐ │ NAME │ AGE │ PRODUCT TITLE │ PRODUCT │ │ │ │ │ CATALOG # │ ├──────┼─────┼─────────────────────────┼───────────┤ │ Gai │ 350 │ SpiderFrog Shirt - Medi │ 123456 │ │ │ │ um │ │ │ │ │ Floral Bottle │ 147585 │ ├──────┼─────┼─────────────────────────┼───────────┤ │ Noah │ 21 │ Pouch │ 456789 │ │ │ │ Ching Ching │ 963852 │ └──────┴─────┴─────────────────────────┴───────────┘

If printExtended=true:

err := coreutils.PrintTable(customersSlice, "Customers", "No customers were found", true)

Customers ┌──────┬─────┬─────────────────────────┬───────────┬───────────┐ │ NAME │ AGE │ PRODUCT TITLE │ PRODUCT │ Color │ │ │ │ │ CATALOG # │ │ ├──────┼─────┼─────────────────────────┼───────────┼───────────┤ │ Gai │ 350 │ SpiderFrog Shirt - Medi │ 123456 │ Green │ │ │ │ um │ │ │ │ │ │ Floral Bottle │ 147585 │ Blue │ ├──────┼─────┼─────────────────────────┼───────────┼───────────┤ │ Noah │ 21 │ Pouch │ 456789 │ Red │ │ │ │ Ching Ching │ 963852 │ Gold │ └──────┴─────┴─────────────────────────┴───────────┴───────────┘

If customersSlice was empty, emptyTableMessage would have been printed instead:

Customers ┌─────────────────────────┐ │ No customers were found │ └─────────────────────────┘

func PrintTitle added in v2.7.2 

func PrintTitle(str string) string

Print the test to the console in green color.

func RemoveAllWhiteSpaces added in v2.11.3 

func RemoveAllWhiteSpaces(input string) string

func RemoveEmojisIfNonSupportedTerminal added in v2.20.0 

func RemoveEmojisIfNonSupportedTerminal(msg string) string

Remove emojis from non-supported terminals

func RemoveFlagFromCommand 

func RemoveFlagFromCommand(args *[]string, flagIndex, flagValueIndex int)

Removes the provided flag and value from the command arguments

func ReplaceVars 

func ReplaceVars(content []byte, specVars map[string]string) []byte

func SetCliExecutableName added in v2.5.0 

func SetCliExecutableName(executableName string)

func SetCliUserAgentName 

func SetCliUserAgentName(cliUserAgentNameToSet string)

func SetCliUserAgentVersion 

func SetCliUserAgentVersion(versionToSet string)

func SetClientAgentName 

func SetClientAgentName(clientAgentToSet string)

func SetClientAgentVersion 

func SetClientAgentVersion(versionToSet string)

func SetIfEmpty 

func SetIfEmpty(str *string, defaultStr string) bool

func SpecVarsStringToMap 

func SpecVarsStringToMap(rawVars string) map[string]string

func SumTrueValues 

func SumTrueValues(boolArr []bool) int

func ValidateMinimumVersion added in v2.27.0 

func ValidateMinimumVersion(product MinVersionProduct, currentVersion, minimumVersion string) error

Types

type CliError 

type CliError struct {
	ExitCode
	ErrorMsg string
}

func (CliError) Error 

func (err CliError) Error() string

type Credentials 

type Credentials interface {
	SetUser(string)
	SetPassword(string)
	GetUser() string
	GetPassword() string
}

type ExitCode 

type ExitCode struct {
	Code int
}

Exit codes:

func GetExitCode 

func GetExitCode(err error, success, failed int, failNoOp bool) ExitCode

type GeneralExecCmd 

type GeneralExecCmd struct {
	ExecPath string
	Command  []string
}

Command used to execute general commands.

func (*GeneralExecCmd) GetCmd 

func (pluginCmd *GeneralExecCmd) GetCmd() *exec.Cmd

func (*GeneralExecCmd) GetEnv 

func (pluginCmd *GeneralExecCmd) GetEnv() map[string]string

func (*GeneralExecCmd) GetErrWriter 

func (pluginCmd *GeneralExecCmd) GetErrWriter() io.WriteCloser

func (*GeneralExecCmd) GetStdWriter 

func (pluginCmd *GeneralExecCmd) GetStdWriter() io.WriteCloser

type MinVersionProduct added in v2.27.0 

type MinVersionProduct string
const (
	Artifactory  MinVersionProduct = "JFrog Artifactory"
	Xray         MinVersionProduct = "JFrog Xray"
	DataTransfer MinVersionProduct = "Data Transfer"
	DockerApi    MinVersionProduct = "Docker API"
	Projects     MinVersionProduct = "JFrog Projects"
)

type OnError 

type OnError string

Error modes (how should the application behave when the CheckError function is invoked):

type TechData added in v2.9.0 

type TechData struct {
	// contains filtered or unexported fields
}

type Technology added in v2.7.0 

type Technology string
const (
	Maven  Technology = "maven"
	Gradle Technology = "gradle"
	Npm    Technology = "npm"
	Yarn   Technology = "yarn"
	Go     Technology = "go"
	Pip    Technology = "pip"
	Pipenv Technology = "pipenv"
	Poetry Technology = "poetry"
	Nuget  Technology = "nuget"
	Dotnet Technology = "dotnet"
	Docker Technology = "docker"
)

func GetAllTechnologiesList added in v2.18.7 

func GetAllTechnologiesList() (technologies []Technology)

func ToTechnologies added in v2.12.0 

func ToTechnologies(args []string) (technologies []Technology)

func (Technology) GetExecCommandName added in v2.20.7 

func (tech Technology) GetExecCommandName() string

func (Technology) GetPackageDescriptor added in v2.20.7 

func (tech Technology) GetPackageDescriptor() string

func (Technology) GetPackageInstallOperator added in v2.29.8 

func (tech Technology) GetPackageInstallOperator() string

func (Technology) GetPackageOperator added in v2.29.8 

func (tech Technology) GetPackageOperator() string

func (Technology) GetPackageType added in v2.20.7 

func (tech Technology) GetPackageType() string

func (Technology) IsCiSetup added in v2.20.7 

func (tech Technology) IsCiSetup() bool

func (Technology) ToFormal added in v2.20.7 

func (tech Technology) ToFormal() string

func (Technology) ToString added in v2.20.7 

func (tech Technology) ToString() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.