From 05274b1b149139d91445ca10a73defe41f14824a Mon Sep 17 00:00:00 2001 From: Victor Morales Date: Tue, 18 Sep 2018 17:19:00 -0700 Subject: Add UTs to plugins Deployment, service and namespace are plugins which offers CRUD operations to manage their resources. They haven't implemented Unit Tests which makes fragile to change/refactor the source code. This change adds their corresponding Unit Tests and defines a standard interface. Change-Id: I1e1eb40f1a18ba33c74069a117462c8df17767ac Signed-off-by: Victor Morales Issue-ID: MULTICLOUD-301 --- src/k8splugin/plugins/service/plugin.go | 83 +++++------ src/k8splugin/plugins/service/plugin_test.go | 199 +++++++++++++++++++++++++++ 2 files changed, 234 insertions(+), 48 deletions(-) create mode 100644 src/k8splugin/plugins/service/plugin_test.go (limited to 'src/k8splugin/plugins/service') diff --git a/src/k8splugin/plugins/service/plugin.go b/src/k8splugin/plugins/service/plugin.go index 36ef24f6..61609e98 100644 --- a/src/k8splugin/plugins/service/plugin.go +++ b/src/k8splugin/plugins/service/plugin.go @@ -14,9 +14,7 @@ limitations under the License. package main import ( - "io/ioutil" "log" - "os" "k8s.io/client-go/kubernetes" @@ -24,58 +22,44 @@ import ( coreV1 "k8s.io/api/core/v1" metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1" - "k8s.io/client-go/kubernetes/scheme" "k8splugin/krd" ) -// CreateResource object in a specific Kubernetes Deployment -func CreateResource(kubedata *krd.GenericKubeResourceData, kubeclient *kubernetes.Clientset) (string, error) { - if kubedata.Namespace == "" { - kubedata.Namespace = "default" - } - - if _, err := os.Stat(kubedata.YamlFilePath); err != nil { - return "", pkgerrors.New("File " + kubedata.YamlFilePath + " not found") - } - - log.Println("Reading service YAML") - rawBytes, err := ioutil.ReadFile(kubedata.YamlFilePath) - if err != nil { - return "", pkgerrors.Wrap(err, "Service YAML file read error") +// Create a service object in a specific Kubernetes cluster +func Create(data *krd.ResourceData, client kubernetes.Interface) (string, error) { + namespace := data.Namespace + if namespace == "" { + namespace = "default" } - - log.Println("Decoding service YAML") - decode := scheme.Codecs.UniversalDeserializer().Decode - obj, _, err := decode(rawBytes, nil, nil) + obj, err := krd.DecodeYAML(data.YamlFilePath) if err != nil { - return "", pkgerrors.Wrap(err, "Deserialize service error") + return "", pkgerrors.Wrap(err, "Decode service object error") } - switch o := obj.(type) { - case *coreV1.Service: - kubedata.ServiceData = o - default: - return "", pkgerrors.New(kubedata.YamlFilePath + " contains another resource different than Service") + service, ok := obj.(*coreV1.Service) + if !ok { + return "", pkgerrors.New("Decoded object contains another resource different than Service") } + service.Namespace = namespace + service.Name = data.VnfId + "-" + service.Name - kubedata.ServiceData.Namespace = kubedata.Namespace - kubedata.ServiceData.Name = kubedata.InternalVNFID + "-" + kubedata.ServiceData.Name - - result, err := kubeclient.CoreV1().Services(kubedata.Namespace).Create(kubedata.ServiceData) + result, err := client.CoreV1().Services(namespace).Create(service) if err != nil { return "", pkgerrors.Wrap(err, "Create Service error") } + return result.GetObjectMeta().GetName(), nil } -// ListResources of existing deployments hosted in a specific Kubernetes Deployment -func ListResources(limit int64, namespace string, kubeclient *kubernetes.Clientset) (*[]string, error) { +// List of existing services hosted in a specific Kubernetes cluster +func List(namespace string, kubeclient kubernetes.Interface) ([]string, error) { if namespace == "" { namespace = "default" } + opts := metaV1.ListOptions{ - Limit: limit, + Limit: krd.ResourcesListLimit, } opts.APIVersion = "apps/v1" opts.Kind = "Service" @@ -84,36 +68,39 @@ func ListResources(limit int64, namespace string, kubeclient *kubernetes.Clients if err != nil { return nil, pkgerrors.Wrap(err, "Get Service list error") } - result := make([]string, 0, limit) + + result := make([]string, 0, krd.ResourcesListLimit) if list != nil { - for _, service := range list.Items { - result = append(result, service.Name) + for _, deployment := range list.Items { + log.Printf("%v", deployment.Name) + result = append(result, deployment.Name) } } - return &result, nil + + return result, nil } -// DeleteResource deletes an existing Kubernetes service -func DeleteResource(name string, namespace string, kubeclient *kubernetes.Clientset) error { +// Delete an existing service hosted in a specific Kubernetes cluster +func Delete(name string, namespace string, kubeclient kubernetes.Interface) error { if namespace == "" { namespace = "default" } - log.Println("Deleting service: " + name) - deletePolicy := metaV1.DeletePropagationForeground - err := kubeclient.CoreV1().Services(namespace).Delete(name, &metaV1.DeleteOptions{ + opts := &metaV1.DeleteOptions{ PropagationPolicy: &deletePolicy, - }) - if err != nil { - return pkgerrors.Wrap(err, "Delete Service error") + } + + log.Println("Deleting service: " + name) + if err := kubeclient.CoreV1().Services(namespace).Delete(name, opts); err != nil { + return pkgerrors.Wrap(err, "Delete service error") } return nil } -// GetResource existing service hosting in a specific Kubernetes Service -func GetResource(name string, namespace string, kubeclient *kubernetes.Clientset) (string, error) { +// Get an existing service hosted in a specific Kubernetes cluster +func Get(name string, namespace string, kubeclient kubernetes.Interface) (string, error) { if namespace == "" { namespace = "default" } diff --git a/src/k8splugin/plugins/service/plugin_test.go b/src/k8splugin/plugins/service/plugin_test.go new file mode 100644 index 00000000..001467df --- /dev/null +++ b/src/k8splugin/plugins/service/plugin_test.go @@ -0,0 +1,199 @@ +// +build unit + +/* +Copyright 2018 Intel Corporation. +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 main + +import ( + "reflect" + "strings" + "testing" + + "k8splugin/krd" + + coreV1 "k8s.io/api/core/v1" + metaV1 "k8s.io/apimachinery/pkg/apis/meta/v1" + testclient "k8s.io/client-go/kubernetes/fake" +) + +func TestCreateService(t *testing.T) { + namespace := "test1" + name := "mock-service" + internalVNFID := "1" + testCases := []struct { + label string + input *krd.ResourceData + clientOutput *coreV1.Service + expectedResult string + expectedError string + }{ + { + label: "Fail to create a service with non-existing file", + input: &krd.ResourceData{ + YamlFilePath: "non-existing_test_file.yaml", + }, + clientOutput: &coreV1.Service{}, + expectedError: "not found", + }, + { + label: "Fail to create a service with invalid type", + input: &krd.ResourceData{ + YamlFilePath: "../../mock_files/mock_yamls/deployment.yaml", + }, + clientOutput: &coreV1.Service{}, + expectedError: "contains another resource different than Service", + }, + { + label: "Successfully create a service", + input: &krd.ResourceData{ + VnfId: internalVNFID, + YamlFilePath: "../../mock_files/mock_yamls/service.yaml", + }, + clientOutput: &coreV1.Service{ + ObjectMeta: metaV1.ObjectMeta{ + Name: name, + Namespace: namespace, + }, + }, + expectedResult: internalVNFID + "-" + name, + }, + } + + for _, testCase := range testCases { + client := testclient.NewSimpleClientset(testCase.clientOutput) + t.Run(testCase.label, func(t *testing.T) { + result, err := Create(testCase.input, client) + if err != nil { + if !strings.Contains(string(err.Error()), testCase.expectedError) { + t.Fatalf("Create method returned an error (%s)", err) + } + } + if !reflect.DeepEqual(testCase.expectedResult, result) { + t.Fatalf("Create method returned %v and it was expected (%v)", result, testCase.expectedResult) + } + }) + } +} + +func TestListService(t *testing.T) { + namespace := "test1" + testCases := []struct { + label string + input string + clientOutput *coreV1.ServiceList + expectedResult []string + }{ + { + label: "Sucessfully to display an empty service list", + input: namespace, + clientOutput: &coreV1.ServiceList{}, + expectedResult: []string{}, + }, + { + label: "Sucessfully to display a list of existing services", + input: namespace, + clientOutput: &coreV1.ServiceList{ + Items: []coreV1.Service{ + coreV1.Service{ + ObjectMeta: metaV1.ObjectMeta{ + Name: "test", + Namespace: namespace, + }, + }, + }, + }, + expectedResult: []string{"test"}, + }, + } + + for _, testCase := range testCases { + client := testclient.NewSimpleClientset(testCase.clientOutput) + t.Run(testCase.label, func(t *testing.T) { + result, err := List(testCase.input, client) + if err != nil { + t.Fatalf("List method returned an error (%s)", err) + } + if !reflect.DeepEqual(testCase.expectedResult, result) { + t.Fatalf("List method returned %v and it was expected (%v)", result, testCase.expectedResult) + } + }) + } +} + +func TestDeleteService(t *testing.T) { + namespace := "test1" + name := "mock-service" + testCases := []struct { + label string + input string + clientOutput *coreV1.Service + }{ + { + label: "Sucessfully to delete an existing service", + input: name, + clientOutput: &coreV1.Service{ + ObjectMeta: metaV1.ObjectMeta{ + Name: name, + Namespace: namespace, + }, + }, + }, + } + + for _, testCase := range testCases { + client := testclient.NewSimpleClientset(testCase.clientOutput) + t.Run(testCase.label, func(t *testing.T) { + err := Delete(testCase.input, namespace, client) + if err != nil { + t.Fatalf("Delete method returned an error (%s)", err) + } + }) + } +} + +func TestGetService(t *testing.T) { + namespace := "test1" + name := "mock-service" + testCases := []struct { + label string + input string + clientOutput *coreV1.Service + expectedResult string + }{ + { + label: "Sucessfully to get an existing service", + input: name, + clientOutput: &coreV1.Service{ + ObjectMeta: metaV1.ObjectMeta{ + Name: name, + Namespace: namespace, + }, + }, + expectedResult: name, + }, + } + + for _, testCase := range testCases { + client := testclient.NewSimpleClientset(testCase.clientOutput) + t.Run(testCase.label, func(t *testing.T) { + result, err := Get(testCase.input, namespace, client) + if err != nil { + t.Fatalf("Get method returned an error (%s)", err) + } + if !reflect.DeepEqual(testCase.expectedResult, result) { + t.Fatalf("Get method returned %v and it was expected (%v)", result, testCase.expectedResult) + } + }) + } +} -- cgit 1.2.3-korg