f2skupper1

type CliLinkStatus struct {
	Wait    int           // skupper link status --help
	Timeout time.Duration // skupper link status --help
	Verbose bool          // skupper link status --help

	// These will be put on the command right after the subcommands, and
	// before other options selected above
	AdditionalArgs []string

	// You can configure any aspects of the command configuration.  However,
	// the fields Command, Args and Shell from the exec.Cmd element will be
	// cleared before execution.
	CliSkupper
}

type CliSkupper struct {
	Args []string

	// The primary way to define the namespace
	Namespace string

	// Secondary way to get the namespace, used only if Namespace is empty
	F2Namespace *f2k8s.Namespace

	// You can configure any aspects of the command configuration.  However,
	// the fields Command, Args and Shell from the exec.Cmd element will be
	// cleared before execution.
	Cmd f2general.Cmd

	frame2.DefaultRunDealer
	frame2.Log
	// contains filtered or unexported fields
}

type CliSkupperInstall struct {
	Namespace                *f2k8s.Namespace
	Ctx                      context.Context
	MaxWait                  time.Duration // If not set, defaults to types.DefaultTimeoutDuration*2
	SkipWait                 bool
	SkipStatus               bool
	EnableConsole            bool
	EnableFlowCollector      bool
	Annotations              []string
	CreateNetworkPolicy      bool
	EnableClusterPermissions bool
	SiteName                 string
	RouterLogging            string
	RouterMode               string
	Ingress                  string
	IngressHost              string
	DisableServiceSync       bool
	RouterCPU                string

	ConsoleAuth     string
	ConsoleUser     string
	ConsolePassword string

	frame2.DefaultRunDealer
	SkupperVersionerDefault
}

type CliSkupperVersion struct {
	Namespace *f2k8s.Namespace
	Ctx       context.Context

	// By default, CliSkupperVersion checks the output of
	// the version command against SKUPPER_TEST_VERSION,
	// when that variable is set
	SkipOutputCheck bool

	frame2.Log
	frame2.DefaultRunDealer
	SkupperVersionerDefault
}

type Connect struct {
	From *f2k8s.Namespace
	To   *f2k8s.Namespace

	SecretName string
	Expiry     string
	Password   string
	TokenType  string
	Uses       string

	LinkName string
	Cost     string

	Ctx context.Context

	frame2.DefaultRunDealer
	frame2.Log
}

type LinkCreate struct {
	Namespace *f2k8s.Namespace

	// The token file to be used on the link creation
	File string
	Name string
	Cost string

	frame2.DefaultRunDealer
	SkupperVersionerDefault
}

type ManifestMatchesDeployment struct {
	Path      string
	Namespace *f2k8s.Namespace

	Ctx context.Context

	frame2.DefaultRunDealer
	frame2.Log
	SkupperVersionerDefault
}

type NetworkStatusConfigMap struct {
	Namespace *f2k8s.Namespace

	SiteName string

	*frame2.DefaultRunDealer
}

type OutgoingLinkCheck struct {
	Namespace *f2k8s.Namespace
	Name      string
	Cost      string

	frame2.DefaultRunDealer
	frame2.Log
}

type RouterCheck struct {
	Namespace *f2k8s.Namespace

	Mode     string
	LogLevel string
	SiteName string

	Ctx context.Context

	Return *interface{}

	frame2.DefaultRunDealer
	frame2.Log
}

type SkupperCliPathSetter interface {
	SetSkupperCliPath(path string, env []string)
	GetNamespace() string
}

type SkupperDelete struct {
	Namespace *f2k8s.Namespace

	Context context.Context
	frame2.DefaultRunDealer
}

