types

type AdditionalWebhookRegister interface {
	// GetWebhookSupport get webhook support map
	GetWebhookSupport() map[metav1alpha1.WebhookEventSupportType][]string
}

type ArtifactDeleter interface {
	Interface
	DeleteArtifact(ctx context.Context, params metav1alpha1.ArtifactOptions) error
}

type ArtifactGetter interface {
	Interface
	GetArtifact(ctx context.Context, params metav1alpha1.ArtifactOptions) (*metav1alpha1.Artifact, error)
}

type ArtifactLister interface {
	Interface
	ListArtifacts(ctx context.Context, params metav1alpha1.ArtifactOptions, option metav1alpha1.ListOptions) (*metav1alpha1.ArtifactList, error)
}

type ArtifactTagDeleter interface {
	Interface
	DeleteArtifactTag(ctx context.Context, params metav1alpha1.ArtifactTagOptions) error
}

type ArtifactTriggerRegister interface {
	GetIntegrationClassName() string

	// cloud event type of push hook that will match
	PushEventType() string
}

type AuthChecker interface {
	AuthCheck(ctx context.Context, option metav1alpha1.AuthCheckOptions) (*metav1alpha1.AuthCheck, error)
}

type AuthTokenGenerator interface {
	AuthToken(ctx context.Context) (*metav1alpha1.AuthToken, error)
}

type BlobStoreLister interface {
	Interface
	ListBlobStores(ctx context.Context, listOption metav1alpha1.ListOptions) (*metav1alpha1.BlobStoreList, error)
}

type CodeQualityGetter interface {
	Interface
	GetCodeQuality(ctx context.Context, projectKey string) (*metav1alpha1.CodeQuality, error)
	GetCodeQualityOverviewByBranch(ctx context.Context, opt metav1alpha1.CodeQualityBaseOption) (*metav1alpha1.CodeQuality, error)
	GetCodeQualityLineCharts(ctx context.Context, opt metav1alpha1.CodeQualityLineChartOption) (*metav1alpha1.CodeQualityLineChart, error)
	GetOverview(ctx context.Context) (*metav1alpha1.CodeQualityProjectOverview, error)
	GetSummaryByTaskID(ctx context.Context, opt metav1alpha1.CodeQualityTaskOption) (*metav1alpha1.CodeQualityTaskMetrics, error)
}

type DependentResourceGetter interface {
	// GetDependentResources parses params and returns expected dependent resources
	GetDependentResources(ctx context.Context, params []metav1alpha1.Param) ([]corev1.ObjectReference, error)
}

type GetProjectOption struct {
	ProjectName string                      `json:"projectName" yaml:"projectName"`
	SubType     metav1alpha1.ProjectSubType `json:"subType" yaml:"subType"`
}

type GitBranchCreator interface {
	Interface
	CreateGitBranch(ctx context.Context, payload metav1alpha1.CreateBranchPayload) (metav1alpha1.GitBranch, error)
}

type GitBranchGetter interface {
	Interface
	GetGitBranch(ctx context.Context, repoOption metav1alpha1.GitRepo, branch string) (metav1alpha1.GitBranch, error)
}

type GitBranchLister interface {
	Interface
	ListGitBranch(ctx context.Context, branchOption metav1alpha1.GitBranchOption, option metav1alpha1.ListOptions) (metav1alpha1.GitBranchList, error)
}

type GitCommitCommentCreator interface {
	Interface
	CreateGitCommitComment(ctx context.Context, payload metav1alpha1.CreateCommitCommentPayload) (metav1alpha1.GitCommitComment, error)
}

type GitCommitCommentLister interface {
	Interface
	ListGitCommitComment(
		ctx context.Context,
		option metav1alpha1.GitCommitOption,
		listOption metav1alpha1.ListOptions,
	) (metav1alpha1.GitCommitCommentList, error)
}

