*: Port from Update to Release for ClusterVersion status

The next/last Actual comparison avoids:

  invalid operation: next.Actual == last.Actual (struct containing []string cannot be compared)

The image pullspec is sufficient for that matching.  The test suite's
expected LastProgress changes are because the shift from:

  {Version: "4.0.1", Image: "image/image:1"}

to:

  {Version: "1.0.0-abc", Image: "image/image:1"}

no longer counts as a LastProgress-bumping change (because we're now
only comparing the Image pullspecs).

Also adjusts the upstream/Cincinnati retrieval and payload loading
logic to preserve the additional metadata that we're now exposing.
Storing a Release on the Operator, instead of extending the previous
releaseVersion/releaseImage pattern, makes it easy to keep track of
payload-loaded metadata, so we can fall-back to upstream metadata for
properties where the payload has no opinion, as described in the
enhancement.

In findUpdateFromConfigVersion, if some crazy upstream service
declared a node with a matching version but no image, we used to say
"sorry, no match" without looking through history.  Now we skip the
useless entry and move on to consider later entries and history.  We
only say "no match" if we have no image pullspec associated with the
requested version available.

Author: wking

docs/user/status.md

@@ -110,7 +110,7 @@ It could also be an overloaded or otherwise failing Cincinnati server.
 
 ### ResponseInvalid
 
-The Cincinnati server returned a response that was not valid JSON.
+The Cincinnati server returned a response that was not valid JSON or is otherwise corrupted.
 
 This could be caused by a buggy Cincinnati server.
 It could also be caused by response corruption, e.g. if the configured `upstream` was in the clear over HTTP or via a man-in-the-middle HTTPS proxy, and an intervening component altered the response in flight.

pkg/autoupdate/autoupdate.go

@@ -175,7 +175,10 @@ func (ctrl *Controller) sync(ctx context.Context, key string) error {
 		return nil
 	}
 	up := nextUpdate(clusterversion.Status.AvailableUpdates)
