Add receipt status #526

chriskim06 · 2020-02-29T01:09:47Z

This adds the status object to the receipt type that was added earlier. The changes are pretty small, most of the additions are from tests implemented in the way outlined here.

Fixes #507
Related issue: #483

internal/installation/receipt/receipt.go

codecov-io · 2020-02-29T17:17:18Z

Codecov Report

Merging #526 into master will increase coverage by 0.75%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #526      +/-   ##
==========================================
+ Coverage   58.73%   59.49%   +0.75%     
==========================================
  Files          23       23              
  Lines        1013     1022       +9     
==========================================
+ Hits          595      608      +13     
+ Misses        359      355       -4     
  Partials       59       59

Impacted Files	Coverage Δ
internal/installation/receipt/receipt.go	`88.23% <100%> (+13.23%)`	⬆️
internal/index/indexscanner/scanner.go	`72.88% <0%> (+6.77%)`	⬆️

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 5c5c57b...fe00b8b. Read the comment docs.

ahmetb · 2020-02-29T17:26:01Z

internal/index/indexscanner/testdata/testindex/receipts/custom.yaml

+    uri: http://example.com/
+  shortDescription: in-memory test plugin object
+  version: v1.0.0-test.1
+Status:


This shouldnt be parsing correctly, right?

I didn't actually notice that I capitalized those. Let me look into it.

I thought the json struct tags would affect how it was parsed but it doesn't seem to be that way. When the receipt is written it uses lower case letters for those keys. Am I missing something?

This just shouldn’t be parsing accurately.
We currently ignore unknown fields intentionally.

I'm a little confused I think. What do you mean by unknown fields in this case? If you're referring specifically to the test receipt that has a custom index set in its status, I mainly added that even though only default can be set in a receipt because receipt.Load doesn't validate the index that is parsed. Let me know if I misunderstood.

All our fields are case-sensitive.
So as you can imagine, there can't be a field capitalized like Status.
So typing Status here should be the same as Asadklfjdksfj (which would be ignored).

I tried changing version to Version in my receipts in my normal krew installation and was still able to parse receipts in kubectl krew list (where it loads the receipts and gets .Spec.Version from them). Maybe I'm doing something wrong. I also thought they were case sensitive and made a mistake by accidentally making those capitalized in the test file, but didn't notice it since the tests were passing and they were still parsing correctly.

That's very odd. Let's continue assuming they're case-sensitive.
We can investigate later why.

internal/index/indexscanner/testdata/testindex/receipts/default-explicit.yaml

internal/index/indexscanner/scanner_test.go

internal/index/indexscanner/testdata/testindex/receipts/default-explicit.yaml

ahmetb · 2020-03-01T19:28:45Z

pkg/index/types.go