type GitCommitCreator interface {
	Interface
	CreateGitCommit(ctx context.Context, option coderepositoryv1alpha1.CreateGitCommitOption) (metav1alpha1.GitCommit, error)
}

type GitCommitGetter interface {
	Interface
	GetGitCommit(ctx context.Context, option metav1alpha1.GitCommitOption) (metav1alpha1.GitCommit, error)
}

type GitCommitLister interface {
	Interface
	ListGitCommit(
		ctx context.Context,
		option metav1alpha1.GitCommitListOption,
		listOption metav1alpha1.ListOptions,
	) (metav1alpha1.GitCommitList, error)
}

type GitCommitStatusCreator interface {
	Interface
	CreateGitCommitStatus(ctx context.Context, payload metav1alpha1.CreateCommitStatusPayload) (metav1alpha1.GitCommitStatus, error)
}

type GitCommitStatusLister interface {
	Interface
	ListGitCommitStatus(
		ctx context.Context,
		option metav1alpha1.GitCommitOption,
		listOption metav1alpha1.ListOptions,
	) (metav1alpha1.GitCommitStatusList, error)
}

type GitPluginClientSet interface {
	GitPullRequestCommentCreator
	GitPullRequestCommentUpdater
	GitPullRequestCommentLister
	GitPullRequestHandler
	GitPullRequestLister
	GitPullRequestGetter
	GitPullRequestCreator

	GitCommitStatusLister
	GitCommitStatusCreator
	GitCommitCommentLister
	GitCommitCommentCreator

	// GitRepositoryTagCreator
	GitRepositoryTagGetter
	GitRepositoryTagLister

	GitCommitGetter
	GitCommitCreator
	GitCommitLister

	GitRepoFileGetter
	GitRepoFileCreator
	GitRepositoryFileTreeGetter

	GitRepositoryLister
	GitRepositoryGetter

	GitBranchLister
	GitBranchGetter
	GitBranchCreator
}

type GitPullRequestCommentCreator interface {
	Interface
	CreatePullRequestComment(ctx context.Context, option metav1alpha1.CreatePullRequestCommentPayload) (metav1alpha1.GitPullRequestNote, error)
}

type GitPullRequestCommentLister interface {
	Interface
	ListPullRequestComment(
		ctx context.Context,
		option metav1alpha1.GitPullRequestOption,
		listOption metav1alpha1.ListOptions,
	) (metav1alpha1.GitPullRequestNoteList, error)
}

type GitPullRequestCommentUpdater interface {
	Interface
	UpdatePullRequestComment(ctx context.Context, option metav1alpha1.UpdatePullRequestCommentPayload) (metav1alpha1.GitPullRequestNote, error)
}

type GitPullRequestCreator interface {
	Interface
	CreatePullRequest(ctx context.Context, payload metav1alpha1.CreatePullRequestPayload) (metav1alpha1.GitPullRequest, error)
}

type GitPullRequestGetter interface {
	Interface
	GetGitPullRequest(ctx context.Context, option metav1alpha1.GitPullRequestOption) (metav1alpha1.GitPullRequest, error)
}

type GitPullRequestHandler interface {
	Interface
	GitPullRequestLister
	GitPullRequestGetter
	GitPullRequestCreator
}

type GitPullRequestLister interface {
	Interface
	ListGitPullRequest(
		ctx context.Context,
		option metav1alpha1.GitPullRequestListOption,
		listOption metav1alpha1.ListOptions,
	) (metav1alpha1.GitPullRequestList, error)
}

type GitRepoFileCreator interface {
	Interface
	CreateGitRepoFile(ctx context.Context, payload metav1alpha1.CreateRepoFilePayload) (metav1alpha1.GitCommit, error)
}

type GitRepoFileGetter interface {
	Interface
	GetGitRepoFile(ctx context.Context, option metav1alpha1.GitRepoFileOption) (metav1alpha1.GitRepoFile, error)
}

