mage

Documentation

Index

• func Clean()
• func Deploy()
• func Fmt()
• type Build
  • func (b Build) API()
  • func (b Build) Lambda()
• type Glue
  • func (t Glue) Sync()
• type PantherConfig
• type Setup
  • func (s Setup) All()
  • func (Setup) Go()
  • func (Setup) Python()
  • func (Setup) Web()
• type Test
  • func (t Test) CI()
  • func (t Test) Cfn()
  • func (t Test) Cover() error
  • func (t Test) Go()
  • func (t Test) Integration()
  • func (t Test) Python()
  • func (t Test) Web()

Functions

func Clean

func Clean()

Clean Remove auto-generated build artifacts

func Deploy

func Deploy()

Deploy Deploy application infrastructure

func Fmt

func Fmt()

Fmt Format source files

Types

type Build

type Build mg.Namespace

Build contains targets for compiling source code.

func (Build) API

func (b Build) API()

API Generate Go client/models from Swagger specs in api/

func (Build) Lambda

func (b Build) Lambda()

Lambda Compile Go Lambda function source

type Glue

type Glue mg.Namespace

targets for managing Glue tables

func (Glue) Sync

func (t Glue) Sync()

Sync Sync glue table partitions after schema change

type PantherConfig

type PantherConfig struct {
	BucketsParameterValues  bucketsParameters  `yaml:"BucketsParameterValues"`
	BackendParameterValues  backendParameters  `yaml:"BackendParameterValues"`
	FrontendParameterValues frontendParameters `yaml:"FrontendParameterValues"`
	PipLayer                []string           `yaml:"PipLayer"`
	InitialAnalysisSets     []string           `yaml:"InitialAnalysisSets"`
}

PantherConfig describes the panther_config.yml file.

type Setup

type Setup mg.Namespace

Setup contains targets for installing development / CI dependencies

func (Setup) All

func (s Setup) All()

All Install all development dependencies

func (Setup) Go

func (Setup) Go()

Go Install goimports, go-swagger, and golangci-lint

func (Setup) Python

func (Setup) Python()

Python Install the Python virtual env

func (Setup) Web

func (Setup) Web()

Web Npm install

type Test

type Test mg.Namespace

Test contains targets for testing code syntax, style, and correctness.

func (Test) CI

func (t Test) CI()

CI Run all required checks

func (Test) Cfn

func (t Test) Cfn()

Cfn Lint CloudFormation templates

func (Test) Cover

func (t Test) Cover() error

Cover Run Go unit tests and view test coverage in HTML

func (Test) Go

func (t Test) Go()

Go Test Go source

func (Test) Integration

func (t Test) Integration()

Integration Run integration tests (integration_test.go,integration.py)

func (Test) Python

func (t Test) Python()

Python Test Python source

func (Test) Web

func (t Test) Web()

Web Test web source