lint: Introduce Makefile target, introduce pre-commit config and fix issues #495

lyarwood · 2023-02-10T21:42:01Z

What this PR does / why we need it:

Adds a lint Makefile target using golangci-lint initially with the following plugins enabled:

whitespace
misspell
ginkgolinter
errcheck
ineffassign
staticcheck
unused
errname

Additionally provides a pre-commit config users can opt into using to help catch issues before committing changes locally.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Release note:

NONE

openshift-ci · 2023-02-10T21:42:03Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

ksimon1 · 2023-02-11T11:29:02Z

Do you think you can include this linter into our tests?

lyarwood · 2023-02-12T18:07:26Z

Do you think you can include this linter into our tests?

Yup indeed that's why this is just a draft for now, I'll try to work something out next week.

lyarwood · 2023-02-13T10:41:55Z

/retest-required

0xFelix

Nice initiative!

.golangci.yaml

lyarwood · 2023-02-16T19:27:59Z

/hold

lyarwood · 2023-02-16T19:34:20Z

/test ci/prow/images

kubevirt-bot · 2023-02-16T19:34:21Z

@lyarwood: No presubmit jobs available for kubevirt/ssp-operator@master

In response to this:

/test ci/prow/images

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

lyarwood · 2023-03-08T12:49:09Z

/hold

Will continue looking into this next week and will likely end up adding the ability for must-gather to collect the SSP CR.

Slightly confused by the version of must-gather we are using in CI, I can't seem to find a copy of the SSP CR that is present when I use the kubevirt/must-gather image locally. I'll hack around some more today.

lyarwood · 2023-03-08T16:18:46Z

/retest-required

codingben · 2023-03-09T08:28:45Z

@lyarwood Is it possible to also include #509 in this PR?

lyarwood · 2023-03-09T09:27:02Z

internal/operands/vm-console-proxy/reconcile_test.go

Yeah I'll rebase on that shortly once I've worked out the failures

lyarwood · 2023-03-09T14:36:35Z

internal/template-validator/service/service.go

