lib

Documentation

Index

• func CheckClose(v interface{})
• func FindFiles(fs FileSystem, root string, re string) ([]string, error)
• func SummaryBuilder(conftestResults ConftestResults) (string, string)
• func UnZip(source string, destination string) error
• type ConftestResults
  • func Scan(fs FileSystem, rootPath string, policyID string, files []string) ConftestResults
• type File
• type FileSystem
• type HTTPClient
  • func NewHTTPClient(http *http.Client, url string) *HTTPClient
  • func (c *HTTPClient) DownloadFile(fs FileSystem) (string, error)
• type OSFS
  • func (OSFS) Copy(dst io.Writer, src io.Reader) (int64, error)
  • func (OSFS) Create(name string) (File, error)
  • func (OSFS) NewFile(fd uintptr, name string) File
  • func (OSFS) Open(name string) (File, error)
  • func (OSFS) ReadFile(filename string) ([]byte, error)
  • func (OSFS) Remove(name string) error
  • func (OSFS) RemoveAll(name string) error
  • func (OSFS) Stat(name string) (os.FileInfo, error)
  • func (OSFS) Walk(root string, walkFn filepath.WalkFunc) error
  • func (OSFS) WriteFile(filename string, data []byte, perm os.FileMode) error

Functions

func CheckClose

func CheckClose(v interface{})

CheckClose safe closing for defer

func FindFiles

func FindFiles(fs FileSystem, root string, re string) ([]string, error)

FindFiles - Recursively search for files matching a pattern.

func SummaryBuilder

func SummaryBuilder(conftestResults ConftestResults) (string, string)

SummaryBuilder - Builds the summary for the check run.

func UnZip

func UnZip(source string, destination string) error

UnZip - Extracts a zip archive

Types

type ConftestResults

type ConftestResults []struct {
	Filename  string `json:"filename"`
	Successes int    `json:"successes,omitempty"`
	Failures  []struct {
		Msg      string `json:"msg"`
		Metadata struct {
			// contains filtered or unexported fields
		} `json:"metadata,omitempty"`
	} `json:"failures,omitempty"`
	Warnings []struct {
		Msg      string `json:"msg"`
		Metadata struct {
			// contains filtered or unexported fields
		} `json:"metadata,omitempty"`
	} `json:"warnings,omitempty"`
}

ConftestResults - Holds conftest results

func Scan

func Scan(fs FileSystem, rootPath string, policyID string, files []string) ConftestResults

Scan - Use conftest to Scan discovered files.

type File

type File interface {
	io.Closer
	io.Writer
	io.Reader
	io.ReaderAt
	io.Seeker
	Stat() (os.FileInfo, error)
}

File interface

type FileSystem

type FileSystem interface {
	Open(name string) (File, error)
	Copy(dst io.Writer, src io.Reader) (int64, error)
	Create(name string) (File, error)
	Remove(name string) error
	RemoveAll(name string) error
	Stat(name string) (os.FileInfo, error)
	Walk(root string, walkFn filepath.WalkFunc) error
	ReadFile(filename string) ([]byte, error)
	WriteFile(filename string, data []byte, perm os.FileMode) error
	NewFile(fd uintptr, name string) File
}

FileSystem - Interface

type HTTPClient

type HTTPClient struct {
	Client *http.Client
	URL    string
}

HTTPClient - HTTP Client

func NewHTTPClient

func NewHTTPClient(http *http.Client, url string) *HTTPClient

NewHTTPClient - Returns new HTTPClient

func (*HTTPClient) DownloadFile

func (c *HTTPClient) DownloadFile(fs FileSystem) (string, error)

DownloadFile - Download a file from a URL

type OSFS

type OSFS struct{}

OSFS implements fileSystem using the local disk.

func (OSFS) Copy

func (OSFS) Copy(dst io.Writer, src io.Reader) (int64, error)

Copy - Copy File

func (OSFS) Create

func (OSFS) Create(name string) (File, error)

Create - Create File

func (OSFS) NewFile

func (OSFS) NewFile(fd uintptr, name string) File

NewFile - Creates a new File

func (OSFS) Open

func (OSFS) Open(name string) (File, error)

Open - Open File

func (OSFS) ReadFile

func (OSFS) ReadFile(filename string) ([]byte, error)

ReadFile - Reads a File

func (OSFS) Remove

func (OSFS) Remove(name string) error

Remove - Remove File

func (OSFS) RemoveAll

func (OSFS) RemoveAll(name string) error

RemoveAll - Remove Directory

func (OSFS) Stat

func (OSFS) Stat(name string) (os.FileInfo, error)

Stat - Stat File

func (OSFS) Walk

func (OSFS) Walk(root string, walkFn filepath.WalkFunc) error

Walk - Walk Path

func (OSFS) WriteFile

func (OSFS) WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile - Writes to a File