nunnatsa / ginkgolinter / 21660860836

88%

Build Type

push

github

Committed by nunnatsa

Commit Message

accept async functions with testing.TB variant instead of Gomega

In Kubernetes' ktesting package the following assertion is valid:

    tCtx.Eventually(func(tCtx TContext) { /* maybe fail via tCtx */ }).Should(Succeed())

That works because tCtx.Eventually wraps the function such that failures
reported via tCtx.Error/Errorf/Fatal/Fatalf are visible to the matcher.

Without this change, the "Success matcher only support a single error value, or
function with Gomega as its first parameter" warning is triggered.

Instead of building in specific support for ktesting, the approach is to check
for a first parameter which has any (not necessarily all!) of the testing.TB
methods for reporting failures. That is considered a valid alternative to
a Gomega instance.

There's now a potential false negative in the linter when passing such a
function directly to gomega.Eventually/Consistently. That'll fail at runtime
because gomega cannot call it, so such a false negative isn't too bad (fails
reliably and obviously).

The warning message doesn't get changed because it would be confusing for most
users to call out some vague alternative (vague because the linter has no
details) that most users won't be able to use.

Run Details

30 of 30 new or added lines in 3 files covered. (100.0%)

1 existing line in 1 file now uncovered.

2582 of 2935 relevant lines covered (87.97%)

1757.85 hits per line