check

Documentation

Overview

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Package check contains the linter checks

Index

• Constants
• Variables
• type BadContainerCommands
  • func (check *BadContainerCommands) Run(opts *Options, ctx *Context) (*Result, error)
• type Context
• type DeprecatedInstruction
  • func (c *DeprecatedInstruction) Run(opts *Options, ctx *Context) (*Result, error)
• type EmptyDockerfile
  • func (c *EmptyDockerfile) Run(opts *Options, ctx *Context) (*Result, error)
• type EmptyDockerignore
  • func (c *EmptyDockerignore) Run(opts *Options, ctx *Context) (*Result, error)
• type EmptyStage
  • func (c *EmptyStage) Run(opts *Options, ctx *Context) (*Result, error)
• type EntrypointCmdShellForm
  • func (c *EntrypointCmdShellForm) Run(opts *Options, ctx *Context) (*Result, error)
• type Info
  • func (i *Info) Get() *Info
• type InvalidInstruction
  • func (c *InvalidInstruction) Run(opts *Options, ctx *Context) (*Result, error)
• type InvalidStageArgs
  • func (c *InvalidStageArgs) Run(opts *Options, ctx *Context) (*Result, error)
• type LastUserRoot
  • func (c *LastUserRoot) Run(opts *Options, ctx *Context) (*Result, error)
• type MalformedInstExecForm
  • func (c *MalformedInstExecForm) Run(opts *Options, ctx *Context) (*Result, error)
• type Match
• type MultipleCmdInstructions
  • func (c *MultipleCmdInstructions) Run(opts *Options, ctx *Context) (*Result, error)
• type MultipleEntrypointInstructions
  • func (c *MultipleEntrypointInstructions) Run(opts *Options, ctx *Context) (*Result, error)
• type NoDockerignore
  • func (c *NoDockerignore) Run(opts *Options, ctx *Context) (*Result, error)
• type NoEnvArgs
  • func (c *NoEnvArgs) Run(opts *Options, ctx *Context) (*Result, error)
• type NoStageArgs
  • func (c *NoStageArgs) Run(opts *Options, ctx *Context) (*Result, error)
• type NoStages
  • func (c *NoStages) Run(opts *Options, ctx *Context) (*Result, error)
• type NoWorkdirPath
  • func (c *NoWorkdirPath) Run(opts *Options, ctx *Context) (*Result, error)
• type Options
• type PyPipInstallLatest
  • func (c *PyPipInstallLatest) Run(opts *Options, ctx *Context) (*Result, error)
• type RelativeWorkdir
  • func (c *RelativeWorkdir) Run(opts *Options, ctx *Context) (*Result, error)
• type Result
• type Runner
• type SeparateRemove
  • func (c *SeparateRemove) Run(opts *Options, ctx *Context) (*Result, error)
• type StageFromLatest
  • func (c *StageFromLatest) Run(opts *Options, ctx *Context) (*Result, error)
• type StagelessInstruction
  • func (c *StagelessInstruction) Run(opts *Options, ctx *Context) (*Result, error)
• type TooManyLayers
  • func (c *TooManyLayers) Run(opts *Options, ctx *Context) (*Result, error)
• type UnknownInstruction
  • func (c *UnknownInstruction) Run(opts *Options, ctx *Context) (*Result, error)
• type UnnecessaryLayer
  • func (c *UnnecessaryLayer) Run(opts *Options, ctx *Context) (*Result, error)

Constants

const (
	LabelLevel       = "level"
	LabelScope       = "scope"
	LabelInstruction = "instruction"
	LabelApp         = "app"
	LabelShell       = "shell"
)

const (
	LevelAny   = "any"
	LevelFatal = "fatal" //parse or other errors that will result in image build failures
	LevelError = "error"
	LevelWarn  = "warn"
	LevelInfo  = "info"
	LevelStyle = "style"
)

const (
	ScopeAll          = "all"
	ScopeDockerfile   = "dockerfile"
	ScopeStage        = "stage"
	ScopeInstruction  = "instruction"
	ScopeDockerignore = "dockerignore"
	ScopeData         = "data"
	ScopeApp          = "app"
	ScopeShell        = "shell"
)

Variables

var AllChecks = []Runner{}

Types

type BadContainerCommands

type BadContainerCommands struct {
	Info
	Names []string
}

func (*BadContainerCommands) Run

func (check *BadContainerCommands) Run(opts *Options, ctx *Context) (*Result, error)

type Context

type Context struct {
	DockerfilePath  string
	Dockerfile      *spec.Dockerfile
	BuildContextDir string
	Dockerignore    *dockerignore.Matcher
}

type DeprecatedInstruction

type DeprecatedInstruction struct {
	Info
}

func (*DeprecatedInstruction) Run

func (c *DeprecatedInstruction) Run(opts *Options, ctx *Context) (*Result, error)

type EmptyDockerfile

type EmptyDockerfile struct {
	Info
}

func (*EmptyDockerfile) Run

func (c *EmptyDockerfile) Run(opts *Options, ctx *Context) (*Result, error)

type EmptyDockerignore

type EmptyDockerignore struct {
	Info
}

func (*EmptyDockerignore) Run

func (c *EmptyDockerignore) Run(opts *Options, ctx *Context) (*Result, error)

type EmptyStage

type EmptyStage struct {
	Info
}

func (*EmptyStage) Run

