mage

Documentation

Index

• func CI() error
• func CIVerify() error
• func Clean() error
• func CleanTest() error
• func Cover(file string) error
• func Doc() error
• func DockerBuild() error
• func EnsureAllTools() error
• func Format() error
• func Gitwd() (string, error)
• func Lint() error
• func PrintCoverage() error
• func RunUnitTestAndSuiteTest() error
• func SuiteTest() error
• func Test() error
• func TestRace() error
• func TmpFile(name, contents string) (func(), error)
• func UnitTest() error

Functions

func CI

func CI() error

CI runs format, lint, doc and test.

func CIVerify

func CIVerify() error

CIVerify checks if format, lint, doc and test were ran.

func Clean

func Clean() error

Clean cleans the testcache

func CleanTest

func CleanTest() error

CleanTest runs unit tests without the test cache.

func Cover

func Cover(file string) error

Cover checks code coverage from unit tests.

func Doc

func Doc() error

Doc generates documents for the code.

func DockerBuild

func DockerBuild() error

Build docker image with docker compose.

func EnsureAllTools

func EnsureAllTools() error

EnsureAllTools checks to see if a valid version of the needed tools are installed, and downloads/installs them if not.

func Format

func Format() error

Format formats the code.

func Gitwd

func Gitwd() (string, error)

Gitwd is a utility to get the relative working directory within the Git root.

func Lint

func Lint() error

Lint lints the code.

func PrintCoverage

func PrintCoverage() error

Retrieve the test coverage count from coverage.out file.

func RunUnitTestAndSuiteTest

func RunUnitTestAndSuiteTest() error

Test runs both unit and suite tests.

func SuiteTest

func SuiteTest() error

SuiteTest runs the suite tests.

func Test

func Test() error

Test runs the unit tests.

func TestRace

func TestRace() error

TestRace runs unit tests without the test cache. TODO: remove once integration tests no longer reference this.

func TmpFile

func TmpFile(name, contents string) (func(), error)

TmpFile writes the contents to the given temporary file and returns a function to clean up that file.

func UnitTest

func UnitTest() error

UnitTest runs the unit tests.