core

type AzureClient interface {
	FindUsingSASUrl(ctx context.Context, sasURL string) (io.ReadCloser, error)
	Find(ctx context.Context, path string) (io.ReadCloser, error)
	Create(ctx context.Context, path string, reader io.Reader, mimeType string) (string, error)
	CreateUsingSASURL(ctx context.Context, sasURL string, reader io.Reader, mimeType string) (string, error)
	GetSASURL(ctx context.Context, purpose SASURLPurpose, query map[string]interface{}) (string, error)
	Exists(ctx context.Context, path string) (bool, error)
}

type BlockTestService interface {
	GetBlockTests(ctx context.Context, blocklistYAML []string, branch string) error
}

type BuildAbortMsg struct {
	BuildID string `json:"build_id"`
}

type Builder interface {
	// GetDriver returns driver for use
	GetDriver(version int, ymlFilePath string) (Driver, error)
}

type Cache struct {
	Key   string   `yaml:"key" validate:"required"`
	Paths []string `yaml:"paths" validate:"required"`
}

type CacheStore interface {
	// Download downloads cache present at cacheKey
	Download(ctx context.Context, cacheKey string) error
	// Upload creates, compresses and uploads cache at cacheKey
	Upload(ctx context.Context, cacheKey string, itemsToCompress ...string) error
	// CacheWorkspace caches the workspace onto a mounted volume
	CacheWorkspace(ctx context.Context, subModule string) error
	// ExtractWorkspace extracts the workspace cache from mounted volume
	ExtractWorkspace(ctx context.Context, subModule string) error
}

type CommandType string

type CommitChangeList struct {
	Sha      string   `json:"Sha"`
	Link     string   `json:"Link"`
	Added    []string `json:"added"`
	Removed  []string `json:"removed"`
	Modified []string `json:"modified"`
	Message  string   `json:"message"`
}

type ContainerImageConfig struct {
	AuthRegistry string
	Image        string
	Mode         config.ModeType
	PullPolicy   config.PullPolicyType
}

type ContainerStatus struct {
	Done  bool
	Error errs.Err
}

type CoverageManifest struct {
	Removedfiles      []string           `json:"removed_files"`
	AllFilesExecuted  bool               `json:"all_files_executed"`
	CoverageThreshold *CoverageThreshold `json:"coverage_threshold,omitempty"`
}

type CoverageService interface {
	MergeAndUpload(ctx context.Context, payload *Payload) error
}

type CoverageThreshold struct {
	Branches   float64 `yaml:"branches" json:"branches" validate:"number,min=0,max=100"`
	Lines      float64 `yaml:"lines" json:"lines" validate:"number,min=0,max=100"`
	Functions  float64 `yaml:"functions" json:"functions" validate:"number,min=0,max=100"`
	Statements float64 `yaml:"statements" json:"statements" validate:"number,min=0,max=100"`
	PerFile    bool    `yaml:"perFile" json:"perFile"`
}

type DiffManager interface {
	GetChangedFiles(ctx context.Context, payload *Payload, oauth *Oauth) (map[string]int, error)
}

type DiscoveryResult struct {
	Tests           []TestPayload      `json:"tests"`
	ImpactedTests   []string           `json:"impactedTests"`
	TestSuites      []TestSuitePayload `json:"testSuites"`
	ExecuteAllTests bool               `json:"executeAllTests"`
	Parallelism     int                `json:"parallelism"`
	SplitMode       SplitMode          `json:"splitMode"`
	RepoID          string             `json:"repoID"`
	BuildID         string             `json:"buildID"`
	CommitID        string             `json:"commitID"`
	TaskID          string             `json:"taskID"`
	OrgID           string             `json:"orgID"`
	Branch          string             `json:"branch"`
	SubModule       string             `json:"subModule"`
}

type DiscoveyArgs struct {
	TestPattern      []string
	Payload          *Payload
	EnvMap           map[string]string
	SecretData       map[string]string
	TestConfigFile   string
	FrameWork        string
	SmartRun         bool
	Diff             map[string]int
	DiffExists       bool
	FrameWorkVersion int
	CWD              string
}