-	clusterversion.Spec.DesiredUpdate = &up
+	clusterversion.Spec.DesiredUpdate = &v1.Update{
+		Version: up.Version,
+		Image:   up.Image,
+	}
 
 	_, updated, err := resourceapply.ApplyClusterVersionFromCache(ctx, ctrl.cvLister, ctrl.client.ConfigV1(), clusterversion)
 	if updated {
@@ -184,11 +187,11 @@ func (ctrl *Controller) sync(ctx context.Context, key string) error {
 	return err
 }
 
-func updateAvail(ups []v1.Update) bool {
+func updateAvail(ups []v1.Release) bool {
 	return len(ups) > 0
 }
 
-func nextUpdate(ups []v1.Update) v1.Update {
+func nextUpdate(ups []v1.Release) v1.Release {
 	sorted := ups
 	sort.Slice(sorted, func(i, j int) bool {
 		vi := semver.MustParse(sorted[i].Version)

pkg/autoupdate/autoupdate_test.go

@@ -29,9 +29,9 @@ func TestNextUpdate(t *testing.T) {
 	}}
 	for idx, test := range tests {
 		t.Run(fmt.Sprintf("test: #%d", idx), func(t *testing.T) {
-			ups := []v1.Update{}
+			ups := []v1.Release{}
 			for _, v := range test.avail {
-				ups = append(ups, v1.Update{Version: v})
+				ups = append(ups, v1.Release{Version: v})
 			}
 
 			got := nextUpdate(ups)

pkg/cincinnati/cincinnati.go

@@ -56,14 +56,15 @@ func (err *Error) Error() string {
 	return fmt.Sprintf("%s: %s", err.Reason, err.Message)
 }
 
-// GetUpdates fetches the next-applicable update payloads from the specified
+// GetUpdates fetches the current and next-applicable update payloads from the specified
 // upstream Cincinnati stack given the current version and channel. The next-
 // applicable updates are determined by downloading the update graph, finding
 // the current version within that graph (typically the root node), and then
 // finding all of the children. These children are the available updates for
 // the current version and their payloads indicate from where the actual update
 // image can be downloaded.
-func (c Client) GetUpdates(ctx context.Context, uri *url.URL, arch string, channel string, version semver.Version) ([]Update, error) {
+func (c Client) GetUpdates(ctx context.Context, uri *url.URL, arch string, channel string, version semver.Version) (Update, []Update, error) {
+	var current Update
 	transport := http.Transport{}
 	// Prepare parametrized cincinnati query.
 	queryParams := uri.Query()
@@ -76,7 +77,7 @@ func (c Client) GetUpdates(ctx context.Context, uri *url.URL, arch string, chann
 	// Download the update graph.
 	req, err := http.NewRequest("GET", uri.String(), nil)
 	if err != nil {
-		return nil, &Error{Reason: "InvalidRequest", Message: err.Error(), cause: err}
+		return current, nil, &Error{Reason: "InvalidRequest", Message: err.Error(), cause: err}
 	}
 	req.Header.Add("Accept", GraphMediaType)
 	if c.tlsConfig != nil {
@@ -92,23 +93,23 @@ func (c Client) GetUpdates(ctx context.Context, uri *url.URL, arch string, chann
 	defer cancel()
 	resp, err := client.Do(req.WithContext(timeoutCtx))
 	if err != nil {
-		return nil, &Error{Reason: "RemoteFailed", Message: err.Error(), cause: err}
+		return current, nil, &Error{Reason: "RemoteFailed", Message: err.Error(), cause: err}
 	}
 	defer resp.Body.Close()
 
 	if resp.StatusCode != http.StatusOK {
-		return nil, &Error{Reason: "ResponseFailed", Message: fmt.Sprintf("unexpected HTTP status: %s", resp.Status)}
+		return current, nil, &Error{Reason: "ResponseFailed", Message: fmt.Sprintf("unexpected HTTP status: %s", resp.Status)}
 	}
 
 	// Parse the graph.
 	body, err := ioutil.ReadAll(resp.Body)
 	if err != nil {
-		return nil, &Error{Reason: "ResponseFailed", Message: err.Error(), cause: err}
+		return current, nil, &Error{Reason: "ResponseFailed", Message: err.Error(), cause: err}
 	}
 
 	var graph graph
 	if err = json.Unmarshal(body, &graph); err != nil {
-		return nil, &Error{Reason: "ResponseInvalid", Message: err.Error(), cause: err}
+		return current, nil, &Error{Reason: "ResponseInvalid", Message: err.Error(), cause: err}
 	}
 
 	// Find the current version within the graph.
@@ -117,12 +118,13 @@ func (c Client) GetUpdates(ctx context.Context, uri *url.URL, arch string, chann
 	for i, node := range graph.Nodes {
 		if version.EQ(node.Version) {
 			currentIdx = i
+			current = Update(graph.Nodes[i])
 			found = true
 			break
 		}
 	}
 	if !found {
-		return nil, &Error{
+		return current, nil, &Error{
 			Reason:  "VersionNotFound",
 			Message: fmt.Sprintf("currently installed version %s not found in the %q channel", version, channel),
 		}
@@ -141,7 +143,7 @@ func (c Client) GetUpdates(ctx context.Context, uri *url.URL, arch string, chann
 		updates = append(updates, Update(graph.Nodes[i]))
 	}
 
-	return updates, nil
+	return current, updates, nil
 }
 
 type graph struct {
@@ -150,8 +152,9 @@ type graph struct {
 }
 
 type node struct {
-	Version semver.Version `json:"version"`
-	Image   string         `json:"payload"`
+	Version  semver.Version    `json:"version"`
+	Image    string            `json:"payload"`
+	Metadata map[string]string `json:"metadata,omitempty"`
 }
 
 type edge struct {

pkg/cincinnati/cincinnati_test.go

@@ -25,26 +25,30 @@ func TestGetUpdates(t *testing.T) {
 		version string
 
 		expectedQuery string
+		current       Update
 		available     []Update
 		err           string
 	}{{
 		name:          "one update available",
 		version:       "4.0.0-4",
 		expectedQuery: "arch=test-arch&channel=test-channel&id=01234567-0123-0123-0123-0123456789ab&version=4.0.0-4",
+		current:       Update{Version: semver.MustParse("4.0.0-4"), Image: "quay.io/openshift-release-dev/ocp-release:4.0.0-4"},
 		available: []Update{
-			{semver.MustParse("4.0.0-5"), "quay.io/openshift-release-dev/ocp-release:4.0.0-5"},
+			{Version: semver.MustParse("4.0.0-5"), Image: "quay.io/openshift-release-dev/ocp-release:4.0.0-5"},
 		},
 	}, {
 		name:          "two updates available",
 		version:       "4.0.0-5",
 		expectedQuery: "arch=test-arch&channel=test-channel&id=01234567-0123-0123-0123-0123456789ab&version=4.0.0-5",
+		current:       Update{Version: semver.MustParse("4.0.0-5"), Image: "quay.io/openshift-release-dev/ocp-release:4.0.0-5"},
 		available: []Update{
-			{semver.MustParse("4.0.0-6"), "quay.io/openshift-release-dev/ocp-release:4.0.0-6"},
-			{semver.MustParse("4.0.0-6+2"), "quay.io/openshift-release-dev/ocp-release:4.0.0-6+2"},
+			{Version: semver.MustParse("4.0.0-6"), Image: "quay.io/openshift-release-dev/ocp-release:4.0.0-6"},
+			{Version: semver.MustParse("4.0.0-6+2"), Image: "quay.io/openshift-release-dev/ocp-release:4.0.0-6+2"},
 		},
 	}, {
 		name:          "no updates available",
 		version:       "4.0.0-0.okd-0",
+		current:       Update{Version: semver.MustParse("4.0.0-0.okd-0"), Image: "quay.io/openshift-release-dev/ocp-release:4.0.0-0.okd-0"},
 		expectedQuery: "arch=test-arch&channel=test-channel&id=01234567-0123-0123-0123-0123456789ab&version=4.0.0-0.okd-0",
 	}, {
 		name:          "unknown version",
@@ -79,38 +83,31 @@ func TestGetUpdates(t *testing.T) {
 					"nodes": [
 					  {
 						"version": "4.0.0-4",
-						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-4",
-						"metadata": {}
+						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-4"
 					  },
 					  {
 						"version": "4.0.0-5",
-						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-5",
-						"metadata": {}
+						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-5"
 					  },
 					  {
 						"version": "4.0.0-6",
-						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-6",
-						"metadata": {}
+						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-6"
 					  },
 					  {
 						"version": "4.0.0-6+2",
-						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-6+2",
-						"metadata": {}
+						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-6+2"
 					  },
 					  {
 						"version": "4.0.0-0.okd-0",
-						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-0.okd-0",
-						"metadata": {}
+						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-0.okd-0"
 					  },
 					  {
 						"version": "4.0.0-0.2",
-						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-0.2",
-						"metadata": {}
+						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-0.2"
 					  },
 					  {
 						"version": "4.0.0-0.3",
-						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-0.3",
-						"metadata": {}
+						"payload": "quay.io/openshift-release-dev/ocp-release:4.0.0-0.3"
 					  }
 					],
 					"edges": [[0,1],[1,2],[1,3],[5,6]]
@@ -133,13 +130,16 @@ func TestGetUpdates(t *testing.T) {
 				t.Fatal(err)
 			}
 
-			updates, err := c.GetUpdates(context.Background(), uri, arch, channelName, semver.MustParse(test.version))
+			current, updates, err := c.GetUpdates(context.Background(), uri, arch, channelName, semver.MustParse(test.version))
 			if test.err == "" {
 				if err != nil {
 					t.Fatalf("expected nil error, got: %v", err)
 				}
+				if !reflect.DeepEqual(current, test.current) {
+					t.Fatalf("expected current %v, got: %v", test.current, current)
+				}
 				if !reflect.DeepEqual(updates, test.available) {
-					t.Fatalf("expected %v, got: %v", test.available, updates)
+					t.Fatalf("expected updates %v, got: %v", test.available, updates)
 				}
 			} else {
 				if err == nil || err.Error() != test.err {
@@ -181,7 +181,11 @@ func Test_nodeUnmarshalJSON(t *testing.T) {
 			"metadata": {}
 		  }`),
 
-		exp: node{semver.MustParse("4.0.0-5"), "quay.io/openshift-release-dev/ocp-release:4.0.0-5"},
+		exp: node{
+			Version:  semver.MustParse("4.0.0-5"),
+			Image:    "quay.io/openshift-release-dev/ocp-release:4.0.0-5",
+			Metadata: map[string]string{},
+		},
 	}, {
 		raw: []byte(`{
 			"version": "4.0.0-0.1",
@@ -190,7 +194,13 @@ func Test_nodeUnmarshalJSON(t *testing.T) {
 			  "description": "This is the beta1 image based on the 4.0.0-0.nightly-2019-01-15-010905 build"
 			}
 		  }`),
-		exp: node{semver.MustParse("4.0.0-0.1"), "quay.io/openshift-release-dev/ocp-release:4.0.0-0.1"},
+		exp: node{
+			Version: semver.MustParse("4.0.0-0.1"),
+			Image:   "quay.io/openshift-release-dev/ocp-release:4.0.0-0.1",
+			Metadata: map[string]string{
+				"description": "This is the beta1 image based on the 4.0.0-0.nightly-2019-01-15-010905 build",
+			},
+		},
 	}, {
 		raw: []byte(`{
 			"version": "v4.0.0-0.1",