contextcheck

README

contextcheck

contextcheck is a static analysis tool, it is used to check a function whether use context.Background() or context.TODO() directly instead of the input ctx when calling the sub-function, or even don't pass the ctx, which will result in a broken call link.

For example:

func call1(ctx context.Context) {
    ...
    call2(context.Background()) // should use ctx

    call3() // should pass the ctx
    ...
}

func call2(ctx context.Context) {
    ...
}

func call3() {
    ctx := context.TODO()
    call2(ctx)
}

Installation

You can get contextcheck by go get command.

$ go get -u github.com/sylvia7788/contextcheck

or build yourself.

$ make build
$ make install

Usage

Invoke contextcheck with your package name

$ contextcheck ./...
$ # or
$ contextcheck github.com/you/yourproject/...

Documentation

Index

• Constants
• func NewAnalyzer() *analysis.Analyzer
• func NewRun() func(pass *analysis.Pass) (interface{}, error)

Constants

const (
	CtxIn      int = 1 << iota // ctx in function's param
	CtxOut                     // ctx in function's results
	CtxInField                 // ctx in function's field param

	CtxInOut = CtxIn | CtxOut
)

Functions

func NewAnalyzer

func NewAnalyzer() *analysis.Analyzer

func NewRun

func NewRun() func(pass *analysis.Pass) (interface{}, error)