[Fix][kubectl-plugin]: make version handle digests (#2876)

Right now `kubectl ray version` returns only the image digest if the KubeRay
operator uses an image reference that contains both tag and digest. This change
returns both and also handles the case where only the digest is present.

We depend on the https://github.com/novln/docker-parser library to simplify
image reference parsing logic except in the case where both tag and digest are used
which the library doesn't seem to handle. See [this issue][1].

[1]: novln/docker-parser#3

Author: davidxia

kubectl-plugin/go.mod

@@ -6,6 +6,7 @@ toolchain go1.22.5
 
 require (
 	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
+	github.com/novln/docker-parser v1.0.0
 	github.com/onsi/ginkgo/v2 v2.20.2
 	github.com/onsi/gomega v1.34.2
 	github.com/ray-project/kuberay/ray-operator v0.0.0

kubectl-plugin/go.sum

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"strings"
 
+	dockerparser "github.com/novln/docker-parser"
 	"github.com/ray-project/kuberay/kubectl-plugin/pkg/util"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/client-go/kubernetes"
@@ -80,12 +81,18 @@ func (c *k8sClient) GetKubeRayOperatorVersion(ctx context.Context) (string, erro
 	}
 
 	image := containers[0].Image
-	parts := strings.Split(image, ":")
-	if len(parts) < 2 {
-		return "", fmt.Errorf("unable to parse KubeRay operator version from image: %s", image)
+	ref, err := dockerparser.Parse(image)
+	if err != nil {
+		return "", fmt.Errorf("unable to parse KubeRay operator version from image: %w", err)
+	}
+
+	// If image reference contains both digest and tag, return both
+	if strings.Contains(image, "@sha256:") && strings.Count(image, ":") == 2 {
+		parts := strings.SplitN(image, ":", 2)
+		return parts[len(parts)-1], nil
 	}
 
-	return parts[len(parts)-1], nil
+	return ref.Tag(), nil
 }
 
 func (c *k8sClient) GetRayHeadSvcName(ctx context.Context, namespace string, resourceType util.ResourceType, name string) (string, error) {

kubectl-plugin/pkg/util/client/client.go

@@ -31,7 +31,7 @@ func TestGetKubeRayOperatorVersion(t *testing.T) {
 					Spec: corev1.PodSpec{
 						Containers: []corev1.Container{
 							{
-								Image: "kuberay/operator:v0.5.0",
+								Image: "kuberay/operator:v0.5.0@sha256:cc8ce713f3b4be3c72cca1f63ee78e3733bc7283472ecae367b47a128f7e4478",
 							},
 						},
 					},
@@ -40,6 +40,28 @@ func TestGetKubeRayOperatorVersion(t *testing.T) {
 		},
 	}
 	kustomizeObjects := []runtime.Object{
+		&appsv1.Deployment{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "kuberay-operator-kustomize",
+				Namespace: "test",
+				Labels: map[string]string{
+					"app.kubernetes.io/name": "kuberay",
+				},
+			},
+			Spec: appsv1.DeploymentSpec{
+				Template: corev1.PodTemplateSpec{
+					Spec: corev1.PodSpec{
+						Containers: []corev1.Container{
+							{
+								Image: "kuberay/operator:v0.6.0@sha256:cc8ce713f3b4be3c72cca1f63ee78e3733bc7283472ecae367b47a128f7e4478",
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+	kustomizeObjectsImageWithOnlyTag := []runtime.Object{
 		&appsv1.Deployment{
 			ObjectMeta: metav1.ObjectMeta{
 				Name:      "kuberay-operator-kustomize",
@@ -61,6 +83,28 @@ func TestGetKubeRayOperatorVersion(t *testing.T) {
 			},
 		},
 	}
+	kustomizeObjectsImageWithOnlyDigest := []runtime.Object{
+		&appsv1.Deployment{
+			ObjectMeta: metav1.ObjectMeta{
+				Name:      "kuberay-operator-kustomize",
+				Namespace: "test",
+				Labels: map[string]string{
+					"app.kubernetes.io/name": "kuberay",
+				},
+			},
+			Spec: appsv1.DeploymentSpec{
+				Template: corev1.PodTemplateSpec{
+					Spec: corev1.PodSpec{
+						Containers: []corev1.Container{
+							{
+								Image: "kuberay/operator@sha256:cc8ce713f3b4be3c72cca1f63ee78e3733bc7283472ecae367b47a128f7e4478",
+							},
+						},
+					},
+				},
+			},
+		},
+	}
 
 	tests := []struct {
 		name            string
@@ -69,23 +113,35 @@ func TestGetKubeRayOperatorVersion(t *testing.T) {
 		kubeObjects     []runtime.Object
 	}{
 		{
-			name:            "kubeRay operator not found",
+			name:            "KubeRay operator not found",
 			expectedVersion: "",
 			expectedError:   "no KubeRay operator deployments found in any namespace",
 			kubeObjects:     nil,
 		},
 		{
-			name:            "find kubeRay operator version for helm chart",
-			expectedVersion: "v0.5.0",
+			name:            "find KubeRay operator version for helm chart",
+			expectedVersion: "v0.5.0@sha256:cc8ce713f3b4be3c72cca1f63ee78e3733bc7283472ecae367b47a128f7e4478",
 			expectedError:   "",
 			kubeObjects:     helmKubeObjects,
 		},
 		{
-			name:            "find kubeRay operator version for Kustomize",
-			expectedVersion: "v0.6.0",
+			name:            "find KubeRay operator version for Kustomize",
+			expectedVersion: "v0.6.0@sha256:cc8ce713f3b4be3c72cca1f63ee78e3733bc7283472ecae367b47a128f7e4478",
 			expectedError:   "",
 			kubeObjects:     kustomizeObjects,
 		},
+		{
+			name:            "find KubeRay operator version for Kustomize",
+			expectedVersion: "v0.6.0",
+			expectedError:   "",
+			kubeObjects:     kustomizeObjectsImageWithOnlyTag,
+		},
+		{
+			name:            "find KubeRay operator version for Kustomize",
+			expectedVersion: "sha256:cc8ce713f3b4be3c72cca1f63ee78e3733bc7283472ecae367b47a128f7e4478",
+			expectedError:   "",
+			kubeObjects:     kustomizeObjectsImageWithOnlyDigest,
+		},
 	}
 
 	for _, tc := range tests {
@@ -96,7 +152,7 @@ func TestGetKubeRayOperatorVersion(t *testing.T) {
 			version, err := client.GetKubeRayOperatorVersion(context.Background())
 
 			if tc.expectedVersion != "" {
-				assert.Equal(t, version, tc.expectedVersion)
+				assert.Equal(t, tc.expectedVersion, version)
 				assert.NoError(t, err)
 			} else {
 				assert.EqualError(t, err, tc.expectedError)