type DockerRunner interface {
	// Creates the execution enging
	Create(context.Context, *RunnerOptions) ContainerStatus

	// Run runs the execution engine
	Run(context.Context, *RunnerOptions) ContainerStatus

	// WaitForRunning waits for runner to get completed
	WaitForCompletion(ctx context.Context, r *RunnerOptions) error

	// Destroy the execution engine
	Destroy(ctx context.Context, r *RunnerOptions) error

	// GetInfo will get resources details of the infra
	GetInfo(context.Context) (float32, int64)

	// Initiate runs docker containers
	Initiate(context.Context, *RunnerOptions, chan ContainerStatus)

	// PullImage will pull image from remote
	PullImage(containerImageConfig *ContainerImageConfig, r *RunnerOptions) error

	// KillRunningDocker kills  container spawn by synapse
	KillRunningDocker(ctx context.Context)

	// KillContainerForBuildID kills synapse container which is running for given buildID
	KillContainerForBuildID(buildID string) error

	CreateVolume(ctx context.Context, r *RunnerOptions) error

	// RemoveOldVolumes removes volumes that are older than X hours
	RemoveOldVolumes(ctx context.Context)

	// CopyFileToContainer copies content to container in file
	CopyFileToContainer(ctx context.Context, path, fileName, containerID string, content []byte) error

	// FindVolumes checks if docker volume is available
	FindVolumes(volumeName string) (bool, error)

	// RemoveVolume removes volume
	RemoveVolume(ctx context.Context, volumeName string) error
}

type Driver interface {
	// RunDiscovery runs the test discovery
	RunDiscovery(ctx context.Context, payload *Payload,
		taskPayload *TaskPayload, oauth *Oauth, coverageDir string, secretMap map[string]string) error
	// RunExecution runs the test execution
	RunExecution(ctx context.Context, payload *Payload,
		taskPayload *TaskPayload, oauth *Oauth, coverageDir string, secretMap map[string]string) error
}

type EventType string

type ExecutionID string

type ExecutionManager interface {
	// ExecuteUserCommands executes the preRun or postRun commands given by user in his yaml.
	ExecuteUserCommands(ctx context.Context,
		commandType CommandType,
		payload *Payload,
		runConfig *Run,
		secretData map[string]string,
		logwriter LogWriterStrategy,
		cwd string) error

	// ExecuteInternalCommands executes the commands like installing runners and test discovery.
	ExecuteInternalCommands(ctx context.Context,
		commandType CommandType,
		commands []string,
		cwd string, envMap,
		secretData map[string]string) error
	// GetEnvVariables get the environment variables from the env map given by user.
	GetEnvVariables(envMap, secretData map[string]string) ([]string, error)
}

type ExecutionResult struct {
	TestPayload      []TestPayload      `json:"testResults"`
	TestSuitePayload []TestSuitePayload `json:"testSuiteResults"`
}

type ExecutionResults struct {
	TaskID   string            `json:"taskID"`
	BuildID  string            `json:"buildID"`
	RepoID   string            `json:"repoID"`
	OrgID    string            `json:"orgID"`
	CommitID string            `json:"commitID"`
	TaskType TaskType          `json:"taskType"`
	Results  []ExecutionResult `json:"results"`
}

type GitManager interface {
	// Clone repository from TAS config
	Clone(ctx context.Context, payload *Payload, oauth *Oauth) error
	// DownloadFileByCommit download file from repo for given commit
	DownloadFileByCommit(ctx context.Context, gitProvider, repoSlug, commitID, filePath string, oauth *Oauth) (string, error)
}

type JobInfo struct {
	Status  StatusType `json:"status"`
	JobID   string     `json:"job_id"`
	ID      string     `json:"id"`
	Mode    string     `json:"mode"`
	BuildID string     `json:"build_id"`
	Message string     `json:"message"`
}

type ListSubModuleService interface {
	// Send sends count of submodules to TAS server
	Send(ctx context.Context, buildID string, totalSubmodule int) error
}

type LogWriterStrategy interface {
	// Write reads data from io.Reader and write it to various data stream
	Write(ctx context.Context, reader io.Reader) <-chan error
}

