Migrating from consul to mongodb for backend

Migrating to mongodb from consul.
The main reason being the value size limitation of 512kb in consul.
See https://jira.onap.org/browse/MULTICLOUD-426 for details.
This requires a little bit of hierarchy management
and data management.
We are no longer converting structs to json encoded
strings. The underlying db supports structs without any modifications.
Also, since Mongo has the concept of collections, each submodule can
use its own collection for storage as needed.
Definition uses a collection called rbdef right now.
P10: Enabling unit tests for mongo.go. This requires the usage
     of aliased functions.
P11: Expanded unit tests for all functions in mongo.go
P12: Refactored parameter validation.
     Removed TestHealthCheck as we are not mocking any of the
       db commands right now
     Checking return value of read with an expected value
P13: Adding back consul support.
     Fixing functional test
     Full consul implementation check and modifications is
     being tracked by MULTICLOUD-427
P15: Fix ReadAll unit test and corresponding code
     ReadAll now returns error when no objects are found

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

1 files changed, 22 insertions, 5 deletions

diff --git a/src/k8splugin/db/store.go b/src/k8splugin/db/store.go
index c1a8b31f..a235597a 100644
--- a/src/k8splugin/db/store.go
+++ b/src/k8splugin/db/store.go
@@ -25,21 +25,38 @@ var DBconn Store
 
 // Store is an interface for accessing a database
 type Store interface {
+	// Returns nil if db health is good
 	HealthCheck() error
 
-	Create(string, string) error
-	Read(string) (string, error)
-	// Update(string) (string, error)
-	Delete(string) error
+	// Unmarshal implements any unmarshaling needed for the database
+	Unmarshal(inp []byte, out interface{}) error
 
-	ReadAll(string) ([]string, error)
+	// Creates a new master table with key and links data with tag and
+	// creates a pointer to the newly added data in the master table
+	Create(table, key, tag string, data interface{}) error
+
+	// Reads data for a particular key with specific tag.
+	Read(table, key, tag string) ([]byte, error)
+
+	//TODO: Update(context.Context, string, interface{}) error
+
+	// Deletes a specific tag data for key.
+	// TODO: If tag is empty, it will delete all tags under key.
+	Delete(table, key, tag string) error
+
+	// Reads all master tables and data from the specified tag in table
+	ReadAll(table, tag string) (map[string][]byte, error)
 }
 
 // CreateDBClient creates the DB client
 func CreateDBClient(dbType string) error {
 	var err error
 	switch dbType {
+	case "mongo":
+		// create a mongodb database with k8splugin as the name
+		DBconn, err = NewMongoStore("k8splugin", nil)
 	case "consul":
+		// create a consul kv store
 		DBconn, err = NewConsulStore(nil)
 	default:
 		return pkgerrors.New(dbType + "DB not supported")