@@ -62,4 +62,17 @@ type FileOperation struct {
 // Receipt describes a plugin receipt file.
 type Receipt struct {
 	Plugin `json:",inline" yaml:",inline"`
+
+	Status ReceiptStatus `json:"status,omitempty"`


why ,omitempty? we want receipts to always have status (except today's receipts, which currently don't have, but once they are updated, they should).

This was just me misremembering what we talked about before, I wrote up the receipt issue before you and I cleared that up and I copied over the struct definitions I wrote there and forgot to remove this. I'll get rid of it 👍

internal/index/indexscanner/scanner_test.go

internal/installation/receipt/receipt_test.go

ahmetb · 2020-03-03T21:28:30Z

/lgtm
@corneliusweig for a quick review

corneliusweig

This already looks quite good. However, I'd like to reduce the number of extra test files. Ideally, you don't even need to add extra yaml files at all (see below).
But if you have a good reason to add these, please remove one of them because it does not add anything.

corneliusweig · 2020-03-03T21:12:05Z

internal/index/indexscanner/scanner_test.go

+	}
+	tests := []struct {
+		name       string
+		args       args


I haven't read the previous review comments, but is there a reason why receiptFilePath is wrapped in this args struct? There could as well just be a single receiptFilePath field.

Its left over from a previous version. I had some other things there before that I moved out, I'll make the change.

internal/index/indexscanner/scanner_test.go

corneliusweig · 2020-03-03T21:16:07Z

internal/index/indexscanner/scanner_test.go

+			wantStatus: index.ReceiptStatus{},
+		},
+		{
+			name: "read receipt of plugin from default index with status",


Suggested change

name: "read receipt of plugin from default index with status",

name: "read receipt with explicit source index",

corneliusweig · 2020-03-03T21:20:30Z

internal/installation/receipt/receipt_test.go

 	dest := tmpDir.Path("some-plugin.yaml")

 	if err := Store(testPlugin, dest); err != nil {
 		t.Fatal(err)
 	}

-	actual, err := indexscanner.LoadPluginByName(tmpDir.Root(), "some-plugin")
+	actual, err := indexscanner.ReadReceiptFromFile(tmpDir.Path("some-plugin.yaml"))


Suggested change

actual, err := indexscanner.ReadReceiptFromFile(tmpDir.Path("some-plugin.yaml"))

actual, err := indexscanner.ReadReceiptFromFile(dest)

corneliusweig · 2020-03-03T21:27:57Z

internal/index/indexscanner/scanner_test.go

+			args: args{
+				receiptFilePath: filepath.Join(testdataPath(t), "testindex", "receipts", "foo.yaml"),
+			},


You could also use your testdata builder NewReceipt().WithXX().V() and store that in a temporary directory with tmpDir.WriteYAML(...).
Why did you opt for test fixtures instead?

Ya I can change it to this. I think I did it this way because this is how it was outlined in the previous receipts PR and I just had that on my mind while I was working on this initially.

Yeah, we talked about both options. Back then we didn't have the receipt builder, so the static file was easier. But now, I think the dynamic approach is far better.

ahmetb · 2020-03-03T22:50:00Z

It's also currently unclear to me where we should be doing the "defaulting" of the missing status.index.name. Deferring this to the caller is error-prone. Potentially parsing function could do that.

WDYT @corneliusweig?

corneliusweig · 2020-03-04T00:58:23Z

Doing the defaulting while reading leads to the least duplication, so let's do it that way. Good idea!

Add tests to scanner_test.go to verify reading receipt files

corneliusweig

The last two little nits, then it's ready to merge from my side.

internal/index/indexscanner/scanner.go

pkg/index/types.go

ahmetb · 2020-03-04T22:19:56Z

/approve
we're close1!!!1

k8s-ci-robot · 2020-03-04T22:20:19Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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]

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

ahmetb · 2020-03-05T00:24:51Z

internal/index/indexscanner/scanner_test.go

-	wantStatus := &index.ReceiptStatus{
-		Source: index.SourceIndex{
-			Name: name,
+	type args struct {


for this time it's ok but in the future I recommend avoiding single-field type args

Crap sorry about that, you mentioned that before. I'll remember next time and change this in a follow up PR most likely.

ahmetb · 2020-03-05T00:25:27Z

/lgtm

corneliusweig · 2020-03-05T20:48:30Z

🎊 One more step! So nice to see this going forward!

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 29, 2020

k8s-ci-robot requested review from ahmetb and soltysh February 29, 2020 01:10

ahmetb reviewed Feb 29, 2020

View reviewed changes

internal/installation/receipt/receipt.go Outdated Show resolved Hide resolved

ahmetb reviewed Feb 29, 2020

View reviewed changes

internal/index/indexscanner/testdata/testindex/receipts/default-explicit.yaml Outdated Show resolved Hide resolved

ahmetb reviewed Mar 1, 2020

View reviewed changes

internal/index/indexscanner/scanner_test.go Outdated Show resolved Hide resolved

ahmetb reviewed Mar 1, 2020

View reviewed changes

internal/index/indexscanner/scanner_test.go Outdated Show resolved Hide resolved

ahmetb reviewed Mar 1, 2020

View reviewed changes

internal/index/indexscanner/scanner_test.go Outdated Show resolved Hide resolved

ahmetb reviewed Mar 1, 2020

View reviewed changes

internal/index/indexscanner/scanner_test.go Outdated Show resolved Hide resolved

ahmetb reviewed Mar 1, 2020

View reviewed changes

internal/index/indexscanner/testdata/testindex/receipts/default-explicit.yaml Outdated Show resolved Hide resolved

ahmetb reviewed Mar 1, 2020

View reviewed changes

ahmetb reviewed Mar 3, 2020

View reviewed changes

internal/index/indexscanner/scanner_test.go Outdated Show resolved Hide resolved

ahmetb reviewed Mar 3, 2020

View reviewed changes

internal/installation/receipt/receipt_test.go Outdated Show resolved Hide resolved

k8s-ci-robot assigned ahmetb Mar 3, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 3, 2020

corneliusweig reviewed Mar 3, 2020

View reviewed changes

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 3, 2020

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 4, 2020

chriskim06 added 5 commits March 4, 2020 09:38

Add receipt status

d2c8264

Add tests to scanner_test.go to verify reading receipt files

Add comment to receiptFromPlugin function

29f9b04

Code review changes

b19910f

Code review changes

f790682

Update store test and code review change

8367880

chriskim06 added 3 commits March 4, 2020 09:38

Initialize new receipt in tests with default index

15d1319

Code review changes

60c4d60

Set default index when receipt is parsed

22764a6

chriskim06 force-pushed the receipt-status branch from c1f485e to 22764a6 Compare March 4, 2020 17:38

corneliusweig reviewed Mar 4, 2020

View reviewed changes

internal/index/indexscanner/scanner.go Show resolved Hide resolved

pkg/index/types.go Show resolved Hide resolved

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2020

Add test case for receipt without status

fe00b8b

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 4, 2020

ahmetb reviewed Mar 5, 2020

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 5, 2020

k8s-ci-robot merged commit 31e0f49 into kubernetes-sigs:master Mar 5, 2020

ahmetb added the area/multi-index label Mar 28, 2020

chriskim06 mentioned this pull request Mar 28, 2020

REQUEST: New membership for chriskim06 kubernetes/org#1757

Closed

6 tasks

chriskim06 deleted the receipt-status branch June 11, 2020 15:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add receipt status #526

Add receipt status #526

chriskim06 commented Feb 29, 2020

codecov-io commented Feb 29, 2020 •

edited

Loading

ahmetb Feb 29, 2020 •

edited

Loading

chriskim06 Feb 29, 2020

chriskim06 Feb 29, 2020

ahmetb Feb 29, 2020

chriskim06 Mar 1, 2020

ahmetb Mar 1, 2020

chriskim06 Mar 2, 2020

ahmetb Mar 2, 2020 •

edited

Loading

ahmetb Mar 1, 2020

chriskim06 Mar 2, 2020

ahmetb commented Mar 3, 2020

corneliusweig left a comment

corneliusweig Mar 3, 2020

chriskim06 Mar 3, 2020

corneliusweig Mar 3, 2020

corneliusweig Mar 3, 2020

corneliusweig Mar 3, 2020

chriskim06 Mar 3, 2020

corneliusweig Mar 4, 2020

ahmetb commented Mar 3, 2020 •

edited

Loading

corneliusweig commented Mar 4, 2020

corneliusweig left a comment

ahmetb commented Mar 4, 2020

k8s-ci-robot commented Mar 4, 2020

ahmetb Mar 5, 2020

chriskim06 Mar 5, 2020

ahmetb commented Mar 5, 2020

corneliusweig commented Mar 5, 2020

	name: "read receipt of plugin from default index with status",
	name: "read receipt with explicit source index",

	actual, err := indexscanner.ReadReceiptFromFile(tmpDir.Path("some-plugin.yaml"))
	actual, err := indexscanner.ReadReceiptFromFile(dest)

Add receipt status #526

Add receipt status #526

Conversation

chriskim06 commented Feb 29, 2020

codecov-io commented Feb 29, 2020 • edited Loading

Codecov Report

ahmetb Feb 29, 2020 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmetb Mar 2, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmetb commented Mar 3, 2020

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

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

Choose a reason for hiding this comment

ahmetb commented Mar 3, 2020 • edited Loading

corneliusweig commented Mar 4, 2020

corneliusweig left a comment

Choose a reason for hiding this comment

ahmetb commented Mar 4, 2020

k8s-ci-robot commented Mar 4, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahmetb commented Mar 5, 2020

corneliusweig commented Mar 5, 2020

codecov-io commented Feb 29, 2020 •

edited

Loading

ahmetb Feb 29, 2020 •

edited

Loading

ahmetb Mar 2, 2020 •

edited

Loading

ahmetb commented Mar 3, 2020 •

edited

Loading