app

Documentation

Index

• Constants
• Variables
• func IsProduction() bool
• func IsWindows() bool
• func ReleaseStage() string
• func UserAgent() string

Constants

const (
	// project owner on GitHub
	RepositoryOwner = "watermint"

	// Project name on GitHub
	RepositoryName = "toolbox"

	// Package name
	Pkg = "github.com/" + RepositoryOwner + "/" + RepositoryName
)

Project information

const (
	// Peer name for deployment
	PeerDeploy = "deploy"

	// Peer name for end to end test.
	PeerEndToEndTest = "end_to_end_test"
)

Peer names

const (
	StageDev     = "dev"
	StageBeta    = "beta"
	StageRelease = "release"
)

Stages of deployment

const (
	// Env variable name of verbose debug mode. Expected format is bool.
	EnvNameDebugVerbose = "TOOLBOX_DEBUG_VERBOSE"

	// Env variable name of quiet mode on test.
	EnvNameTestQuiet = "TOOLBOX_TEST_QUIET"

	// Env variable name of deploy token. Expected format is JSON encoded tokens.
	EnvNameDeployToken = "TOOLBOX_DEPLOY_TOKEN"

	// Env variable name for skip end to end tests. Expected format is bool.
	EnvNameEndToEndSkipTest = "TOOLBOX_SKIPENDTOENDTEST"

	// Env variable name for end to end token. Expected format is JSON encoded tokens
	EnvNameEndToEndToken = "TOOLBOX_ENDTOEND_TOKEN"

	// Env variable name for test resource file. Expected format is file path.
	EnvNameTestResource = "TOOLBOX_TEST_RESOURCE"

	// Env variable name for replay store path.
	EnvNameReplayPath = "TOOLBOX_REPLAY_PATH"

	// Env variable name for replay store shared link.
	EnvNameReplayUrl = "TOOLBOX_REPLAY_URL"

	// Env variable name for toolbox home
	EnvNameToolboxHome = "TOOLBOX_HOME"

	// Env variable name for build signature
	EnvNameToolboxBuilderKey = "TOOLBOX_BUILDERKEY"

	// Env variable name for build app keys data
	EnvNameToolboxAppKeys = "TOOLBOX_APPKEYS"
)

Environment variable names

const (
	// Project status badge
	ProjectStatusBadge = `` /* 258-byte string literal not displayed */

	// Project logo
	ProjectLogo = `![watermint toolbox](resources/images/watermint-toolbox-256x256.png)`
)

Document

const (
	// Log prefix
	LogToolbox = "toolbox"
	LogCapture = "capture"
	LogSummary = "summary"

	// Log names
	LogNameStart  = "recipe.log"
	LogNameFinish = "result.log"
)

const (
	ExperimentDbxClientConditionerNarrow20  = "dbx_client_conditioner_narrow20"  // 429 error for 20% traffic
	ExperimentDbxClientConditionerNarrow40  = "dbx_client_conditioner_narrow40"  // 429 error for 40% traffic
	ExperimentDbxClientConditionerNarrow100 = "dbx_client_conditioner_narrow100" // 429 error for 100% traffic

	ExperimentDbxClientConditionerError20  = "dbx_client_conditioner_error20"  // 500 error for 20% traffic
	ExperimentDbxClientConditionerError40  = "dbx_client_conditioner_error40"  // 500 error for 40% traffic
	ExperimentDbxClientConditionerError100 = "dbx_client_conditioner_error100" // 500 error for 100% traffic

	// Execute batch sequentially in same batchId
	ExperimentBatchSequential = "batch_sequential"
	// Execute batch with random batchId order
	ExperimentBatchRandom = "batch_random"
	// Execute batch from the largest batch
	ExperimentBatchBalance = "batch_balance"

	// Do not hard limit window size
	ExperimentCongestionWindowNoLimit = "congestion_window_no_limit"
	// Aggressive initial window size
	ExperimentCongestionWindowAggressive = "congestion_window_aggressive"
	// Reduce call create_folder on sync
	ExperimentFileSyncDisableReduceCreateFolder = "file_sync_disable_reduce_create_folder"
	// Use legacy local to dropbox sync connector
	ExperimentFileSyncLegacyLocalToDropboxConnector = "legacy_local_to_dbx_connector"
	// Use non-cache dropbox file system
	ExperimentFileSyncNoCacheDropboxFileSystem = "use_no_cache_dbxfs"

	// ExperimentReportAllColumns Do not hide columns
	ExperimentReportAllColumns = "report_all_columns"

	// ExperimentProfileMemory Enable memory profiler
	ExperimentProfileMemory = "profile_memory"

	// ExperimentProfileCpu Enable CPU profiler
	ExperimentProfileCpu = "profile_cpu"
)

Variables

var (
	Name           = "watermint toolbox"
	Version        = app_build.SelectVersion(BuildInfo.Version)
	BuildInfo      = resources.Build()
	BuildId        = Version.String()
	Release        = resources.Release()
	Copyright      = fmt.Sprintf("© 2016-%4d Takayuki Okazaki", BuildInfo.Year)
	LandingPage    = "https://toolbox.watermint.org"
	DefaultWebPort = 7800
)

var (
	ErrorUserCancelled = errors.New("user cancelled")
)

var (
	ExperimentalFeatures = []string{
		ExperimentBatchBalance,
		ExperimentBatchRandom,
		ExperimentBatchSequential,
		ExperimentCongestionWindowAggressive,
		ExperimentCongestionWindowNoLimit,
		ExperimentDbxClientConditionerError100,
		ExperimentDbxClientConditionerError20,
		ExperimentDbxClientConditionerError40,
		ExperimentDbxClientConditionerNarrow100,
		ExperimentDbxClientConditionerNarrow20,
		ExperimentDbxClientConditionerNarrow40,
		ExperimentFileSyncDisableReduceCreateFolder,
		ExperimentFileSyncLegacyLocalToDropboxConnector,
		ExperimentFileSyncNoCacheDropboxFileSystem,
		ExperimentProfileCpu,
		ExperimentProfileMemory,
		ExperimentReportAllColumns,
	}
)

Functions

func IsProduction

func IsProduction() bool

func IsWindows

func IsWindows() bool

func ReleaseStage

func ReleaseStage() string

func UserAgent

func UserAgent() string