type GitRepositoryCreator interface {
	Interface
	CreateGitRepository(ctx context.Context, payload metav1alpha1.CreateGitRepositoryPayload) (metav1alpha1.GitRepository, error)
}

type GitRepositoryDeleter interface {
	Interface
	DeleteGitRepository(ctx context.Context, gitRepo metav1alpha1.GitRepo) error
}

type GitRepositoryFileTreeGetter interface {
	Interface
	GetGitRepositoryFileTree(
		ctx context.Context,
		repoOption metav1alpha1.GitRepoFileTreeOption,
		listOption metav1alpha1.ListOptions,
	) (metav1alpha1.GitRepositoryFileTree, error)
}

type GitRepositoryGetter interface {
	Interface
	GetGitRepository(ctx context.Context, repoOption metav1alpha1.GitRepo) (metav1alpha1.GitRepository, error)
}

type GitRepositoryLister interface {
	Interface
	ListGitRepository(
		ctx context.Context,
		id, keyword string,
		subtype metav1alpha1.ProjectSubType,
		listOption metav1alpha1.ListOptions,
	) (metav1alpha1.GitRepositoryList, error)
}

type GitRepositoryTagCreator interface {
	Interface
	CreateGitRepositoryTag(ctx context.Context, option metav1alpha1.CreateGitTagPayload) (metav1alpha1.GitRepositoryTag, error)
}

type GitRepositoryTagGetter interface {
	Interface
	GetGitRepositoryTag(
		ctx context.Context,
		option metav1alpha1.GitRepositoryTagOption,
	) (metav1alpha1.GitRepositoryTag, error)
}

type GitRepositoryTagLister interface {
	Interface
	ListGitRepositoryTag(
		ctx context.Context,
		option metav1alpha1.GitRepositoryTagListOption,
		listOption metav1alpha1.ListOptions,
	) (metav1alpha1.GitRepositoryTagList, error)
}

type GitTriggerRegister interface {
	GetIntegrationClassName() string

	// cloud event type of pull request hook that will match
	PullRequestEventType() string

	// cloud event type of push hook that will match
	PushEventType() string

	// cloud event type of push hook that will match
	TagEventType() string
}

type ImageConfigGetter interface {
	Interface
	GetImageConfig(ctx context.Context, params metav1alpha1.ArtifactOptions) (*metav1alpha1.ImageConfig, error)
}

type Initializer interface {
	// Initialize  the tool service if desired
	Initialize(ctx context.Context) error
}

type Interface interface {
	Path() string
	Setup(context.Context, *zap.SugaredLogger) error
}

type IssueAttributeGetter interface {
	Interface
	GetIssueAttribute(ctx context.Context, params metav1alpha1.IssueOptions, option metav1alpha1.ListOptions) (*metav1alpha1.Attribute, error)
}

type IssueBranchCreator interface {
	Interface
	CreateIssueBranch(ctx context.Context, params metav1alpha1.IssueOptions, payload metav1alpha1.Branch) (*metav1alpha1.Branch, error)
}

type IssueBranchDeleter interface {
	Interface
	DeleteIssueBranch(ctx context.Context, params metav1alpha1.IssueOptions, option metav1alpha1.ListOptions) error
}

type IssueBranchLister interface {
	Interface
	ListIssueBranches(ctx context.Context, params metav1alpha1.IssueOptions, option metav1alpha1.ListOptions) (*metav1alpha1.BranchList, error)
}

type IssueGetter interface {
	Interface
	GetIssue(ctx context.Context, params metav1alpha1.IssueOptions, option metav1alpha1.ListOptions) (*metav1alpha1.Issue, error)
}

type IssueLister interface {
	Interface
	ListIssues(ctx context.Context, params metav1alpha1.IssueOptions, option metav1alpha1.ListOptions) (*metav1alpha1.IssueList, error)
}

