Move platform detection to pkg/installation #286

ahmetb · 2019-07-22T00:21:26Z

/kind cleanup

moved Platform matching methods to pkg/installation, where:
- they make more sense
- they can be tested without worrying about cyclic imports due to pkg/testutil.
rewrote some tests in platform_test.go to be shorter.
added a check to verify-code-patterns that uses a heuristic to detect inline
initializations of index.(Plugin|Platform) structs.

Fixes #284.

codecov-io · 2019-07-22T03:54:32Z

Codecov Report

Merging #286 into master will increase coverage by 0.63%.
The diff coverage is 85.71%.

@@            Coverage Diff             @@
##           master     #286      +/-   ##
==========================================
+ Coverage   54.84%   55.47%   +0.63%     
==========================================
  Files          19       19              
  Lines         877      876       -1     
==========================================
+ Hits          481      486       +5     
+ Misses        342      337       -5     
+ Partials       54       53       -1

Impacted Files	Coverage Δ
pkg/installation/util.go	`41.37% <100%> (ø)`	⬆️
pkg/installation/platform.go	`91.66% <83.33%> (ø)`
pkg/receipt/receipt.go
pkg/installation/receipt/receipt.go	`75% <0%> (ø)`
pkg/index/validation/validate.go	`95.34% <0%> (+4.65%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2364ae4...8d3c7a0. Read the comment docs.

- moved Platform matching methods to pkg/installation, where: - they make more sense - they can be tested without worrying about cyclic imports due to pkg/testutil. - rewrote some tests in platform_test.go to be shorter. - added a test for "no platforms specified" case in TestValidatePlugin. - added a check to verify-code-patterns that uses a heuristic to detect inline initializations of index.(Plugin|Platform) structs. Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>

pkg/index/validation/validate_test.go

hack/verify-code-patterns.sh

corneliusweig

Some small nits, otherwise looks great.

corneliusweig · 2019-07-22T07:02:30Z

pkg/installation/platform_test.go

+	inOS, inArch := runtime.GOOS, runtime.GOARCH
+	outOS, outArch := osArch()
+	if inOS != outOS {
+		t.Fatalf("returned OS=%q; expected=%q", outOS, inOS)


Errorf would do fine here and below.

corneliusweig · 2019-07-22T07:02:52Z

pkg/installation/platform_test.go

+	if inArch != outArch {
+		t.Fatalf("returned Arch=%q; expected=%q", outArch, inArch)
+	}
+}


another awkward brace. I know, it's fine ;)

I don't get it :) I realized there was a missing empty line, so I added it now.

pkg/installation/platform_test.go

corneliusweig · 2019-07-22T07:21:26Z

hack/verify-code-patterns.sh

+# TODO(ahmetb): ideally this plugin should cleanly scan all (index\.)(Plugin|Platform) occurrences except slice literals
+# (which are prefixed with []). However I could not get negative lookbehind pattern to work with grep to match to ones
+# that do not have a [] prefix.
+out="$(grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '\s+(index\.)(Plugin|Platform){' || true)"


Suggested change

out="$(grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '\s+(index\.)(Plugin|Platform){' || true)"

out="$(grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '[^]](index\.)(Plugin|Platform){' || true)"

This works with GNU grep. Can you check?

Can you explain [^]]? To me it reads like [^] is a negated set but it's empty, then there's a ] literal outside that's supposed to be a match.

I didn't know either. But if there is a negated character set, the first char following the caret is always interpreted verbatim. So this is indeed a negated char set of just ]. Iow it matches anything but a ], which is what we need here, right?

try on https://www.regexr.com

https://regexr.com/4ht16

I didn't find out what regex standard regexr.com uses, but I can see that regexr interprets my proposed pattern differently. My GNU grep 3.1 does what I described, I just double-checked. Have you checked, if it also works with BSD grep?

I finally found a proper reference: man 7 regex says

To include a literal ']' in the list, make it the first character (following a possible '^'). To include a literal '-', make it the first or last character, or the
second endpoint of a range.

For gnu grep, [^]] and [^\]] are different things:

$ grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '[^\]](index\.)(Plugin|Platform){' cmd/validate-krew-manifest/main_test.go:177: err := isOverlappingPlatformSelectors([]index.Platform{p1, p2}) cmd/validate-krew-manifest/main_test.go:192: err := isOverlappingPlatformSelectors([]index.Platform{p1, p2}) $ grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '[^]](index\.)(Plugin|Platform){' cmd/validate-krew-manifest/main_test.go:169: p1 := index.Platform{ cmd/validate-krew-manifest/main_test.go:174: p2 := index.Platform{ cmd/validate-krew-manifest/main_test.go:184: p1 := index.Platform{ cmd/validate-krew-manifest/main_test.go:189: p2 := index.Platform{

BSD grep is very dumb. It accepts arguments but then accepts input from STDIN (its cli is not fully compatible with gnu grep).

$ /usr/bin/grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '[^]](index\.)(Plugin|Platform){' | cat grep: warning: recursive search of stdin

maybe we should try to fix but I don't care much.

I've incorporated your recommendation.

hack/verify-code-patterns.sh

corneliusweig · 2019-07-22T07:24:49Z

@ahmetb Off-topic: as long as you don't have to rebase, could you put your review amendments in a separate commit? That makes the second review round easier.

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>

corneliusweig · 2019-07-22T19:36:35Z

/lgtm
/approve

k8s-ci-robot · 2019-07-22T19:36:40Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, corneliusweig

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ahmetb,corneliusweig]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jul 22, 2019

k8s-ci-robot requested review from corneliusweig and juanvallejo July 22, 2019 00:21

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 22, 2019

ahmetb force-pushed the presubmit-no-inline-plugin-structs branch 3 times, most recently from ca57cc6 to 95dfc10 Compare July 22, 2019 03:51

ahmetb force-pushed the presubmit-no-inline-plugin-structs branch from 95dfc10 to bc7357b Compare July 22, 2019 03:58

ahmetb commented Jul 22, 2019

View reviewed changes

pkg/index/validation/validate_test.go Show resolved Hide resolved

ahmetb commented Jul 22, 2019

View reviewed changes

hack/verify-code-patterns.sh Show resolved Hide resolved

corneliusweig suggested changes Jul 22, 2019

View reviewed changes

ahmetb added 2 commits July 22, 2019 09:56

Address code review comments

226fd68

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>

Fix regexp

8d3c7a0

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>

k8s-ci-robot assigned corneliusweig Jul 22, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 22, 2019

k8s-ci-robot merged commit 009e0ea into kubernetes-sigs:master Jul 22, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move platform detection to pkg/installation #286

Move platform detection to pkg/installation #286

ahmetb commented Jul 22, 2019 •

edited

codecov-io commented Jul 22, 2019 •

edited

corneliusweig left a comment

corneliusweig Jul 22, 2019

corneliusweig Jul 22, 2019

ahmetb Jul 22, 2019 •

edited

corneliusweig Jul 22, 2019

ahmetb Jul 22, 2019 •

edited

corneliusweig Jul 22, 2019

ahmetb Jul 22, 2019

ahmetb Jul 22, 2019

corneliusweig Jul 22, 2019 •

edited

corneliusweig Jul 22, 2019

ahmetb Jul 22, 2019

ahmetb Jul 22, 2019

corneliusweig commented Jul 22, 2019

corneliusweig commented Jul 22, 2019

k8s-ci-robot commented Jul 22, 2019

	out="$(grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '\s+(index\.)(Plugin\|Platform){' \|\| true)"
	out="$(grep --include '*_test.go' --exclude-dir 'vendor/' -EIrn '[^]](index\.)(Plugin\|Platform){' \|\| true)"

Move platform detection to pkg/installation #286

Move platform detection to pkg/installation #286

Conversation

ahmetb commented Jul 22, 2019 • edited

codecov-io commented Jul 22, 2019 • edited

Codecov Report

corneliusweig left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmetb Jul 22, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmetb Jul 22, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

corneliusweig Jul 22, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

corneliusweig commented Jul 22, 2019

corneliusweig commented Jul 22, 2019

k8s-ci-robot commented Jul 22, 2019

ahmetb commented Jul 22, 2019 •

edited

codecov-io commented Jul 22, 2019 •

edited

ahmetb Jul 22, 2019 •

edited

ahmetb Jul 22, 2019 •

edited

corneliusweig Jul 22, 2019 •

edited