README
¶
Results Render Drivers
This directory contains drivers for the results renderer. More drivers can be
added by implementing the render.Driver interface and registering them in
the reader drivers array.
Currently AMPEL supports the following drivers:
attester: Generates an AMPEL ResultSet attestation.tty: The driver that displays results in the terminal screen.html: Renders evaluation results as HTML.markdown: Outputs the evaluation results in markdown.vsa: Renders the results set in a Verification Summary attestation.
The tty, html and markdown drivers share code through the TableBuilder
interface. The results output is handled by a central logic core that builds
a main table and delegates to a decorator to handle the all the
format-specific nuances.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Formats ¶ added in v1.3.4
func Formats() []string
Formats returns the names of the registered rendering drivers
func LoadDefaultDrivers ¶
func LoadDefaultDrivers()
func RegisterDriver ¶
func UnregisterDriver ¶
Types ¶
type Driver ¶
type Driver interface {
RenderResultSet(w io.Writer, status *papi.ResultSet) error
RenderResult(w io.Writer, status *papi.Result) error
RenderResultGroup(w io.Writer, status *papi.ResultGroup) error
}
func GetDriverBytType ¶
type Engine ¶
type Engine struct {
Driver Driver
}
func (*Engine) RenderResult ¶
RenderResult calls the method of the same name of the configured driver
func (*Engine) RenderResultSet ¶
RenderResultSet calls the method of the same name of the configured driver
Source Files
Click to show internal directories.
Click to hide internal directories.