type LivenessChecker interface {
	// CheckAlive check the tool service is alive
	CheckAlive(ctx context.Context) error
}

type PluginAddressable interface {
	// GetAddressURL Returns its own plugin access URL
	GetAddressURL() *apis.URL
}

type PluginAttributes interface {
	SetAttribute(k string, values ...string)
	GetAttribute(k string) []string
	Attributes() map[string][]string
}

type PluginDisplayColumns interface {
	SetDisplayColumns(k string, values ...metav1alpha1.DisplayColumn)
	GetDisplayColumns() map[string]metav1alpha1.DisplayColumns
}

type PluginRegister interface {
	Interface
	PluginAddressable
	// GetIntegrationClassName returns integration class name
	GetIntegrationClassName() string
	// GetWebhookURL Returns a Webhook accessible URL for external tools
	// If not supported return nil, false
	GetWebhookURL() (*apis.URL, bool)
	// GetSupportedVersions Returns a list of supported versions by the plugin
	// For SaaS platform plugins use a "online" version.
	GetSupportedVersions() []string
	// GetSecretTypes Returns all secret types supported by the plugin
	GetSecretTypes() []string
	// GetReplicationPolicyTypes return replication policy types for ClusterIntegration
	GetReplicationPolicyTypes() []string
	// GetResourceTypes Returns a list of Resource types that can be used in ClusterIntegration and Integration
	GetResourceTypes() []string
	// GetAllowEmptySecret Returns if an empty secret is allowed with IntegrationClass
	GetAllowEmptySecret() []string
}

type PluginVersionAttributes interface {
	// GetVersionAttributes get the differential configuration of the specified version
	GetVersionAttributes(version string) map[string][]string

	// SetVersionAttributes set the differential configuration of the specified version
	SetVersionAttributes(version string, attributes map[string][]string)
}

type ProjectArtifactDeleter interface {
	Interface
	DeleteProjectArtifact(ctx context.Context, params metav1alpha1.ProjectArtifactOptions) error
}

type ProjectArtifactFileGetter interface {
	Interface
	GetProjectArtifactFile(ctx context.Context, params metav1alpha1.ProjectArtifactOptions) (io.ReadCloser, error)
}

type ProjectArtifactGetter interface {
	Interface
	GetProjectArtifact(ctx context.Context, params metav1alpha1.ProjectArtifactOptions) (*metav1alpha1.Artifact, error)
}

type ProjectArtifactLister interface {
	Interface
	ListProjectArtifacts(ctx context.Context, params metav1alpha1.ArtifactOptions, option metav1alpha1.ListOptions) (*metav1alpha1.ArtifactList, error)
}

type ProjectArtifactUploader interface {
	Interface
	UploadArtifact(ctx context.Context, params metav1alpha1.ProjectArtifactOptions, r io.Reader) error
}

type ProjectCreator interface {
	Interface
	CreateProject(ctx context.Context, project *metav1alpha1.Project) (*metav1alpha1.Project, error)
}

type ProjectDeleter interface {
	Interface
	DeleteProject(ctx context.Context, project *metav1alpha1.Project) error
}

type ProjectGetter interface {
	Interface
	GetProject(ctx context.Context, id string) (*metav1alpha1.Project, error)
}

type ProjectLister interface {
	Interface
	ListProjects(ctx context.Context, option metav1alpha1.ListOptions) (*metav1alpha1.ProjectList, error)
}

type ProjectUserLister interface {
	Interface
	ListProjectUsers(ctx context.Context, params metav1alpha1.UserOptions, option metav1alpha1.ListOptions) (*metav1alpha1.UserList, error)
}

type RepositoryGetter interface {
	Interface
	GetRepository(
		ctx context.Context,
		params metav1alpha1.RepositoryOptions,
	) (*metav1alpha1.Repository, error)
}

