noctx

noctx

noctx finds function calls without context.Context.

Passing context.Context enables library user to cancel request, getting trace information and so on.

noctx helps you to identify code that could be rewritten to use the context.Context.

Usage

noctx with go vet

go vet is a Go standard tool for analyzing source code.

1. Install noctx.

$ go install github.com/sonatard/noctx/cmd/noctx@latest

1. Execute noctx

$ go vet -vettool=`which noctx` main.go
./main.go:6:11: net/http.Get must not be called

noctx with golangci-lint

golangci-lint is a fast Go linters runner.

1. Install golangci-lint. golangci-lint - Install

2. Setup .golangci.yml

# Add noctx to enable linters.
linters:
  enable:
    - noctx

# Or enable-all is true.
linters:
  default: all
  disable:
   - xxx # Add unused linter to disable linters.

1. Execute noctx

# Use .golangci.yml
$ golangci-lint run

# Only execute noctx
golangci-lint run --enable-only noctx

net/http package

Rules

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/noctx.go#L41-L50

Sample

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/testdata/src/http_client/http_client.go#L11 https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/testdata/src/http_request/http_request.go#L17

Reference

• net/http - NewRequest
• net/http - NewRequestWithContext
• net/http - Request.WithContext

net package

Rules

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/noctx.go#L26-L39

Sample

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/testdata/src/network/net.go#L17

References

• net - ListenConfig
• net - Dialer.DialContext
• net - Resolver
• net - DefaultResolver

database/sql package

Rules

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/noctx.go#L52-L66

Sample

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/testdata/src/sql/sql.go#L18

Reference

• database/sql

crypt/tls package

Rules

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/noctx.go#L71-L74

Sample

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/testdata/src/crypto_tls/tls.go#L17

Reference

• crypto/tls - Dialer.DialContext
• crypto/tls - Conn.HandshakeContext

exec package

Rules

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/noctx.go#L68-L69

Sample

https://github.com/sonatard/noctx/blob/b768dab1764733f7f69c5075b7497eff4c58f260/testdata/src/exec_cmd/exec.go#L11

Reference

• exec - exec.CommandContext