bodyclose

README

bodyclose

bodyclose is a static analysis tool which checks whether res.Body is correctly closed.

Install

Using as a golangci-lint plugin (golangci-lint v2+)

The bodyclose linter can be used as a plugin with golangci-lint v2+.

1. Add the plugin to your project:

go get github.com/bfirestone/bodyclose

1. Enable it in your .golangci.yml configuration:

linters-settings:
  plugin:
    enable: true
    path: github.com/bfirestone/bodyclose # Add path to your go.mod

linters:
  enable:
    - bodyclose # Enable the linter

Using as a standalone tool

You can get bodyclose by go get command.

$ go get -u github.com/timakin/bodyclose

How to use

bodyclose run with go vet as below when Go is 1.12 and higher.

$ go vet -vettool=$(which bodyclose) github.com/timakin/go_api/...
# github.com/timakin/go_api
internal/httpclient/httpclient.go:13:13: response body must be closed

When Go is lower than 1.12, just run bodyclose command with the package name (import path).

But it cannot accept some options such as --tags.

$ bodyclose github.com/timakin/go_api/...
~/go/src/github.com/timakin/api/internal/httpclient/httpclient.go:13:13: response body must be closed

Analyzer

bodyclose validates whether *net/http.Response of HTTP request calls method Body.Close() such as below code.

resp, err := http.Get("http://example.com/") // Wrong case
if err != nil {
	// handle error
}
body, err := ioutil.ReadAll(resp.Body)

This code is wrong. You must call resp.Body.Close when finished reading resp.Body.

resp, err := http.Get("http://example.com/")
if err != nil {
	// handle error
}
defer resp.Body.Close() // OK
body, err := ioutil.ReadAll(resp.Body)

In the GoDoc of Client.Do this rule is clearly described.

If you forget this sentence, a HTTP client cannot re-use a persistent TCP connection to the server for a subsequent "keep-alive" request.

Documentation

Overview

Package bodyclose provides a linter that checks whether HTTP response bodies are properly closed. This linter can be used as a plugin with golangci-lint v2+ or as a standalone tool.

When used with golangci-lint v2+, configure your .golangci.yml like this:

linters-settings:
  plugin:
    enable: true
    path: github.com/bfirestone/bodyclose

linters:
  enable:
    - bodyclose

Index

• func New(settings any) (register.LinterPlugin, error)
• type BodyClosePlugin
  • func (p *BodyClosePlugin) BuildAnalyzers() ([]*analysis.Analyzer, error)
  • func (p *BodyClosePlugin) GetLoadMode() string

Functions

func New

func New(settings any) (register.LinterPlugin, error)

New creates a new instance of the bodyclose linter plugin

Types

type BodyClosePlugin

type BodyClosePlugin struct{}

func (*BodyClosePlugin) BuildAnalyzers

func (p *BodyClosePlugin) BuildAnalyzers() ([]*analysis.Analyzer, error)

BuildAnalyzers returns the bodyclose analyzer

func (*BodyClosePlugin) GetLoadMode

func (p *BodyClosePlugin) GetLoadMode() string

GetLoadMode specifies what kind of AST loading is needed