mage

Documentation

Index

• func Clean()
• func Deploy()
• func Doc()
• func Fmt()
• func Teardown()
• type Build
  • func (b Build) API()
  • func (b Build) All()
  • func (b Build) Cfn()
  • func (b Build) Devtools()
  • func (b Build) Lambda()
  • func (b Build) Opstools()
• type Glue
  • func (t Glue) Sync()
  • func (t Glue) Update()
• type Setup
  • func (s Setup) All()
  • func (Setup) Go()
  • func (Setup) Python()
  • func (Setup) Swagger()
  • func (Setup) Web()
• type Show
  • func (b Show) Schemas()
• 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 Doc

func Doc()

Generate all documentation

func Fmt

func Fmt()

Fmt Format source files

func Teardown

func Teardown()

Teardown Destroy all Panther infrastructure

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) All

func (b Build) All()

Build all deployment artifacts

func (Build) Cfn

func (b Build) Cfn()

Generate CloudFormation templates in out/deployments folder

func (Build) Devtools

func (b Build) Devtools()

Devtools Compile developer tools from source

func (Build) Lambda

func (b Build) Lambda()

Lambda Compile Go Lambda function source

func (Build) Opstools

func (b Build) Opstools()

Opstools Compile Go operational tools from 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

func (Glue) Update

func (t Glue) Update()

Updates the panther-glue cloudformation template (used for schema migrations)

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) Swagger

func (Setup) Swagger()

Install go-swagger for SDK generation

func (Setup) Web

func (Setup) Web()

Web Npm install

type Show

type Show mg.Namespace

func (Show) Schemas

func (b Show) Schemas()

Schemas Prints to stdout a JSON representation each supported log type

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 (build:all, test:cfn, test:go, test:python, test:web)

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