Move controller module into separate package

Move the controller part of the module package
into a separate controller package.

Issue-ID: MULTICLOUD-1029
Signed-off-by: Eric Multanen <eric.w.multanen@intel.com>
Change-Id: Id07c1012aeff8a72458b37d42671495510cade75

2 files changed, 391 insertions, 0 deletions

diff --git a/src/orchestrator/pkg/module/controller/controller.go b/src/orchestrator/pkg/module/controller/controller.go
new file mode 100644
index 00000000..c4957413
--- /dev/null
+++ b/src/orchestrator/pkg/module/controller/controller.go
@@ -0,0 +1,194 @@
+/*
+ * 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 controller
+
+import (
+	"encoding/json"
+
+	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"
+	log "github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/logutils"
+	rpc "github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/rpc"
+	mtypes "github.com/onap/multicloud-k8s/src/orchestrator/pkg/module/types"
+	pkgerrors "github.com/pkg/errors"
+)
+
+// Controller contains the parameters needed for Controllers
+// It implements the interface for managing the Controllers
+type Controller struct {
+	Metadata mtypes.Metadata `json:"metadata"`
+	Spec     ControllerSpec  `json:"spec"`
+}
+
+type ControllerSpec struct {
+	Host     string `json:"host"`
+	Port     int    `json:"port"`
+	Type     string `json:"type"`
+	Priority int    `json:"priority"`
+}
+
+const MinControllerPriority = 1
+const MaxControllerPriority = 1000000
+const CONTROLLER_TYPE_ACTION string = "action"
+const CONTROLLER_TYPE_PLACEMENT string = "placement"
+
+var CONTROLLER_TYPES = [...]string{CONTROLLER_TYPE_ACTION, CONTROLLER_TYPE_PLACEMENT}
+
+// 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, mayExist bool) (Controller, error)
+	GetController(name string) (Controller, error)
+	GetControllers() ([]Controller, error)
+	InitControllers()
+	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, mayExist bool) (Controller, error) {
+
+	//Construct the composite key to select the entry
+	key := ControllerKey{
+		ControllerName: m.Metadata.Name,
+	}
+
+	//Check if this Controller already exists
+	_, err := mc.GetController(m.Metadata.Name)
+	if err == nil && !mayExist {
+		return Controller{}, pkgerrors.New("Controller already exists")
+	}
+
+	err = db.DBconn.Insert(mc.collectionName, key, nil, mc.tagMeta, m)
+	if err != nil {
+		return Controller{}, pkgerrors.Wrap(err, "Creating DB Entry")
+	}
+
+	// send message to create/update the  rpc connection
+	rpc.UpdateRpcConn(m.Metadata.Name, m.Spec.Host, m.Spec.Port)
+
+	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.Find(mc.collectionName, key, mc.tagMeta)
+	if err != nil {
+		return Controller{}, pkgerrors.Wrap(err, "Get Controller")
+	}
+
+	if value != nil {
+		microserv := Controller{}
+		err = db.DBconn.Unmarshal(value[0], &microserv)
+		if err != nil {
+			return Controller{}, pkgerrors.Wrap(err, "Unmarshaling Value")
+		}
+		return microserv, nil
+	}
+
+	return Controller{}, pkgerrors.New("Error getting Controller")
+}
+
+// GetControllers returns all the  Controllers that are registered
+func (mc *ControllerClient) GetControllers() ([]Controller, error) {
+
+	//Construct the composite key to select the entry
+	key := ControllerKey{
+		ControllerName: "",
+	}
+
+	var resp []Controller
+	values, err := db.DBconn.Find(mc.collectionName, key, mc.tagMeta)
+	if err != nil {
+		return []Controller{}, pkgerrors.Wrap(err, "Get Controller")
+	}
+
+	for _, value := range values {
+		microserv := Controller{}
+		err = db.DBconn.Unmarshal(value, &microserv)
+		if err != nil {
+			return []Controller{}, pkgerrors.Wrap(err, "Unmarshaling Value")
+		}
+
+		resp = append(resp, microserv)
+	}
+
+	return resp, nil
+}
+
+// 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.Remove(mc.collectionName, key)
+	if err != nil {
+		return pkgerrors.Wrap(err, "Delete Controller Entry;")
+	}
+
+	// send message to close rpc connection
+	rpc.RemoveRpcConn(name)
+
+	return nil
+}
+
+// InitControllers initializes connctions for controllers in the DB
+func (mc *ControllerClient) InitControllers() {
+	vals, _ := mc.GetControllers()
+	for _, v := range vals {
+		log.Info("Initializing RPC connection for controller", log.Fields{
+			"Controller": v.Metadata.Name,
+		})
+		rpc.UpdateRpcConn(v.Metadata.Name, v.Spec.Host, v.Spec.Port)
+	}
+}
diff --git a/src/orchestrator/pkg/module/controller/controller_test.go b/src/orchestrator/pkg/module/controller/controller_test.go
new file mode 100644
index 00000000..44e7a0ca
--- /dev/null
+++ b/src/orchestrator/pkg/module/controller/controller_test.go
@@ -0,0 +1,197 @@
+/*
+ * 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 controller
+
+import (
+	"reflect"
+	"strings"
+	"testing"
+
+	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"
+	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/module/types"
+
+	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{
+				Metadata: types.Metadata{
+					Name: "testController",
+				},
+				Spec: ControllerSpec{
+					Host: "132.156.0.10",
+					Port: 8080,
+				},
+			},
+			expected: Controller{
+				Metadata: types.Metadata{
+					Name: "testController",
+				},
+				Spec: ControllerSpec{
+					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, false)
+			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{
+				Metadata: types.Metadata{
+					Name: "testController",
+				},
+				Spec: ControllerSpec{
+					Host: "132.156.0.10",
+					Port: 8080,
+				},
+			},
+			expectedError: "",
+			mockdb: &db.MockDB{
+				Items: map[string]map[string][]byte{
+					ControllerKey{ControllerName: "testController"}.String(): {
+						"controllermetadata": []byte(
+							"{\"metadata\":{" +
+								"\"name\":\"testController\"" +
+								"}," +
+								"\"spec\":{" +
+								"\"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)
+				}
+			}
+		})
+	}
+}