type RepositoryLister interface {
	Interface
	ListRepositories(
		ctx context.Context,
		params metav1alpha1.RepositoryOptions,
		option metav1alpha1.ListOptions,
	) (*metav1alpha1.RepositoryList, error)
}

type ResourcePathFormatter interface {
	// GetResourcePathFmt resource path format
	GetResourcePathFmt() map[metav1alpha1.ResourcePathScene]string
	// GetSubResourcePathFmt resource path format
	GetSubResourcePathFmt() map[metav1alpha1.ResourcePathScene]string
}

type ScanImage interface {
	Interface
	ScanImage(ctx context.Context, params metav1alpha1.ArtifactOptions) error
}

type SubtypeProjectGetter interface {
	Interface
	GetSubTypeProject(ctx context.Context, getOption GetProjectOption) (*metav1alpha1.Project, error)
}

type TestCaseExecutionCreator interface {
	Interface
	CreateTestCaseExecution(ctx context.Context, params metav1alpha1.TestProjectOptions, payload metav1alpha1.TestCaseExecution) (*metav1alpha1.TestCaseExecution, error)
}

type TestCaseExecutionLister interface {
	Interface
	ListTestCaseExecutions(ctx context.Context, params metav1alpha1.TestProjectOptions, options metav1alpha1.ListOptions) (*metav1alpha1.TestCaseExecutionList, error)
}

type TestCaseGetter interface {
	Interface
	GetTestCase(ctx context.Context, params metav1alpha1.TestProjectOptions) (*metav1alpha1.TestCase, error)
}

type TestCaseLister interface {
	Interface
	ListTestCases(ctx context.Context, params metav1alpha1.TestProjectOptions, options metav1alpha1.ListOptions) (*metav1alpha1.TestCaseList, error)
}

type TestModuleLister interface {
	Interface
	ListTestModules(ctx context.Context, params metav1alpha1.TestProjectOptions, options metav1alpha1.ListOptions) (*metav1alpha1.TestModuleList, error)
}

type TestPlanGetter interface {
	Interface
	GetTestPlan(ctx context.Context, params metav1alpha1.TestProjectOptions) (*metav1alpha1.TestPlan, error)
}

type TestPlanLister interface {
	Interface
	ListTestPlans(ctx context.Context, params metav1alpha1.TestProjectOptions, option metav1alpha1.ListOptions) (*metav1alpha1.TestPlanList, error)
}

type ToolMetadataGetter interface {
	// GetToolMetadata get the version information corresponding to the address.
	GetToolMetadata(ctx context.Context) (*metav1alpha1.ToolMeta, error)
}

type WebhookCreator interface {
	CreateWebhook(ctx context.Context, spec metav1alpha1.WebhookRegisterSpec, secret corev1.Secret) (metav1alpha1.WebhookRegisterStatus, error)
}

type WebhookDeleter interface {
	DeleteWebhook(ctx context.Context, spec metav1alpha1.WebhookRegisterSpec, secret corev1.Secret) error
}

type WebhookLister interface {
	ListWebhooks(ctx context.Context, uri apis.URL, secret corev1.Secret) ([]metav1alpha1.WebhookRegisterStatus, error)
}

type WebhookReceiver interface {
	Interface
	ReceiveWebhook(ctx context.Context, req *restful.Request, secret string) (cloudevent.Event, error)
}

type WebhookRegister interface {
	WebhookCreator
	WebhookUpdater
	WebhookDeleter
	WebhookLister
}

type WebhookResourceDiffer interface {
	// IsSameResource will provide two ResourceURI
	// the plugin should discern if they are the same.
	// If this method is not implemented a standard comparisons will be used
	IsSameResource(ctx context.Context, i, j metav1alpha1.ResourceURI) bool
}

type WebhookUpdater interface {
	UpdateWebhook(ctx context.Context, spec metav1alpha1.WebhookRegisterSpec, secret corev1.Secret) (metav1alpha1.WebhookRegisterStatus, error)
}