type LoginDetails struct {
	Name           string  `json:"name"`
	SynapseID      string  `json:"synapse_id"`
	SecretKey      string  `json:"secret_key"`
	CPU            float32 `json:"cpu"`
	RAM            int64   `json:"ram"`
	SynapseVersion string  `json:"synapse_version"`
}

type Merge struct {
	Patterns []string          `yaml:"pattern" validate:"required,gt=0"`
	EnvMap   map[string]string `yaml:"env" validate:"omitempty,gt=0"`
}

type MergeV2 struct {
	PreRun     *Run              `yaml:"preRun" validate:"omitempty"`
	SubModules []SubModule       `yaml:"subModules" validate:"required,gt=0"`
	EnvMap     map[string]string `yaml:"env" validate:"omitempty,gt=0"`
}

type Message struct {
	Type    MessageType `json:"type"`
	Content []byte      `json:"content"`
	Success bool        `json:"success"`
}

type MessageType string

type Modifier struct {
	Type   string
	Config string
	Cli    string
}

type NotifMessage struct {
	Type   string
	Value  string
	Status string
	Error  string
}

type Oauth struct {
	AccessToken  string    `json:"access_token"`
	Expiry       time.Time `json:"expiry"`
	RefreshToken string    `json:"refresh_token"`
	Type         TokenType `json:"token_type,omitempty"`
}

type Payload struct {
	RepoSlug                   string             `json:"repo_slug"`
	ForkSlug                   string             `json:"fork_slug"`
	RepoLink                   string             `json:"repo_link"`
	BuildTargetCommit          string             `json:"build_target_commit"`
	BuildBaseCommit            string             `json:"build_base_commit"`
	TaskID                     string             `json:"task_id"`
	BranchName                 string             `json:"branch_name"`
	BuildID                    string             `json:"build_id"`
	RepoID                     string             `json:"repo_id"`
	OrgID                      string             `json:"org_id"`
	GitProvider                string             `json:"git_provider"`
	PrivateRepo                bool               `json:"private_repo"`
	EventType                  EventType          `json:"event_type"`
	Diff                       string             `json:"diff_url"`
	PullRequestNumber          int                `json:"pull_request_number"`
	Commits                    []CommitChangeList `json:"commits"`
	TasFileName                string             `json:"tas_file_name"`
	Locators                   string             `json:"locators"`
	LocatorAddress             string             `json:"locator_address"`
	ParentCommitCoverageExists bool               `json:"parent_commit_coverage_exists"`
	LicenseTier                Tier               `json:"license_tier"`
	CollectCoverage            bool               `json:"collect_coverage"`
	TaskType                   TaskType           `json:"-"`
}

type PayloadManager interface {
	// ValidatePayload validates the nucleus payload
	ValidatePayload(ctx context.Context, payload *Payload) error
	// FetchPayload used for fetching the payload used for running nucleus
	FetchPayload(ctx context.Context, payloadAddress string) (*Payload, error)
}

type Pipeline struct {
	Cfg                  *config.NucleusConfig
	Payload              *Payload
	Logger               lumber.Logger
	PayloadManager       PayloadManager
	TASConfigManager     TASConfigManager
	GitManager           GitManager
	ExecutionManager     ExecutionManager
	DiffManager          DiffManager
	CacheStore           CacheStore
	TestDiscoveryService TestDiscoveryService
	BlockTestService     BlockTestService
	TestExecutionService TestExecutionService
	CoverageService      CoverageService
	TestStats            TestStats
	Task                 Task
	SecretParser         SecretParser
	Builder              Builder
}

type PodType string

type PostMergeStrategyName string

type Requests interface {
	// MakeAPIRequest makes an HTTP request with auth
	MakeAPIRequest(ctx context.Context, httpMethod, endpoint string, body []byte, params map[string]interface{},
		headers map[string]string) (rawbody []byte, statusCode int, err error)
}

type ResourceStats struct {
	Status StatType `json:"status"`
	CPU    float32  `json:"cpu"`
	RAM    int64    `json:"ram"`
}

type Run struct {
	Commands []string          `yaml:"command" validate:"omitempty,gt=0"`
	EnvMap   map[string]string `yaml:"env" validate:"omitempty,gt=0"`
}