type SkupperExpose struct {
	Namespace *f2k8s.Namespace
	Type      string
	Name      string

	// TODO.  Change this into some constants, so it can be reused and translated by different backing
	//        implementations.
	// A string that will compile into a Regex, which matches the command stderr to define an
	// expected failure.
	FailureReason string

	Address                string
	Headless               bool
	Protocol               string
	Ports                  []int
	PublishNotReadyAddress bool
	TargetPorts            []string
	EnableTls              bool // deprecated since 1.3
	GenerateTlsSecrets     bool

	AutoTeardown bool

	frame2.DefaultRunDealer
	SkupperVersionerDefault
}

type SkupperExpose1_2 struct {
	Namespace *f2k8s.Namespace
	Type      string
	Name      string

	// TODO.  Change this into some constants, so it can be reused and translated by different backing
	//        implementations.
	// A string that will compile into a Regex, which matches the command stderr to define an
	// expected failure.
	FailureReason string

	Address                string
	Headless               bool
	Protocol               string
	Ports                  []int
	PublishNotReadyAddress bool
	TargetPorts            []string
	EnableTls              bool

	AutoTeardown bool

	frame2.DefaultRunDealer
}

type SkupperExpose1_3 struct {
	Namespace *f2k8s.Namespace
	Type      string
	Name      string

	// TODO.  Change this into some constants, so it can be reused and translated by different backing
	//        implementations.
	// A string that will compile into a Regex, which matches the command stderr to define an
	// expected failure.
	FailureReason string

	Address                string
	Headless               bool
	Protocol               string
	Ports                  []int
	PublishNotReadyAddress bool
	TargetPorts            []string
	EnableTls              bool
	GenerateTlsSecrets     bool

	AutoTeardown bool

	frame2.DefaultRunDealer
}

type SkupperInfo struct {
	Namespace *f2k8s.Namespace

	Result SkupperInfoContents

	Ctx context.Context
	frame2.DefaultRunDealer
	frame2.Log
}

type SkupperInfoContents struct {
	Images    SkupperManifestContent
	PodImages SkupperManifestContent

	HasRouter            bool
	HasServiceController bool
	HasPrometheus        bool

	RouterDeployment            *appsv1.Deployment
	ServiceControllerDeployment *appsv1.Deployment
	PrometheusDeployment        *appsv1.Deployment

	AllPods *corev1.PodList
}

type SkupperInstallSimple struct {
	Namespace     *f2k8s.Namespace
	EnableConsole bool

	frame2.DefaultRunDealer
}

type SkupperManifest struct {

	// Path to the manifest.json file; if not provided, it will be
	// searched first on the test root, then on the source root.
	//
	// Starting with 1.5, if the Path is empty, the command
	// `skupper version manifest` will be executed to generate a
	// manifest file, instead of searching for it.
	Path string

	SkipComparison bool

	Expected SkupperManifestContent
	Result   *SkupperManifestContent

	frame2.DefaultRunDealer
	frame2.Log
	SkupperVersionerDefault
}

type SkupperManifestContent struct {
	Images    []SkupperManifestContentImage
	Variables map[string]string
}

type SkupperManifestContentImage struct {
	Name       string
	Repository string
}

type SkupperServiceBind struct {
	Namespace  *f2k8s.Namespace
	Name       string
	TargetType string
	TargetName string

	Protocol               string
	PublishNotReadyAddress bool
	TargetPort             []string

	AutoTeardown bool
	Runner       *frame2.Run
}

type SkupperServiceCreate struct {
	Namespace *f2k8s.Namespace
	Name      string
	Port      []string

	Aggregate    string
	EnableTls    bool
	EventChannel bool
	Protocol     string

	Runner       *frame2.Run
	AutoTeardown bool
}

type SkupperServiceDelete struct {
	Namespace *f2k8s.Namespace
	ArgName   string

	Runner *frame2.Run
	Wait   time.Duration
	Ctx    context.Context
}

type SkupperServiceUnbind struct {
	Namespace  *f2k8s.Namespace
	Name       string
	TargetType string
	TargetName string

	Runner *frame2.Run
}

type SkupperUnLink struct {
	Name   string
	From   *f2k8s.Namespace
	To     *f2k8s.Namespace
	Ctx    context.Context
	Runner *frame2.Run
	frame2.Log
}

