msg

Documentation

Index

• Constants
• func Error(msg string)
• func IgnoredNpmPackagesMsg(framework string, installedVersion string, ignoredPackages []string) string
• func LogGlobalTimeoutShutdown()
• func LogRootDirWarning()
• func LogSauceIgnoreNotExist()
• func LogUploadTimeout()
• func LogUploadTimeoutSuggestion()
• func PathTooLongForArchive(path string)
• func SuiteSplitNoMatch(suiteName, path string, pattern []string)

Constants

const (
	// FailedToUpload indicates the upload failure
	FailedToUpload = "failed to upload project"
	// FileNotFound indicates file not found
	FileNotFound = "%s: file not found"
	// UploadingTimeout is a the message to warn the user that its upload reach the timeout.
	UploadingTimeout = `Failed to upload the project because it took too long. `
)

appstore uploading

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"
	// 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"
	// 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"
	// 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"
	// InvalidDockerFileTransferType indicates illegal file transfer type
	InvalidDockerFileTransferType = "illegal file transfer type '%s', must be one of '%s'"
)

common config settings

const (
	// MissingCypressVersion indicates no valid cypress version provided
	MissingCypressVersion = "" /* 136-byte string literal not displayed */
	// DuplicateSuiteName indicates duplicate suite name
	DuplicateSuiteName = "suite names must be unique, but found duplicate for '%s'"
	// 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 config.testFiles 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"
)

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 (
	// 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 (
	// 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"
)

common client

const DockerLogo = `` /* 819-byte string literal not displayed */

DockerLogo is an eyecatcher message that indicates the user is running tests inside a docker container.

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 = `` /* 599-byte string literal not displayed */

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

const SauceLogo = `` /* 1962-byte string literal not displayed */

SauceLogo is an eyecatcher message that indicates the user is running tests in the Sauce Labs cloud.

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 UploadingTimeoutSuggestion = `` /* 520-byte string literal not displayed */

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

Functions

func Error

func Error(msg string)

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

func IgnoredNpmPackagesMsg

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

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

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 LogUploadTimeout

func LogUploadTimeout()

LogUploadTimeout prints out a timeout warning.

func LogUploadTimeoutSuggestion

func LogUploadTimeoutSuggestion()

LogUploadTimeoutSuggestion prints out adding unnecessary files to .sauceignore

func PathTooLongForArchive

func PathTooLongForArchive(path string)

PathTooLongForArchive prints the error message due to some filepath being too long.

func SuiteSplitNoMatch

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

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