Restructure code and create module library

Restructures and moves code to make it
aligned with the current design.
https://wiki.onap.org/display/DW/Multi+Cluster+Application+Scheduler
examples/example_module.go shows how to
import and use modules from this package.
Patch#2 Updated example

Issue-ID: MULTICLOUD-871
Signed-off-by: Ritu Sood <ritu.sood@intel.com>
Change-Id: Ia1e9802a946a07dcca8f79f0e2250933ab3efa66

3 files changed, 344 insertions, 0 deletions

diff --git a/src/orchestrator/pkg/module/module.go b/src/orchestrator/pkg/module/module.go
new file mode 100644
index 00000000..e4482098
--- /dev/null
+++ b/src/orchestrator/pkg/module/module.go
@@ -0,0 +1,34 @@
+/*
+ * 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 module
+
+import (
+	)
+
+// Client for using the services in the orchestrator
+type Client struct {
+    Project *ProjectClient
+    // Add Clients for API's here
+}
+
+// NewClient creates a new client for using the services
+func NewClient() *Client {
+    c:= &Client{}
+    c.Project = NewProjectClient()
+    // Add Client API handlers here
+    return c
+}
\ No newline at end of file
diff --git a/src/orchestrator/pkg/module/project.go b/src/orchestrator/pkg/module/project.go
new file mode 100644
index 00000000..e44164f9
--- /dev/null
+++ b/src/orchestrator/pkg/module/project.go
@@ -0,0 +1,133 @@
+/*
+ * Copyright 2019 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"
+)
+
+// Project contains the parameters needed for Projects
+// It implements the interface for managing the Projects
+type Project struct {
+	ProjectName string `json:"project-name"`
+	Description string `json:"description"`
+}
+
+// ProjectKey is the key structure that is used in the database
+type ProjectKey struct {
+	ProjectName string `json:"rb-name"`
+}
+
+// We will use json marshalling to convert to string to
+// preserve the underlying structure.
+func (pk ProjectKey) String() string {
+	out, err := json.Marshal(pk)
+	if err != nil {
+		return ""
+	}
+
+	return string(out)
+}
+
+// Manager is an interface exposes the Project functionality
+type ProjectManager interface {
+	CreateProject(pr Project) (Project, error)
+	GetProject(name string) (Project, error)
+	DeleteProject(name string) error
+}
+
+// ProjectClient implements the Manager
+// It will also be used to maintain some localized state
+type ProjectClient struct {
+	storeName           string
+	tagMeta, tagContent string
+}
+
+// NewProjectClient returns an instance of the ProjectClient
+// which implements the Manager
+func NewProjectClient() *ProjectClient {
+	return &ProjectClient{
+		tagMeta: "projectmetadata",
+	}
+}
+
+// CreateProject a new collection based on the project
+func (v *ProjectClient) CreateProject(p Project) (Project, error) {
+
+	//Construct the composite key to select the entry
+	key := ProjectKey{
+		ProjectName: p.ProjectName,
+	}
+
+	//Check if this Project already exists
+	_, err := v.GetProject(p.ProjectName)
+	if err == nil {
+		return Project{}, pkgerrors.New("Project already exists")
+	}
+
+	err = db.DBconn.Create(p.ProjectName, key, v.tagMeta, p)
+	if err != nil {
+		return Project{}, pkgerrors.Wrap(err, "Creating DB Entry")
+	}
+
+	return p, nil
+}
+
+// GetProject returns the Project for corresponding name
+func (v *ProjectClient) GetProject(name string) (Project, error) {
+
+	//Construct the composite key to select the entry
+	key := ProjectKey{
+		ProjectName: name,
+	}
+	value, err := db.DBconn.Read(name, key, v.tagMeta)
+	if err != nil {
+		return Project{}, pkgerrors.Wrap(err, "Get Project")
+	}
+
+	//value is a byte array
+	if value != nil {
+		proj := Project{}
+		err = db.DBconn.Unmarshal(value, &proj)
+		if err != nil {
+			return Project{}, pkgerrors.Wrap(err, "Unmarshaling Value")
+		}
+		return proj, nil
+	}
+
+	return Project{}, pkgerrors.New("Error getting Project")
+}
+
+// DeleteProject the  Project from database
+func (v *ProjectClient) DeleteProject(name string) error {
+
+	//Construct the composite key to select the entry
+	key := ProjectKey{
+		ProjectName: name,
+	}
+	err := db.DBconn.Delete(name, key, v.tagMeta)
+	if err != nil {
+		return pkgerrors.Wrap(err, "Delete Project Entry;")
+	}
+
+	//TODO: Delete the collection when the project is deleted
+	return nil
+}
diff --git a/src/orchestrator/pkg/module/project_test.go b/src/orchestrator/pkg/module/project_test.go
new file mode 100644
index 00000000..7f4d9b3e
--- /dev/null
+++ b/src/orchestrator/pkg/module/project_test.go
@@ -0,0 +1,177 @@
+/*
+ * 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 module
+
+import (
+	"reflect"
+	"strings"
+	"testing"
+
+	"github.com/onap/multicloud-k8s/src/orchestrator/pkg/infra/db"
+
+	pkgerrors "github.com/pkg/errors"
+)
+
+func TestCreateProject(t *testing.T) {
+	testCases := []struct {
+		label         string
+		inp           Project
+		expectedError string
+		mockdb        *db.MockDB
+		expected      Project
+	}{
+		{
+			label: "Create Project",
+			inp: Project{
+				ProjectName: "testProject",
+				Description: "A sample Project used for unit testing",
+			},
+			expected: Project{
+				ProjectName: "testProject",
+				Description: "A sample Project used for unit testing",
+			},
+			expectedError: "",
+			mockdb:        &db.MockDB{},
+		},
+		{
+			label:         "Failed Create Project",
+			expectedError: "Error Creating Project",
+			mockdb: &db.MockDB{
+				Err: pkgerrors.New("Error Creating Project"),
+			},
+		},
+	}
+
+	for _, testCase := range testCases {
+		t.Run(testCase.label, func(t *testing.T) {
+			db.DBconn = testCase.mockdb
+			impl := NewProjectClient()
+			got, err := impl.CreateProject(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 TestGetProject(t *testing.T) {
+
+	testCases := []struct {
+		label         string
+		name          string
+		expectedError string
+		mockdb        *db.MockDB
+		inp           string
+		expected      Project
+	}{
+		{
+			label: "Get Project",
+			name:  "testProject",
+			expected: Project{
+				ProjectName: "testProject",
+				Description: "Test project for unit testing",
+			},
+			expectedError: "",
+			mockdb: &db.MockDB{
+				Items: map[string]map[string][]byte{
+					ProjectKey{ProjectName: "testProject"}.String(): {
+						"projectmetadata": []byte(
+							"{\"project-name\":\"testProject\"," +
+								"\"description\":\"Test project for unit testing\"}"),
+					},
+				},
+			},
+		},
+		{
+			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 := NewProjectClient()
+			got, err := impl.GetProject(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 TestDeleteProject(t *testing.T) {
+
+	testCases := []struct {
+		label         string
+		name          string
+		expectedError string
+		mockdb        *db.MockDB
+	}{
+		{
+			label:  "Delete Project",
+			name:   "testProject",
+			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 := NewProjectClient()
+			err := impl.DeleteProject(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)
+				}
+			}
+		})
+	}
+}