Populate receipt status on install/upgrade #555

chriskim06 · 2020-03-21T19:41:48Z

Related issue: #483

ahmetb · 2020-03-25T16:19:11Z

cmd/krew/cmd/install.go

 			}

 			if *manifest != "" {
 				plugin, err := indexscanner.ReadPluginFromFile(*manifest)
 				if err != nil {
 					return errors.Wrap(err, "failed to load plugin manifest from file")
 				}
-				install = append(install, plugin)
+				install = append(install, receipt.New(plugin, constants.DefaultIndexName))


I think we should not convert to Receipt until we actually installed, and we're about to write the Receipt object to disk. Thoughts @corneliusweig?

This complicates the code a bit, because nothing's installed yet, but scan index dir + convert everything to Receipt in-memory already. Looks odd in the code to me.

That's why I was imagining a small internal type, specific to this pkg that contains Plugin+indexname only.

I have something like this in mind:

type pluginEntry { p plugin indexName string }

it's low effort, and doesn't overload Receipt type, just because it has a field to store the indexName. :)

Ya I was going back and forth on that a lot when I was working on this. It felt weird to add a new type that was essentially the same as Receipt but I agree that it is weird/conceptually wrong to create the receipt before the plugin is actually installed.

Yeah, this is definitely cleaner. Just because Receipt happens to have the field that we want to store in addition does not mean it is the right choice. Consider what happens when we add more fields to Receipt. What would happen most likely is that we would not update this instance and then we have a in invalid Receipt in our hands. So a dedicated struct is what we need here.

ahmetb · 2020-03-25T16:56:53Z

internal/installation/install.go

