operator/pkg/controlplane: test metricsadapter
In this commit, we add unit tests for the metrics adapter controlplane pkg of the operator making sure that installing Karmada Metrics Adapter Deployment works as expect and its associated service. Signed-off-by: Mohamed Awnallah <mohamedmohey2352@gmail.com>
This commit is contained in:
Mohamed Awnallah
parent
19b32a2979
commit
f9d9b098c1
|
|
@ -0,0 +1,236 @@
|
|||
/*
|
||||
Copyright 2024 The Karmada 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 metricsadapter
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
appsv1 "k8s.io/api/apps/v1"
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
fakeclientset "k8s.io/client-go/kubernetes/fake"
|
||||
coretesting "k8s.io/client-go/testing"
|
||||
"k8s.io/utils/ptr"
|
||||
|
||||
operatorv1alpha1 "github.com/karmada-io/karmada/operator/pkg/apis/operator/v1alpha1"
|
||||
"github.com/karmada-io/karmada/operator/pkg/util"
|
||||
)
|
||||
|
||||
func TestEnsureKarmadaMetricAdapter(t *testing.T) {
|
||||
var replicas int32 = 2
|
||||
image, imageTag := "docker.io/karmada/karmada-metrics-adapter", "latest"
|
||||
name := "karmada-demo"
|
||||
namespace := "test"
|
||||
imagePullPolicy := corev1.PullIfNotPresent
|
||||
annotations := map[string]string{"annotationKey": "annotationValue"}
|
||||
labels := map[string]string{"labelKey": "labelValue"}
|
||||
|
||||
cfg := &operatorv1alpha1.KarmadaMetricsAdapter{
|
||||
CommonSettings: operatorv1alpha1.CommonSettings{
|
||||
Image: operatorv1alpha1.Image{
|
||||
ImageRepository: image,
|
||||
ImageTag: imageTag,
|
||||
},
|
||||
Replicas: ptr.To[int32](replicas),
|
||||
Annotations: annotations,
|
||||
Labels: labels,
|
||||
Resources: corev1.ResourceRequirements{},
|
||||
ImagePullPolicy: imagePullPolicy,
|
||||
},
|
||||
}
|
||||
|
||||
// Create fake clientset.
|
||||
fakeClient := fakeclientset.NewSimpleClientset()
|
||||
|
||||
err := EnsureKarmadaMetricAdapter(fakeClient, cfg, name, namespace)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to ensure karmada metrics adapter, but got: %v", err)
|
||||
}
|
||||
|
||||
actions := fakeClient.Actions()
|
||||
if len(actions) != 2 {
|
||||
t.Fatalf("expected 2 actions, but got %d", len(actions))
|
||||
}
|
||||
}
|
||||
|
||||
func TestInstallKarmadaMetricAdapter(t *testing.T) {
|
||||
var replicas int32 = 2
|
||||
image, imageTag := "docker.io/karmada/karmada-metrics-adapter", "latest"
|
||||
name := "karmada-demo"
|
||||
namespace := "test"
|
||||
imagePullPolicy := corev1.PullIfNotPresent
|
||||
annotations := map[string]string{"annotationKey": "annotationValue"}
|
||||
labels := map[string]string{"labelKey": "labelValue"}
|
||||
|
||||
cfg := &operatorv1alpha1.KarmadaMetricsAdapter{
|
||||
CommonSettings: operatorv1alpha1.CommonSettings{
|
||||
Image: operatorv1alpha1.Image{
|
||||
ImageRepository: image,
|
||||
ImageTag: imageTag,
|
||||
},
|
||||
Replicas: ptr.To[int32](replicas),
|
||||
Annotations: annotations,
|
||||
Labels: labels,
|
||||
Resources: corev1.ResourceRequirements{},
|
||||
ImagePullPolicy: imagePullPolicy,
|
||||
},
|
||||
}
|
||||
|
||||
// Create fake clientset.
|
||||
fakeClient := fakeclientset.NewSimpleClientset()
|
||||
|
||||
err := installKarmadaMetricAdapter(fakeClient, cfg, name, namespace)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to install karmada metrics adapter: %v", err)
|
||||
}
|
||||
|
||||
err = verifyDeploymentCreation(
|
||||
fakeClient, replicas, imagePullPolicy, name, namespace, image, imageTag,
|
||||
)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to verify deployment creation: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateKarmadaMetricAdapterService(t *testing.T) {
|
||||
// Define inputs.
|
||||
name := "karmada-demo"
|
||||
namespace := "test"
|
||||
|
||||
// Initialize fake clientset.
|
||||
client := fakeclientset.NewSimpleClientset()
|
||||
|
||||
err := createKarmadaMetricAdapterService(client, name, namespace)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create karmada metrics adapter service %v", err)
|
||||
}
|
||||
|
||||
// Ensure the expected action (service creation) occurred.
|
||||
actions := client.Actions()
|
||||
if len(actions) != 1 {
|
||||
t.Fatalf("expected 1 actions, but got %d actions", len(actions))
|
||||
}
|
||||
|
||||
// Validate the action is a CreateAction and it's for the correct resource (Service).
|
||||
createAction, ok := actions[0].(coretesting.CreateAction)
|
||||
if !ok {
|
||||
t.Fatalf("expected CreateAction, but got %T", actions[0])
|
||||
}
|
||||
|
||||
if createAction.GetResource().Resource != "services" {
|
||||
t.Fatalf("expected action on 'services', but got '%s'", createAction.GetResource().Resource)
|
||||
}
|
||||
|
||||
// Validate the created service object.
|
||||
service := createAction.GetObject().(*corev1.Service)
|
||||
expectedServiceName := util.KarmadaMetricsAdapterName(name)
|
||||
if service.Name != expectedServiceName {
|
||||
t.Fatalf("expected service name '%s', but got '%s'", expectedServiceName, service.Name)
|
||||
}
|
||||
|
||||
if service.Namespace != namespace {
|
||||
t.Fatalf("expected service namespace '%s', but got '%s'", namespace, service.Namespace)
|
||||
}
|
||||
}
|
||||
|
||||
func verifyDeploymentCreation(client *fakeclientset.Clientset, replicas int32, imagePullPolicy corev1.PullPolicy, name, namespace, image, imageTag string) error {
|
||||
// Assert that a Deployment was created.
|
||||
actions := client.Actions()
|
||||
if len(actions) != 1 {
|
||||
return fmt.Errorf("expected exactly 1 action either create or update, but got %d actions", len(actions))
|
||||
}
|
||||
|
||||
// Check that the action was a Deployment creation.
|
||||
createAction, ok := actions[0].(coretesting.CreateAction)
|
||||
if !ok {
|
||||
return fmt.Errorf("expected a CreateAction, but got %T", actions[0])
|
||||
}
|
||||
|
||||
if createAction.GetResource().Resource != "deployments" {
|
||||
return fmt.Errorf("expected action on 'statefulsets', but got '%s'", createAction.GetResource().Resource)
|
||||
}
|
||||
|
||||
deployment := createAction.GetObject().(*appsv1.Deployment)
|
||||
return verifyDeploymentDetails(
|
||||
deployment, replicas, imagePullPolicy, name, namespace, image, imageTag,
|
||||
)
|
||||
}
|
||||
|
||||
// verifyDeploymentDetails validates the details of a Deployment against the expected parameters.
|
||||
func verifyDeploymentDetails(deployment *appsv1.Deployment, replicas int32, imagePullPolicy corev1.PullPolicy, name, namespace, image, imageTag string) error {
|
||||
expectedDeploymentName := util.KarmadaMetricsAdapterName(name)
|
||||
if deployment.Name != expectedDeploymentName {
|
||||
return fmt.Errorf("expected deployment name '%s', but got '%s'", expectedDeploymentName, deployment.Name)
|
||||
}
|
||||
|
||||
if deployment.Namespace != namespace {
|
||||
return fmt.Errorf("expected deployment namespace '%s', but got '%s'", namespace, deployment.Namespace)
|
||||
}
|
||||
|
||||
if _, exists := deployment.Annotations["annotationKey"]; !exists {
|
||||
return fmt.Errorf("expected annotation with key 'annotationKey' and value 'annotationValue', but it was missing")
|
||||
}
|
||||
|
||||
if _, exists := deployment.Labels["labelKey"]; !exists {
|
||||
return fmt.Errorf("expected label with key 'labelKey' and value 'labelValue', but it was missing")
|
||||
}
|
||||
|
||||
if deployment.Spec.Replicas == nil || *deployment.Spec.Replicas != replicas {
|
||||
return fmt.Errorf("expected replicas to be %d, but got %d", replicas, deployment.Spec.Replicas)
|
||||
}
|
||||
|
||||
containers := deployment.Spec.Template.Spec.Containers
|
||||
if len(containers) != 1 {
|
||||
return fmt.Errorf("expected exactly 1 container, but got %d", len(containers))
|
||||
}
|
||||
container := containers[0]
|
||||
|
||||
expectedImage := fmt.Sprintf("%s:%s", image, imageTag)
|
||||
if container.Image != expectedImage {
|
||||
return fmt.Errorf("expected container image '%s', but got '%s'", expectedImage, container.Image)
|
||||
}
|
||||
|
||||
if container.ImagePullPolicy != imagePullPolicy {
|
||||
return fmt.Errorf("expected image pull policy '%s', but got '%s'", imagePullPolicy, container.ImagePullPolicy)
|
||||
}
|
||||
|
||||
var extractedSecrets []string
|
||||
for _, volume := range deployment.Spec.Template.Spec.Volumes {
|
||||
extractedSecrets = append(extractedSecrets, volume.Secret.SecretName)
|
||||
}
|
||||
expectedSecrets := []string{
|
||||
util.AdminKubeconfigSecretName(name),
|
||||
util.KarmadaCertSecretName(name),
|
||||
}
|
||||
for _, expectedSecret := range expectedSecrets {
|
||||
if !contains(extractedSecrets, expectedSecret) {
|
||||
return fmt.Errorf("expected secret '%s' not found in extracted secrets", expectedSecret)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// contains check if a slice contains a specific string.
|
||||
func contains(slice []string, item string) bool {
|
||||
for _, s := range slice {
|
||||
if s == item {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
Loading…
Reference in New Issue