Merge pull request #5588 from mohamedawnallah/unitTestKarmadaWebhook
operator/pkg/controlplane: unit test karmada webhook
This commit is contained in:
karmada-bot
GitHub
commit
3e0516fb96
|
|
@ -0,0 +1,259 @@
|
|||
/*
|
||||
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 webhook
|
||||
|
||||
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 TestEnsureKarmadaWebhook(t *testing.T) {
|
||||
var replicas int32 = 2
|
||||
image, imageTag := "docker.io/karmada/karmada-webhook", "latest"
|
||||
name := "karmada-demo"
|
||||
namespace := "test"
|
||||
imagePullPolicy := corev1.PullIfNotPresent
|
||||
annotations := map[string]string{"annotationKey": "annotationValue"}
|
||||
labels := map[string]string{"labelKey": "labelValue"}
|
||||
extraArgs := map[string]string{"cmd1": "arg1", "cmd2": "arg2"}
|
||||
|
||||
cfg := &operatorv1alpha1.KarmadaWebhook{
|
||||
CommonSettings: operatorv1alpha1.CommonSettings{
|
||||
Image: operatorv1alpha1.Image{
|
||||
ImageRepository: image,
|
||||
ImageTag: imageTag,
|
||||
},
|
||||
Replicas: ptr.To[int32](replicas),
|
||||
Annotations: annotations,
|
||||
Labels: labels,
|
||||
Resources: corev1.ResourceRequirements{},
|
||||
ImagePullPolicy: imagePullPolicy,
|
||||
},
|
||||
ExtraArgs: extraArgs,
|
||||
}
|
||||
|
||||
// Create fake clientset.
|
||||
fakeClient := fakeclientset.NewSimpleClientset()
|
||||
|
||||
err := EnsureKarmadaWebhook(fakeClient, cfg, name, namespace, map[string]bool{})
|
||||
if err != nil {
|
||||
t.Fatalf("failed to ensure karmada webhook, but got: %v", err)
|
||||
}
|
||||
|
||||
actions := fakeClient.Actions()
|
||||
if len(actions) != 2 {
|
||||
t.Fatalf("expected 2 actions, but got %d", len(actions))
|
||||
}
|
||||
}
|
||||
|
||||
func TestInstallKarmadaWebhook(t *testing.T) {
|
||||
var replicas int32 = 2
|
||||
image, imageTag := "docker.io/karmada/karmada-webhook", "latest"
|
||||
name := "karmada-demo"
|
||||
namespace := "test"
|
||||
imagePullPolicy := corev1.PullIfNotPresent
|
||||
annotations := map[string]string{"annotationKey": "annotationValue"}
|
||||
labels := map[string]string{"labelKey": "labelValue"}
|
||||
extraArgs := map[string]string{"cmd1": "arg1", "cmd2": "arg2"}
|
||||
|
||||
cfg := &operatorv1alpha1.KarmadaWebhook{
|
||||
CommonSettings: operatorv1alpha1.CommonSettings{
|
||||
Image: operatorv1alpha1.Image{
|
||||
ImageRepository: image,
|
||||
ImageTag: imageTag,
|
||||
},
|
||||
Replicas: ptr.To[int32](replicas),
|
||||
Annotations: annotations,
|
||||
Labels: labels,
|
||||
Resources: corev1.ResourceRequirements{},
|
||||
ImagePullPolicy: imagePullPolicy,
|
||||
},
|
||||
ExtraArgs: extraArgs,
|
||||
}
|
||||
|
||||
// Create fake clientset.
|
||||
fakeClient := fakeclientset.NewSimpleClientset()
|
||||
|
||||
err := installKarmadaWebhook(fakeClient, cfg, name, namespace, map[string]bool{})
|
||||
if err != nil {
|
||||
t.Fatalf("failed to install karmada webhook: %v", err)
|
||||
}
|
||||
|
||||
err = verifyDeploymentCreation(fakeClient, replicas, imagePullPolicy, extraArgs, name, namespace, image, imageTag)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to verify karmada webhook deployment creation: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestCreateKarmadaWebhookService(t *testing.T) {
|
||||
// Define inputs.
|
||||
name := "karmada-demo"
|
||||
namespace := "test"
|
||||
|
||||
// Initialize fake clientset.
|
||||
client := fakeclientset.NewSimpleClientset()
|
||||
|
||||
err := createKarmadaWebhookService(client, name, namespace)
|
||||
if err != nil {
|
||||
t.Fatalf("failed to create karmada webhook service")
|
||||
}
|
||||
|
||||
// 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.KarmadaWebhookName(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)
|
||||
}
|
||||
}
|
||||
|
||||
// verifyDeploymentCreation validates the details of a Deployment against the expected parameters.
|
||||
func verifyDeploymentCreation(client *fakeclientset.Clientset, replicas int32, imagePullPolicy corev1.PullPolicy, extraArgs map[string]string, 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 'deployments', but got '%s'", createAction.GetResource().Resource)
|
||||
}
|
||||
|
||||
deployment := createAction.GetObject().(*appsv1.Deployment)
|
||||
return verifyDeploymentDetails(deployment, replicas, imagePullPolicy, extraArgs, 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, extraArgs map[string]string, name, namespace, image, imageTag string) error {
|
||||
expectedDeploymentName := util.KarmadaWebhookName(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))
|
||||
}
|
||||
|
||||
expectedImage := fmt.Sprintf("%s:%s", image, imageTag)
|
||||
container := containers[0]
|
||||
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)
|
||||
}
|
||||
|
||||
err := verifyExtraArgs(&container, extraArgs)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to verify extra args: %v", err)
|
||||
}
|
||||
|
||||
err = verifySecrets(deployment, name)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to verify secrets: %v", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// verifySecrets validates that the expected secrets are present in the Deployment's volumes.
|
||||
func verifySecrets(deployment *appsv1.Deployment, name string) error {
|
||||
var extractedSecrets []string
|
||||
for _, volume := range deployment.Spec.Template.Spec.Volumes {
|
||||
extractedSecrets = append(extractedSecrets, volume.Secret.SecretName)
|
||||
}
|
||||
expectedSecrets := []string{
|
||||
util.AdminKubeconfigSecretName(name),
|
||||
util.WebhookCertSecretName(name),
|
||||
}
|
||||
for _, expectedSecret := range expectedSecrets {
|
||||
if !contains(extractedSecrets, expectedSecret) {
|
||||
return fmt.Errorf("expected secret '%s' not found in extracted secrets", expectedSecret)
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// verifyExtraArgs checks that the container command includes the extra arguments.
|
||||
func verifyExtraArgs(container *corev1.Container, extraArgs map[string]string) error {
|
||||
for key, value := range extraArgs {
|
||||
expectedArg := fmt.Sprintf("--%s=%s", key, value)
|
||||
if !contains(container.Command, expectedArg) {
|
||||
return fmt.Errorf("expected container commands to include '%s', but it was missing", expectedArg)
|
||||
}
|
||||
}
|
||||
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