framework

type Artifact struct {
	// Image is a fully qualified OCI image for the plugin binary.
	Image string `json:"image,omitempty"`
	// AssetURI is a URI of the plugin binary. This can be a fully qualified HTTP path or a local path.
	URI string `json:"uri,omitempty"`
	// SHA256 hash of the plugin binary.
	Digest string `json:"digest,omitempty"`
	// Type of the binary artifact. Valid values are S3, OCIImage.
	Type string `json:"type"`
	// OS of the plugin binary in `GOOS` format.
	OS string `json:"os"`
	// Arch is CPU architecture of the plugin binary in `GOARCH` format.
	Arch string `json:"arch"`
}

type ArtifactList []Artifact

type CLIOption func(*CLIOptions)

type CLIOptions struct {
	FilePath string // file path to tanzu installation; Default values for legacy Tanzu CLI is set using TANZU_CLI_COEXISTENCE_LEGACY_TANZU_CLI_DIR and new Tanzu CLI is set using TANZU_CLI_COEXISTENCE_NEW_TANZU_CLI_DIR
	Override bool   // new tanzu cli overrides the installation of legacy tanzu cli; Default value is false
}

type CLIPlugin struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`
	Spec              CLIPluginSpec `json:"spec"`
}

type CLIPluginSpec struct {
	// Description is the plugin's description.
	Description string `json:"description"`
	// Recommended version that Tanzu CLI should use if available.
	// The value should be a valid semantic version as defined in
	// https://semver.org/. E.g., 2.0.1
	RecommendedVersion string `json:"recommendedVersion"`
	// Artifacts contains an artifact list for every supported version.
	Artifacts map[string]ArtifactList `json:"artifacts,omitempty"`
	// Optional specifies whether the plugin is mandatory or optional
	// If optional, the plugin will not get auto-downloaded as part of
	// `tanzu login` or `tanzu plugin sync` command
	// To view the list of plugin, user can use `tanzu plugin list` and
	// to download a specific plugin run, `tanzu plugin install <plugin-name>`
	Optional bool `json:"optional,omitempty"`
	// Target specifies the target of the plugin. Only needed for standalone plugins
	Target configtypes.Target `json:"target,omitempty"`
}

type CertAddOptions struct {
	Host              string
	CACertificatePath string
	SkipCertVerify    string
	Insecure          string
}

type CertDetails struct {
	CaCertificate        string `json:"ca-certificate"`
	Host                 string `json:"host"`
	Insecure             string `json:"insecure"`
	SkipCertVerification string `json:"skip-cert-verification"`
}

type CliOps interface {
	CLIInit(opts ...E2EOption) error
	CLIVersion(opts ...E2EOption) (string, error)
	UninstallTanzuCLI(opts ...E2EOption) error
	InstallLegacyTanzuCLI(opts ...E2EOption) error
	RollbackToLegacyTanzuCLI(tf *Framework, opts ...E2EOption) error
	InstallNewTanzuCLI(opts ...E2EOption) error
	ReinstallNewTanzuCLI(opts ...E2EOption) error
	// CompletionCmd executes `tanzu completion` command for given shell as input value, and returns stdout, stderr and error
	CompletionCmd(shell string, opts ...E2EOption) (string, string, error)
}

type ClusterInfo struct {
	Name               string
	ClusterKubeContext string
	EndPoint           string
	KubeConfigPath     string
	APIKey             string
}

type ClusterOps interface {
	// CreateCluster creates the cluster with given name
	CreateCluster(clusterName string) (stdOut, stdErr string, err error)
	// DeleteCluster deletes the cluster with given name
	DeleteCluster(clusterName string) (stdOut, stdErr string, err error)
	// ClusterStatus checks the status of the cluster for given cluster name
	ClusterStatus(clusterName string) (stdOut, stdErr string, err error)
	// GetClusterEndpoint returns the cluster endpoint for the given cluster name
	GetClusterEndpoint(clusterName string) (endpoint, stdOut, stdErr string, err error)
	// GetClusterContext returns the given cluster kubeconfig context
	GetClusterContext(clusterName string) string
	// GetKubeconfigPath returns the default kubeconfig path
	GetKubeconfigPath() string
	// ApplyConfig applies the given configFilePath on to the given contextName cluster context
	ApplyConfig(contextName, configFilePath string) (stdOut, stdErr string, err error)
}

type CmdOps interface {
	Exec(command string, opts ...E2EOption) (stdOut, stdErr *bytes.Buffer, err error)
	ExecContainsString(command, contains string, opts ...E2EOption) error
	ExecContainsAnyString(command string, contains []string, opts ...E2EOption) error
	ExecContainsErrorString(command, contains string, opts ...E2EOption) error
	ExecNotContainsStdErrorString(command, contains string, opts ...E2EOption) error
	ExecNotContainsString(command, contains string, opts ...E2EOption) error
	TanzuCmdExec(command string, opts ...E2EOption) (stdOut, stdErr *bytes.Buffer, err error)
}

type ConfigCertOps interface {
	// ConfigCertAdd adds cert config for a host, and returns stdOut and error info
	ConfigCertAdd(certAddOpts *CertAddOptions, opts ...E2EOption) (string, error)

	// ConfigCertDelete deletes cert config for a host, and returns error info
	ConfigCertDelete(host string, opts ...E2EOption) error

	// ConfigCertList list cert
	ConfigCertList(opts ...E2EOption) ([]*CertDetails, error)
}

type ConfigCmdOps interface {
	ConfigLifecycleOps
	ConfigCertOps
}

type ConfigLifecycleOps interface {
	// ConfigWithOptions performs config command with given options
	ConfigWithOptions(opts ...E2EOption) (stdOut, stdErr *bytes.Buffer, err error)
	// ConfigSetFeatureFlag sets the tanzu config feature flag
	ConfigSetFeatureFlag(path, value string, opts ...E2EOption) error
	// ConfigGetFeatureFlag gets the tanzu config feature flag
	ConfigGetFeatureFlag(path string, opts ...E2EOption) (string, error)
	// ConfigUnsetFeature un-sets the tanzu config feature flag
	ConfigUnsetFeature(path string, opts ...E2EOption) error
	// ConfigInit performs "tanzu config init"
	ConfigInit(opts ...E2EOption) error
	// GetConfig gets the tanzu config
	GetConfig(opts ...E2EOption) (*configapi.ClientConfig, error)
	// DeleteCLIConfigurationFiles deletes cli configuration files
	DeleteCLIConfigurationFiles() error
	// IsCLIConfigurationFilesExists checks the existence of cli configuration files
	IsCLIConfigurationFilesExists() bool
}

type ContainerRuntime interface {
	StartContainerRuntime() (stdOut, stdErr string, err error)
	ContainerRuntimeStatus() (stdOut, stdErr string, err error)
	StopContainerRuntime() (stdOut, stdErr string, err error)
}

type ContextCmdOps interface {
	// ContextCreateOps helps context create operations
	ContextCreateOps
	// UseContext helps to run 'context use' command
	UseContext(contextName string, opts ...E2EOption) (stdOutStr, stdErrStr string, err error)
	// GetContext helps to run `context get` command
	GetContext(contextName string, opts ...E2EOption) (ContextInfo, error)
	// ListContext helps to run `context list` command
	ListContext(opts ...E2EOption) (contexts []*ContextListInfo, stdOutStr, stdErrStr string, err error)
	// DeleteContext helps to run `context delete` command
	DeleteContext(contextName string, opts ...E2EOption) (stdOutStr, stdErrStr string, err error)
	// GetActiveContext returns current active context for given context-type
	GetActiveContext(contextType string, opts ...E2EOption) (string, error)
	// GetActiveContexts returns all active contexts
	GetActiveContexts(opts ...E2EOption) ([]*ContextListInfo, error)
	// UnsetContext unsets the given context with 'tanzu context unset' and returns stdOut, stdErr and error
	UnsetContext(contextName string, opts ...E2EOption) (stdOutStr, stdErrStr string, err error)
}

type ContextCreateOps interface {
	// CreateContextWithEndPoint creates a context with a given endpoint URL
	CreateContextWithEndPoint(contextName, endpoint string, opts ...E2EOption) error
	// CreateContextWithEndPointStaging creates a context with a given endpoint URL for staging, returns stdout, stderr and error
	CreateContextWithEndPointStaging(contextName, endpoint string, opts ...E2EOption) (stdOut, stdErr string, err error)
	// CreateContextWithKubeconfig creates a context with the given kubeconfig file path and a context from the kubeconfig file
	CreateContextWithKubeconfig(contextName, kubeconfigPath, kubeContext string, opts ...E2EOption) (stdOut, stdErr string, err error)
	// CreateContextWithDefaultKubeconfig creates a context with the default kubeconfig file and a given input context name if it exists in the default kubeconfig file
	CreateContextWithDefaultKubeconfig(contextName, kubeContext string, opts ...E2EOption) error
}

type ContextInfo struct {
	Name        string `json:"name"`
	Target      string `json:"target"`
	ClusterOpts struct {
		Path                string `json:"path"`
		Context             string `json:"context"`
		IsManagementCluster bool   `json:"isManagementCluster"`
	} `json:"clusterOpts"`
}

type ContextListInfo struct {
	Endpoint            string `json:"endpoint"`
	Iscurrent           string `json:"iscurrent"`
	Ismanagementcluster string `json:"ismanagementcluster"`
	Kubeconfigpath      string `json:"kubeconfigpath"`
	Kubecontext         string `json:"kubecontext"`
	Name                string `json:"name"`
	Type                string `json:"type"`
}

type DiscoveryOptions struct {
	Name       string
	SourceType string
	URI        string
}

type Docker interface {
	ContainerRuntime
}

type E2EOption func(*E2EOptions)

type E2EOptions struct {
	TanzuBinary string // TanzuBinary should be set to customize the tanzu binary either the binary name if available with PATH variable or full binary path with name ; default is tanzu from PATH variable
	CLIOptions
	AdditionalFlags string
}

type Framework struct {
	Exec CmdOps
	CliOps
	Config       ConfigCmdOps
	KindCluster  ClusterOps
	PluginCmd    PluginCmdOps    // performs plugin command operations
	PluginHelper PluginHelperOps // helper (pre-setup) for plugin cmd operations
	ContextCmd   ContextCmdOps
}

type GeneratePluginOps interface {
	// GeneratePluginBinaries generates plugin binaries for given plugin metadata and return generated plugin binary file paths
	GeneratePluginBinaries(pluginsMeta []*PluginMeta) ([]string, []error)
}

type ImgpkgOps interface {
	PushBinary(filepath, registryBucketURL string) (registryURL string, err error)
	PushBundle(filepath, registryBucketURL string) (registryURL string, err error)
	PullBinary(url string, outputPath string) (stdOut string, err error)
	PullBundle(url string, outputPath string) (stdOut string, err error)
}

type KindCluster interface {
	ClusterOps
}

type PluginBasicOps interface {
	// ListPlugins execytes 'tanzu plugin list' command and
	// returns the output, stdOut, stdErr and error
	ListPlugins(opts ...E2EOption) ([]*PluginInfo, string, string, error)
	// ListInstalledPlugins lists all installed plugins
	ListInstalledPlugins(opts ...E2EOption) ([]*PluginInfo, error)
	// ListPluginsForGivenContext lists all plugins for a given context and either installed only or all
	ListPluginsForGivenContext(context string, installedOnly bool, opts ...E2EOption) ([]*PluginInfo, error)
	// SearchPlugins searches all plugins for given filter (keyword|regex) by running 'tanzu plugin search' command
	SearchPlugins(filter string, opts ...E2EOption) ([]*PluginInfo, string, string, error)
	// InstallPlugin installs given plugin and flags
	InstallPlugin(pluginName, target, versions string, opts ...E2EOption) (stdOut, stdErr string, err error)
	// Sync performs sync operation and returns stdOut, stdErr and error
	Sync(opts ...E2EOption) (string, string, error)
	// DescribePlugin describes given plugin and flags, returns the plugin description as PluginDescribe
	DescribePlugin(pluginName, target string, opts ...E2EOption) ([]*PluginDescribe, error)
	// DescribePluginLegacy describes given plugin and flags, returns plugin description in string format
	DescribePluginLegacy(pluginName, target string, opts ...E2EOption) (string, error)
	// UninstallPlugin uninstalls/deletes given plugin
	UninstallPlugin(pluginName, target string, opts ...E2EOption) error
	// DeletePlugin deletes/uninstalls given plugin
	DeletePlugin(pluginName, target string, opts ...E2EOption) error
	// ExecuteSubCommand executes specific plugin sub-command
	ExecuteSubCommand(pluginWithSubCommand string, opts ...E2EOption) (string, error)
	// CleanPlugins executes the plugin clean command to delete all existing plugins
	CleanPlugins(opts ...E2EOption) error
	// RunPluginCmd runs plugin command with provided options
	RunPluginCmd(options string, opts ...E2EOption) (string, string, error)
}

type PluginCmdOps interface {
	PluginBasicOps
	PluginSourceOps
	PluginGroupOps
	PluginDownloadAndUploadOps
}

type PluginDescribe struct {
	Buildsha                     string `yaml:"buildsha"`
	Completiontype               string `yaml:"completiontype"`
	Defaultfeatureflags          string `yaml:"defaultfeatureflags"`
	Description                  string `yaml:"description"`
	Digest                       string `yaml:"digest"`
	Discoveredrecommendedversion string `yaml:"discoveredrecommendedversion"`
	Discovery                    string `yaml:"discovery"`
	Docurl                       string `yaml:"docurl"`
	Group                        string `yaml:"group"`
	Installationpath             string `yaml:"installationpath"`
	Name                         string `yaml:"name"`
	Scope                        string `yaml:"scope"`
	Status                       string `yaml:"status"`
	Target                       string `yaml:"target"`
	Version                      string `yaml:"version"`
}

type PluginDownloadAndUploadOps interface {
	// DownloadPluginBundle downloads the plugin inventory and plugin bundles to local tar file
	DownloadPluginBundle(image string, groups []string, toTar string, opts ...E2EOption) error

	// UploadPluginBundle performs the uploading plugin bundle to the remote repository
	// Based on the remote repository status, it setups a new discovery source endpoint
	// or merges the additional plugins in the bundle to the existing discovery source
	UploadPluginBundle(toRepo string, tar string, opts ...E2EOption) error
}

type PluginGroup struct {
	Name        string   `json:"name"`
	Group       string   `json:"group"`
	Description string   `json:"description"`
	Latest      string   `json:"latest"`
	Versions    []string `json:"versions"`
}

type PluginGroupGet struct {
	Group         string `json:"group"`
	PluginName    string `json:"pluginname"`
	PluginTarget  string `json:"plugintarget"`
	PluginVersion string `json:"pluginversion"`
}

type PluginGroupOps interface {
	// SearchPluginGroups performs plugin group search
	// input: flagsWithValues - flags and values if any
	SearchPluginGroups(flagsWithValues string, opts ...E2EOption) ([]*PluginGroup, error)

	// GetPluginGroup performs plugin group get
	// input: flagsWithValues - flags and values if any
	GetPluginGroup(groupName string, flagsWithValues string, opts ...E2EOption) ([]*PluginGroupGet, error)

	// InstallPluginsFromGroup a plugin or all plugins from the given plugin group
	InstallPluginsFromGroup(pluginNameORAll, groupName string, opts ...E2EOption) (stdout string, stdErr string, err error)
}

type PluginHelperOps interface {
	GeneratePluginOps
	PublishPluginOps
}

type PluginInfo struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Target      string `json:"target"`
	Discovery   string `json:"discovery"`
	Scope       string `json:"scope"`
	Status      string `json:"status"`
	Version     string `json:"version"`
	Context     string `json:"context"`
}

type PluginMeta struct {
	// contains filtered or unexported fields
}

type PluginRegistry interface {
	// StartRegistry starts plugin registry
	StartRegistry() (url string, err error)

	// StopRegistry stops plugin registry
	StopRegistry() error

	// IsRegistryRunning validates plugin registry status
	IsRegistryRunning() (bool, error)

	// GetRegistryURLWithDefaultCLIPluginsBucket returns the default registry url with default bucket for CLI plugin's
	GetRegistryURLWithDefaultCLIPluginsBucket() (url string)
}

type PluginSearch struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Target      string `json:"target"`
	Latest      string `json:"latest"`
}

type PluginSourceInfo struct {
	Name  string `json:"name"`
	Image string `json:"image"`
}

type PluginSourceOps interface {
	// UpdatePluginDiscoverySource updates plugin discovery source, and returns stdOut and error info
	UpdatePluginDiscoverySource(discoveryOpts *DiscoveryOptions, opts ...E2EOption) (string, error)

	// DeletePluginDiscoverySource removes the plugin discovery source, and returns stdOut and error info
	DeletePluginDiscoverySource(pluginSourceName string, opts ...E2EOption) (string, error)

	// ListPluginSources returns all available plugin discovery sources
	ListPluginSources(opts ...E2EOption) ([]*PluginSourceInfo, error)

	// InitPluginDiscoverySource initializes the plugin source to its default value, and returns stdOut and error info
	InitPluginDiscoverySource(opts ...E2EOption) (string, error)
}

type PublishPluginOps interface {
	// PublishPluginBinary publishes the plugin binaries to given registry bucket and returns the plugin distribution urls
	PublishPluginBinary(pluginsInfo []*PluginMeta) (distributionUrls []string, errs []error)

	// GeneratePluginBundle generates plugin bundle in local file system for given plugin metadata
	GeneratePluginBundle(pluginsMeta []*PluginMeta) ([]string, []error)

	// PublishPluginBundle publishes the plugin bundles to given registry bucket and returns the plugins discovery urls
	PublishPluginBundle(pluginsInfo []*PluginMeta) (discoveryUrls []string, errs []error)
}

type Server struct {
	Context  string `json:"context"`
	Endpoint string `json:"endpoint"`
	Name     string `json:"name"`
	Path     string `json:"path"`
	Type     string `json:"type"`
}

type TMCPlugin struct {
	Name               string `yaml:"name"`
	Description        string `yaml:"description"`
	RecommendedVersion string `yaml:"recommendedVersion"`
}

type TMCPluginsInfo struct {
	Plugins []TMCPlugin `yaml:"plugins"`
}

type TMCPluginsMockRequestResponseMapping struct {
	Request struct {
		Method string `json:"method"`
		URL    string `json:"url"`
	} `json:"request"`
	Response struct {
		Status  int    `json:"status"`
		Body    string `json:"body"`
		Headers struct {
			ContentType string `json:"Content-Type"`
			Accept      string `json:"Accept"`
		} `json:"headers"`
	} `json:"response"`
}

type TMCPluginsResponse struct {
	PluginsInfo TMCPluginsInfo `yaml:"pluginsInfo"`
}