clitest

Documentation

Overview

Package clitest provides constants and errors kind reused by the cli implementation and the e2e test infrastructure.

Index

• Constants

Constants

const (
	// CloudDisablingMessage is the message displayed in the warning when disabling
	// the cloud features.
	CloudDisablingMessage = "disabling the cloud features"

	// CloudNoMembershipMessage is the message displayed when the user is not member
	// of any organization.
	CloudNoMembershipMessage = "You are not an active member of any organization"

	// CloudSyncDriftFailedMessage is the message displayed when a drift sync fails.
	CloudSyncDriftFailedMessage = "failed to sync the drift status"

	// CloudSkippingTerraformPlanSync is the message displayed when a terraform plan sync is skipped.
	CloudSkippingTerraformPlanSync = "skipping the sync of Terraform plan details"

	// CloudLoginRequiredMessage is the message displayed when cloud login is required.
	CloudLoginRequiredMessage = "This command uses Terramate Cloud features and requires you to be logged in"

	// CloudTargetsNotEnabledMessage is the message displayed when the targets feature is not enabled.
	CloudTargetsNotEnabledMessage = `The \"targets\" feature is not enabled`

	// CloudTargetsInvalidFormat is the message displayed when the target value format is wrong.
	CloudTargetsInvalidFormat = `--target value has invalid format`
)

const (
	// ErrCloud indicates the cloud feature is unprocessable for any reason.
	// Depending on the uimode (human x automation) the cli can fatal or skip the
	// cloud integration.
	ErrCloud errors.Kind = "unprocessable cloud feature"

	// ErrCloudCompat is the error thrown when cloud compatibility check failed.
	ErrCloudCompat errors.Kind = "Terramate Cloud compatibility check"

	// ErrCloudOnboardingIncomplete indicates the onboarding process is incomplete.
	ErrCloudOnboardingIncomplete errors.Kind = "cloud commands cannot be used until onboarding is complete"

	// ErrCloudStacksWithoutID indicates that some stacks are missing the ID field.
	ErrCloudStacksWithoutID errors.Kind = "all the cloud sync features requires that selected stacks contain an ID field"

	// ErrCloudTerraformPlanFile indicates there was an error gathering the plan file details.
	ErrCloudTerraformPlanFile errors.Kind = "failed to gather details from plan file"

	// ErrCloudInvalidTerraformPlanFilePath indicates the plan file is not valid.
	ErrCloudInvalidTerraformPlanFilePath errors.Kind = "invalid plan file path"

	// ErrSafeguardKeywordValidation indicates the safeguard keywords validation failed.
	ErrSafeguardKeywordValidation errors.Kind = "failed to validate safeguard keywords"
)