Fix various linting issues and minor bugs #280

thaJeztah · 2024-08-22T10:35:41Z

See individual commits for details.

thaJeztah · 2024-08-22T10:40:38Z

assert/cmp/compare.go


 func formatErrorMessage(err error) string {
-	//nolint:errorlint // unwrapping is not appropriate here
+	// unwrapping is not appropriate here


LOL looks like different versions of the linters disagree. Let me add nolintlint to the ignore list;

assert/cmp/compare.go:252:14: type assertion on error will fail on wrapped errors. Use errors.As to check for specific errors (errorlint) if _, ok := err.(causer); ok { ^

Current versions of this linter default to no allowing third-party dependencies by default (only stdlib and golang.org/x/sys). As there's currently no configuration set to prevent a specific import, this results in some imports being flagged; fs/manifest_test.go:11:2: import 'github.com/google/go-cmp/cmp' is not allowed from list 'Main' (depguard) "github.com/google/go-cmp/cmp" ^ assert/assert.go:96:2: import 'github.com/google/go-cmp/cmp' is not allowed from list 'Main' (depguard) gocmp "github.com/google/go-cmp/cmp" ^ assert/assert_test.go:8:2: import 'github.com/google/go-cmp/cmp' is not allowed from list 'Main' (depguard) gocmp "github.com/google/go-cmp/cmp" ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

The nolintlint linter considers the `nolint` to be redundant; assert/cmp/compare.go:251:2: directive `//nolint:errorlint // unwrapping is not appropriate here` is unused for linter "errorlint" (nolintlint) //nolint:errorlint // unwrapping is not appropriate here ^ But depending on the go version, it may trigger a warning: assert/cmp/compare.go:252:14: type assertion on error will fail on wrapped errors. Use errors.As to check for specific errors (errorlint) if _, ok := err.(causer); ok { ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

assert/assert_test.go:108:3: empty-block: this block is empty, you can remove it (revive) for range []int{1, 2, 3, 4} { } Signed-off-by: Sebastiaan van Stijn <[email protected]>

internal/source/source.go

internal/source/source.go:75:2: return both the `nil` error and invalid value: use a sentinel error instead (nilnil) return nil, nil ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

"cap" is now a builtin: internal/source/source_test.go:50:2: redefines-builtin-id: redefinition of the built-in function cap (revive) cap := &capture{} ^ internal/source/source_test.go:73:2: redefines-builtin-id: redefinition of the built-in function cap (revive) cap := &capture{} ^ internal/source/source_test.go:86:2: redefines-builtin-id: redefinition of the built-in function cap (revive) cap := &capture{} ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

fs/report_test.go:187:19: unused-parameter: parameter 'b' seems to be unused, consider removing or renaming it as _ (revive) matcher := func(b []byte) CompareResult { ^ fs/report_test.go:196:19: unused-parameter: parameter 'b' seems to be unused, consider removing or renaming it as _ (revive) matcher := func(b []byte) CompareResult { ^ fs/report.go:107:46: printf: non-constant format string in call to gotest.tools/v3/fs.existenceProblem (govet) p = append(p, existenceProblem("content", r.FailureMessage())) ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

assert/assert_test.go:249:12: unused-parameter: parameter 'b' seems to be unused, consider removing or renaming it as _ (revive) f := func(b bool) {} ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

Current versions of govet check for printf functions called with a format string, but no arguments. This results in linting errors: fs/report.go:107:46: printf: non-constant format string in call to gotest.tools/v3/fs.existenceProblem (govet) p = append(p, existenceProblem("content", r.FailureMessage())) ^ This patch changes existenceProblem to use format.Message, which is used elsewhere for similar situations. Signed-off-by: Sebastiaan van Stijn <[email protected]>

poll/example_test.go:38:16: unused-parameter: parameter 't' seems to be unused, consider removing or renaming it as _ (revive) check := func(t poll.LogT) poll.Result { ^ poll/poll_test.go:21:21: unused-parameter: parameter 'args' seems to be unused, consider removing or renaming it as _ (revive) func (t *fakeT) Log(args ...interface{}) {} ^ poll/poll_test.go:23:22: unused-parameter: parameter 'format' seems to be unused, consider removing or renaming it as _ (revive) func (t *fakeT) Logf(format string, args ...interface{}) {} ^ poll/poll_test.go:28:16: unused-parameter: parameter 't' seems to be unused, consider removing or renaming it as _ (revive) check := func(t LogT) Result { ^ poll/poll.go:154:18: printf: non-constant format string in call to gotest.tools/v3/poll.Continue (govet) return Continue(buf.String()) ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

assert/opt/opt_test.go:254:20: unused-parameter: parameter 't' seems to be unused, consider removing or renaming it as _ (revive) func TestPathDebug(t *testing.T) { ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

x/subtest/example_test.go:47:23: unused-parameter: parameter 't' seems to be unused, consider removing or renaming it as _ (revive) func startFakeService(t subtest.TestContext) string { ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

poll/poll.go:154:18: printf: non-constant format string in call to gotest.tools/v3/poll.Continue (govet) return Continue(buf.String()) ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

ccoVeille · 2024-08-28T13:41:08Z

poll/poll_test.go


-func (t *fakeT) Log(args ...interface{}) {}
+func (t *fakeT) Log(...interface{}) {}

-func (t *fakeT) Logf(format string, args ...interface{}) {}
+func (t *fakeT) Logf(string, ...interface{}) {}


Maybe you coule use any instead of interface{}

I kept interface{} for now, so that we didn't have to raise the go version in go.mod;

gotest.tools/go.mod

Line 3 in 631f6c8

go 1.17

(any would require go1.18 as minimum; https://go.dev/ref/spec#Go_1.18)

I know 😬 but Go 1.18 is now not only old, but no longer supported

Yup, more than aware; I also know that it's not uncommon for companies to maintain an (internal) LTS version of older Go versions. Not all of those will be visible publicly on GitHub. (e.g. I know Google for a long time required compatibility with go1.13 for some of their systems - they maintained their own version for that).

ccoVeille · 2024-08-28T13:41:33Z

fs/report.go


-func existenceProblem(filename, reason string, args ...interface{}) problem {
-	return problem(filename + ": " + fmt.Sprintf(reason, args...))
+func existenceProblem(filename string, msgAndArgs ...interface{}) problem {


Maybe you coule use ...any instead of ...interface{}

dnephin

Thank you!

We should update the Go minimum version sometime soon.

thaJeztah · 2024-08-29T07:39:49Z

We should update the Go minimum version sometime soon.

Yes, if there's a need to bump, that's probably fine.

I tried to avoid it if there's no strict / important reason, knowing that gotest.tools is a test-dependency, and (library) projects may want to continue support for old Go versions, therefore running tests against those, so it's worth trying to keep the requirements as low as reasonably possible.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [gotest.tools/v3](https://github.com/gotestyourself/gotest.tools) | require | patch | `v3.5.1` -> `v3.5.2` | --- ### Release Notes <details> <summary>gotestyourself/gotest.tools (gotest.tools/v3)</summary> ### [`v3.5.2`](https://github.com/gotestyourself/gotest.tools/releases/tag/v3.5.2) [Compare Source](gotestyourself/gotest.tools@v3.5.1...v3.5.2) #### What's Changed - assert: ensure message is always displayed & fix under bazel by [@cstrahan](https://github.com/cstrahan) in gotestyourself/gotest.tools#276 - go.mod: golang.org/x/tools v0.13.0 for go1.22+ compatibility by [@thaJeztah](https://github.com/thaJeztah) in gotestyourself/gotest.tools#282 - poll: Continue(): use format.Message for formatting by [@thaJeztah](https://github.com/thaJeztah) in gotestyourself/gotest.tools#279 - fix TestFromDirSymlink on Windows due to missing drive-letter by [@thaJeztah](https://github.com/thaJeztah) in gotestyourself/gotest.tools#283 - Fix various linting issues and minor bugs by [@thaJeztah](https://github.com/thaJeztah) in gotestyourself/gotest.tools#280 - fix badges in readme, gofmt, and minor linting fix by [@thaJeztah](https://github.com/thaJeztah) in gotestyourself/gotest.tools#284 - circleci: add go1.21, go1.22, go1.23, and update golangci-lint to v1.60.3 by [@thaJeztah](https://github.com/thaJeztah) in gotestyourself/gotest.tools#285 - assert, assert/cmp: un-deprecate assert.ErrorType for now by [@thaJeztah](https://github.com/thaJeztah) in gotestyourself/gotest.tools#286 #### New Contributors - [@cstrahan](https://github.com/cstrahan) made their first contribution in gotestyourself/gotest.tools#276 **Full Changelog**: gotestyourself/gotest.tools@v3.5.1...v3.5.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC), Automerge - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/524 Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>

thaJeztah commented Aug 22, 2024

View reviewed changes

thaJeztah force-pushed the linting_errors branch from 65d6780 to 6d6c58c Compare August 22, 2024 10:45

thaJeztah added 3 commits August 26, 2024 11:39

assert: fix empty-block (revive)

10b8a75

assert/assert_test.go:108:3: empty-block: this block is empty, you can remove it (revive) for range []int{1, 2, 3, 4} { } Signed-off-by: Sebastiaan van Stijn <[email protected]>

thaJeztah force-pushed the linting_errors branch from 6d6c58c to d65bc1e Compare August 26, 2024 09:39

ccoVeille reviewed Aug 28, 2024

View reviewed changes

internal/source/source.go Outdated Show resolved Hide resolved

internal/source/source.go Outdated Show resolved Hide resolved

thaJeztah added 9 commits August 28, 2024 14:54

internal/source: don't return nil result without an error (nilnil)

996232d

internal/source/source.go:75:2: return both the `nil` error and invalid value: use a sentinel error instead (nilnil) return nil, nil ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

assert: don't name unused parameters (revive)

7b3f988

assert/assert_test.go:249:12: unused-parameter: parameter 'b' seems to be unused, consider removing or renaming it as _ (revive) f := func(b bool) {} ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

assert: TestPathDebug: fix missing assertion

f5aded3

assert/opt/opt_test.go:254:20: unused-parameter: parameter 't' seems to be unused, consider removing or renaming it as _ (revive) func TestPathDebug(t *testing.T) { ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

poll: fix printf: non-constant format string in call (govet)

d21c522

poll/poll.go:154:18: printf: non-constant format string in call to gotest.tools/v3/poll.Continue (govet) return Continue(buf.String()) ^ Signed-off-by: Sebastiaan van Stijn <[email protected]>

thaJeztah force-pushed the linting_errors branch from d65bc1e to d21c522 Compare August 28, 2024 12:54

ccoVeille reviewed Aug 28, 2024

View reviewed changes

dnephin approved these changes Aug 29, 2024

View reviewed changes

dnephin merged commit 9aa7888 into gotestyourself:main Aug 29, 2024

thaJeztah deleted the linting_errors branch August 29, 2024 06:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix various linting issues and minor bugs #280

Fix various linting issues and minor bugs #280

Uh oh!

thaJeztah commented Aug 22, 2024

Uh oh!

thaJeztah Aug 22, 2024

Uh oh!

Uh oh!

Uh oh!

ccoVeille Aug 28, 2024

Uh oh!

thaJeztah Aug 28, 2024

Uh oh!

ccoVeille Aug 29, 2024

Uh oh!

thaJeztah Aug 29, 2024

Uh oh!

ccoVeille Aug 28, 2024

Uh oh!

dnephin left a comment

Uh oh!

thaJeztah commented Aug 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix various linting issues and minor bugs #280

Fix various linting issues and minor bugs #280

Uh oh!

Conversation

thaJeztah commented Aug 22, 2024

Uh oh!

thaJeztah Aug 22, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ccoVeille Aug 28, 2024

Choose a reason for hiding this comment

Uh oh!

thaJeztah Aug 28, 2024

Choose a reason for hiding this comment

Uh oh!

ccoVeille Aug 29, 2024

Choose a reason for hiding this comment

Uh oh!

thaJeztah Aug 29, 2024

Choose a reason for hiding this comment

Uh oh!

ccoVeille Aug 28, 2024

Choose a reason for hiding this comment

Uh oh!

dnephin left a comment

Choose a reason for hiding this comment

Uh oh!

thaJeztah commented Aug 29, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants