msg

Documentation

Index

• Constants
• func EOLNotice(name, version string, removalDate time.Time, availableVersions []string) string
• func Error(msg string)
• func FormatAvailableVersions(name string, versions []string) string
• func IgnoredNpmPackagesMsg(framework string, installedVersion string, ignoredPackages []string) string
• func LogArchivePathLengthWarning(limit int)
• func LogArchiveSizeWarning()
• func LogConsoleOut(name, logs string)
• func LogGlobalTimeoutShutdown()
• func LogRootDirWarning()
• func LogSauceIgnoreNotExist()
• func LogUnsupportedFramework(frameworkName string)
• func LogUnsupportedPlatform(platform string, supported []string)
• func RemovalNotice(name, version string, availableVersions []string) string
• func SuiteSplitNoMatch(suiteName, path string, pattern []string)

Constants

const (
	// InvalidUsername indicates invalid username
	InvalidUsername = "invalid username"
	// EmptyUsername asks user to type a username
	EmptyUsername = "you need to type a username"
	// InvalidAccessKey indicates invalid key
	InvalidAccessKey = "invalid access key"
	// EmptyAccessKey asks user to type an access key
	EmptyAccessKey = "you need to type an access key"
	// EmptyCredentials indicates no credentials
	EmptyCredentials = "no credentials available"
	// InvalidSelectedFramework indicates invalid framework
	InvalidSelectedFramework = "invalid framework selected"
	// InvalidCredentials indicates invalid credentials
	InvalidCredentials = "invalid credentials provided"
	// UnableToCheckCredentials
	UnableToCheckCredentials = "unable to check credentials"
	// MissingFrameworkVersion indicates empty framework version
	MissingFrameworkVersion = "no %s version specified"
	// MissingCypressConfig indicates no cypress config file
	MissingCypressConfig = "no cypress config file specified"
	// MissingPlatformName indicates no platform name
	MissingPlatformName = "no platform name specified"
	// MissingBrowserName indicates no browser name
	MissingBrowserName = "no browser name specified"
	// MissingDockerImage indicates no app
	MissingDockerImage = "no image provided"
	// MissingApp indicates no app
	MissingApp = "no app provided"
	// MissingTestApp indicates no testApp
	MissingTestApp = "no testApp provided"
	// MissingDeviceOrEmulator indicates no device or emulator
	MissingDeviceOrEmulator = "either device or emulator configuration needs to be provided"
	// MissingDeviceOrEmulator indicates no device or emulator
	MissingDeviceOrSimulator = "either device or simulator configuration needs to be provided"
	// MissingDevice indicates no device provided
	MissingDevice = "no device provided"
	// EmptyAdhocSuiteName is thrown when a flag is specified that has a dependency on the --name flag.
	EmptyAdhocSuiteName = "adhoc suite parameters can only be used with a new adhoc suite by setting --name"
	// UnknownFrameworkConfig indicates unknown framework config
	UnknownFrameworkConfig = "unknown framework configuration"
	// UnableToFetchFrameworkList indicates fail to fetch framework list
	UnableToFetchFrameworkList = "unable to fetch frameworks list"
)

cmd setting

const (
	// MissingConfigFile indicates no config file
	MissingConfigFile = "no config file was provided"
	// InvalidSauceConfig indicates it's not a valid sauce config
	InvalidSauceConfig = "" /* 182-byte string literal not displayed */
)

config settings

