commands

type AuthResourceManagementCP interface {
	GetProject() (*cloudresourcemanager.Project, error)

	// GetProjectPolicy retrieves the current project's IAM policy.
	GetProjectPolicy() (*cloudresourcemanager.Policy, error)

	// SetProjectPolicy sets the policy.
	SetProjectPolicy(policy *cloudresourcemanager.Policy) error

	// GetBucketACL retrieves a Cloud Storage bucket's ACL list.
	GetBucketACL(ctx context.Context, bucket string) ([]storage.ACLRule, error)

	// SetBucketACL adds the entity + role pair to the ACL list for the provided bucket.
	SetBucketACL(ctx context.Context, bucket string, entity storage.ACLEntity, role storage.ACLRole) error
}

type ConfigGcloudCLI interface {
	// IsGcloudInstalled returns true if gcloud is installed.
	IsGcloudInstalled() bool
	// PrintInstallInstructions prints install instructions to the console.
	PrintInstallInstructions()
}

type DeleteGCECP interface {
	// Instance retrieves the instance from the control plane (if available).
	Instance() (*ctrl.GCEInstance, error)
	// DeleteInstance requests the deletion of the instance.
	DeleteInstance() (ctrl.LongRunningOperation, error)
}

type DeleteTPUCP interface {
	// Instance retrieves the instance from the control plane (if available).
	Instance() (*ctrl.TPUInstance, error)
	// DeleteInstance requests the deletion of the instance.
	DeleteInstance() (ctrl.LongRunningOperation, error)
}

type ListGCEInstancesCP interface {
	// ListInstances lists the available Compute Engine instances.
	ListInstances() ([]*ctrl.GCEInstance, error)
}

type ListTPUInstancesCP interface {
	// ListInstances lists the available TPU instances.
	ListInstances() ([]*ctrl.TPUInstance, error)
}

type PauseGCECP interface {
	// Instance retrieves the instance from the control plane (if available).
	Instance() (*ctrl.GCEInstance, error)
	// StopInstance requests the halting of the instance.
	StopInstance() (ctrl.LongRunningOperation, error)
}

type PauseTPUCP interface {
	// Instance retrieves the instance from the control plane (if available).
	Instance() (*ctrl.TPUInstance, error)
	// DeleteInstance requests the deletion of the instance.
	DeleteInstance() (ctrl.LongRunningOperation, error)
}

type RestartTPUCP interface {
	// Instance retrieves the instance from the control plane (if available).
	Instance() (*ctrl.TPUInstance, error)
	// CreateInstance requests the creation of the instance.
	//
	// CreateInstance is implemented by TPUCP.CreateInstance and is expected to match.
	CreateInstance(ctx context.Context, version string, preemptible, reserved bool, hardwareType, network string) (ctrl.LongRunningOperation, error)
	// DeleteInstance requests the deletion of the instance.
	DeleteInstance() (ctrl.LongRunningOperation, error)
}

type StatusGCECP interface {
	// OptionallyRetrieveInstance retrieves the instance, but can optionally not enable the TPU API.
	OptionallyRetrieveInstance(bool) (*ctrl.GCEInstance, bool, error)
}

type StatusTPUCP interface {
	// OptionallyRetrieveInstance retrieves the instance, but can optionally not enable the TPU API.
	OptionallyRetrieveInstance(bool) (*ctrl.TPUInstance, bool, error)
}

type TFVersionsCP interface {
	// ListVersions returns the available TPU TensorFlow versions.
	ListVersions() ([]*tpu.TensorFlowVersion, error)
}

type TPULocationsCP interface {
	// ListLocations lists available locations.
	ListLocations() ([]*tpu.Location, error)
}

type TPUSizeCP interface {
	// ListSizes lists available TPU sizes.
	ListSizes() ([]*tpu.AcceleratorType, error)
}

type UpGCECP interface {
	// Instance retrieves the instance from the control plane (if available).
	Instance() (*ctrl.GCEInstance, error)
	// OptionallyRetrieveInstance retrieves the instance, but can optionally not enable the TPU API.
	OptionallyRetrieveInstance(bool) (*ctrl.GCEInstance, bool, error)
	// CreateInstance requests the creation of the instance.
	CreateInstance(*ctrl.GCECreateRequest) (ctrl.LongRunningOperation, error)
	// StartInstance requests the starting of the instance.
	StartInstance() (ctrl.LongRunningOperation, error)
}

type UpGcloudCLI interface {
	// IsGcloudInstalled determines if the gcloud command line tool is installed and available on the path.
	IsGcloudInstalled() bool
	// SSHToInstance takes over the process and turns it into an ssh connection to the Compute Engine instance of the flock.
	SSHToInstance(forwardPorts, forwardAgent bool, tpuInstance *ctrl.TPUInstance) error
	// PrintInstallInstructions prints instructions to the console for how to install gcloud.
	PrintInstallInstructions()
}

type UpResourceManagementCP interface {
	// AddTPUUserAgent authorizes the TPU user agent, if required.
	AddTPUUserAgent(tpuUserAgent string) error

	// IsProjectInGoogleOrg determines if the project is part of the Google organziation.
	//
	// This is used to provide more helpful error messages
	IsProjectInGoogleOrg() (bool, error)
}

type UpTPUCP interface {
	// Instance retrieves the instance from the control plane (if available).
	Instance() (*ctrl.TPUInstance, error)
	// OptionallyRetrieveInstance retrieves the instance, but can optionally not enable the TPU API.
	OptionallyRetrieveInstance(bool) (*ctrl.TPUInstance, bool, error)
	// CreateInstance requests the creation of the instance.
	CreateInstance(ctx context.Context, version string, preemptible, reserved bool, hardwareType, network string) (ctrl.LongRunningOperation, error)
	// ListVersions retrieves the list of available TensorFlow versions.
	ListVersions() ([]*tpu.TensorFlowVersion, error)
}