@@ -60,7 +64,9 @@ func Setup(service Service) {
 		f2 := klogFlags.Lookup(f1.Name)
 		if f2 != nil {
 			value := f1.Value.String()
-			f2.Value.Set(value)
+			if err := f2.Value.Set(value); err != nil {
+				panic(fmt.Sprintf("%v", err))


Wonderful, this is causing a panic in the tests. Looking in more detail now.

panic: syntax error: expect file.go:234 │ goroutine 1 [running]: │ │ kubevirt.io/ssp-operator/internal/template-validator/service.Setup.func1(0xc000284a00) │ │ /workspace/internal/template-validator/service/service.go:68 +0xd9 │ │ github.com/spf13/pflag.(*FlagSet).VisitAll(0xc00014e000?, 0xc00009ff10) │ │ /workspace/vendor/github.com/spf13/pflag/flag.go:290 +0xec │ │ kubevirt.io/ssp-operator/internal/template-validator/service.Setup({0x18c4760?, 0xc000458000?}) │ │ /workspace/internal/template-validator/service/service.go:63 +0x185 │ │ main.Main() │ │ /workspace/internal/template-validator/main.go:13 +0x39 │ │ main.main() │ │ /workspace/internal/template-validator/main.go:20 +0x19

Fixed by 1650fa6

Signed-off-by: Lee Yarwood <[email protected]>

lyarwood · 2023-03-09T17:07:12Z

/unhold

lyarwood · 2023-03-10T07:49:33Z

/retest-required

0xFelix · 2023-03-10T08:49:32Z

Looks good, just one ping about a previous comment.

Signed-off-by: Lee Yarwood <[email protected]>

This change introduces pre-commit, a useful framework for ensuring changes meet certain requirements *before* they are fully committed. This requires the user install pre-commit itself but this is as easy as: https://pre-commit.com/#usage $ pip install --user pre-commit $ cd path/to/ssp-operator && pre-commit install Signed-off-by: Lee Yarwood <[email protected]>

This change removes some older glue code with a native pflag call to handle the setup of any goflag flags defined by indirect dependencies like glog. This should be removed when this dependency has gone. Signed-off-by: Lee Yarwood <[email protected]>

sonarqubecloud · 2023-03-13T10:45:50Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

0xFelix · 2023-03-13T13:26:40Z

Thanks!
/lgtm
/retest

lyarwood · 2023-03-13T18:28:01Z

/retest-required

lyarwood · 2023-03-13T22:06:03Z

https://prow.ci.openshift.org/job-history/gs/origin-ci-test/pr-logs/directory/pull-ci-kubevirt-ssp-operator-master-e2e-single-node-functests looks like the job is broken? I'll take a look in the morning.

lyarwood · 2023-03-14T11:23:36Z

/retest-required

lyarwood · 2023-03-14T13:25:18Z

/retest-required

kubevirt-bot added the release-note-none Denotes a PR that doesn't merit a release note. label Feb 10, 2023

kubevirt-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Feb 10, 2023

kubevirt-bot requested review from 0xFelix and ksimon1 February 10, 2023 21:42

kubevirt-bot added the size/L label Feb 10, 2023

lyarwood changed the title ~~ginkgo-linter: Fix all reported errors~~ ginkgo-linter: Fix all reported errors and add a lint Makefile target Feb 13, 2023

lyarwood marked this pull request as ready for review February 13, 2023 09:18

kubevirt-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 13, 2023

kubevirt-bot requested a review from akrejcir February 13, 2023 09:18

lyarwood force-pushed the ginkgo-linter branch from 754fe60 to 82fbfda Compare February 15, 2023 10:35

lyarwood changed the title ~~ginkgo-linter: Fix all reported errors and add a lint Makefile target~~ golangci-lint: Introduce Makefile lint target and fix issues for the ginkgolint, whitespace and misspell plugins Feb 15, 2023

lyarwood changed the title ~~golangci-lint: Introduce Makefile lint target and fix issues for the ginkgolint, whitespace and misspell plugins~~ golangci-lint: Introduce lint Makefile target and fix issues for the ginkgolint, whitespace and misspell plugins Feb 15, 2023

0xFelix reviewed Feb 15, 2023

View reviewed changes

.golangci.yaml Outdated Show resolved Hide resolved

.golangci.yaml Show resolved Hide resolved

lyarwood force-pushed the ginkgo-linter branch from a88f209 to 00aa9af Compare February 15, 2023 16:25

kubevirt-bot added dco-signoff: no Indicates the PR's author has not DCO signed all their commits. and removed dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Feb 15, 2023

lyarwood force-pushed the ginkgo-linter branch from 00aa9af to 4172a99 Compare February 15, 2023 16:27

kubevirt-bot added dco-signoff: yes Indicates the PR's author has DCO signed all their commits. and removed dco-signoff: no Indicates the PR's author has not DCO signed all their commits. labels Feb 15, 2023

kubevirt-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 16, 2023

lyarwood marked this pull request as draft February 16, 2023 19:28

kubevirt-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 16, 2023

lyarwood force-pushed the ginkgo-linter branch from 6ec89a1 to 960bbed Compare March 9, 2023 09:40

lyarwood commented Mar 9, 2023

View reviewed changes

lyarwood added 3 commits March 9, 2023 16:52

lint: Add Makefile target using golangci-lint

b338d15

Signed-off-by: Lee Yarwood <[email protected]>

lint: Add misspell

b1c7997

Signed-off-by: Lee Yarwood <[email protected]>

lint: Add ginkgolinter

ef51dc2

Signed-off-by: Lee Yarwood <[email protected]>

lyarwood force-pushed the ginkgo-linter branch from 960bbed to 1650fa6 Compare March 9, 2023 16:55

kubevirt-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 9, 2023

lyarwood added 7 commits March 13, 2023 10:44

lint: Add errcheck

9b3bb20

Signed-off-by: Lee Yarwood <[email protected]>

lint: Add ineffassign

5ce8bfa

Signed-off-by: Lee Yarwood <[email protected]>

lint: Add staticcheck

c143559

Signed-off-by: Lee Yarwood <[email protected]>

lint: Add unused

37505b1

Signed-off-by: Lee Yarwood <[email protected]>

lint: Add errname

e4c94ed

Signed-off-by: Lee Yarwood <[email protected]>

lyarwood force-pushed the ginkgo-linter branch from 1650fa6 to d5c0c85 Compare March 13, 2023 10:45

kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Mar 13, 2023

kubevirt-bot merged commit 6b778b1 into kubevirt:master Mar 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

lint: Introduce Makefile target, introduce pre-commit config and fix issues #495

lint: Introduce Makefile target, introduce pre-commit config and fix issues #495

lyarwood commented Feb 10, 2023 •

edited

Loading

openshift-ci bot commented Feb 10, 2023

ksimon1 commented Feb 11, 2023

lyarwood commented Feb 12, 2023

lyarwood commented Feb 13, 2023

0xFelix left a comment

lyarwood commented Feb 16, 2023

lyarwood commented Feb 16, 2023

kubevirt-bot commented Feb 16, 2023

lyarwood commented Mar 8, 2023

lyarwood commented Mar 8, 2023

codingben commented Mar 9, 2023

lyarwood commented Mar 9, 2023

lyarwood Mar 9, 2023

lyarwood Mar 9, 2023

lyarwood commented Mar 9, 2023

lyarwood commented Mar 10, 2023

0xFelix commented Mar 10, 2023

sonarqubecloud bot commented Mar 13, 2023

0xFelix commented Mar 13, 2023

lyarwood commented Mar 13, 2023

lyarwood commented Mar 13, 2023

lyarwood commented Mar 14, 2023

lyarwood commented Mar 14, 2023

lint: Introduce Makefile target, introduce pre-commit config and fix issues #495

lint: Introduce Makefile target, introduce pre-commit config and fix issues #495

Conversation

lyarwood commented Feb 10, 2023 • edited Loading

openshift-ci bot commented Feb 10, 2023

ksimon1 commented Feb 11, 2023

lyarwood commented Feb 12, 2023

lyarwood commented Feb 13, 2023

0xFelix left a comment

Choose a reason for hiding this comment

lyarwood commented Feb 16, 2023

lyarwood commented Feb 16, 2023

kubevirt-bot commented Feb 16, 2023

lyarwood commented Mar 8, 2023

lyarwood commented Mar 8, 2023

codingben commented Mar 9, 2023

lyarwood commented Mar 9, 2023

lyarwood Mar 9, 2023

Choose a reason for hiding this comment

lyarwood Mar 9, 2023

Choose a reason for hiding this comment

lyarwood commented Mar 9, 2023

lyarwood commented Mar 10, 2023

0xFelix commented Mar 10, 2023

sonarqubecloud bot commented Mar 13, 2023

0xFelix commented Mar 13, 2023

lyarwood commented Mar 13, 2023

lyarwood commented Mar 13, 2023

lyarwood commented Mar 14, 2023

lyarwood commented Mar 14, 2023

lyarwood commented Feb 10, 2023 •

edited

Loading