Files

349 lines
11 KiB
Go

/*
Copyright 2024 The KServe Authors.
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 service
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/intstr"
"github.com/kserve/kserve/pkg/apis/serving/v1beta1"
"github.com/kserve/kserve/pkg/constants"
)
var emptyServiceConfig = &v1beta1.ServiceConfig{}
func TestCreateDefaultDeployment(t *testing.T) {
type args struct {
componentMeta metav1.ObjectMeta
componentExt *v1beta1.ComponentExtensionSpec
podSpec *corev1.PodSpec
multiNodeEnabled bool
}
testInput := map[string]args{
"default-service": {
componentMeta: metav1.ObjectMeta{
Name: "default-predictor",
Namespace: "default-predictor-namespace",
Annotations: map[string]string{
"annotation": "annotation-value",
},
Labels: map[string]string{
constants.DeploymentMode: string(constants.Standard),
constants.AutoscalerClass: string(constants.DefaultAutoscalerClass),
},
},
componentExt: &v1beta1.ComponentExtensionSpec{},
podSpec: &corev1.PodSpec{
Volumes: []corev1.Volume{
{
Name: "default-predictor-example-volume",
},
},
Containers: []corev1.Container{
{
Name: "kserve-container",
Image: "default-predictor-example-image",
Env: []corev1.EnvVar{
{Name: "default-predictor-example-env", Value: "example-env"},
},
},
},
},
multiNodeEnabled: false,
},
"multiNode-service": {
componentMeta: metav1.ObjectMeta{
Name: "default-predictor",
Namespace: "default-predictor-namespace",
Annotations: map[string]string{
"annotation": "annotation-value",
},
Labels: map[string]string{
constants.RawDeploymentAppLabel: "isvc.default-predictor",
constants.InferenceServicePodLabelKey: "default-predictor",
constants.KServiceComponentLabel: string(v1beta1.PredictorComponent),
constants.InferenceServiceGenerationPodLabelKey: "1",
},
},
componentExt: &v1beta1.ComponentExtensionSpec{},
podSpec: &corev1.PodSpec{
Volumes: []corev1.Volume{
{
Name: "default-predictor-example-volume",
},
},
Containers: []corev1.Container{
{
Name: "kserve-container",
Image: "default-predictor-example-image",
Env: []corev1.EnvVar{
{Name: "default-predictor-example-env", Value: "example-env"},
},
},
},
},
multiNodeEnabled: true,
},
}
expectedServices := map[string][]*corev1.Service{
"default-service": {
&corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "default-predictor",
Namespace: "default-predictor-namespace",
Labels: map[string]string{
constants.AutoscalerClass: string(constants.DefaultAutoscalerClass),
constants.DeploymentMode: string(constants.Standard),
},
Annotations: map[string]string{
"annotation": "annotation-value",
},
},
Spec: corev1.ServiceSpec{
Ports: []corev1.ServicePort{
{
Name: "default-predictor",
Protocol: corev1.ProtocolTCP,
Port: 80,
TargetPort: intstr.IntOrString{IntVal: 8080},
},
},
Selector: map[string]string{
constants.RawDeploymentAppLabel: "isvc.default-predictor",
},
},
},
},
"multiNode-service": {
&corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "default-predictor",
Namespace: "default-predictor-namespace",
Labels: map[string]string{
constants.RawDeploymentAppLabel: "isvc.default-predictor",
constants.KServiceComponentLabel: "predictor",
constants.InferenceServicePodLabelKey: "default-predictor",
constants.InferenceServiceGenerationPodLabelKey: "1",
},
Annotations: map[string]string{
"annotation": "annotation-value",
},
},
Spec: corev1.ServiceSpec{
Ports: []corev1.ServicePort{
{
Name: "default-predictor",
Protocol: corev1.ProtocolTCP,
Port: 80,
TargetPort: intstr.IntOrString{IntVal: 8080},
},
},
Selector: map[string]string{
"app": "isvc.default-predictor",
},
},
},
&corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "default-head-1",
Namespace: "default-predictor-namespace",
Labels: map[string]string{
constants.RawDeploymentAppLabel: "isvc.default-predictor",
constants.KServiceComponentLabel: "predictor",
constants.InferenceServicePodLabelKey: "default-predictor",
constants.InferenceServiceGenerationPodLabelKey: "1",
constants.MultiNodeRoleLabelKey: constants.MultiNodeHead,
},
Annotations: map[string]string{
"annotation": "annotation-value",
},
},
Spec: corev1.ServiceSpec{
Selector: map[string]string{
constants.RawDeploymentAppLabel: "isvc.default-predictor",
constants.InferenceServiceGenerationPodLabelKey: "1",
},
ClusterIP: "None",
PublishNotReadyAddresses: true,
},
},
&corev1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: "default-workers-1",
Namespace: "default-predictor-namespace",
Labels: map[string]string{
constants.RawDeploymentAppLabel: "isvc.default-predictor",
constants.KServiceComponentLabel: "predictor",
constants.InferenceServicePodLabelKey: "default-predictor",
constants.InferenceServiceGenerationPodLabelKey: "1",
constants.MultiNodeRoleLabelKey: constants.MultiNodeWorker,
},
Annotations: map[string]string{
"annotation": "annotation-value",
},
},
Spec: corev1.ServiceSpec{
Selector: map[string]string{
"app": "isvc.default-predictor-worker",
constants.InferenceServiceGenerationPodLabelKey: "1",
},
ClusterIP: "None",
PublishNotReadyAddresses: true,
},
},
},
}
tests := []struct {
name string
args args
expected []*corev1.Service
}{
{
name: "default service",
args: args{
componentMeta: testInput["default-service"].componentMeta,
componentExt: testInput["default-service"].componentExt,
podSpec: testInput["default-service"].podSpec,
multiNodeEnabled: testInput["default-service"].multiNodeEnabled,
},
expected: expectedServices["default-service"],
},
{
name: "multiNode service",
args: args{
componentMeta: testInput["multiNode-service"].componentMeta,
componentExt: testInput["multiNode-service"].componentExt,
podSpec: testInput["multiNode-service"].podSpec,
multiNodeEnabled: testInput["multiNode-service"].multiNodeEnabled,
},
expected: expectedServices["multiNode-service"],
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got := createService(tt.args.componentMeta, tt.args.componentExt, tt.args.podSpec, tt.args.multiNodeEnabled, emptyServiceConfig)
require.Len(t, got, len(tt.expected))
for i, svc := range got {
// DeepDerivative checks that all non-zero fields in expected are present in actual,
// ignoring extra fields (e.g. annotations added by platform-specific hooks).
assert.True(t, equality.Semantic.DeepDerivative(tt.expected[i], svc),
"service[%d] mismatch: expected %+v, got %+v", i, tt.expected[i], svc)
}
})
}
}
func TestCreateServiceRawServiceConfigEmpty(t *testing.T) {
// nothing expected
runTestServiceCreate(emptyServiceConfig, "", t)
}
func TestCreateServiceRawServiceAndConfigNil(t *testing.T) {
var serviceConfig *v1beta1.ServiceConfig
// no service means empty
runTestServiceCreate(serviceConfig, "", t)
}
func TestCreateServiceRawFalseAndConfigTrue(t *testing.T) {
serviceConfig := &v1beta1.ServiceConfig{
ServiceClusterIPNone: true,
}
runTestServiceCreate(serviceConfig, corev1.ClusterIPNone, t)
}
func TestCreateServiceRawTrueAndConfigFalse(t *testing.T) {
serviceConfig := &v1beta1.ServiceConfig{
ServiceClusterIPNone: false,
}
runTestServiceCreate(serviceConfig, "", t)
}
func TestCreateServiceRawFalseAndConfigNil(t *testing.T) {
runTestServiceCreate(emptyServiceConfig, "", t)
}
func TestCreateServiceRawTrueAndConfigNil(t *testing.T) {
// service is there, but no property, should be empty
runTestServiceCreate(emptyServiceConfig, "", t)
}
func runTestServiceCreate(serviceConfig *v1beta1.ServiceConfig, expectedClusterIP string, t *testing.T) {
componentMeta := metav1.ObjectMeta{
Name: "test-service",
Namespace: "default",
}
componentExt := &v1beta1.ComponentExtensionSpec{}
podSpec := &corev1.PodSpec{}
service := createService(componentMeta, componentExt, podSpec, false, serviceConfig)
assert.Equal(t, componentMeta, service[0].ObjectMeta, "Expected ObjectMeta to be equal")
assert.Equal(t, map[string]string{"app": "isvc.test-service"}, service[0].Spec.Selector, "Expected Selector to be equal")
assert.Equal(t, expectedClusterIP, service[0].Spec.ClusterIP, "Expected ClusterIP to be equal")
}
// Test interface methods added for ServiceReconciler interface
func TestGetServiceList(t *testing.T) {
service1 := &corev1.Service{ObjectMeta: metav1.ObjectMeta{Name: "service1"}}
service2 := &corev1.Service{ObjectMeta: metav1.ObjectMeta{Name: "service2"}}
reconciler := &ServiceReconciler{
ServiceList: []*corev1.Service{service1, service2},
}
services := reconciler.GetServiceList()
assert.Len(t, services, 2)
assert.Equal(t, "service1", services[0].Name)
assert.Equal(t, "service2", services[1].Name)
}
func TestServiceSetControllerReferences(t *testing.T) {
scheme := runtime.NewScheme()
_ = v1beta1.AddToScheme(scheme)
_ = corev1.AddToScheme(scheme)
owner := &v1beta1.InferenceService{
ObjectMeta: metav1.ObjectMeta{Name: "test-isvc", Namespace: "default", UID: "test-uid"},
}
service1 := &corev1.Service{ObjectMeta: metav1.ObjectMeta{Name: "service1", Namespace: "default"}}
service2 := &corev1.Service{ObjectMeta: metav1.ObjectMeta{Name: "service2", Namespace: "default"}}
reconciler := &ServiceReconciler{
ServiceList: []*corev1.Service{service1, service2},
}
err := reconciler.SetControllerReferences(owner, scheme)
require.NoError(t, err)
// Verify owner references were set
assert.Len(t, service1.GetOwnerReferences(), 1)
assert.Equal(t, owner.Name, service1.GetOwnerReferences()[0].Name)
assert.Len(t, service2.GetOwnerReferences(), 1)
assert.Equal(t, owner.Name, service2.GetOwnerReferences()[0].Name)
}