Reconcile names in code and Jira items

k8splugin manages deployment of resource bundles
and these are not restricted to vnfs.
This names' change is to reflect that functionality.
P2: using rb instead of resource bundle

Issue-ID: MULTICLOUD-410
Change-Id: I09e0b92a8fc13562e1c6bb17dc8bc13de97264d7
Signed-off-by: Kiran Kamineni <kiran.k.kamineni@intel.com>

2 files changed, 397 insertions, 0 deletions

diff --git a/src/k8splugin/rb/definition.go b/src/k8splugin/rb/definition.go
new file mode 100644
index 00000000..03fffdda
--- /dev/null
+++ b/src/k8splugin/rb/definition.go
@@ -0,0 +1,135 @@
+/*
+ * Copyright 2018 Intel Corporation, Inc
+ *
+ * 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 rb
+
+import (
+	"k8splugin/db"
+	"log"
+
+	uuid "github.com/hashicorp/go-uuid"
+	pkgerrors "github.com/pkg/errors"
+)
+
+// Definition contains the parameters needed for resource bundle (rb) definitions
+// It implements the interface for managing the definitions
+type Definition struct {
+	Name        string `json:"name"`
+	Description string `json:"description"`
+	UUID        string `json:"uuid,omitempty"`
+	ServiceType string `json:"service-type"`
+}
+
+// DefinitionManager is an interface exposes the resource bundle definition functionality
+type DefinitionManager interface {
+	Create(def Definition) (Definition, error)
+	List() ([]Definition, error)
+	Get(resID string) (Definition, error)
+	Delete(resID string) error
+}
+
+// DefinitionClient implements the DefinitionManager
+// It will also be used to maintain some localized state
+type DefinitionClient struct {
+	keyPrefix string
+}
+
+// NewDefinitionClient returns an instance of the DefinitionClient
+// which implements the DefinitionManager
+// Uses rb/def prefix
+func NewDefinitionClient() *DefinitionClient {
+	return &DefinitionClient{
+		keyPrefix: "rb/def/"}
+}
+
+// Create an entry for the resource in the database
+func (v *DefinitionClient) Create(def Definition) (Definition, error) {
+	// If UUID is empty, we will generate one
+	if def.UUID == "" {
+		def.UUID, _ = uuid.GenerateUUID()
+	}
+	key := v.keyPrefix + def.UUID
+
+	serData, err := db.Serialize(v)
+	if err != nil {
+		return Definition{}, pkgerrors.Wrap(err, "Serialize Resource Bundle Definition")
+	}
+
+	err = db.DBconn.Create(key, serData)
+	if err != nil {
+		return Definition{}, pkgerrors.Wrap(err, "Creating DB Entry")
+	}
+
+	return def, nil
+}
+
+// List all resource entries in the database
+func (v *DefinitionClient) List() ([]Definition, error) {
+	strArray, err := db.DBconn.ReadAll(v.keyPrefix)
+	if err != nil {
+		return []Definition{}, pkgerrors.Wrap(err, "Listing Resource Bundle Definitions")
+	}
+
+	var retData []Definition
+
+	for _, key := range strArray {
+		value, err := db.DBconn.Read(key)
+		if err != nil {
+			log.Printf("Error Reading Key: %s", key)
+			continue
+		}
+		if value != "" {
+			def := Definition{}
+			err = db.DeSerialize(value, &def)
+			if err != nil {
+				log.Printf("Error Deserializing Value: %s", value)
+				continue
+			}
+			retData = append(retData, def)
+		}
+	}
+
+	return retData, nil
+}
+
+// Get returns the Resource Bundle Definition for corresponding ID
+func (v *DefinitionClient) Get(id string) (Definition, error) {
+	value, err := db.DBconn.Read(v.keyPrefix + id)
+	if err != nil {
+		return Definition{}, pkgerrors.Wrap(err, "Get Resource Bundle definition")
+	}
+
+	if value != "" {
+		def := Definition{}
+		err = db.DeSerialize(value, &def)
+		if err != nil {
+			return Definition{}, pkgerrors.Wrap(err, "Deserializing Value")
+		}
+		return def, nil
+	}
+
+	return Definition{}, pkgerrors.New("Error getting Resource Bundle Definition")
+}
+
+// Delete the Resource Bundle definition from database
+func (v *DefinitionClient) Delete(id string) error {
+	err := db.DBconn.Delete(v.keyPrefix + id)
+	if err != nil {
+		return pkgerrors.Wrap(err, "Delete Resource Bundle Definitions")
+	}
+
+	return nil
+}
diff --git a/src/k8splugin/rb/definition_test.go b/src/k8splugin/rb/definition_test.go
new file mode 100644
index 00000000..a3993c8c
--- /dev/null
+++ b/src/k8splugin/rb/definition_test.go
@@ -0,0 +1,262 @@
+// +build unit
+
+/*
+ * Copyright 2018 Intel Corporation, Inc
+ *
+ * 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 rb
+
+import (
+	"k8splugin/db"
+	"reflect"
+	"strings"
+	"testing"
+
+	"github.com/hashicorp/consul/api"
+	pkgerrors "github.com/pkg/errors"
+)
+
+func TestCreate(t *testing.T) {
+	testCases := []struct {
+		label         string
+		inp           Definition
+		expectedError string
+		mockdb        *db.MockDB
+		expected      Definition
+	}{
+		{
+			label: "Create Resource Bundle Definition",
+			inp: Definition{
+				UUID:        "123e4567-e89b-12d3-a456-426655440000",
+				Name:        "testresourcebundle",
+				Description: "testresourcebundle",
+				ServiceType: "firewall",
+			},
+			expected: Definition{
+				UUID:        "123e4567-e89b-12d3-a456-426655440000",
+				Name:        "testresourcebundle",
+				Description: "testresourcebundle",
+				ServiceType: "firewall",
+			},
+			expectedError: "",
+			mockdb:        &db.MockDB{},
+		},
+		{
+			label:         "Failed Create Resource Bundle Definition",
+			expectedError: "Error Creating Definition",
+			mockdb: &db.MockDB{
+				Err: pkgerrors.New("Error Creating Definition"),
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.label, func(t *testing.T) {
+			db.DBconn = testCase.mockdb
+			impl := NewDefinitionClient()
+			got, err := impl.Create(testCase.inp)
+			if err != nil {
+				if testCase.expectedError == "" {
+					t.Fatalf("Create returned an unexpected error %s", err)
+				}
+				if strings.Contains(err.Error(), testCase.expectedError) == false {
+					t.Fatalf("Create returned an unexpected error %s", err)
+				}
+			} else {
+				if reflect.DeepEqual(testCase.expected, got) == false {
+					t.Errorf("Create Resource Bundle returned unexpected body: got %v;"+
+						" expected %v", got, testCase.expected)
+				}
+			}
+		})
+	}
+}
+
+func TestList(t *testing.T) {
+
+	testCases := []struct {
+		label         string
+		expectedError string
+		mockdb        *db.MockDB
+		expected      []Definition
+	}{
+		{
+			label: "List Resource Bundle Definition",
+			expected: []Definition{
+				{
+					UUID:        "123e4567-e89b-12d3-a456-426655440000",
+					Name:        "testresourcebundle",
+					Description: "testresourcebundle",
+					ServiceType: "firewall",
+				},
+				{
+					UUID:        "123e4567-e89b-12d3-a456-426655441111",
+					Name:        "testresourcebundle2",
+					Description: "testresourcebundle2",
+					ServiceType: "dns",
+				},
+			},
+			expectedError: "",
+			mockdb: &db.MockDB{
+				Items: api.KVPairs{
+					&api.KVPair{
+						Key: "rb/def/123e4567-e89b-12d3-a456-426655440000",
+						Value: []byte("{\"name\":\"testresourcebundle\"," +
+							"\"description\":\"testresourcebundle\"," +
+							"\"uuid\":\"123e4567-e89b-12d3-a456-426655440000\"," +
+							"\"service-type\":\"firewall\"}"),
+					},
+					&api.KVPair{
+						Key: "rb/def/123e4567-e89b-12d3-a456-426655441111",
+						Value: []byte("{\"name\":\"testresourcebundle2\"," +
+							"\"description\":\"testresourcebundle2\"," +
+							"\"uuid\":\"123e4567-e89b-12d3-a456-426655441111\"," +
+							"\"service-type\":\"dns\"}"),
+					},
+				},
+			},
+		},
+		{
+			label:         "List Error",
+			expectedError: "DB Error",
+			mockdb: &db.MockDB{
+				Err: pkgerrors.New("DB Error"),
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.label, func(t *testing.T) {
+			db.DBconn = testCase.mockdb
+			impl := NewDefinitionClient()
+			got, err := impl.List()
+			if err != nil {
+				if testCase.expectedError == "" {
+					t.Fatalf("List returned an unexpected error %s", err)
+				}
+				if strings.Contains(err.Error(), testCase.expectedError) == false {
+					t.Fatalf("List returned an unexpected error %s", err)
+				}
+			} else {
+				if reflect.DeepEqual(testCase.expected, got) == false {
+					t.Errorf("List Resource Bundle returned unexpected body: got %v;"+
+						" expected %v", got, testCase.expected)
+				}
+			}
+		})
+	}
+}
+
+func TestGet(t *testing.T) {
+
+	testCases := []struct {
+		label         string
+		expectedError string
+		mockdb        *db.MockDB
+		inp           string
+		expected      Definition
+	}{
+		{
+			label: "Get Resource Bundle Definition",
+			inp:   "123e4567-e89b-12d3-a456-426655440000",
+			expected: Definition{
+				UUID:        "123e4567-e89b-12d3-a456-426655440000",
+				Name:        "testresourcebundle",
+				Description: "testresourcebundle",
+				ServiceType: "firewall",
+			},
+			expectedError: "",
+			mockdb: &db.MockDB{
+				Items: api.KVPairs{
+					&api.KVPair{
+						Key: "rb/def/123e4567-e89b-12d3-a456-426655440000",
+						Value: []byte("{\"name\":\"testresourcebundle\"," +
+							"\"description\":\"testresourcebundle\"," +
+							"\"uuid\":\"123e4567-e89b-12d3-a456-426655440000\"," +
+							"\"service-type\":\"firewall\"}"),
+					},
+				},
+			},
+		},
+		{
+			label:         "Get Error",
+			expectedError: "DB Error",
+			mockdb: &db.MockDB{
+				Err: pkgerrors.New("DB Error"),
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.label, func(t *testing.T) {
+			db.DBconn = testCase.mockdb
+			impl := NewDefinitionClient()
+			got, err := impl.Get(testCase.inp)
+			if err != nil {
+				if testCase.expectedError == "" {
+					t.Fatalf("Get returned an unexpected error %s", err)
+				}
+				if strings.Contains(err.Error(), testCase.expectedError) == false {
+					t.Fatalf("Get returned an unexpected error %s", err)
+				}
+			} else {
+				if reflect.DeepEqual(testCase.expected, got) == false {
+					t.Errorf("Get Resource Bundle returned unexpected body: got %v;"+
+						" expected %v", got, testCase.expected)
+				}
+			}
+		})
+	}
+}
+
+func TestDelete(t *testing.T) {
+
+	testCases := []struct {
+		label         string
+		inp           string
+		expectedError string
+		mockdb        *db.MockDB
+		expected      []Definition
+	}{
+		{
+			label:  "Delete Resource Bundle Definition",
+			inp:    "123e4567-e89b-12d3-a456-426655440000",
+			mockdb: &db.MockDB{},
+		},
+		{
+			label:         "Delete Error",
+			expectedError: "DB Error",
+			mockdb: &db.MockDB{
+				Err: pkgerrors.New("DB Error"),
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.label, func(t *testing.T) {
+			db.DBconn = testCase.mockdb
+			impl := NewDefinitionClient()
+			err := impl.Delete(testCase.inp)
+			if err != nil {
+				if testCase.expectedError == "" {
+					t.Fatalf("Delete returned an unexpected error %s", err)
+				}
+				if strings.Contains(err.Error(), testCase.expectedError) == false {
+					t.Fatalf("Delete returned an unexpected error %s", err)
+				}
+			}
+		})
+	}
+}