shipshape

Documentation

Overview

Package shipshape provides the basic types and base functions for parsing config, running checks as well as the file & yaml checks.

Index

• Variables
• func FetchConfigData(files []string) ([][]byte, error)
• func Init(projectDir string, configFiles []string, checkTypesToRun []string, ...) error
• func JUnit(w *bufio.Writer)
• func ParseConfigData(configData [][]byte) error
• func ProcessCheck(rl *result.ResultList, c config.Check)
• func ReadAndParseConfig(projectDir string, files []string) error
• func RunChecks()
• func SimpleDisplay(w *bufio.Writer)
• func TableDisplay(w *tabwriter.Writer)
• type JUnitError
• type JUnitTestCase
• type JUnitTestSuite
• type JUnitTestSuites

Variables

var OutputFormats = []string{"json", "junit", "simple", "table"}

var RunConfig config.Config

var RunResultList result.ResultList

Functions

func FetchConfigData

func FetchConfigData(files []string) ([][]byte, error)

func Init

func Init(projectDir string, configFiles []string, checkTypesToRun []string, excludeDb bool, remediate bool, logLevel string, lagoonApiBaseUrl string, lagoonApiToken string) error

func JUnit

func JUnit(w *bufio.Writer)

JUnit outputs the checks results in the JUnit XML format.

func ParseConfigData

func ParseConfigData(configData [][]byte) error

func ProcessCheck

func ProcessCheck(rl *result.ResultList, c config.Check)

func ReadAndParseConfig

func ReadAndParseConfig(projectDir string, files []string) error

func RunChecks

func RunChecks()

func SimpleDisplay

func SimpleDisplay(w *bufio.Writer)

SimpleDisplay outputs only failures to the writer.

func TableDisplay

func TableDisplay(w *tabwriter.Writer)

TableDisplay generates the tabular output for the ResultList.

Types

type JUnitError

type JUnitError struct {
	XMLName xml.Name `xml:"error"`
	Message string   `xml:"message,attr"`
}

type JUnitTestCase

type JUnitTestCase struct {
	XMLName   xml.Name `xml:"testcase"`
	Name      string   `xml:"name,attr"`
	ClassName string   `xml:"classname,attr"`
	Errors    []JUnitError
}

type JUnitTestSuite

type JUnitTestSuite struct {
	XMLName   xml.Name `xml:"testsuite"`
	Name      string   `xml:"name,attr"`
	Tests     int      `xml:"tests,attr"`
	Errors    int      `xml:"errors,attr"`
	TestCases []JUnitTestCase
}

type JUnitTestSuites

type JUnitTestSuites struct {
	XMLName    xml.Name `xml:"testsuites"`
	Tests      uint32   `xml:"tests,attr"`
	Errors     uint32   `xml:"errors,attr"`
	TestSuites []JUnitTestSuite
}

JUnit format taken from https://llg.cubic.org/docs/junit/.