type SkupperUnexpose struct {
	Namespace *f2k8s.Namespace
	Type      string
	Name      string
	Address   string

	Runner *frame2.Run
}

type SkupperUpgradable interface {
	SkupperUpgradable() *f2k8s.Namespace
	GetNamespace() string
}

type SkupperUpgrade struct {
	Runner       *frame2.Run
	Namespace    *f2k8s.Namespace
	ForceRestart bool
	SkipVersion  bool

	Wait time.Duration
	Ctx  context.Context

	// If true, skips checking the images against the manifest.  If
	// false and no manifest available, panic
	SkipManifest bool

	// Location of the manifest file to be used on the manifest/image
	// tag check.  If empty, check: (?)
	//
	// Before 1.5:
	// - Current dir (ie, etc package dir)
	// - Source root dir
	//
	// Since 1.5:
	// - Execute skupper version manifest to generate a manifest.json file
	ManifestFile string

	// If true, the upgrade output will be inspected, to ensure the message
	// "No update required in 'namespace'" was not shown.
	//
	// In practice, it makes it an error to try to upgrade a site that is
	// already in the right version
	CheckUpdateRequired bool
}

type SkupperVersioner interface {
	SetSkupperVersion(version string)
	GetSkupperVersion() string
	GetNamespace() string
}

type SkupperVersionerDefault struct {
	// You can define this value directly, if you want to set its
	// value directly on a frame.  For acquiring its value, though,
	// use GetSkupperVersion() instead, as it may do special
	// manipulation.
	SkupperVersion string
}

type Status struct {
	Namespace *f2k8s.Namespace
	Ctx       context.Context

	Verbose bool

	CheckStatus bool
	Enabled     bool

	// Only TotalConn is supported for non-verbose
	CheckConnectionCounts bool
	TotalConn             int
	DirectConn            int
	IndirectConn          int

	// TODO non-zero count is still not implemented
	CheckServiceCount bool
	ExposedServices   int

	// Mode and Sitename checks are not supported for
	// non-verbose
	Mode     string
	SiteName string

	// Policies check is not yet implemetned for
	// non-verbose TODO
	CheckPolicies bool
	Policies      bool

	frame2.Log
	frame2.DefaultRunDealer
	SkupperVersionerDefault
}

type TokenCheck struct {
	Namespace *f2k8s.Namespace

	FileName string

	// If Name is not provided, it will be derived from the token
	// file.  If both provided, TokenCheck will ensure they match
	Name string

	Expiry    string
	Password  string
	TokenType string
	Uses      string

	// By default, on the comparison between the Expiry above and
	// what's on the secret, the following rules will be followed:
	//
	// - If both are below 60s, they'll be considered equivalent
	// - Otherwise, if the difference between them is less than 20%,
	// they'll be considered equivalent
	//
	// This is to allow for
	//
	// - clock differences between computer running the test and the cluster
	// - time between creating a token and calling TokenCheck
	//
	// If MaxExpiryDelta is set, however, a fixed delta will be used
	// for the comparison
	MaxExpiryDelta time.Duration

	CheckDefaults bool

	frame2.DefaultRunDealer
	frame2.Log
}

type TokenCreate struct {
	Namespace *f2k8s.Namespace

	Expiry    string
	Name      string
	Password  string
	TokenType string
	Uses      string

	FileName string

	// By default, the token file is automatically removed at the
	// end of the test
	SkipTearDown bool

	frame2.DefaultRunDealer
	frame2.Log
	SkupperVersionerDefault
}

type ValidateSkupperAvailable struct {
	Namespace  *f2k8s.Namespace
	Ctx        context.Context
	MaxWait    time.Duration // If not set, defaults to types.DefaultTimeoutDuration*2
	SkipWait   bool
	SkipStatus bool

	frame2.DefaultRunDealer
	frame2.Log
}