lib

type AppConfig struct {
	// The output format to use
	Format string `json:"format" yaml:"format" xml:"format"`
	// Whether to build a full report or summary
	Level string `json:"level" yaml:"level" xml:"level"`
	// The file or directory path to write the output to
	Output string `json:"output" yaml:"output" xml:"output"`
	// The input coverage file from `go test -coverprofile`
	Input []string `json:"input" yaml:"input" xml:"input"`
	// The source code folder location on disk
	SourceDir string `json:"source" yaml:"source" xml:"source"`
	// The display name of the package
	ProjectName string `json:"ProjectName" yaml:"ProjectName" xml:"ProjectName"`
}

type AppError struct {
	Message string `json:"message" yaml:"message" xml:"message"`
	Code    int    `json:"code" yaml:"code" xml:"code"`
}

type PathTuple struct {
	// The displayable name for this path
	Name string `json:"name"`
	// The navigable path for this path
	Path string `json:"path"`
}

type ReportContainer interface {
	// AddFolder adds a ReportedFolder to the container
	AddFolder(rf *ReportedFolder)
	// ContainsFolder returns true, and a pointer to ReportedFolder if the container contains a ReportedFolder with the given path
	ContainsFolder(folderPath string) (*ReportedFolder, bool)
	// AddFile adds a ReportedFile to the container
	AddFile(rf *ReportedFile)
	// ContainsFile returns true, and a pointer to ReportedFile if the container contains a ReportedFile with the given path
	ContainsFile(filePath string) (*ReportedFile, bool)
	// Updates the roll-up coverage value for the container and all children
	UpdateCoverage()
}

type ReportContext struct {
	// The application configuration
	Config AppConfig `json:"config" yaml:"config" xml:"config"`
	// The associated metadata for the report
	Meta ReportMeta `json:"meta" yaml:"meta" xml:"meta"`
	// All reported files from the coverage report
	ReportedFiles []*ReportedFile `json:"reportedFiles" yaml:"reportedFiles" xml:"reportedFiles"`
	// ReportedFolders is an array of ReportedFolder entries, each containing at least one reported file
	ReportedFolders []*ReportedFolder `json:"reportedFolders" yaml:"reportedFolders" xml:"reportedFolders"`
	// Whether this is a full report or summary
	IsFullReport bool `json:"isFullReport" yaml:"isFullReport" xml:"isFullReport"`
	// The file or directory path where the output will be written
	Output string `json:"output" yaml:"output" xml:"output"`
	// The coverage percentage for the entire report
	CoveredPct float64 `json:"coveredPct" yaml:"coveredPct" xml:"coveredPct"`
}

type ReportMeta struct {
	// The display name of the package
	ProjectName string `json:"ProjectName" yaml:"ProjectName" xml:"ProjectName"`
	// The common root directory path for all reported files
	CommonRoot string `json:"commonRoot" yaml:"commonRoot" xml:"commonRoot"`
	// The parent of the CommonRoot directory path
	ParentRoot string `json:"parentRoot" yaml:"parentRoot" xml:"parentRoot"`
}

type ReportedBlock struct {
	// The start line number for this block
	StartLine int `json:"start"`
	// The start column number for this block
	StartCol int `json:"startCol"`
	// The stop line number for this block
	StopLine int `json:"stop"`
	// The stop column number for this block
	StopCol int `json:"stopCol"`
	// Whether or not this block is covered
	Covered bool `json:"covered"`
}

type ReportedFile struct {
	// The associated metadata for the report
	Meta ReportMeta `json:"meta" yaml:"meta" xml:"meta"`
	// The resolved source file for this coverage profile
	SourceFile string `json:"sourceFile" yaml:"sourceFile" xml:"sourceFile"`
	// The reported lines, covered an uncovered for this file
	ReportedLines []ReportedBlock `json:"reportedLines" yaml:"reportedLines" xml:"reportedLines"`
	// The reported lines that are covered for this file
	CoveredLines []ReportedBlock `json:"coveredLines" yaml:"coveredLines" xml:"coveredLines"`
	// A map of the path parts for this file, the key is displayable and the value is navigable
	PathParts []PathTuple `json:"pathParts" yaml:"pathParts" xml:"pathParts"`
	// The display path for this file
	DisplayPath string `json:"displayPath" yaml:"displayPath" xml:"displayPath"`
	// The output file path for this file with a '.out' extension
	OutFilePath string `json:"outFilePath" yaml:"outFilePath" xml:"outFilePath"`
	// The file name for this file
	FileName string `json:"fileName" yaml:"fileName" xml:"fileName"`
	// The source code for this file
	SourceCode string `json:"sourceCode" yaml:"sourceCode" xml:"sourceCode"`

	// The relative path to the assets folder from this file
	AssetsPath string `json:"assetsPath" yaml:"assetsPath" xml:"assetsPath"`
	// The percentage of coverage for this file
	CoveredPct float64 `json:"coveredPct" yaml:"coveredPct" xml:"coveredPct"`
	// The coverage profile for this file
	Profile *cover.Profile `json:"-" yaml:"-" xml:"-"`
	// contains filtered or unexported fields
}

type ReportedFolder struct {
	// The associated metadata for the report
	Meta ReportMeta `json:"meta" yaml:"meta" xml:"meta"`
	// The reported files for this folder
	ReportedFiles []*ReportedFile `json:"sourceFiles" yaml:"sourceFiles" xml:"sourceFiles"`
	// The reported subfolder for this folder
	ReportedFolders []*ReportedFolder `json:"reportedFolders" yaml:"reportedFolders" xml:"reportedFolders"`
	// The resolved folder path for this folder
	FolderPath string `json:"folderPath" yaml:"folderPath" xml:"folderPath"`
	// The name for this folder
	FolderName string `json:"folderName" yaml:"folderName" xml:"folderName"`
	// The path parts for this folder
	PathParts []PathTuple `json:"pathParts" yaml:"pathParts" xml:"pathParts"`
	// The display path for this folder
	DisplayPath string `json:"displayPath" yaml:"displayPath" xml:"displayPath"`
	// The output file path for this folder
	OutFilePath string `json:"outFilePath" yaml:"outFilePath" xml:"outFilePath"`
	// The relative path to the assets folder from this folder
	AssetsPath string `json:"assetsPath" yaml:"assetsPath" xml:"assetsPath"`
	// The roll-up percentage of coverage for the files in this folder
	CoveredPct float64 `json:"coveredPct" yaml:"coveredPct" xml:"coveredPct"`
}