const (
	// MissingRegion indicates no sauce region provided
	MissingRegion = "no sauce region set"
	// EmptySuite indicates no suites in the config
	EmptySuite = "no suites defined"
	// MissingSuiteName indicates no suite name
	MissingSuiteName = "suite name is not found for suite %d"
	// DuplicateSuiteName indicates duplicate suite name
	DuplicateSuiteName = "suite names must be unique, but found duplicate for '%s'"
	// SuiteNameNotFound indicates it cannot find the specified suite by name
	SuiteNameNotFound = "no suite named '%s' found"
	// InvalidKeyValueInputFormat indicates wrong setting for key-value pairs
	InvalidKeyValueInputFormat = "wrong input format; must be of key-value"
	// InvalidGitRelease indicates the git release is malformed
	InvalidGitRelease = "malformed git release string in metadata"
	// MissingFrameworkVersionConfig indicates empty framework version in the sauce config
	MissingFrameworkVersionConfig = "" /* 136-byte string literal not displayed */
	// UnableToLocateRootDir indicates no rootDir provided
	UnableToLocateRootDir = "unable to locate the rootDir folder %s"
	// UnsupportedBrowser indicates the specified browser is not supported
	UnsupportedBrowser = "browserName: %s is not supported. List of supported browsers: %s"
	// UnsupportedFrameworkVersion indicates the specified framework version is not supported
	UnsupportedFrameworkVersion = "unsupported framework version"
	// InvalidDeviceType indicates invalid device type
	InvalidDeviceType = "deviceType: %s is unsupported for suite: %s. Devices index: %d. Supported device types: %s"
	// MissingDeviceConfig indicates neither device name nor device ID is provided
	MissingDeviceConfig = "missing device name or ID for suite: %s. Devices index: %d"
	// InvalidVisibility indicates that the configured visibility is invalid and has no effect on the test results
	InvalidVisibility = "'%s' is not a valid visibility value. Must be one of [%s]"
	// InvalidLaunchingOption indicates the launching option is invalid
	InvalidLaunchingOption = "illegal launching option '%s', must be %s"
	// NoEmulatorSupport indicates lack of emulator support for the specified region.
	NoEmulatorSupport = "emulators are currently not supported in your specified region"
	// NoFrameworkSupport indicates lack of framework support for the specified region.
	NoFrameworkSupport = "this framework is currently not supported in your specified region"
	// InfoUsingDefaultPlatform indicates using the default value for platform.
	InfoUsingDefaultPlatform = "using default platform '%s' for suite suite '%s'"
	// InvalidReries indicates retries is less than 0
	InvalidReries = "retries should not be less than 0"
	// InvalidPassThreshold indicates invalid pass threshold
	InvalidPassThreshold = "passThreshold should not be greater than retries+1"
	// ShardingConfigurationNoMatchingTests indicates no test matching sharding configuration
	ShardingConfigurationNoMatchingTests = "sharding configuration resulted in no matching tests"
)

common config settings

const (
	// NoProjectName indicates the absence of a project name in a suite
	NoProjectName = "suites must have a projectName defined"
	// ProjectListFailure indicates failure to get the list of projects
	ProjectListFailure = "unable to list projects"
	// ProjectNotFound indicates the project was not found
	ProjectNotFound = `Project "%s" was not found in region %s`
	// HookQueryFailure indicates failure when fetching the hooks
	HookQueryFailure = "unable to query for hooks"
	// NoHookForProject indicates the absence of available hook
	NoHookForProject = `No hooks found for project "%s"`
	// WebhookCreationLink indicates where to create a webhook.
	WebhookCreationLink = `Go to %s to create a webhook for project "%s"`
	// FailedToPrepareSuites indicates failure of preliminary steps for api-testing
	FailedToPrepareSuites = "failed to get some suites associated hookIDs"
)

apitesting config settings

const (
	// MissingCypressVersion indicates no valid cypress version provided
	MissingCypressVersion = "" /* 136-byte string literal not displayed */
	// IllegalSymbol indicates suitename contains illegal symbol
	IllegalSymbol = "illegal symbol '%c' in suite name: '%s'"
	// MissingBrowserInSuite indicates no browser specified
	MissingBrowserInSuite = "no browser specified in suite '%s'"
	// MissingTestFiles indicates no testFiles specified
	MissingTestFiles = "no test files specified in suite '%s'"
	// UnableToLocateCypressCfg indicates it cannot locate cypress config file by the path
	UnableToLocateCypressCfg = "unable to locate the cypress config file at: %s"
	// InvalidCypressTestingType indicates the testingType should be 'e2e' or 'component'
	InvalidCypressTestingType = "invalid testingType in suite '%s'. testingType should be 'e2e' or 'component' only"
)

cypress config settings

