Added unitest for support-package

.github/workflows/verify_unit_test.yml

@@ -0,0 +1,24 @@
+name: Verify Unit tests
+
+on:
+  pull_request:
+    paths:
+      - 'support/**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: v1.19
+
+
+
+    - name: Run unit tests
+      run: go test ./support/. -v

go.mod

@@ -21,6 +21,7 @@ require (
 	github.com/cespare/xxhash/v2 v2.1.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/emicklei/go-restful/v3 v3.10.1 // indirect
+	github.com/evanphx/json-patch v4.12.0+incompatible // indirect
 	github.com/go-logr/logr v1.2.4 // indirect
 	github.com/go-openapi/jsonpointer v0.19.6 // indirect
 	github.com/go-openapi/jsonreference v0.20.1 // indirect
@@ -43,6 +44,7 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/prometheus/client_golang v1.14.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
 	github.com/prometheus/common v0.37.0 // indirect

go.sum

@@ -80,6 +80,7 @@ github.com/envoyproxy/go-control-plane v0.9.9-0.20201210154907-fd9021fe5dad/go.m
 github.com/envoyproxy/go-control-plane v0.9.9-0.20210512163311-63b5d3c536b0/go.mod h1:hliV/p42l8fGbc6Y9bQ70uLwIvmJyVE5k4iMKlh8wCQ=
 github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
 github.com/evanphx/json-patch v4.12.0+incompatible h1:4onqiflcdA9EOZ4RxV643DvftH5pOlLGNtQ5lPWQu84=
+github.com/evanphx/json-patch v4.12.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
 github.com/evanphx/json-patch/v5 v5.6.0 h1:b91NhWfaz02IuVxO9faSllyAtNXHMPkC5J8sJCLunww=
 github.com/evanphx/json-patch/v5 v5.6.0/go.mod h1:G79N1coSVB93tBe7j6PhzjmR3/2VvlbKOFpnXhI9Bw4=
 github.com/flowstack/go-jsonschema v0.1.1/go.mod h1:yL7fNggx1o8rm9RlgXv7hTBWxdBM0rVwpMwimd3F3N0=

support/batch_test.go

@@ -0,0 +1,47 @@
+/*
+Copyright 2023.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package support
+
+import (
+	"testing"
+
+	"github.com/onsi/gomega"
+
+	batchv1 "k8s.io/api/batch/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+func TestGetJob(t *testing.T) {
+
+	test := NewTest(t)
+
+	Job := &batchv1.Job{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "my-job-1",
+			Namespace: "my-namespace",
+		},
+	}
+
+	test.client.Core().BatchV1().Jobs("my-namespace").Create(test.ctx, Job, metav1.CreateOptions{})
+
+	// Call the Job function using the fake client
+	jobs := GetJob(test, "my-namespace", "my-job-1")
+
+	test.Expect(jobs.Name).To(gomega.Equal("my-job-1"))
+	test.Expect(jobs.Namespace).To(gomega.Equal("my-namespace"))
+
+}

support/core_test.go

@@ -0,0 +1,45 @@
+package support
+
+import (
+	"testing"
+
+	"github.com/onsi/gomega"
+
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+func TestGetPods(t *testing.T) {
+	test := NewTest(t)
+
+	pod := &corev1.Pod{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "test-pod",
+			Namespace: "test-namespace",
+		},
+	}
+
+	test.client.Core().CoreV1().Pods("test-namespace").Create(test.ctx, pod, metav1.CreateOptions{})
+
+	// Call the GetPods function with the fake client and namespace
+	pods := GetPods(test, "test-namespace", metav1.ListOptions{})
+
+	test.Expect(pods).Should(gomega.HaveLen(1), "Expected 1 pod, but got %d", len(pods))
+	test.Expect(pods[0].Name).To(gomega.Equal("test-pod"), "Expected pod name 'test-pod', but got '%s'", pods[0].Name)
+}
+
+func TestGetNodes(t *testing.T) {
+	test := NewTest(t)
+	node := &corev1.Node{
+		ObjectMeta: metav1.ObjectMeta{
+			Name: "test-node",
+		},
+	}
+
+	test.client.Core().CoreV1().Nodes().Create(test.ctx, node, metav1.CreateOptions{})
+	nodes := GetNodes(test)
+
+	test.Expect(nodes).Should(gomega.HaveLen(1), "Expected 1 node, but got %d", len(nodes))
+	test.Expect(nodes[0].Name).To(gomega.Equal("test-node"), "Expected node name 'test-node', but got '%s'", nodes[0].Name)
+
+}

support/environment_test.go

@@ -0,0 +1,145 @@
+package support
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/onsi/gomega"
+)
+
+func TestGetCodeFlareSDKVersion(t *testing.T) {
+
+	g := gomega.NewGomegaWithT(t)
+	// Set the environment variable.
+	os.Setenv(CodeFlareTestSdkVersion, "1.2.3")
+
+	// Get the version.
+	version := GetCodeFlareSDKVersion()
+
+	// Assert that the version is correct.
+
+	g.Expect(version).To(gomega.Equal("1.2.3"), "Expected version 1.2.3, but got %s", version)
+
+}
+
+func TestGetRayVersion(t *testing.T) {
+
+	g := gomega.NewGomegaWithT(t)
+	// Set the environment variable.
+	os.Setenv(CodeFlareTestRayVersion, "1.4.5")
+
+	// Get the version.
+	version := GetRayVersion()
+
+	// Assert that the version is correct.
+
+	g.Expect(version).To(gomega.Equal("1.4.5"), "Expected version 1.4.5, but got %s", version)
+
+}
+
+func TestGetRayImage(t *testing.T) {
+
+	g := gomega.NewGomegaWithT(t)
+	// Set the environment variable.
+	os.Setenv(CodeFlareTestRayImage, "ray/ray:latest")
+
+	// Get the image.
+	image := GetRayImage()
+
+	// Assert that the image is correct.
+
+	g.Expect(image).To(gomega.Equal("ray/ray:latest"), "Expected image ray/ray:latest, but got %s", image)
+
+}
+
+func TestGetPyTorchImage(t *testing.T) {
+
+	g := gomega.NewGomegaWithT(t)
+	// Set the environment variable.
+	os.Setenv(CodeFlareTestPyTorchImage, "pytorch/pytorch:latest")
+
+	// Get the image.
+	image := GetPyTorchImage()
+
+	// Assert that the image is correct.
+
+	g.Expect(image).To(gomega.Equal("pytorch/pytorch:latest"), "Expected image pytorch/pytorch:latest, but got %s", image)
+
+}
+
+func TestGetClusterID(t *testing.T) {
+
+	g := gomega.NewGomegaWithT(t)
+	os.Setenv(ClusterID, "my-cluster-id")
+	clusterId, ok := GetClusterId()
+	if !ok {
+		gomega.Expect(ok).To(gomega.BeTrue(), "Expected GetClusterId() to return true, but got false.")
+	}
+
+	g.Expect(clusterId).To(gomega.Equal("my-cluster-id"), "Expected GetClusterId() to return 'my-cluster-id', but got '%s'.", clusterId)
+
+}
+
+func TestGetInstascaleOcmSecret(t *testing.T) {
+
+	g := gomega.NewGomegaWithT(t)
+	// Set the Instascale OCM secret environment variable.
+	os.Setenv(InstaScaleOcmSecret, "default/instascale-ocm-secret")
+	// Get the Instascale OCM secret namespace and secret name.
+	namespace, secretName := GetInstascaleOcmSecret()
+
+	// Verify that the namespace and secret name are correct.
+
+	g.Expect(fmt.Sprintf("%s/%s", namespace, secretName)).To(
+		gomega.Equal("default/instascale-ocm-secret"),
+		"Expected GetInstascaleOcmSecret() to return 'default/instascale-ocm-secret', but got '%s/%s'.",
+		namespace, secretName,
+	)
+
+}
+
+func TestGetClusterType(t *testing.T) {
+
+	g := gomega.NewGomegaWithT(t)
+
+	tests := []struct {
+		name        string
+		envVarValue string
+		expected    ClusterType
+	}{
+		{
+			name:        "OSD cluster",
+			envVarValue: "OSD",
+			expected:    OsdCluster,
+		},
+		{
+			name:        "OCP cluster",
+			envVarValue: "OCP",
+			expected:    OcpCluster,
+		},
+		{
+			name:        "Hypershift cluster",
+			envVarValue: "HYPERSHIFT",
+			expected:    HypershiftCluster,
+		},
+		{
+			name:        "KIND cluster",
+			envVarValue: "KIND",
+			expected:    KindCluster,
+		},
+	}
+	ttt := With(t)
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			os.Setenv(ClusterTypeEnvVar, tt.envVarValue)
+			actual := GetClusterType(ttt)
+
+			g.Expect(actual).To(
+				gomega.Equal(tt.expected),
+				"Expected GetClusterType() to return %v, but got %v", tt.expected, actual,
+			)
+
+		})
+	}
+}

support/events_test.go

@@ -0,0 +1,40 @@
+package support
+
+import (
+	"testing"
+)
+
+func TestGetDefaultEventValueIfNull(t *testing.T) {
+	tests := []struct {
+		input    string
+		expected string
+	}{
+		{"World", "World"},
+	}
+
+	for _, test := range tests {
+		actual := getDefaultEventValueIfNull(test.input)
+		if actual != test.expected {
+			t.Errorf("getDefaultEventValueIfNull(%s) = %s; expected %s", test.input, actual, test.expected)
+		}
+	}
+}
+
+func TestGetWhitespaceStr(t *testing.T) {
+	tests := []struct {
+		size     int
+		expected string
+	}{
+		{0, ""},
+		{1, " "},
+		{5, "     "},
+		{10, "          "},
+	}
+
+	for _, test := range tests {
+		actual := getWhitespaceStr(test.size)
+		if actual != test.expected {
+			t.Errorf("getWhitespaceStr(%d) = %s; expected %s", test.size, actual, test.expected)
+		}
+	}
+}

support/fakeclient.go

@@ -0,0 +1,31 @@
+package support
+
+import (
+	"testing"
+
+	fakeray "github.com/ray-project/kuberay/ray-operator/pkg/client/clientset/versioned/fake"
+
+	fakeCore "k8s.io/client-go/kubernetes/fake"
+
+	fakeimage "github.com/openshift/client-go/image/clientset/versioned/fake"
+	fakeMachine "github.com/openshift/client-go/machine/clientset/versioned/fake"
+	fakeroute "github.com/openshift/client-go/route/clientset/versioned/fake"
+)
+
+func NewTest(t *testing.T) *T {
+	fakeCoreClient := fakeCore.NewSimpleClientset()
+	fakemachineClient := fakeMachine.NewSimpleClientset()
+	fakeimageClient := fakeimage.NewSimpleClientset()
+	fakerouteClient := fakeroute.NewSimpleClientset()
+	fakerayClient := fakeray.NewSimpleClientset()
+
+	test := With(t).(*T)
+	test.client = &testClient{
+		core:    fakeCoreClient,
+		machine: fakemachineClient,
+		image:   fakeimageClient,
+		route:   fakerouteClient,
+		ray:     fakerayClient,
+	}
+	return test
+}

support/image_test.go

@@ -0,0 +1,30 @@
+package support
+
+import (
+	"testing"
+
+	"github.com/onsi/gomega"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	imagev1 "github.com/openshift/api/image/v1"
+)
+
+func TestGetImageStream(t *testing.T) {
+
+	test := NewTest(t)
+
+	ImageStream := &imagev1.ImageStream{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "my-imagestream-1",
+			Namespace: "my-namespace",
+		},
+	}
+
+	test.client.Image().ImageV1().ImageStreams("my-namespace").Create(test.ctx, ImageStream, metav1.CreateOptions{})
+
+	image := GetImageStream(test, "my-namespace", "my-imagestream-1")
+
+	test.Expect(image.Name).To(gomega.Equal("my-imagestream-1"))
+	test.Expect(image.Namespace).To(gomega.Equal("my-namespace"))
+}