@@ -54,7 +54,8 @@ var (

 // Install will download and install a plugin. The operation tries
 // to not get the plugin dir in a bad state if it fails during the process.
-func Install(p environment.Paths, plugin index.Plugin, opts InstallOpts) error {
+func Install(p environment.Paths, pluginReceipt index.Receipt, opts InstallOpts) error {


this should not receive a Receipt, conceptually sounds wrong.

ahmetb · 2020-03-25T16:57:33Z

internal/installation/receipt/receipt.go

 	"sigs.k8s.io/krew/pkg/index"
 )

 // Store saves the given plugin receipt at the destination.
 // The caller has to ensure that the destination directory exists.
-func Store(plugin index.Plugin, dest string) error {
+func Store(plugin index.Receipt, dest string) error {


you might wanna rename variable name to receipt as well + update godoc. :)

ahmetb · 2020-03-25T16:57:45Z

internal/installation/receipt/receipt.go

+	if name == "" {
+		name = constants.DefaultIndexName
+	}


under what condition we specify "" ?

You're right, I forgot the CanonicalPluginName function returns the default index already. I can remove this.

Even without that, this should not happen. We'll always have an index name in pkg/installation.

CanonicalPluginName should be used only for turning user input (e.g. install args) to full plugin names.

It sounds like you are talking about the same thing. Anyway, everybody agrees that the check name == "" is unnecessary, because it is covered elsewhere.

ahmetb · 2020-03-26T16:42:44Z

cmd/krew/cmd/install.go

-				install = append(install, plugin)
+				install = append(install, pluginEntry{
+					p:         plugin,
+					indexName: constants.DefaultIndexName,


this is a case we did not think of.
I guess we can keep shoving them into default. thoughts @corneliusweig ?

This is what happens at the moment. But we can use the opportunity to separate this better from the default index. So instead, what about setting the indexName to detached or something similar?

++ @chriskim06 do you mind making a small PR?

ahmetb · 2020-03-26T16:46:46Z

Right now we lack any integration tests for the changes.

Note that you're changing criticial path in this PR. So we need to make sure newly added behavior works. We can merge, but the very next PR we need would be the integration tests.

Some basic cases I'm thinking easily:

add index + install with its prefix
install plugins with default/ prefix

chriskim06 · 2020-03-26T18:41:15Z

I can add the integration tests here or in a separate one if that'll make it easier. Let me know which one you'd prefer.

ahmetb · 2020-03-27T05:22:56Z

cmd/krew/cmd/install.go

-			for _, plugin := range install {
-				klog.V(2).Infof("Will install plugin: %s\n", plugin.Name)
+			for _, pluginEntry := range install {
+				klog.V(2).Infof("Will install plugin: %s\n", pluginEntry.p.Name)


this will omit the index name.

ahmetb · 2020-03-27T05:32:22Z

I can add the integration tests here or in a separate one if that'll make it easier. Let me know which one you'd prefer.

I'm curious how you tested this currently. I'm trying to get it to work locally and tried a fake local index at a directory, and wasn't able to install. So the integration tests can actually verify it works.

chriskim06 · 2020-03-27T05:57:49Z

That's strange. I pretty much did what you mentioned and what's in the integration test: add index then install and it worked.

ahmetb · 2020-03-27T06:11:24Z

/lgtm
/approve

nice and small patch!

k8s-ci-robot · 2020-03-27T06:11:44Z

[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-27T06:12:45Z

While testing locally I noticed that if I create a fake index dir, do git init . and locally and add that, the repo is cloned but it is empty (since it has no commits).

So we need to document that while testing with local index repos, they need to commit the changes, so that the update or index add mechanism can clone the copy of the index from a commit.

chriskim06 added 6 commits March 20, 2020 18:33

Create receipt earlier to pass to Store function

42f6917

Add godoc to receipt function

6eaaf35

Add simple test

d79dbb5

Update some variable names to make more sense

7ec4a79

Use default index name in new receipts

d7cb108

Use index name in plugin lookup

fd6b506

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 21, 2020

k8s-ci-robot requested review from ahmetb and corneliusweig March 21, 2020 19:41

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 21, 2020

ahmetb reviewed Mar 25, 2020

View reviewed changes

Code review changes

78c9800

ahmetb reviewed Mar 26, 2020

View reviewed changes

ahmetb reviewed Mar 27, 2020

View reviewed changes

Add integration test

fcc6505

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 27, 2020

k8s-ci-robot assigned ahmetb Mar 27, 2020

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

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

k8s-ci-robot merged commit ba34034 into kubernetes-sigs:master Mar 27, 2020

ahmetb mentioned this pull request Mar 28, 2020

Proposal: make krew info work with multiple indexes #559

Closed

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 populate-receipt-status branch June 11, 2020 15:05

chriskim06 mentioned this pull request Jul 24, 2020

Not friendly "upgrade" message for detached plugins #625

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Populate receipt status on install/upgrade #555

Populate receipt status on install/upgrade #555

chriskim06 commented Mar 21, 2020

ahmetb Mar 25, 2020

ahmetb Mar 25, 2020 •

edited

Loading

chriskim06 Mar 25, 2020

corneliusweig Mar 25, 2020

ahmetb Mar 25, 2020

ahmetb Mar 25, 2020

ahmetb Mar 25, 2020

chriskim06 Mar 25, 2020

ahmetb Mar 25, 2020

corneliusweig Mar 25, 2020 •

edited

Loading

ahmetb Mar 26, 2020

corneliusweig Mar 28, 2020

ahmetb Mar 29, 2020

ahmetb commented Mar 26, 2020

chriskim06 commented Mar 26, 2020

ahmetb Mar 27, 2020

ahmetb commented Mar 27, 2020

chriskim06 commented Mar 27, 2020

ahmetb commented Mar 27, 2020 •

edited

Loading

k8s-ci-robot commented Mar 27, 2020

ahmetb commented Mar 27, 2020

Populate receipt status on install/upgrade #555

Populate receipt status on install/upgrade #555

Conversation

chriskim06 commented Mar 21, 2020

Choose a reason for hiding this comment

ahmetb Mar 25, 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

Choose a reason for hiding this comment

corneliusweig Mar 25, 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

ahmetb commented Mar 26, 2020

chriskim06 commented Mar 26, 2020

Choose a reason for hiding this comment

ahmetb commented Mar 27, 2020

chriskim06 commented Mar 27, 2020

ahmetb commented Mar 27, 2020 • edited Loading

k8s-ci-robot commented Mar 27, 2020

ahmetb commented Mar 27, 2020

ahmetb Mar 25, 2020 •

edited

Loading

corneliusweig Mar 25, 2020 •

edited

Loading

ahmetb commented Mar 27, 2020 •

edited

Loading