Add Controller Register API to Orchestrator

Add API allows Controllers to register
themselves as gRPC servers consumed by
the orchestrator.

Issue-ID: MULTICLOUD-995
Signed-off-by: Marcus G K Williams <marcus.williams@intel.com>
Change-Id: I75946a4af711bf2e9d65f354923db494da667e70

3 files changed, 318 insertions, 0 deletions

diff --git a/src/orchestrator/pkg/module/controller.go b/src/orchestrator/pkg/module/controller.go
new file mode 100644
index 00000000..35d6f892
--- /dev/null
+++ b/src/orchestrator/pkg/module/controller.go
@@ -0,0 +1,135 @@
+/*
+ * Copyright 2020 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 module
+
+import (
+	"encoding/json"
+
+	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"
+
+	pkgerrors "github.com/pkg/errors"
+)
+
+// Controller contains the parameters needed for Controllers
+// It implements the interface for managing the Controllers
+type Controller struct {
+	Name string `json:"name"`
+
+	Host string `json:"host"`
+
+	Port int64 `json:"port"`
+}
+
+// ControllerKey is the key structure that is used in the database
+type ControllerKey struct {
+	ControllerName string `json:"controller-name"`
+}
+
+// We will use json marshalling to convert to string to
+// preserve the underlying structure.
+func (mk ControllerKey) String() string {
+	out, err := json.Marshal(mk)
+	if err != nil {
+		return ""
+	}
+
+	return string(out)
+}
+
+// ControllerManager is an interface exposes the Controller functionality
+type ControllerManager interface {
+	CreateController(ms Controller) (Controller, error)
+	GetController(name string) (Controller, error)
+	DeleteController(name string) error
+}
+
+// ControllerClient implements the Manager
+// It will also be used to maintain some localized state
+type ControllerClient struct {
+	collectionName string
+	tagMeta        string
+}
+
+// NewControllerClient returns an instance of the ControllerClient
+// which implements the Manager
+func NewControllerClient() *ControllerClient {
+	return &ControllerClient{
+		collectionName: "controller",
+		tagMeta:        "controllermetadata",
+	}
+}
+
+// CreateController a new collection based on the Controller
+func (mc *ControllerClient) CreateController(m Controller) (Controller, error) {
+
+	//Construct the composite key to select the entry
+	key := ControllerKey{
+		ControllerName: m.Name,
+	}
+
+	//Check if this Controller already exists
+	_, err := mc.GetController(m.Name)
+	if err == nil {
+		return Controller{}, pkgerrors.New("Controller already exists")
+	}
+
+	err = db.DBconn.Create(mc.collectionName, key, mc.tagMeta, m)
+	if err != nil {
+		return Controller{}, pkgerrors.Wrap(err, "Creating DB Entry")
+	}
+
+	return m, nil
+}
+
+// GetController returns the Controller for corresponding name
+func (mc *ControllerClient) GetController(name string) (Controller, error) {
+
+	//Construct the composite key to select the entry
+	key := ControllerKey{
+		ControllerName: name,
+	}
+	value, err := db.DBconn.Read(mc.collectionName, key, mc.tagMeta)
+	if err != nil {
+		return Controller{}, pkgerrors.Wrap(err, "Get Controller")
+	}
+
+	//value is a byte array
+	if value != nil {
+		microserv := Controller{}
+		err = db.DBconn.Unmarshal(value, &microserv)
+		if err != nil {
+			return Controller{}, pkgerrors.Wrap(err, "Unmarshaling Value")
+		}
+		return microserv, nil
+	}
+
+	return Controller{}, pkgerrors.New("Error getting Controller")
+}
+
+// DeleteController the  Controller from database
+func (mc *ControllerClient) DeleteController(name string) error {
+
+	//Construct the composite key to select the entry
+	key := ControllerKey{
+		ControllerName: name,
+	}
+	err := db.DBconn.Delete(name, key, mc.tagMeta)
+	if err != nil {
+		return pkgerrors.Wrap(err, "Delete Controller Entry;")
+	}
+	return nil
+}
diff --git a/src/orchestrator/pkg/module/controller_test.go b/src/orchestrator/pkg/module/controller_test.go
new file mode 100644
index 00000000..2e783c13
--- /dev/null
+++ b/src/orchestrator/pkg/module/controller_test.go
@@ -0,0 +1,181 @@
+/*
+ * Copyright 2020 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 module
+
+import (
+	"reflect"
+	"strings"
+	"testing"
+
+	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"
+
+	pkgerrors "github.com/pkg/errors"
+)
+
+func TestCreateController(t *testing.T) {
+	testCases := []struct {
+		label         string
+		inp           Controller
+		expectedError string
+		mockdb        *db.MockDB
+		expected      Controller
+	}{
+		{
+			label: "Create Controller",
+			inp: Controller{
+				Name: "testController",
+				Host: "132.156.0.10",
+				Port: 8080,
+			},
+			expected: Controller{
+				Name: "testController",
+				Host: "132.156.0.10",
+				Port: 8080,
+			},
+			expectedError: "",
+			mockdb:        &db.MockDB{},
+		},
+		{
+			label:         "Failed Create Controller",
+			expectedError: "Error Creating Controller",
+			mockdb: &db.MockDB{
+				Err: pkgerrors.New("Error Creating Controller"),
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.label, func(t *testing.T) {
+			db.DBconn = testCase.mockdb
+			impl := NewControllerClient()
+			got, err := impl.CreateController(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 returned unexpected body: got %v;"+
+						" expected %v", got, testCase.expected)
+				}
+			}
+		})
+	}
+}
+
+func TestGetController(t *testing.T) {
+
+	testCases := []struct {
+		label         string
+		name          string
+		expectedError string
+		mockdb        *db.MockDB
+		inp           string
+		expected      Controller
+	}{
+		{
+			label: "Get Controller",
+			name:  "testController",
+			expected: Controller{
+				Name: "testController",
+				Host: "132.156.0.10",
+				Port: 8080,
+			},
+			expectedError: "",
+			mockdb: &db.MockDB{
+				Items: map[string]map[string][]byte{
+					ControllerKey{ControllerName: "testController"}.String(): {
+						"controllermetadata": []byte(
+							"{\"name\":\"testController\"," +
+								"\"host\":\"132.156.0.10\"," +
+								"\"port\":8080}"),
+					},
+				},
+			},
+		},
+		{
+			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 := NewControllerClient()
+			got, err := impl.GetController(testCase.name)
+			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 returned unexpected body: got %v;"+
+						" expected %v", got, testCase.expected)
+				}
+			}
+		})
+	}
+}
+
+func TestDeleteController(t *testing.T) {
+
+	testCases := []struct {
+		label         string
+		name          string
+		expectedError string
+		mockdb        *db.MockDB
+	}{
+		{
+			label:  "Delete Controller",
+			name:   "testController",
+			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 := NewControllerClient()
+			err := impl.DeleteController(testCase.name)
+			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)
+				}
+			}
+		})
+	}
+}
diff --git a/src/orchestrator/pkg/module/module.go b/src/orchestrator/pkg/module/module.go
index d03e5ffb..a94a4207 100644
--- a/src/orchestrator/pkg/module/module.go
+++ b/src/orchestrator/pkg/module/module.go
@@ -20,6 +20,7 @@ package module
 type Client struct {
 	Project      *ProjectClient
 	CompositeApp *CompositeAppClient
+	Controller *ControllerClient
 	// Add Clients for API's here
 }
 
@@ -28,6 +29,7 @@ func NewClient() *Client {
 	c := &Client{}
 	c.Project = NewProjectClient()
 	c.CompositeApp = NewCompositeAppClient()
+	c.Controller = NewControllerClient()
 	// Add Client API handlers here
 	return c
 }