test: Parameterize Ray image and version

Author: astefanutti

Makefile

@@ -21,9 +21,12 @@ MCAD_REF ?= release-${MCAD_VERSION}
 MCAD_REPO ?= github.com/project-codeflare/multi-cluster-app-dispatcher
 MCAD_CRD ?= ${MCAD_REPO}/config/crd?ref=${MCAD_REF}
 
-# KUBERAY_VERSION defines the default version of the KubeRay operator
+# KUBERAY_VERSION defines the default version of the KubeRay operator (used for testing)
 KUBERAY_VERSION ?= v0.5.0
 
+# RAY_VERSION defines the default version of Ray (used for testing)
+RAY_VERSION ?= 2.5.0
+
 # CODEFLARE_SDK_VERSION defines the default version of the CodeFlare SDK
 CODEFLARE_SDK_VERSION ?= 0.4.4
 
@@ -67,6 +70,9 @@ MCAD_IMAGE ?= $(IMAGE_ORG_BASE)/mcad-controller:$(MCAD_REF)
 # INSTASCALE_IMAGE defines the default container image for the InstaScale controller
 INSTASCALE_IMAGE ?= $(IMAGE_ORG_BASE)/instascale-controller:$(INSTASCALE_VERSION)
 
+# RAY_IMAGE defines the default container image for Ray (used for testing)
+RAY_IMAGE ?= rayproject/ray:$(RAY_VERSION)
+
 # BUNDLE_IMG defines the image:tag used for the bundle.
 # You can use it as an arg. (E.g make bundle-build BUNDLE_IMG=<some-registry>/<project-name-bundle>:<tag>)
 BUNDLE_IMG ?= $(IMAGE_TAG_BASE)-bundle:$(VERSION)
@@ -122,6 +128,7 @@ help: ## Display this help.
 ##@ Development
 
 DEFAULTS_FILE := controllers/defaults.go
+DEFAULTS_TEST_FILE := test/support/defaults.go
 
 .PHONY: defaults
 defaults:
@@ -135,12 +142,26 @@ defaults:
 	@echo "const (" >> $(DEFAULTS_FILE)
 	@echo "  MCADImage = \"$(MCAD_IMAGE)\"" >> $(DEFAULTS_FILE)
 	@echo "  InstaScaleImage = \"$(INSTASCALE_IMAGE)\"" >> $(DEFAULTS_FILE)
-	@echo "  CodeFlareSDKVersion = \"$(CODEFLARE_SDK_VERSION)\"" >> $(DEFAULTS_FILE)
 	@echo "" >> $(DEFAULTS_FILE)
 	@echo ")" >> $(DEFAULTS_FILE)
 	@echo "" >> $(DEFAULTS_FILE)
 
-	gofmt -w $(DEFAULTS_FILE)
+	$(info Regenerating $(DEFAULTS_TEST_FILE))
+	@echo "package support" > $(DEFAULTS_TEST_FILE)
+	@echo "" >> $(DEFAULTS_TEST_FILE)
+	@echo "// ***********************" >> $(DEFAULTS_TEST_FILE)
+	@echo "//  DO NOT EDIT THIS FILE"  >> $(DEFAULTS_TEST_FILE)
+	@echo "// ***********************" >> $(DEFAULTS_TEST_FILE)
+	@echo "" >> $(DEFAULTS_TEST_FILE)
+	@echo "const (" >> $(DEFAULTS_TEST_FILE)
+	@echo "  CodeFlareSDKVersion = \"$(CODEFLARE_SDK_VERSION)\"" >> $(DEFAULTS_TEST_FILE)
+	@echo "  RayVersion = \"$(RAY_VERSION)\"" >> $(DEFAULTS_TEST_FILE)
+	@echo "  RayImage = \"$(RAY_IMAGE)\"" >> $(DEFAULTS_TEST_FILE)
+	@echo "" >> $(DEFAULTS_TEST_FILE)
+	@echo ")" >> $(DEFAULTS_TEST_FILE)
+	@echo "" >> $(DEFAULTS_TEST_FILE)
+
+	gofmt -w $(DEFAULTS_FILE) $(DEFAULTS_TEST_FILE)
 
 .PHONY: manifests
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.

