report

Documentation

Index

• func ReportFromFilePath(filePath string) (metrics.ValidationReport, error)
• func SaveReports(run metrics.ValidationReport, jsonPath, htmlPath string) error
• type HTMLReportGenerator
  • func (h *HTMLReportGenerator) GenerateAlertNotification(run metrics.ValidationReport) ([]byte, error)
  • func (h *HTMLReportGenerator) GenerateValidationReport(run metrics.ValidationReport) ([]byte, error)
  • func (h *HTMLReportGenerator) ReportFromFilePath(path string) (metrics.ValidationReport, error)
  • func (h *HTMLReportGenerator) SaveReportToFile(run metrics.ValidationReport, filePath string) error
• type JSONReportGenerator
  • func (j *JSONReportGenerator) GenerateAlertNotification(run metrics.ValidationReport) ([]byte, error)
  • func (j *JSONReportGenerator) GenerateValidationReport(run metrics.ValidationReport) ([]byte, error)
  • func (j *JSONReportGenerator) ReportFromFilePath(path string) (metrics.ValidationReport, error)
  • func (j *JSONReportGenerator) SaveReportToFile(run metrics.ValidationReport, filePath string) error
• type ReportGenerator

Functions

func ReportFromFilePath

func ReportFromFilePath(filePath string) (metrics.ValidationReport, error)

func SaveReports

func SaveReports(run metrics.ValidationReport, jsonPath, htmlPath string) error

SaveReports saves both JSON and HTML reports.

Types

type HTMLReportGenerator

type HTMLReportGenerator struct{}

HTMLReportGenerator generates HTML reports.

func (*HTMLReportGenerator) GenerateAlertNotification

func (h *HTMLReportGenerator) GenerateAlertNotification(run metrics.ValidationReport) ([]byte, error)

GenerateAlertNotification generates an HTML alert.

func (*HTMLReportGenerator) GenerateValidationReport

func (h *HTMLReportGenerator) GenerateValidationReport(run metrics.ValidationReport) ([]byte, error)

GenerateValidationReport generates an HTML report from the validation run.

func (*HTMLReportGenerator) ReportFromFilePath

func (h *HTMLReportGenerator) ReportFromFilePath(path string) (metrics.ValidationReport, error)

ReportFromFilePath loads and generates a report from a file

func (*HTMLReportGenerator) SaveReportToFile

func (h *HTMLReportGenerator) SaveReportToFile(run metrics.ValidationReport, filePath string) error

SaveReportToFile saves the HTML report to a file.

type JSONReportGenerator

type JSONReportGenerator struct{}

JSONReportGenerator generates JSON reports.

func (*JSONReportGenerator) GenerateAlertNotification

func (j *JSONReportGenerator) GenerateAlertNotification(run metrics.ValidationReport) ([]byte, error)

GenerateAlertNotification generates an alert message in JSON format.

func (*JSONReportGenerator) GenerateValidationReport

func (j *JSONReportGenerator) GenerateValidationReport(run metrics.ValidationReport) ([]byte, error)

GenerateValidationReport serializes the ValidationReport to JSON.

func (*JSONReportGenerator) ReportFromFilePath

func (j *JSONReportGenerator) ReportFromFilePath(path string) (metrics.ValidationReport, error)

ReportFromFilePath loads and generates a report from a file

func (*JSONReportGenerator) SaveReportToFile

func (j *JSONReportGenerator) SaveReportToFile(run metrics.ValidationReport, filePath string) error

SaveReportToFile saves the JSON report to a file.

type ReportGenerator

type ReportGenerator interface {
	GenerateValidationReport(run metrics.ValidationReport) ([]byte, error)
	GenerateAlertNotification(run metrics.ValidationReport) ([]byte, error)
	SaveReportToFile(run metrics.ValidationReport, filePath string) error
	ReportFromFilePath(filePath string) (metrics.ValidationReport, error)
}

ReportGenerator defines the methods for generating reports.