type RunnerOptions struct {
	ContainerID       string            `json:"container_id"`
	DockerImage       string            `json:"docker_image"`
	ContainerPort     int               `json:"container_port"`
	HostPort          int               `json:"host_port"`
	Label             map[string]string `json:"label"`
	NameSpace         string            `json:"name_space"`
	ServiceAccount    string            `json:"service_account"`
	PodName           string            `json:"pod_name"`
	ContainerName     string            `json:"container_name"`
	ContainerArgs     []string          `json:"container_args"`
	ContainerCommands []string          `json:"container_commands"`
	HostVolumePath    string            `json:"host_volume_path"`
	Env               []string          `json:"env"`
	OrgID             string            `json:"org_id"`
	Vault             *VaultOpts        `json:"vault"`
	LogfilePath       string            `json:"logfile_path"`
	PodType           PodType           `json:"pod_type"`
	Tier              Tier              `json:"tier"`
}

type SASURLPurpose string

type Secret map[string]string

type SecretParser interface {
	// GetOauthSecret parses the oauth secret for given path
	GetOauthSecret(filepath string) (*Oauth, error)
	// GetRepoSecret parses the repo secret for given path
	GetRepoSecret(string) (map[string]string, error)
	// SubstituteSecret replace secret placeholders with their respective values
	SubstituteSecret(command string, secretData map[string]string) (string, error)
	// Expired reports whether the token is expired.
	Expired(token *Oauth) bool
}

type SecretsManager interface {
	// GetLambdatestSecrets returns lambdatest config
	GetLambdatestSecrets() *config.LambdatestConfig

	// GetDockerSecrets returns Mode , RegistryAuth, and URL for pulling remote docker image
	GetDockerSecrets(r *RunnerOptions) (ContainerImageConfig, error)

	// GetSynapseName returns synapse name mentioned in config
	GetSynapseName() string
	// GetOauthToken returns oauth token
	GetOauthToken() *Oauth

	// GetGitSecretBytes get git secrets in bytes
	GetGitSecretBytes() ([]byte, error)

	// GetRepoSecretBytes get repo secrets in bytes
	GetRepoSecretBytes(repo string) ([]byte, error)
}

type Specs struct {
	CPU float32
	RAM int64
}

type SplitMode string

type Stability struct {
	ConsecutiveRuns int `yaml:"consecutive_runs"`
}

type StatType string

type Status string

type StatusType string

type SubModule struct {
	Name               string   `yaml:"name" validate:"required"`
	Path               string   `yaml:"path" validate:"required"`
	Patterns           []string `yaml:"pattern" validate:"required,gt=0"`
	Framework          string   `yaml:"framework" validate:"required,oneof=jest mocha jasmine"`
	Blocklist          []string `yaml:"blocklist"`
	Prerun             *Run     `yaml:"preRun" validate:"omitempty"`
	Postrun            *Run     `yaml:"postRun" validate:"omitempty"`
	RunPrerunEveryTime bool     `yaml:"runPreRunEveryTime"`
	Parallelism        int      `yaml:"parallelism"` // TODO: will be supported later
	ConfigFile         string   `yaml:"configFile" validate:"omitempty"`
}

type SubModuleList struct {
	BuildID        string `json:"buildID"`
	TotalSubModule int    `json:"totalSubModule"`
}

type SynapseManager interface {
	// InitiateConnection initiates the connection with LT cloud
	InitiateConnection(ctx context.Context, wg *sync.WaitGroup, connectionFailed chan struct{})
}