const (
	// MissingAppPath indicates empty app path
	MissingAppPath = "missing path to app. Define a path to an .apk or .aab file in the espresso.app property of your config"
	// MissingTestAppPath indicates empty testApp path
	MissingTestAppPath = "missing path to test app. Define a path to an .apk or .aab file in the espresso.testApp property of your config"
	// MissingDevicesOrEmulatorConfig indicates no devices or emulator config provided
	MissingDevicesOrEmulatorConfig = "missing devices or emulators configuration for suite: %s"
	// MissingEmulatorName indicates empty emulator name
	MissingEmulatorName = "missing emulator name for suite: %s. Emulators index: %d"
	// InvalidEmulatorName indicates invalid emulator name
	InvalidEmulatorName = `missing "emulator" in emulator name: %s. Suite name: %s. Emulators index: %d`
	// MissingEmulatorPlatformVersion indicates no emulator platform version provided
	MissingEmulatorPlatformVersion = "missing platform versions for emulator: %s. Suite name: %s. Emulators index: %d"
)

espresso config settings

const (
	// MissingImageRunnerWorkloadType indicates no workload type provided
	MissingImageRunnerWorkloadType = `missing "workload" value for suite: %s`
	// InvalidImageRunnerWorkloadType indicates invalid workload type provided
	InvalidImageRunnerWorkloadType = `%q is an invalid "workload" value for suite: %s`
	// MissingImageRunnerImage indicates no docker image provided
	MissingImageRunnerImage = `missing "image" for suite: %s`
	// ImageRunnerMaxConcurrency indicates that the concurrency value is too high.
	ImageRunnerMaxConcurrency = "Maximum concurrency for imagerunner is 5. Replacing %d with 5."
	// InvalidResourceProfile indicates the resourceProfile is not valid
	InvalidResourceProfile = "invalid resourceProfile for suite: %s, resourceProfile should be of format %v"
	// MissingServiceName indicates no service name provided
	MissingServiceName = `missing "name" for service in suite: %s`
	// MissingServiceImage indicates no docker image provided
	MissingServiceImage = `missing "image" for service: %s in suite: %s`
	// InvalidServiceResourceProfile indicates the service resourceProfile is not valid
	InvalidServiceResourceProfile = "invalid resourceProfile for service: %s in suite: %s, resourceProfile should be of format %v"
)

ImageRunner config settings

const (
	// MissingXcuitestAppPath indicates empty app path for xcuitest
	MissingXcuitestAppPath = "missing path to app .ipa"
	// MissingXcuitestTestAppPath indicates empty testApp path for xcuitest
	MissingXcuitestTestAppPath = "missing path to test app .ipa"
	// MissingXcuitestDeviceConfig indicates empty device setting for xcuitest
	MissingXcuitestDeviceConfig = "missing devices configuration for suite: %s"
)

XCUITest config settings

const (
	// UnableToFetchFile indicates a failure when fetching a file
	UnableToFetchFile = "Unable to fetch file '%s'"
	// UnableToUnmarshallFile indicates a failure to unmarshall a file
	UnableToUnmarshallFile = "Unable to unmarshall file '%s'"
	// SkippingSmartRetries implies that all tests will be retried.
	SkippingSmartRetries = "Skipping SmartRetry. Retrying all tests from the previous job."
	// RetryWithTests indicates which tests will be run
	RetryWithTests = "Retrying with failed tests: %q"
	// UnableToCreateRunnerConfig indicates a failure to create runner config file
	UnableToCreateRunnerConfig = "Unable to create runner config file"
	// UnableToFilterFailedTests indicates a failure to filter failed tests
	UnableToFilterFailedTests = "Unable to filter failed tests"
	// UnableToArchiveRunnerConfig indicates a failure to archive the runner config file
	UnableToArchiveRunnerConfig = "Unable to archive sauce runner config file"
	// UnableToUploadConfig indicates a failure to upload config
	UnableToUploadConfig = "Unable to upload sauce runner config file %q"
	// UnreliableReport indicates that the job is not smart-retryable due to its
	// status.
	UnreliableReport = "Test reports from errored jobs are not a reliable source to correctly determine failed tests."
)

Smart Retries

const (
	// InternalServerError indicates internal server error
	InternalServerError = "internal server error"
	// JobNotFound indicates job was not found
	JobNotFound = "job not found"
	// AssetNotFound indicates requested asset was not found
	AssetNotFound = "asset not found"
	// TunnelNotFound indicates tunnel was not found
	TunnelNotFound = "tunnel not found"
	// RetrieveJobHistoryError indicates failed to retrieve job history
	RetrieveJobHistoryError = "Unable to retrieve job history. Launching jobs in the default order."
	// InsightsReportError indicates failure push to insights.
	InsightsReportError = "unable to report result to insights"
)

