From a1373742a2c3f980360e4980f3b23b0ff3480ae6 Mon Sep 17 00:00:00 2001 From: Shashank Kumar Shankar Date: Mon, 20 Aug 2018 15:50:50 -0700 Subject: Seed code for k8s multicloud plugin This patch provides the initial seed code for the multicloud Kubernetes plugin and also provides the plugin feature to add new Kubernetes kinds. Change-Id: Ie5ee414656665070cde2834c4855ac2ebc179a9a Issue-ID: MULTICLOUD-301 Signed-off-by: Shashank Kumar Shankar Signed-off-by: Victor Morales --- src/k8splugin/csar/parser.go | 207 ++++++++++++++++++++++++++++++++++++++ src/k8splugin/csar/parser_test.go | 130 ++++++++++++++++++++++++ 2 files changed, 337 insertions(+) create mode 100644 src/k8splugin/csar/parser.go create mode 100644 src/k8splugin/csar/parser_test.go (limited to 'src/k8splugin/csar') diff --git a/src/k8splugin/csar/parser.go b/src/k8splugin/csar/parser.go new file mode 100644 index 00000000..abd6ad92 --- /dev/null +++ b/src/k8splugin/csar/parser.go @@ -0,0 +1,207 @@ +/* +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 csar + +import ( + "encoding/hex" + "io/ioutil" + "log" + "math/rand" + "os" + + "k8s.io/client-go/kubernetes" + + pkgerrors "github.com/pkg/errors" + "gopkg.in/yaml.v2" + + "k8splugin/krd" +) + +func generateExternalVNFID(charLen int) string { + b := make([]byte, charLen/2) + rand.Read(b) + return hex.EncodeToString(b) +} + +// CreateVNF reads the CSAR files from the files system and creates them one by one +var CreateVNF = func(csarID string, cloudRegionID string, namespace string, kubeclient *kubernetes.Clientset) (string, map[string][]string, error) { + namespacePlugin, ok := krd.LoadedPlugins["namespace"] + if !ok { + return "", nil, pkgerrors.New("No plugin for namespace resource found") + } + + symGetNamespaceFunc, err := namespacePlugin.Lookup("GetResource") + if err != nil { + return "", nil, pkgerrors.Wrap(err, "Error fetching namespace plugin") + } + + present, err := symGetNamespaceFunc.(func(string, *kubernetes.Clientset) (bool, error))( + namespace, kubeclient) + if err != nil { + return "", nil, pkgerrors.Wrap(err, "Error in plugin namespace plugin") + } + + if present == false { + symGetNamespaceFunc, err := namespacePlugin.Lookup("CreateResource") + if err != nil { + return "", nil, pkgerrors.Wrap(err, "Error fetching namespace plugin") + } + + err = symGetNamespaceFunc.(func(string, *kubernetes.Clientset) error)( + namespace, kubeclient) + if err != nil { + return "", nil, pkgerrors.Wrap(err, "Error creating "+namespace+" namespace") + } + } + + var path string + + // uuid + externalVNFID := generateExternalVNFID(8) + + // cloud1-default-uuid + internalVNFID := cloudRegionID + "-" + namespace + "-" + externalVNFID + + csarDirPath := os.Getenv("CSAR_DIR") + "/" + csarID + metadataYAMLPath := csarDirPath + "/metadata.yaml" + + seqFile, err := ReadMetadataFile(metadataYAMLPath) + if err != nil { + return "", nil, pkgerrors.Wrap(err, "Error while reading Metadata File: "+metadataYAMLPath) + } + + resourceYAMLNameMap := make(map[string][]string) + + for _, resource := range seqFile.ResourceTypePathMap { + for resourceName, resourceFileNames := range resource { + // Load/Use Deployment data/client + + var resourceNameList []string + + for _, filename := range resourceFileNames { + path = csarDirPath + "/" + filename + + _, err = os.Stat(path) + if os.IsNotExist(err) { + return "", nil, pkgerrors.New("File " + path + "does not exists") + } + + log.Println("Processing file: " + path) + + genericKubeData := &krd.GenericKubeResourceData{ + YamlFilePath: path, + Namespace: namespace, + InternalVNFID: internalVNFID, + } + + typePlugin, ok := krd.LoadedPlugins[resourceName] + if !ok { + return "", nil, pkgerrors.New("No plugin for resource " + resourceName + " found") + } + + symCreateResourceFunc, err := typePlugin.Lookup("CreateResource") + if err != nil { + return "", nil, pkgerrors.Wrap(err, "Error fetching "+resourceName+" plugin") + } + + // cloud1-default-uuid-sisedeploy + internalResourceName, err := symCreateResourceFunc.(func(*krd.GenericKubeResourceData, *kubernetes.Clientset) (string, error))( + genericKubeData, kubeclient) + if err != nil { + return "", nil, pkgerrors.Wrap(err, "Error in plugin "+resourceName+" plugin") + } + + // ["cloud1-default-uuid-sisedeploy1", "cloud1-default-uuid-sisedeploy2", ... ] + resourceNameList = append(resourceNameList, internalResourceName) + + /* + { + "deployment": ["cloud1-default-uuid-sisedeploy1", "cloud1-default-uuid-sisedeploy2", ... ] + } + */ + resourceYAMLNameMap[resourceName] = resourceNameList + } + } + } + + /* + uuid, + { + "deployment": ["cloud1-default-uuid-sisedeploy1", "cloud1-default-uuid-sisedeploy2", ... ] + "service": ["cloud1-default-uuid-sisesvc1", "cloud1-default-uuid-sisesvc2", ... ] + }, + nil + */ + return externalVNFID, resourceYAMLNameMap, nil +} + +// DestroyVNF deletes VNFs based on data passed +var DestroyVNF = func(data map[string][]string, namespace string, kubeclient *kubernetes.Clientset) error { + /* data: + { + "deployment": ["cloud1-default-uuid-sisedeploy1", "cloud1-default-uuid-sisedeploy2", ... ] + "service": ["cloud1-default-uuid-sisesvc1", "cloud1-default-uuid-sisesvc2", ... ] + }, + */ + + for resourceName, resourceList := range data { + typePlugin, ok := krd.LoadedPlugins[resourceName] + if !ok { + return pkgerrors.New("No plugin for resource " + resourceName + " found") + } + + symDeleteResourceFunc, err := typePlugin.Lookup("DeleteResource") + if err != nil { + return pkgerrors.Wrap(err, "Error fetching "+resourceName+" plugin") + } + + for _, resourceName := range resourceList { + + log.Println("Deleting resource: " + resourceName) + + err = symDeleteResourceFunc.(func(string, string, *kubernetes.Clientset) error)( + resourceName, namespace, kubeclient) + if err != nil { + return pkgerrors.Wrap(err, "Error destroying "+resourceName) + } + } + } + + return nil +} + +// MetadataFile stores the metadata of execution +type MetadataFile struct { + ResourceTypePathMap []map[string][]string `yaml:"resources"` +} + +// ReadMetadataFile reads the metadata yaml to return the order or reads +var ReadMetadataFile = func(yamlFilePath string) (MetadataFile, error) { + var seqFile MetadataFile + + if _, err := os.Stat(yamlFilePath); err == nil { + log.Println("Reading metadata YAML: " + yamlFilePath) + rawBytes, err := ioutil.ReadFile(yamlFilePath) + if err != nil { + return seqFile, pkgerrors.Wrap(err, "Metadata YAML file read error") + } + + err = yaml.Unmarshal(rawBytes, &seqFile) + if err != nil { + return seqFile, pkgerrors.Wrap(err, "Metadata YAML file read error") + } + } + + return seqFile, nil +} diff --git a/src/k8splugin/csar/parser_test.go b/src/k8splugin/csar/parser_test.go new file mode 100644 index 00000000..cec5395e --- /dev/null +++ b/src/k8splugin/csar/parser_test.go @@ -0,0 +1,130 @@ +/* +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 csar + +import ( + "io/ioutil" + "k8s.io/client-go/kubernetes" + "log" + "os" + "plugin" + "testing" + + pkgerrors "github.com/pkg/errors" + "gopkg.in/yaml.v2" + + "k8splugin/krd" +) + +func LoadMockPlugins(krdLoadedPlugins *map[string]*plugin.Plugin) error { + if _, err := os.Stat("../mock_files/mock_plugins/mockplugin.so"); os.IsNotExist(err) { + return pkgerrors.New("mockplugin.so does not exist. Please compile mockplugin.go to generate") + } + + mockPlugin, err := plugin.Open("../mock_files/mock_plugins/mockplugin.so") + if err != nil { + return pkgerrors.Cause(err) + } + + (*krdLoadedPlugins)["namespace"] = mockPlugin + (*krdLoadedPlugins)["deployment"] = mockPlugin + (*krdLoadedPlugins)["service"] = mockPlugin + + return nil +} + +func TestCreateVNF(t *testing.T) { + oldkrdPluginData := krd.LoadedPlugins + oldReadMetadataFile := ReadMetadataFile + + defer func() { + krd.LoadedPlugins = oldkrdPluginData + ReadMetadataFile = oldReadMetadataFile + }() + + err := LoadMockPlugins(&krd.LoadedPlugins) + if err != nil { + t.Fatalf("TestCreateVNF returned an error (%s)", err) + } + + ReadMetadataFile = func(yamlFilePath string) (MetadataFile, error) { + var seqFile MetadataFile + + if _, err := os.Stat(yamlFilePath); err == nil { + rawBytes, err := ioutil.ReadFile("../mock_files/mock_yamls/metadata.yaml") + if err != nil { + return seqFile, pkgerrors.Wrap(err, "Metadata YAML file read error") + } + + err = yaml.Unmarshal(rawBytes, &seqFile) + if err != nil { + return seqFile, pkgerrors.Wrap(err, "Metadata YAML file unmarshall error") + } + } + + return seqFile, nil + } + + kubeclient := kubernetes.Clientset{} + + t.Run("Successfully create VNF", func(t *testing.T) { + externaluuid, data, err := CreateVNF("uuid", "cloudregion1", "test", &kubeclient) + if err != nil { + t.Fatalf("TestCreateVNF returned an error (%s)", err) + } + + log.Println(externaluuid) + + if data == nil { + t.Fatalf("TestCreateVNF returned empty data (%s)", data) + } + }) + +} + +func TestDeleteVNF(t *testing.T) { + oldkrdPluginData := krd.LoadedPlugins + + defer func() { + krd.LoadedPlugins = oldkrdPluginData + }() + + err := LoadMockPlugins(&krd.LoadedPlugins) + if err != nil { + t.Fatalf("TestCreateVNF returned an error (%s)", err) + } + + kubeclient := kubernetes.Clientset{} + + t.Run("Successfully delete VNF", func(t *testing.T) { + data := map[string][]string{ + "deployment": []string{"cloud1-default-uuid-sisedeploy"}, + "service": []string{"cloud1-default-uuid-sisesvc"}, + } + + err := DestroyVNF(data, "test", &kubeclient) + if err != nil { + t.Fatalf("TestCreateVNF returned an error (%s)", err) + } + }) +} + +func TestReadMetadataFile(t *testing.T) { + t.Run("Successfully read Metadata YAML file", func(t *testing.T) { + _, err := ReadMetadataFile("../mock_files//mock_yamls/metadata.yaml") + if err != nil { + t.Fatalf("TestReadMetadataFile returned an error (%s)", err) + } + }) +} -- cgit 1.2.3-korg