type TASConfig struct {
	SmartRun          bool               `yaml:"smartRun"`
	Framework         string             `yaml:"framework" validate:"required,oneof=jest mocha jasmine golang junit"`
	Blocklist         []string           `yaml:"blocklist"`
	Postmerge         *Merge             `yaml:"postMerge" validate:"omitempty"`
	Premerge          *Merge             `yaml:"preMerge" validate:"omitempty"`
	Cache             *Cache             `yaml:"cache" validate:"omitempty"`
	Prerun            *Run               `yaml:"preRun" validate:"omitempty"`
	Postrun           *Run               `yaml:"postRun" validate:"omitempty"`
	Parallelism       int                `yaml:"parallelism"`
	SplitMode         SplitMode          `yaml:"splitMode" validate:"oneof=test file"`
	SkipCache         bool               `yaml:"skipCache"`
	ConfigFile        string             `yaml:"configFile" validate:"omitempty"`
	CoverageThreshold *CoverageThreshold `yaml:"coverageThreshold" validate:"omitempty"`
	Tier              Tier               `yaml:"tier" validate:"oneof=xsmall small medium large xlarge"`
	NodeVersion       string             `yaml:"nodeVersion" validate:"omitempty,semver"`
	ContainerImage    string             `yaml:"containerImage"`
	FrameworkVersion  int                `yaml:"frameworkVersion" validate:"omitempty"`
	Version           string             `yaml:"version" validate:"required"`
}

type TASConfigDownloaderOutput struct {
	Version   int         `json:"version"`
	TASConfig interface{} `json:"tasConfig"`
}

type TASConfigManager interface {
	// LoadAndValidate loads and returns the tas config
	LoadAndValidate(ctx context.Context, version int, path string, eventType EventType, licenseTier Tier,
		tasFilePathInRepo string) (interface{}, error)

	// GetVersion returns TAS yml version
	GetVersion(path string) (int, error)

	// GetTasConfigFilePath returns file path of tas config
	GetTasConfigFilePath(payload *Payload) (string, error)
}

type TASConfigV2 struct {
	SmartRun          bool               `yaml:"smartRun"`
	Cache             *Cache             `yaml:"cache" validate:"omitempty"`
	Tier              Tier               `yaml:"tier" validate:"oneof=xsmall small medium large xlarge"`
	PostMerge         *MergeV2           `yaml:"postMerge" validate:"omitempty"`
	PreMerge          *MergeV2           `yaml:"preMerge" validate:"omitempty"`
	SkipCache         bool               `yaml:"skipCache"`
	CoverageThreshold *CoverageThreshold `yaml:"coverageThreshold" validate:"omitempty"`
	Parallelism       int                `yaml:"parallelism"` // TODO: will be supported later
	Version           string             `yaml:"version" validate:"required"`
	SplitMode         SplitMode          `yaml:"splitMode" validate:"oneof=test file"`
	ContainerImage    string             `yaml:"containerImage"`
	NodeVersion       string             `yaml:"nodeVersion" validate:"omitempty,semver"`
}

type TasVersion struct {
	Version string `yaml:"version" validate:"required"`
}

type Task interface {
	// UpdateStatus updates status of the task
	UpdateStatus(ctx context.Context, payload *TaskPayload) error
}

type TaskPayload struct {
	TaskID      string    `json:"task_id"`
	Status      Status    `json:"status"`
	RepoSlug    string    `json:"repo_slug"`
	RepoLink    string    `json:"repo_link"`
	RepoID      string    `json:"repo_id"`
	OrgID       string    `json:"org_id"`
	GitProvider string    `json:"git_provider"`
	CommitID    string    `json:"commit_id,omitempty"`
	BuildID     string    `json:"build_id"`
	StartTime   time.Time `json:"start_time"`
	EndTime     time.Time `json:"end_time,omitempty"`
	Remark      string    `json:"remark,omitempty"`
	Type        TaskType  `json:"type"`
}

type TaskType string

type TestDiscoveryService interface {
	// Discover executes the test discovery scripts.
	Discover(ctx context.Context, args *DiscoveyArgs) (*DiscoveryResult, error)

	// SendResult sends discovery result to TAS server
	SendResult(ctx context.Context, testDiscoveryResult *DiscoveryResult) error
}

type TestExecutionArgs struct {
	Payload           *Payload
	CoverageDir       string
	LogWriterStrategy LogWriterStrategy
	TestPattern       []string
	EnvMap            map[string]string
	TestConfigFile    string
	FrameWork         string
	SecretData        map[string]string
	FrameWorkVersion  int
	CWD               string
}

type TestExecutionService interface {
	// Run executes the test execution scripts
	Run(ctx context.Context, testExecutionArgs *TestExecutionArgs) (results *ExecutionResults, err error)
	// SendResults sends the test execution results to the TAS server.
	SendResults(ctx context.Context, payload *ExecutionResults) (resp *TestReportResponsePayload, err error)
}

type TestPayload struct {
	TestID          string             `json:"testID"`
	Detail          string             `json:"_detail"`
	SuiteID         string             `json:"suiteID"`
	Suites          []string           `json:"_suites"`
	Title           string             `json:"title"`
	FullTitle       string             `json:"fullTitle"`
	Name            string             `json:"name"`
	Duration        int                `json:"duration"`
	FilePath        string             `json:"file"`
	Line            string             `json:"line"`
	Col             string             `json:"col"`
	CurrentRetry    int                `json:"currentRetry"`
	Status          string             `json:"status"`
	DAG             []string           `json:"dependsOn"`
	Filelocator     string             `json:"locator"`
	BlocklistSource string             `json:"blocklistSource"`
	Blocklisted     bool               `json:"blocklist"`
	StartTime       time.Time          `json:"start_time"`
	EndTime         time.Time          `json:"end_time"`
	Stats           []TestProcessStats `json:"stats"`
	FailureMessage  string             `json:"failureMessage"`
}

type TestProcessStats struct {
	Memory     uint64    `json:"memory_consumed,omitempty"`
	CPU        float64   `json:"cpu_percentage,omitempty"`
	Storage    uint64    `json:"storage,omitempty"`
	RecordTime time.Time `json:"record_time"`
}

type TestReportResponsePayload struct {
	TaskID     string `json:"taskID"`
	TaskStatus Status `json:"taskStatus"`
	Remark     string `json:"remark,omitempty"`
}

type TestStats interface {
	CaptureTestStats(pid int32, collectStats bool) error
}

type TestStatus string

type TestSuitePayload struct {
	SuiteID         string             `json:"suiteID"`
	SuiteName       string             `json:"suiteName"`
	ParentSuiteID   string             `json:"parentSuiteID"`
	BlocklistSource string             `json:"blocklistSource"`
	Blocklisted     bool               `json:"blocklist"`
	StartTime       time.Time          `json:"start_time"`
	EndTime         time.Time          `json:"end_time"`
	Duration        int                `json:"duration"`
	Status          string             `json:"status"`
	Stats           []TestProcessStats `json:"stats"`
	TotalTests      int                `json:"totalTests"`
}

type Tier string

type TokenType string

type VaultOpts struct {
	// SecretPath path of the repo secrets.
	SecretPath string
	// TokenPath path of the user token.
	TokenPath string
	// RoleName vault role name
	RoleName string
	// Namespace is the default vault namespace
	Namespace string
}

type VaultSecret struct {
	Secrets Secret `json:"data"`
}

type VolumeDetails struct {
	CreatedAt  time.Time              `json:"CreatedAt,omitempty"`
	Driver     string                 `json:"Driver"`
	Labels     map[string]string      `json:"Labels"`
	Mountpoint string                 `json:"Mountpoint"`
	Name       string                 `json:"Name"`
	Options    map[string]string      `json:"Options"`
	Scope      string                 `json:"Scope"`
	Status     map[string]interface{} `json:"Status,omitempty"`
}

type YMLParsingRequestMessage struct {
	GitProvider string    `json:"gitProvider"`
	CommitID    string    `json:"commitID"`
	Event       EventType `json:"eventType"`
	RepoSlug    string    `json:"repoSlug"`
	TasFileName string    `json:"tasFilePath"`
	LicenseTier Tier      `json:"license_tier"`
	OrgID       string    `json:"orgID"`
	BuildID     string    `json:"buildID"`
}

type YMLParsingResultMessage struct {
	ErrorMsg  string                    `json:"ErrorMsg"`
	OrgID     string                    `json:"orgID"`
	BuildID   string                    `json:"buildID"`
	YMLOutput TASConfigDownloaderOutput `json:"ymlOutput"`
}

type ZstdCompressor interface {
	Compress(ctx context.Context, compressedFileName string, preservePath bool, workingDirectory string, filesToCompress ...string) error
	Decompress(ctx context.Context, filePath string, preservePath bool, workingDirectory string) error
}