common client

const (
	// NpmEmptyURLError indicates a missing URL value
	NpmEmptyURLError = "url of scoped registry at index %d is empty"
	// NpmTooManyDefaultRegistry indicates that there is multiple registry without scope
	NpmTooManyDefaultRegistry = "only one default (scopeless) registry is allowed"
)

npm related messages

const ArchiveFileCountWarning = "The project archive is unusually large which can cause delays in your test execution."

ArchiveFileCountWarning is a warning to the user that their project archive may be unintentionally large.

const ArchivePathLengthWarning = "The project archive contains paths that exceed the limit of %d characters. This archive may not be usable on Windows."

ArchivePathLengthWarning is a warning to the user that their project archive may unintentionally contain long file paths.

const EmptyBuildID = "using empty build ID"

EmptyBuildID indicates it's using empty build ID

const (
	// EmptyDockerImgName indicates no docker image name provided
	EmptyDockerImgName = "no docker image specified"
)

container

const (
	// InvalidTestCafeDeviceSetting indicates the unsupported device keyword in the config
	InvalidTestCafeDeviceSetting = "the 'devices' keyword in your config is now reserved for real devices, please use 'simulators' instead"
)

testcafe config settings

const SauceIgnoreNotExist = `` /* 539-byte string literal not displayed */

SauceIgnoreNotExist is a recommendation to create a .sauceignore file in the case that it is missing.

const SauceIgnoreSuggestion = `` /* 460-byte string literal not displayed */

SauceIgnoreSuggestion is a recommendation to add unnecessary files to .sauceignore in the case that the bundled file is too big.

const SignupMessage = `` /* 171-byte string literal not displayed */

SignupMessage explains how to obtain a Sauce Labs account and where to find the access key.

const WarningLine = "************************************* WARNING *************************************"

WarningLine is a line of starts highlighting the WARNING word.

Functions

func EOLNotice

func EOLNotice(name, version string, removalDate time.Time, availableVersions []string) string

EOLNotice generates an EOL message for a given version.

func Error

func Error(msg string)

Error prints out the given message, prefixed with a color coded 'ERROR: ' segment.

func FormatAvailableVersions

func FormatAvailableVersions(name string, versions []string) string

FormatAvailableVersions formats a message listing the available versions.

func IgnoredNpmPackagesMsg

func IgnoredNpmPackagesMsg(framework string, installedVersion string, ignoredPackages []string) string

IgnoredNpmPackagesMsg returns a warning message that framework npm packages are ignored.

func LogArchivePathLengthWarning

func LogArchivePathLengthWarning(limit int)

LogArchivePathLengthWarning prints out a warning about the project archive path length along with suggestions on how to fix it.

func LogArchiveSizeWarning

func LogArchiveSizeWarning()

LogArchiveSizeWarning prints out a warning about the project archive size along with suggestions on how to fix it.

func LogConsoleOut

func LogConsoleOut(name, logs string)

func LogGlobalTimeoutShutdown

func LogGlobalTimeoutShutdown()

LogGlobalTimeoutShutdown prints out the global timeout shutdown message.

func LogRootDirWarning

func LogRootDirWarning()

LogRootDirWarning prints out a warning message regarding the lack of an explicit rootDir configuration.

func LogSauceIgnoreNotExist

func LogSauceIgnoreNotExist()

LogSauceIgnoreNotExist prints out a formatted and color coded version of SauceIgnoreNotExist.

func LogUnsupportedFramework

func LogUnsupportedFramework(frameworkName string)

LogUnsupportedFramework prints out the unsupported framework message.

func LogUnsupportedPlatform

func LogUnsupportedPlatform(platform string, supported []string)

func RemovalNotice

func RemovalNotice(name, version string, availableVersions []string) string

RemovalNotice generates a removal message for a given version.

func SuiteSplitNoMatch

func SuiteSplitNoMatch(suiteName, path string, pattern []string)

SuiteSplitNoMatch prints the error message due to no files matching pattern found.