nunnatsa / ginkgolinter
84%
main: 88%

LAST BUILD BRANCH: dependabot/go_modules/golang.org/x/tools-0.38.0
DEFAULT BRANCH: main
Repo Added
Token d9ik705i5Md7LA6J92R9w7EJjDCvwAne4 regen
Build 344 Last
Files 56
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH matcherror
branch: matcherror
CHANGE BRANCH
x
Sync Branches

coverage: 84.444% (+0.5%) from 83.908%
6811556342

Pull #118

github

nunnatsa 
New rule(s): Wrong Usage of the `MatchError` gomega Matcher

The `MatchError` gomega matcher asserts an error value (and if it's not nil).

There are four valid formats for using this Matcher:
* error value; e.g. `Expect(err).To(MatchError(anotherErr))`
* string, to be equal to the output of the `Error()` method; e.g. `Expect(err).To(MatchError("Not Found"))`
* A gomega matcher that asserts strings; e.g. `Expect(err).To(MatchError(ContainSubstring("Found")))`
* [from v0.29.0] a function that receive a single error parameter and returns a single boolean value.
  In this format, an additional single string parameter, with the function description, is also required; e.g.
  `Expect(err).To(MatchError(isNotFound, "is the error is a not found error"))`

These four format are checked on runtime, but sometimes it's too late. ginkgolinter performs a static analysis and so it
will find these issues on build time.

ginkgolinter checks the following:
* Is the first parameter is one of the four options above.
* That there are no additional parameters passed to the matcher; e.g.
  `MatchError(isNotFoundFunc, "a valid description" , "not used string")`. In this case, the matcher won't fail on run
  time, but the additional parameters are not in use and ignored.
* If the first parameter is a function with the format of `func(error)bool`, ginkgolinter makes sure that the second
  parameter exists and its type is string.
Pull Request #118: New rule(s): Wrong Usage of the `MatchError` gomega Matcher

89 of 96 new or added lines in 2 files covered. (92.71%)

1102 of 1305 relevant lines covered (84.44%)

767.75 hits per line

Relevant lines Covered
1305 RELEVANT LINES 1102 COVERED LINES
767.75 HITS PER LINE
Source Files on matcherror

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
6811556342 matcherror New rule(s): Wrong Usage of the `MatchError` gomega Matcher The `MatchError` gomega matcher asserts an error value (and if it's not nil). There are four valid formats for using this Matcher: * error value; e.g. `Expect(err).To(MatchError(another... Pull #118 nunnatsa github
84.44
See All Builds (344)

Badge your Repo: ginkgolinter

We detected this repo isn’t badged! Grab the embed code to the right, add it to your repo to show off your code coverage, and when the badge is live hit the refresh button to remove this message.
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

Refresh