v1alpha1

type AnalisysMetrics struct {
	// Branch store rate metrics for current
	Branch *CodeChangeMetrics `json:"branch"`

	// Target stores target branch data
	// only populated when using a Pull Request
	// +optional
	Target *CodeChangeMetrics `json:"target,omitempty"`

	// Ratings resulted from code scan analysis
	// stores one rating type as an item
	// using the key as unique identifier for the rating type
	Ratings map[string]AnalysisRating `json:"ratings,omitempty"`

	// Languages detected in code base
	// +optional
	Languages []string `json:"languages"`

	// CodeSize based on scanned code base
	CodeSize *CodeSize `json:"codeSize"`
}

type AnalysisRating struct {
	// Rate describe the analysis rate, such as:
	// - A
	// - B
	// - C
	// - D
	// - E
	Rate string `json:"rate"`

	// IssuesCount stores the related issues number
	// for the analyzed metric
	IssuesCount int `json:"issues"`
}

type AnalysisResult struct {
	// Result of the code analysis:
	//  - Succeeded: successful code analysis with passing quality gates
	//  - Failed: failed code analysis
	//  - Canceled: canceled code analysis due to canceled task
	// +optional
	Result string `json:"result,omitempty"`
	// ReportURL for analyzed code revision
	// +optional
	ReportURL string `json:"reportURL,omitempty"`
	// TaskID of the performed analysis
	// +optional
	TaskID string `json:"taskID,omitempty"`
	// ProjectID for code analysis tool
	// +optional
	ProjectID string `json:"projectID,omitempty"`

	// Metrics for code analysis
	Metrics *AnalisysMetrics `json:"metrics,omitempty"`
}

type AutomatedTestResult struct {
	// Total test cases number
	Total int `json:"total"`

	// Passed test cases number
	// +optional
	Passed int `json:"passed"`

	// Failed test cases number
	// +optional
	Failed int `json:"failed"`

	// Error test case number
	// +optional
	Error int `json:"error"`

	// Skipped test cases number
	// +optional
	Skipped int `json:"skipped"`

	// PassedTestsRate rate of passed tests
	// calculated using  passed / (passed + failed + error) * 100
	// +optional
	PassedTestsRate float64 `json:"passedTestsRate,omitempty"`
}

type CodeChangeMetrics struct {
	// CoverageRate by tests during code analysis
	// +optional
	CoverageRate CodeChangeRates `json:"coverage"`

	// DuplicationRate discovered during code analysis
	// +optional
	DuplicationRate CodeChangeRates `json:"duplications"`
}

type CodeChangeRates struct {
	// New code rate
	// calculated for new code only
	// +optional
	New string `json:"new"`
	// Total code rate
	// measured over existing code
	Total string `json:"total"`
}

type CodeLintIssues struct {

	// Count the number of detected issues
	Count int `json:"count"`
}

type CodeLintResult struct {
	// Result for the linting process
	//  - Succeeded: successful code linting with passing quality gates
	//  - Failed: failed code linting
	//  - Canceled: canceled code linting due to canceled task
	Result string `json:"result"`

	// Issues found during linting process
	// +optional
	Issues *CodeLintIssues `json:"issues,omitempty"`
}

type CodeSize struct {
	// LinesOfCode inside the project
	LinesOfCode int `json:"linesOfCode"`
}

type NamedAnalysisResult struct {
	// Name of a specific analsysis result
	Name string `json:"name,omitempty"`

	AnalysisResult `json:",inline"`
}

type NamedAnalysisResults []NamedAnalysisResult

type NamedAutomatedTestResults struct {
	// Name of a specific unit tests result
	Name string `json:"name,omitempty"`

	AutomatedTestResult `json:",inline"`
}

type NamedCodeLintResult struct {
	// Name of a specific lint result
	Name string `json:"name,omitempty"`

	CodeLintResult `json:",inline"`
}

type NamedCodeLintResults []NamedCodeLintResult

type NamedUnitTestsResult struct {
	// Name of a specific unit tests result
	Name string `json:"name,omitempty"`

	UnitTestsResult `json:",inline"`
}

type NamedUnitTestsResults []NamedUnitTestsResult

type ReportFile struct {
	// ContentType for content type
	ContentType string `json:"contentType"`
	// Key for file key returned from katanomi-data server
	Key string `json:"key"`
}

type TestCoverage struct {
	// Lines represent unit test coverage on lines
	Lines string `json:"lines,omitempty"`

	// Branches stores code branch coverage rate
	// valid value range is 0 to 100
	Branches string `json:"branches,omitempty"`
}

type TestResult struct {
	// Passed test cases number
	// +optional
	Passed int `json:"passed"`

	// Skipped test cases number
	// +optional
	Skipped int `json:"skipped"`

	// Failed test cases number
	// adds on any errored test cases
	// +optional
	Failed int `json:"failed"`

	// PassedTestsRate rate of passed tests
	// calculated using  passed / (passed + failed) * 100
	// +optional
	PassedTestsRate string `json:"passedTestsRate"`

	// ReportFiles are collection of report file object from storage plugin
	// +optional
	ReportFiles []ReportFile `json:"reportFiles"`
}

type UnitTestsResult struct {
	// Type identifies the type of 'unitedTest' related results reusing UnitTestsResult.
	// +optional
	Type string `json:"type,omitempty"`

	// Coverage represent unit test coverage of current build
	Coverage *TestCoverage `json:"coverage"`

	// TestResults stores a summary with the number of
	// test cases  that passed, where skipped or failed.
	// +optional
	TestResult *TestResult `json:"testResults,omitempty"`
}