qa

Documentation

Index

• func AnalyseCode(rootDir string, check *ServerlessCheck) error
• func CheckFunctionDefinitions(rootDir string) (string, error)
• func CheckLocalBuild(rootDir string) (string, error)
• func CheckResourceDefinitions(rootDir string) (string, error)
• func CheckUnusedZips(rootDir string) (string, error)
• func CheckYmlFiles(rootDir string) (string, error)
• func ExtractZipPath(line string) (string, error)
• func ReadYMLDefinitions(dir string, definitions map[string]DefinitionInfo) error
• type DefinitionInfo
• type FunctionInfo
• type ResourceInfo
• type ServerlessCheck
  • func ServerlessQA(rootDir string, warnLevels WarnLevels) (ServerlessCheck, error)
• type ServerlessFunctionDefinition
• type ServerlessPackageDefinition
• type ServerlessProviderDefinition
• type ServerlessResource
• type ServerlessResourceDefinition
• type ServerlessYML
• type Task
• type WarnLevels
• type ZipPath

Functions

func AnalyseCode

func AnalyseCode(rootDir string, check *ServerlessCheck) error

func CheckFunctionDefinitions

func CheckFunctionDefinitions(rootDir string) (string, error)

func CheckLocalBuild

func CheckLocalBuild(rootDir string) (string, error)

func CheckResourceDefinitions

func CheckResourceDefinitions(rootDir string) (string, error)

func CheckUnusedZips

func CheckUnusedZips(rootDir string) (string, error)

func CheckYmlFiles

func CheckYmlFiles(rootDir string) (string, error)

func ExtractZipPath

func ExtractZipPath(line string) (string, error)

ExtractZipPath extracts the zip path from a makefile line.

func ReadYMLDefinitions

func ReadYMLDefinitions(dir string, definitions map[string]DefinitionInfo) error

Types

type DefinitionInfo

type DefinitionInfo struct {
	Path     string
	File     string
	Errors   []string
	Warnings []string
	Def      ServerlessYML
}

type FunctionInfo

type FunctionInfo struct {
	Path string
	File string
}

type ResourceInfo

type ResourceInfo struct {
	Path string
	File string
}

type ServerlessCheck

type ServerlessCheck struct {
	Definitions map[string]DefinitionInfo
	MissingVars map[string][]string
}

func ServerlessQA

func ServerlessQA(rootDir string, warnLevels WarnLevels) (ServerlessCheck, error)

type ServerlessFunctionDefinition

type ServerlessFunctionDefinition struct {
	MemorySize  int                         `yaml:"memorySize"`
	Timeout     int                         `yaml:"timeout"`
	Handler     string                      `yaml:"handler"`
	Package     ServerlessPackageDefinition `yaml:"package"`
	Events      []interface{}               `yaml:"events"`
	Environment map[string]string           `yaml:"environment"`
}

type ServerlessPackageDefinition

type ServerlessPackageDefinition struct {
	Artifact string `yaml:"artifact"`
}

type ServerlessProviderDefinition

type ServerlessProviderDefinition struct {
	Name         string            `yaml:"name"`
	Stage        string            `yaml:"stage"`
	Runtime      string            `yaml:"runtime"`
	Architecture string            `yaml:"architecture"`
	Region       string            `yaml:"region"`
	Environment  map[string]string `yaml:"environment"`
}

type ServerlessResource

type ServerlessResource struct {
	Definitions map[string]ServerlessResourceDefinition `yaml:"Resources"`
}

type ServerlessResourceDefinition

type ServerlessResourceDefinition struct {
	Type       string         `yaml:"Type"`
	Properties map[string]any `yaml:"Properties"`
}

type ServerlessYML

type ServerlessYML struct {
	FrameworkVersion string                                  `yaml:"frameworkVersion"`
	Provider         ServerlessProviderDefinition            `yaml:"provider"`
	Functions        map[string]ServerlessFunctionDefinition `yaml:"functions"`
	Resources        ServerlessResource                      `yaml:"resources"`
}

type Task

type Task struct {
	Path string
}

type WarnLevels

type WarnLevels struct {
	FunctionsMemorySize int
}

type ZipPath

type ZipPath struct {
	Path string
	File string
}