Files

685 lines
18 KiB
Go

package utils
import (
"context"
"testing"
"github.com/stretchr/testify/assert"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/pointer"
rayv1 "github.com/ray-project/kuberay/ray-operator/apis/ray/v1"
corev1 "k8s.io/api/core/v1"
)
func TestGetClusterDomainName(t *testing.T) {
tests := []struct {
name string
env string
want string
}{{
name: "all good from env",
env: "abc.com",
want: "abc.com",
}, {
name: "No env set",
env: "",
want: DefaultDomainName,
}}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if len(tt.env) > 0 {
t.Setenv(ClusterDomainEnvKey, tt.env)
}
got := GetClusterDomainName()
if got != tt.want {
t.Errorf("Test %s failed expected: %s but got: %s", tt.name, tt.want, got)
}
})
}
}
func TestStatus(t *testing.T) {
pod := createSomePod()
pod.Status.Phase = corev1.PodPending
if !IsCreated(pod) {
t.Fail()
}
}
func TestCheckAllPodsRunning(t *testing.T) {
tests := map[string]struct {
pods corev1.PodList
expected bool
}{
"should return true if all Pods are running": {
pods: corev1.PodList{
Items: []corev1.Pod{
*createSomePodWithPhase(corev1.PodRunning),
*createSomePodWithPhase(corev1.PodRunning),
},
},
expected: true,
},
"should return false if there are no Pods": {
pods: corev1.PodList{
Items: []corev1.Pod{},
},
expected: false,
},
"should return false if any Pods don't have .status.phase Running": {
pods: corev1.PodList{
Items: []corev1.Pod{
*createSomePodWithPhase(corev1.PodPending),
*createSomePodWithPhase(corev1.PodRunning),
},
},
expected: false,
},
"should return false if any Pods have a .status.condition of type: Ready that's not status: True": {
pods: corev1.PodList{
Items: []corev1.Pod{
*createSomePodWithPhase(corev1.PodRunning),
*createSomePodWithCondition(corev1.PodReady, corev1.ConditionFalse),
},
},
expected: false,
},
}
for name, tc := range tests {
t.Run(name, func(t *testing.T) {
assert.Equal(t, tc.expected, CheckAllPodsRunning(context.Background(), tc.pods))
})
}
}
func TestCheckName(t *testing.T) {
// test 1 -> change
str := "72fbcc7e-a661-4b18e-ca41-e903-fc3ae634b18e-lazer090scholar-director-s"
str = CheckName(str)
if str != "rca41-e903-fc3ae634b18e-lazer090scholar-director-s" {
t.Fail()
}
// test 2 -> change
str = "--------566666--------444433-----------222222----------4444"
str = CheckName(str)
if str != "r6666--------444433-----------222222----------4444" {
t.Fail()
}
// test 3 -> keep
str = "acceptable-name-head-12345"
str = CheckName(str)
if str != "acceptable-name-head-12345" {
t.Fail()
}
}
func TestCheckRouteName(t *testing.T) {
tests := []struct {
name string
routeName string
namespace string
want string
}{{
name: "long route name truncated",
routeName: "cv-traffic-training-202402090958",
namespace: "development-namespace",
want: "cv-traffic-training-2024020909",
}, {
name: "long route name w/number start truncated and number replaced",
routeName: "2-step-cv-training-network-revisited",
namespace: "development-namespace",
want: "r-step-cv-training-network-rev",
}, {
name: "well-formatted and well-sized route name unaffected",
routeName: "acceptable-name-head-12345",
namespace: "development-namespace",
want: "acceptable-name-head-12345",
}}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
name := CheckRouteName(context.Background(), tc.routeName, tc.namespace)
if name != tc.want {
t.Fatalf("got %s, want %s", name, tc.want)
}
})
}
}
func createSomePod() (pod *corev1.Pod) {
return &corev1.Pod{
TypeMeta: metav1.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
ObjectMeta: metav1.ObjectMeta{
Name: "raycluster-sample-small-group-worker-0",
Namespace: "default",
},
}
}
func createSomePodWithPhase(phase corev1.PodPhase) (pod *corev1.Pod) {
return &corev1.Pod{
TypeMeta: metav1.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
ObjectMeta: metav1.ObjectMeta{
Name: "raycluster-sample-small-group-worker-0",
Namespace: "default",
},
Status: corev1.PodStatus{
Phase: phase,
},
}
}
func createSomePodWithCondition(typ corev1.PodConditionType, status corev1.ConditionStatus) (pod *corev1.Pod) {
return &corev1.Pod{
TypeMeta: metav1.TypeMeta{
APIVersion: "v1",
Kind: "Pod",
},
ObjectMeta: metav1.ObjectMeta{
Name: "raycluster-sample-small-group-worker-0",
Namespace: "default",
},
Status: corev1.PodStatus{
Conditions: []corev1.PodCondition{
{
Type: typ,
Status: status,
},
},
},
}
}
func TestGetHeadGroupServiceAccountName(t *testing.T) {
tests := map[string]struct {
input *rayv1.RayCluster
want string
}{
"Ray cluster with head group service account": {
input: &rayv1.RayCluster{
ObjectMeta: metav1.ObjectMeta{
Name: "raycluster-sample",
Namespace: "default",
},
Spec: rayv1.RayClusterSpec{
HeadGroupSpec: rayv1.HeadGroupSpec{
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{
ServiceAccountName: "my-service-account",
},
},
},
},
},
want: "my-service-account",
},
"Ray cluster without head group service account": {
input: &rayv1.RayCluster{
ObjectMeta: metav1.ObjectMeta{
Name: "raycluster-sample",
Namespace: "default",
},
Spec: rayv1.RayClusterSpec{
HeadGroupSpec: rayv1.HeadGroupSpec{
Template: corev1.PodTemplateSpec{
Spec: corev1.PodSpec{},
},
},
},
},
want: "raycluster-sample",
},
}
for name, tc := range tests {
t.Run(name, func(t *testing.T) {
got := GetHeadGroupServiceAccountName(tc.input)
if got != tc.want {
t.Fatalf("got %s, want %s", got, tc.want)
}
})
}
}
func TestReconcile_CheckNeedRemoveOldPod(t *testing.T) {
namespaceStr := "default"
headTemplate := corev1.PodTemplateSpec{
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "ray-head",
Image: "rayproject/autoscaler",
Command: []string{"python"},
Args: []string{"/opt/code.py"},
Env: []corev1.EnvVar{
{
Name: "MY_POD_IP",
ValueFrom: &corev1.EnvVarSource{
FieldRef: &corev1.ObjectFieldSelector{
FieldPath: "status.podIP",
},
},
},
},
},
},
},
}
pod := corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "headNode",
Namespace: namespaceStr,
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "ray-head",
Image: "rayproject/autoscaler",
Command: []string{"python"},
Args: []string{"/opt/code.py"},
},
},
},
Status: corev1.PodStatus{
Phase: corev1.PodRunning,
},
}
assert.Equal(t, PodNotMatchingTemplate(pod, headTemplate), false, "expect template & pod matching")
pod.Spec.Containers = []corev1.Container{
{
Name: "ray-head",
Image: "rayproject/autoscaler",
Command: []string{"python"},
Args: []string{"/opt/code.py"},
},
{
Name: "ray-head",
Image: "rayproject/autoscaler",
Command: []string{"python"},
Args: []string{"/opt/code.py"},
},
}
assert.Equal(t, PodNotMatchingTemplate(pod, headTemplate), true, "expect template & pod with 2 containers not matching")
workerTemplate := corev1.PodTemplateSpec{
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "ray-worker",
Image: "rayproject/autoscaler",
Command: []string{"echo"},
Args: []string{"Hello Ray"},
Env: []corev1.EnvVar{
{
Name: "MY_POD_IP",
ValueFrom: &corev1.EnvVarSource{
FieldRef: &corev1.ObjectFieldSelector{
FieldPath: "status.podIP",
},
},
},
},
},
},
},
}
pod = corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "pod1",
Namespace: namespaceStr,
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "ray-worker",
Image: "rayproject/autoscaler",
Command: []string{"echo"},
Args: []string{"Hello Ray"},
},
},
},
Status: corev1.PodStatus{
Phase: corev1.PodRunning,
},
}
assert.Equal(t, PodNotMatchingTemplate(pod, workerTemplate), false, "expect template & pod matching")
workerTemplate = corev1.PodTemplateSpec{
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "ray-worker",
Image: "rayproject/autoscaler",
Command: []string{"echo"},
Args: []string{"Hello Ray"},
Resources: corev1.ResourceRequirements{
Limits: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("500m"),
corev1.ResourceMemory: resource.MustParse("512Mi"),
},
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("256m"),
corev1.ResourceMemory: resource.MustParse("256Mi"),
},
},
},
},
},
}
pod = corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: "pod1",
Namespace: namespaceStr,
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "ray-worker",
Image: "rayproject/autoscaler",
Command: []string{"echo"},
Args: []string{"Hello Ray"},
Resources: corev1.ResourceRequirements{
Limits: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("500m"),
corev1.ResourceMemory: resource.MustParse("512Mi"),
},
Requests: corev1.ResourceList{
corev1.ResourceCPU: resource.MustParse("256m"),
corev1.ResourceMemory: resource.MustParse("256Mi"),
},
},
},
},
},
Status: corev1.PodStatus{
Phase: corev1.PodRunning,
},
}
assert.Equal(t, PodNotMatchingTemplate(pod, workerTemplate), false, "expect template & pod matching")
pod.Spec.Containers[0].Resources.Limits[corev1.ResourceCPU] = resource.MustParse("50m")
assert.Equal(t, PodNotMatchingTemplate(pod, workerTemplate), true, "expect template & pod not matching")
pod.Spec.Containers[0].Resources.Limits[corev1.ResourceCPU] = resource.MustParse("500m")
pod.Spec.Containers[0].Resources.Requests[corev1.ResourceCPU] = resource.MustParse("250m")
assert.Equal(t, PodNotMatchingTemplate(pod, workerTemplate), true, "expect template & pod not matching")
}
func TestCalculateAvailableReplicas(t *testing.T) {
podList := corev1.PodList{
Items: []corev1.Pod{
{
ObjectMeta: metav1.ObjectMeta{
Name: "pod1",
Labels: map[string]string{
"ray.io/node-type": string(rayv1.HeadNode),
},
},
Status: corev1.PodStatus{
Phase: corev1.PodRunning,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Name: "pod2",
Labels: map[string]string{
"ray.io/node-type": string(rayv1.WorkerNode),
},
},
Status: corev1.PodStatus{
Phase: corev1.PodRunning,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Name: "pod2",
Labels: map[string]string{
"ray.io/node-type": string(rayv1.WorkerNode),
},
},
Status: corev1.PodStatus{
Phase: corev1.PodPending,
},
},
{
ObjectMeta: metav1.ObjectMeta{
Name: "pod2",
Labels: map[string]string{
"ray.io/node-type": string(rayv1.WorkerNode),
},
},
Status: corev1.PodStatus{
Phase: corev1.PodFailed,
},
},
},
}
count := CalculateAvailableReplicas(podList)
assert.Equal(t, count, int32(1), "expect 1 available replica")
}
func TestFindContainerPort(t *testing.T) {
container := corev1.Container{
Name: "ray-head",
Ports: []corev1.ContainerPort{
{
Name: "port1",
ContainerPort: 10001,
},
{
Name: "port2",
ContainerPort: 10002,
},
},
}
port := FindContainerPort(&container, "port1", -1)
assert.NotEqual(t, port, -1, "expect port1 found")
port = FindContainerPort(&container, "port2", -1)
assert.NotEqual(t, port, -1, "expect port2 found")
port = FindContainerPort(&container, "port3", -1)
assert.Equal(t, port, -1, "expect port3 not found")
}
func TestGenerateHeadServiceName(t *testing.T) {
// GenerateHeadServiceName generates a Ray head service name. Note that there are two types of head services:
//
// (1) For RayCluster: If `HeadService.Name` in the cluster spec is not empty, it will be used as the head service name.
// Otherwise, the name is generated based on the RayCluster CR's name.
// (2) For RayService: It's important to note that the RayService CR not only possesses a head service owned by its RayCluster CR
// but also maintains a separate head service for itself to facilitate zero-downtime upgrades. The name of the head service owned
// by the RayService CR is generated based on the RayService CR's name.
// [RayCluster]
// Test 1: `HeadService.Name` is empty.
headSvcName, err := GenerateHeadServiceName(RayClusterCRD, rayv1.RayClusterSpec{}, "raycluster-sample")
expectedGeneratedSvcName := "raycluster-sample-head-svc"
assert.Nil(t, err)
assert.Equal(t, headSvcName, expectedGeneratedSvcName)
// Test 2: `HeadService.Name` is not empty.
clusterSpecWithHeadService := rayv1.RayClusterSpec{
HeadGroupSpec: rayv1.HeadGroupSpec{
HeadService: &corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "my-head-svc",
},
},
},
}
headSvcName, err = GenerateHeadServiceName(RayClusterCRD, *clusterSpecWithHeadService.DeepCopy(), "raycluster-sample")
assert.Nil(t, err)
assert.Equal(t, headSvcName, "my-head-svc")
// [RayService]
// Test 3: `HeadService.Name` is empty.
headSvcName, err = GenerateHeadServiceName(RayServiceCRD, rayv1.RayClusterSpec{}, "rayservice-sample")
expectedGeneratedSvcName = "rayservice-sample-head-svc"
assert.Nil(t, err)
assert.Equal(t, headSvcName, expectedGeneratedSvcName)
// Test 4: `HeadService.Name` is not empty.
headSvcName, err = GenerateHeadServiceName(RayServiceCRD, *clusterSpecWithHeadService.DeepCopy(), "rayservice-sample")
assert.Nil(t, err)
assert.Equal(t, headSvcName, expectedGeneratedSvcName)
// Invalid CRD type
_, err = GenerateHeadServiceName(RayJobCRD, rayv1.RayClusterSpec{}, "rayjob-sample")
assert.NotNil(t, err)
}
func TestGetWorkerGroupDesiredReplicas(t *testing.T) {
ctx := context.Background()
// Test 1: `WorkerGroupSpec.Replicas` is nil.
// `Replicas` is impossible to be nil in a real RayCluster CR as it has a default value assigned in the CRD.
minReplicas := int32(1)
maxReplicas := int32(5)
workerGroupSpec := rayv1.WorkerGroupSpec{
MinReplicas: &minReplicas,
MaxReplicas: &maxReplicas,
}
assert.Equal(t, GetWorkerGroupDesiredReplicas(ctx, workerGroupSpec), minReplicas)
// Test 2: `WorkerGroupSpec.Replicas` is not nil and is within the range.
replicas := int32(3)
workerGroupSpec.Replicas = &replicas
assert.Equal(t, GetWorkerGroupDesiredReplicas(ctx, workerGroupSpec), replicas)
// Test 3: `WorkerGroupSpec.Replicas` is not nil but is more than maxReplicas.
replicas = int32(6)
workerGroupSpec.Replicas = &replicas
assert.Equal(t, GetWorkerGroupDesiredReplicas(ctx, workerGroupSpec), maxReplicas)
// Test 4: `WorkerGroupSpec.Replicas` is not nil but is less than minReplicas.
replicas = int32(0)
workerGroupSpec.Replicas = &replicas
assert.Equal(t, GetWorkerGroupDesiredReplicas(ctx, workerGroupSpec), minReplicas)
// Test 5: `WorkerGroupSpec.Replicas` is nil and minReplicas is less than maxReplicas.
workerGroupSpec.Replicas = nil
workerGroupSpec.MinReplicas = &maxReplicas
workerGroupSpec.MaxReplicas = &minReplicas
assert.Equal(t, GetWorkerGroupDesiredReplicas(ctx, workerGroupSpec), *workerGroupSpec.MaxReplicas)
}
func TestCalculateDesiredReplicas(t *testing.T) {
tests := map[string]struct {
group1Replicas *int32
group1MinReplicas *int32
group1MaxReplicas *int32
group2Replicas *int32
group2MinReplicas *int32
group2MaxReplicas *int32
answer int32
}{
"Both groups' Replicas are nil": {
group1Replicas: nil,
group1MinReplicas: pointer.Int32(1),
group1MaxReplicas: pointer.Int32(5),
group2Replicas: nil,
group2MinReplicas: pointer.Int32(2),
group2MaxReplicas: pointer.Int32(5),
answer: 3,
},
"Group1's Replicas is smaller than MinReplicas, and Group2's Replicas is more than MaxReplicas.": {
group1Replicas: pointer.Int32(0),
group1MinReplicas: pointer.Int32(2),
group1MaxReplicas: pointer.Int32(5),
group2Replicas: pointer.Int32(6),
group2MinReplicas: pointer.Int32(2),
group2MaxReplicas: pointer.Int32(5),
answer: 7,
},
"Group1's Replicas is more than MaxReplicas.": {
group1Replicas: pointer.Int32(6),
group1MinReplicas: pointer.Int32(2),
group1MaxReplicas: pointer.Int32(5),
group2Replicas: pointer.Int32(3),
group2MinReplicas: pointer.Int32(2),
group2MaxReplicas: pointer.Int32(5),
answer: 8,
},
}
for name, tc := range tests {
t.Run(name, func(t *testing.T) {
cluster := rayv1.RayCluster{
Spec: rayv1.RayClusterSpec{
WorkerGroupSpecs: []rayv1.WorkerGroupSpec{
{
GroupName: "group1",
Replicas: tc.group1Replicas,
MinReplicas: tc.group1MinReplicas,
MaxReplicas: tc.group1MaxReplicas,
},
{
GroupName: "group2",
Replicas: tc.group2Replicas,
MinReplicas: tc.group2MinReplicas,
MaxReplicas: tc.group2MaxReplicas,
},
},
},
}
assert.Equal(t, CalculateDesiredReplicas(context.Background(), &cluster), tc.answer)
})
}
}
func TestUnmarshalRuntimeEnv(t *testing.T) {
tests := map[string]struct {
runtimeEnvYAML string
isErrorNil bool
}{
"Empty runtimeEnvYAML": {
runtimeEnvYAML: "",
isErrorNil: true,
},
"Valid runtimeEnvYAML": {
runtimeEnvYAML: `
env_vars:
counter_name: test_counter
`,
isErrorNil: true,
},
"Invalid runtimeEnvYAML": {
runtimeEnvYAML: `invalid_yaml_str`,
isErrorNil: false,
},
}
for name, tc := range tests {
t.Run(name, func(t *testing.T) {
_, err := UnmarshalRuntimeEnvYAML(tc.runtimeEnvYAML)
if tc.isErrorNil {
assert.Nil(t, err)
} else {
assert.NotNil(t, err)
}
})
}
}