controllers/defaults.go

@@ -5,7 +5,6 @@ package controllers
 // ***********************
 
 const (
-	MCADImage           = "quay.io/project-codeflare/mcad-controller:release-v1.31.0"
-	InstaScaleImage     = "quay.io/project-codeflare/instascale-controller:v0.0.4"
-	CodeFlareSDKVersion = "0.4.4"
+	MCADImage       = "quay.io/project-codeflare/mcad-controller:release-v1.31.0"
+	InstaScaleImage = "quay.io/project-codeflare/instascale-controller:v0.0.4"
 )

test/e2e/mnist_rayjob_mcad_raycluster_test.go

@@ -68,7 +68,7 @@ func TestMNISTRayJobMCADRayCluster(t *testing.T) {
 			Namespace: namespace.Name,
 		},
 		Spec: rayv1alpha1.RayClusterSpec{
-			RayVersion: "2.0.0",
+			RayVersion: GetRayVersion(),
 			HeadGroupSpec: rayv1alpha1.HeadGroupSpec{
 				RayStartParams: map[string]string{
 					"dashboard-host": "0.0.0.0",
@@ -78,7 +78,7 @@ func TestMNISTRayJobMCADRayCluster(t *testing.T) {
 						Containers: []corev1.Container{
 							{
 								Name:  "ray-head",
-								Image: "rayproject/ray:2.0.0",
+								Image: GetRayImage(),
 								Ports: []corev1.ContainerPort{
 									{
 										ContainerPort: 6379,
@@ -152,7 +152,7 @@ func TestMNISTRayJobMCADRayCluster(t *testing.T) {
 							Containers: []corev1.Container{
 								{
 									Name:  "ray-worker",
-									Image: "rayproject/ray:2.0.0",
+									Image: GetRayImage(),
 									Lifecycle: &corev1.Lifecycle{
 										PreStop: &corev1.LifecycleHandler{
 											Exec: &corev1.ExecAction{

test/support/codeflare.go

@@ -18,13 +18,31 @@ package support
 
 import (
 	"os"
+)
 
-	"github.com/project-codeflare/codeflare-operator/controllers"
+// The environment variables hereafter can be used to change the components
+// used for testing.
+const (
+	CodeFlareTestSdkVersion = "CODEFLARE_TEST_SDK_VERSION"
+	CodeFlareTestRayVersion = "CODEFLARE_TEST_RAY_VERSION"
+	CodeFlareTestRayImage   = "CODEFLARE_TEST_RAY_IMAGE"
 )
 
 func GetCodeFlareSDKVersion() string {
-	if value, ok := os.LookupEnv("CODEFLARE_SDK_VERSION"); ok {
-		return value
+	return lookupEnvOrDefault(CodeFlareTestSdkVersion, CodeFlareSDKVersion)
+}
+
+func GetRayVersion() string {
+	return lookupEnvOrDefault(CodeFlareTestRayVersion, RayVersion)
+}
+
+func GetRayImage() string {
+	return lookupEnvOrDefault(CodeFlareTestRayImage, RayImage)
+}
+
+func lookupEnvOrDefault(key, value string) string {
+	if v, ok := os.LookupEnv(key); ok {
+		return v
 	}
-	return controllers.CodeFlareSDKVersion
+	return value
 }

test/support/defaults.go

@@ -0,0 +1,11 @@
+package support
+
+// ***********************
+//  DO NOT EDIT THIS FILE
+// ***********************
+
+const (
+	CodeFlareSDKVersion = "0.4.4"
+	RayVersion          = "2.5.0"
+	RayImage            = "rayproject/ray:2.5.0"
+)