framework

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

type CliOps interface {
	CliInit() error
	CliVersion() (string, error)
	InstallCLI(version string) error
	UninstallCLI(version string) error
}

type ClusterOps interface {
	CreateCluster(name string, args []string) (output string, err error)
	DeleteCluster(name string, args []string) (output string, err error)
	ClusterStatus(name string, args []string) (output string, err error)
}

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

type ConfigLifecycleOps interface {
	ConfigSetFeatureFlag(path, value string) error
	ConfigGetFeatureFlag(path string) (string, error)
	ConfigUnsetFeature(path string) error
	ConfigInit() error
	GetConfig() (*configapi.ClientConfig, error)
	ConfigServerList() error
	ConfigServerDelete(serverName string) error
	DeleteCLIConfigurationFiles() error
	IsCLIConfigurationFilesExists() bool
}

type ContainerRuntime interface {
	StartContainerRuntime() (output string, err error)
	ContainerRuntimeStatus() (status string, err error)
	StopContainerRuntime() (output string, err error)
}

type DiscoveryOptions struct {
	Name       string
	SourceType string
	URI        string
}

type Docker interface {
	ContainerRuntime
}

type Framework struct {
	CliOps
	Config ConfigLifecycleOps
	ClusterOps
	PluginCmd    PluginCmdOps    // performs plugin command operations
	PluginHelper PluginHelperOps // helper (pre-setup) for plugin cmd operations
}

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 lists all plugins by running 'tanzu plugin list' command
	ListPlugins() ([]PluginListInfo, error)
}

type PluginCmdOps interface {
	PluginBasicOps
	PluginSourceOps
}

type PluginHelperOps interface {
	GeneratePluginOps
	PublishPluginOps
}

type PluginListInfo struct {
	Description string `json:"description"`
	Discovery   string `json:"discovery"`
	Name        string `json:"name"`
	Scope       string `json:"scope"`
	Status      string `json:"status"`
	Version     string `json:"version"`
}

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 PluginSourceOps interface {
	// AddPluginDiscoverySource adds plugin discovery source, and returns stdOut and error info
	AddPluginDiscoverySource(discoveryOpts *DiscoveryOptions) (string, error)

	// DeletePluginDiscoverySource removes the plugin discovery source, and returns stdOut and error info
	DeletePluginDiscoverySource(discoveryOpts *DiscoveryOptions) (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)
}