func (c *EmptyStage) Run(opts *Options, ctx *Context) (*Result, error)

type EntrypointCmdShellForm

type EntrypointCmdShellForm struct {
	Info
	Names []string
}

func (*EntrypointCmdShellForm) Run

func (c *EntrypointCmdShellForm) Run(opts *Options, ctx *Context) (*Result, error)

type Info

type Info struct {
	ID           string            `json:"id"`
	Name         string            `json:"name"`
	Description  string            `json:"-"`
	MainMessage  string            `json:"-"` //can be a template with a format string
	MatchMessage string            `json:"-"` //can be a template with a format string
	DetailsURL   string            `json:"-"`
	Labels       map[string]string `json:"-"`
}

func (*Info) Get

func (i *Info) Get() *Info

type InvalidInstruction

type InvalidInstruction struct {
	Info
}

func (*InvalidInstruction) Run

func (c *InvalidInstruction) Run(opts *Options, ctx *Context) (*Result, error)

type InvalidStageArgs

type InvalidStageArgs struct {
	Info
}

func (*InvalidStageArgs) Run

func (c *InvalidStageArgs) Run(opts *Options, ctx *Context) (*Result, error)

type LastUserRoot

type LastUserRoot struct {
	Info
}

func (*LastUserRoot) Run

func (c *LastUserRoot) Run(opts *Options, ctx *Context) (*Result, error)

type MalformedInstExecForm

type MalformedInstExecForm struct {
	Info
}

func (*MalformedInstExecForm) Run

func (c *MalformedInstExecForm) Run(opts *Options, ctx *Context) (*Result, error)

type Match

type Match struct {
	Stage       *spec.BuildStage   `json:"stage,omitempty"`
	Instruction *instruction.Field `json:"instruction,omitempty"`
	Message     string             `json:"message,omitempty"`
}

type MultipleCmdInstructions

type MultipleCmdInstructions struct {
	Info
}

func (*MultipleCmdInstructions) Run

func (c *MultipleCmdInstructions) Run(opts *Options, ctx *Context) (*Result, error)

type MultipleEntrypointInstructions

type MultipleEntrypointInstructions struct {
	Info
}

func (*MultipleEntrypointInstructions) Run

func (c *MultipleEntrypointInstructions) Run(opts *Options, ctx *Context) (*Result, error)

type NoDockerignore

type NoDockerignore struct {
	Info
}

func (*NoDockerignore) Run

func (c *NoDockerignore) Run(opts *Options, ctx *Context) (*Result, error)

type NoEnvArgs

type NoEnvArgs struct {
	Info
}

func (*NoEnvArgs) Run

func (c *NoEnvArgs) Run(opts *Options, ctx *Context) (*Result, error)

type NoStageArgs

type NoStageArgs struct {
	Info
}

func (*NoStageArgs) Run

func (c *NoStageArgs) Run(opts *Options, ctx *Context) (*Result, error)

type NoStages

type NoStages struct {
	Info
}

func (*NoStages) Run

func (c *NoStages) Run(opts *Options, ctx *Context) (*Result, error)

type NoWorkdirPath

type NoWorkdirPath struct {
	Info
}

func (*NoWorkdirPath) Run

func (c *NoWorkdirPath) Run(opts *Options, ctx *Context) (*Result, error)

type Options

type Options struct {
}

type PyPipInstallLatest

type PyPipInstallLatest struct {
	Info
}

func (*PyPipInstallLatest) Run

func (c *PyPipInstallLatest) Run(opts *Options, ctx *Context) (*Result, error)

type RelativeWorkdir

type RelativeWorkdir struct {
	Info
}

func (*RelativeWorkdir) Run

func (c *RelativeWorkdir) Run(opts *Options, ctx *Context) (*Result, error)

type Result

type Result struct {
	Source     *Info    `json:"source"`
	Hit        bool     `json:"-"`
	Message    string   `json:"message,omitempty"`
	Matches    []*Match `json:"matches,omitempty"`
	DetailsURL string   `json:"-"`
}

type Runner

type Runner interface {
	Get() *Info
	Run(opts *Options, ctx *Context) (*Result, error)
}

type SeparateRemove

type SeparateRemove struct {
	Info
}

func (*SeparateRemove) Run

func (c *SeparateRemove) Run(opts *Options, ctx *Context) (*Result, error)

type StageFromLatest

type StageFromLatest struct {
	Info
}

func (*StageFromLatest) Run

func (c *StageFromLatest) Run(opts *Options, ctx *Context) (*Result, error)

type StagelessInstruction

type StagelessInstruction struct {
	Info
}

func (*StagelessInstruction) Run

func (c *StagelessInstruction) Run(opts *Options, ctx *Context) (*Result, error)

type TooManyLayers

type TooManyLayers struct {
	Info
}

func (*TooManyLayers) Run

func (c *TooManyLayers) Run(opts *Options, ctx *Context) (*Result, error)

type UnknownInstruction

type UnknownInstruction struct {
	Info
}

func (*UnknownInstruction) Run

func (c *UnknownInstruction) Run(opts *Options, ctx *Context) (*Result, error)

type UnnecessaryLayer

type UnnecessaryLayer struct {
	Info
}

func (*UnnecessaryLayer) Run

func (c *UnnecessaryLayer) Run(opts *Options, ctx *Context) (*Result, error)