report

Documentation

Index

• Constants
• func AllRequestTracesContent(id string, logs []paltypes.RequestTrace) string
• func CleanupAllRequestTracesContent(id string, logs []paltypes.RequestTrace) string
• func CleanupErrorMarkdownReport(report types.Error, logs []paltypes.RequestTrace) string
• func CleanupMarkdownReport(passReport types.PassReport) string
• func DiffMarkdownReport(report types.Diff, logs []paltypes.RequestTrace) string
• func DiffMessageDescription(diff types.Change) string
• func DiffMessageMarkdown(diff types.Change) string
• func DiffMessageReadable(diff types.Change) string
• func DiffMessageTerraform(diff types.Change) string
• func ErrorMarkdownReport(report types.Error, logs []paltypes.RequestTrace) string
• func GenerateApiTestReports(wd string, swaggerPath string) error
• func HttpRequestToString(r *paltypes.HttpRequest) string
• func HttpResponseToString(r *paltypes.HttpResponse) string
• func IsUrlMatchWithId(url string, id string) bool
• func PassedMarkdownReport(passReport types.PassReport, coverageReport coverage.CoverageReport) string
• func RequestTraceToString(r paltypes.RequestTrace) string
• func RequestTracesContent(id string, logs []paltypes.RequestTrace) string
• type ApiTestConfig
• type ApiTestReport
  • func OavValidateTraffic(traceDir string, swaggerPath string, outputDir string) (*ApiTestReport, error)
• type ErrorItem
• type Suppression
• type UnCoveredOperations

Constants

const (
	TestReportDirName     = "ArmstrongReport"
	TraceLogDirName       = "traces"
	ApiTestReportFileName = "SwaggerAccuracyReport"
	ApiTestConfigFileName = "ApiTestConfig.json"
)

Functions

func AllRequestTracesContent

func AllRequestTracesContent(id string, logs []paltypes.RequestTrace) string

func CleanupAllRequestTracesContent

func CleanupAllRequestTracesContent(id string, logs []paltypes.RequestTrace) string

func CleanupErrorMarkdownReport

func CleanupErrorMarkdownReport(report types.Error, logs []paltypes.RequestTrace) string

func CleanupMarkdownReport

func CleanupMarkdownReport(passReport types.PassReport) string

func DiffMarkdownReport

func DiffMarkdownReport(report types.Diff, logs []paltypes.RequestTrace) string

func DiffMessageDescription

func DiffMessageDescription(diff types.Change) string

func DiffMessageMarkdown

func DiffMessageMarkdown(diff types.Change) string

func DiffMessageReadable

func DiffMessageReadable(diff types.Change) string

func DiffMessageTerraform

func DiffMessageTerraform(diff types.Change) string

func ErrorMarkdownReport

func ErrorMarkdownReport(report types.Error, logs []paltypes.RequestTrace) string

func GenerateApiTestReports

func GenerateApiTestReports(wd string, swaggerPath string) error

func HttpRequestToString

func HttpRequestToString(r *paltypes.HttpRequest) string

func HttpResponseToString

func HttpResponseToString(r *paltypes.HttpResponse) string

func IsUrlMatchWithId

func IsUrlMatchWithId(url string, id string) bool

func PassedMarkdownReport

func PassedMarkdownReport(passReport types.PassReport, coverageReport coverage.CoverageReport) string

func RequestTraceToString

func RequestTraceToString(r paltypes.RequestTrace) string

func RequestTracesContent

func RequestTracesContent(id string, logs []paltypes.RequestTrace) string

Types

type ApiTestConfig

type ApiTestConfig struct {
	SuppressionList []Suppression `json:"suppressionList"`
}

type ApiTestReport

type ApiTestReport struct {
	CoveredSpecFiles        []string              `json:"coveredSpecFiles"`
	UnCoveredOperationsList []UnCoveredOperations `json:"unCoveredOperationsList"`
	Errors                  []ErrorItem           `json:"errors"`
}

func OavValidateTraffic

func OavValidateTraffic(traceDir string, swaggerPath string, outputDir string) (*ApiTestReport, error)

type ErrorItem

type ErrorItem struct {
	Spec                   string `json:"spec"`
	ErrorCode              string `json:"errorCode"`
	ErrorLink              string `json:"errorLink"`
	ErrorMessage           string `json:"errorMessage"`
	OperationId            string `json:"operationId"`
	SchemaPathWithPosition string `json:"schemaPathWithPosition"`
}

type Suppression

type Suppression struct {
	Code      string `json:"rule"`
	File      string `json:"file"`
	Operation string `json:"operation"`
	Reason    string `json:"reason"`
}

type UnCoveredOperations

type UnCoveredOperations struct {
	Spec         string   `json:"spec"`
	OperationIds []string `json:"operationIds"`
}