ginkgolinter

package module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 18, 2022 License: MIT Imports: 11 Imported by: 11

README

Go Report Card Coverage Status

ginkgo-linter

This is a golang linter to check usage of the ginkgo and gomega packages.

ginkgo is a testing framework and gomega is its assertion package.

Install the CLI

Download the right executable from the latest release, according to your OS.

Another option is to use go:

go install github.com/nunnatsa/ginkgolinter/cmd/ginkgolinter@latest

Then add the new executable to your PATH.

usage

ginkgolinter [-fix] ./...

Use the -fix flag to apply the fix suggestions to the source code.

Linter Checks

The linter checks the Expect, ExpectWithOffset and the Ω "actual" functions, with the Should, ShouldNot, To, ToNot and NotTo assertion functions.

It also supports the embedded Not() matcher

Wrong Length Assertion

The linter finds assertion of the golang built-in len function, with all kind of matchers, while there are already gomega matchers for these usecases; We want to assert the item, rather than its length.

There are several wrong patterns:

Expect(len(x)).To(Equal(0)) // should be: Expect(x).To(BeEmpty())
Expect(len(x)).To(BeZero()) // should be: Expect(x).To(BeEmpty())
Expect(len(x)).To(BeNumeric(">", 0)) // should be: Expect(x).ToNot(BeEmpty())
Expect(len(x)).To(BeNumeric(">=", 1)) // should be: Expect(x).ToNot(BeEmpty())
Expect(len(x)).To(BeNumeric("==", 0)) // should be: Expect(x).To(BeEmpty())
Expect(len(x)).To(BeNumeric("!=", 0)) // should be: Expect(x).ToNot(BeEmpty())

Expect(len(x)).To(Equal(1)) // should be: Expect(x).To(HaveLen(1))
Expect(len(x)).To(BeNumeric("==", 2)) // should be: Expect(x).To(HaveLen(2))
Expect(len(x)).To(BeNumeric("!=", 3)) // should be: Expect(x).ToNot(HaveLen(3))

It also supports the embedded Not() matcher; e.g.

Ω(len(x)).Should(Not(Equal(4))) => Ω(x).ShouldNot(HaveLen(4))

Or even (double negative):

Ω(len(x)).To(Not(BeNumeric(">", 0))) => Ω(x).To(BeEmpty())

The output of the linter,when finding issues, looks like this:

./testdata/src/a/a.go:14:5: ginkgo-linter: wrong length assertion; consider using `Expect("abcd").Should(HaveLen(4))` instead
./testdata/src/a/a.go:18:5: ginkgo-linter: wrong length assertion; consider using `Expect("").Should(BeEmpty())` instead
./testdata/src/a/a.go:22:5: ginkgo-linter: wrong length assertion; consider using `Expect("").Should(BeEmpty())` instead
Wrong nil Assertion

The linter finds assertion of the comparison to nil, with all kind of matchers, instead of using the existing BeNil() matcher; We want to assert the item, rather than a comparison result.

There are several wrong patterns:

Expect(x == nil).To(Equal(true)) // should be: Expect(x).To(BeNil())
Expect(nil == x).To(Equal(true)) // should be: Expect(x).To(BeNil())
Expect(x != nil).To(Equal(true)) // should be: Expect(x).ToNot(BeNil())
Expect(nil != nil).To(Equal(true)) // should be: Expect(x).ToNot(BeNil())

Expect(x == nil).To(BeTrue()) // should be: Expect(x).To(BeNil())
Expect(x == nil).To(BeFalse()) // should be: Expect(x).ToNot(BeNil())

It also supports the embedded Not() matcher; e.g.

Ω(x == nil).Should(Not(BeTrue())) => Ω(x).ShouldNot(BeNil())

Or even (double negative):

Ω(x != nil).Should(Not(BeTrue())) => Ω(x).Should(BeNil())

Wrong Error Assertion

The linter finds assertion of errors compared with nil, or to be equal nil, or to be nil. The linter suggests to use Succeed for functions or HaveOccurred for error values..

There are several wrong patterns:

Expect(err == nil).To(Equal(true)) // should be: Expect(err).ToNot(HaveOccurred())
Expect(err == nil).To(BeFalse()) // should be: Expect(err).To(HaveOccurred())
Expect(err != nil).To(BeTrue()) // should be: Expect(err).To(HaveOccurred())
Expect(funcReturnsError()).To(BeNil()) // should be: Expect(HaveOccurred).To(Succeed())

and so on

It also supports the embedded Not() matcher; e.g.

Ω(err == nil).Should(Not(BeTrue())) => Ω(x).Should(HaveOccurred())

Suppress the linter

Suppress warning from command line
  • Use the --suppress-len-assertion=true flag to suppress the wrong length assertion warning
  • Use the --suppress-nil-assertion=true flag to suppress the wrong nil assertion warning
  • Use the --suppress-err-assertion=true flag to suppress the wrong error assertion warning
Suppress warning from the code

To suppress the wrong length assertion warning, add a comment with (only)

ginkgo-linter:ignore-len-assert-warning.

To suppress the wrong nil assertion warning, add a comment with (only)

ginkgo-linter:ignore-nil-assert-warning.

To suppress the wrong error assertion warning, add a comment with (only)

ginkgo-linter:ignore-err-assert-warning.

There are two options to use these comments:

  1. If the comment is at the top of the file, supress the warning for the whole file; e.g.:

    package mypackage
    
    // ginkgo-linter:ignore-len-assert-warning
    
    import (
        . "github.com/onsi/ginkgo/v2"
        . "github.com/onsi/gomega"
    )
    
    var _ = Describe("my test", func() {
         It("should do something", func() {
             Expect(len("abc")).Should(Equal(3)) // nothing in this file will trigger the warning
         })
    })
    
  2. If the comment is before a wrong length check expression, the warning is suppressed for this expression only; for example:

    It("should test something", func() {
        // ginkgo-linter:ignore-nil-assert-warning
        Expect(x == nil).Should(BeTrue()) // this line will not trigger the warning
        Expect(x == nil).Should(BeTrue()) // this line will trigger the warning
    }
    

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsError added in v0.4.0

func IsError(t gotypes.Type) bool

func IsExprError added in v0.4.0

func IsExprError(pass *analysis.Pass, expr ast.Expr) bool

func NewAnalyzer added in v0.2.0

func NewAnalyzer() *analysis.Analyzer

NewAnalyzer returns an Analyzer - the package interface with nogo

Types

This section is empty.

Directories

Path Synopsis
cmd
ginkgolinter command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL