output

Documentation

Overview

Package output renders a run's Result as terminal text, markdown (in the ops-report style: problems first, full table after) or JSON.

Index

• func JSON(res engine.Result) (string, error)
• func JUnit(res engine.Result, suite string) (string, error)
• func Markdown(res engine.Result, title string) string
• func Prometheus(res engine.Result) string
• func Slack(res engine.Result, title string) (string, error)
• func Text(res engine.Result) string

Functions

func JSON

func JSON(res engine.Result) (string, error)

JSON renders the machine-readable result.

func JUnit

func JUnit(res engine.Result, suite string) (string, error)

JUnit renders a run as a JUnit XML report: one testcase per finding, a <failure> for BAD, an <error> for ERROR, and a passing testcase (with a <system-out> note for WARN) otherwise. Suitable for a CI test tab.

func Markdown

func Markdown(res engine.Result, title string) string

Markdown renders an ops-style report: summary, problems, full table.

func Prometheus

func Prometheus(res engine.Result) string

Prometheus renders a run in the Prometheus text exposition format.

One gauge per (check,target) carries the finding severity (0=OK,1=WARN,2=BAD,3=ERROR); if a (check,target) pair appears more than once the worst severity wins, so the series stays unique. Roll-up gauges expose the per-status counts, the overall worst, the run duration and its time.

func Slack

func Slack(res engine.Result, title string) (string, error)

Slack renders a run as a Slack Block Kit message (JSON) for an incoming webhook: a header, the summary line, then the non-OK findings (worst first, the Result is pre-sorted), capped to keep the message readable.

func Text

func Text(res engine.Result) string

Text renders for the terminal: worst findings first (Result is pre-sorted).