BREAKING CHANGE: private repository moved to public github.

Co-authored-by: sydney-ng <sydney.ng@yahoo.com>
ibm-developer · jkingoliver · Jul 30, 2018 · Jul 18, 2018 · Jul 20, 2018 · Jul 20, 2018
commit 9454574fdfb48c8d3767aaae68a450762666e643
diff --git a/.gitconfig b/.gitconfig
@@ -0,0 +1,2 @@
+[commit]
+    template = .gittemplate
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+vendor/
+.DS_Store
+
 # Binaries for programs and plugins
 *.exe
 *.exe~

diff --git a/.gittemplate b/.gittemplate
@@ -0,0 +1,20 @@
+# Type(<scope>): <subject>
+# <body>
+# <footer>
+
+# Type should be one of the following:
+# * BREAKING CHANGES (breaking change) [major release -- 1.x.x]
+# * feat (new feature) [minor release -- x.1.x]
+# * fix (bug fix) [patch release -- 0.0.x]
+# * docs (changes to documentation)
+# * style (formatting, missing semi colons, etc; no code change)
+# * refactor (refactoring production code)
+# * test (adding missing tests, refactoring tests; no production code change)
+# * chore (updating grunt tasks etc; no production code change)
+# Scope is just the scope of the change. Something like (admin) or (teacher).
+# Subject should use clear words and say what you did.
+# The body should go into detail about changes made.
+# The footer should contain any Github (or other tool) issue references or actions.
+
+# For a full example of how to write a good commit message, check out
+# https://conventionalcommits.org/
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
@@ -0,0 +1,34 @@
+# Gopkg.toml example
+#
+# Refer to https://github.com/golang/dep/blob/master/docs/Gopkg.toml.md
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#   name = "github.com/x/y"
+#   version = "2.4.0"
+#
+# [prune]
+#   non-go = false
+#   go-tests = true
+#   unused-packages = true
+
+
+[[constraint]]
+  name = "github.com/tidwall/gjson"
+  version = "1.1.2"
+
+[prune]
+  go-tests = true
+  unused-packages = true
diff --git a/README.md b/README.md
@@ -1,2 +1,78 @@
-# ibm-cloud-env-golang
-IBM Cloud Environment for Go
+# IBM Cloud Environment
+
+The `ibm-cloud-env-golang` module allows to abstract environment variables from various Cloud compute providers, such as, but not limited to, CloudFoundry and Kubernetes, so the application could be environment-agnostic.
+
+The module allows to define an array of search patterns that will be executed one by one until required value is found.
+
+### Installation
+
+```bash
+go get github.com/ibm-developer/ibm-cloud-env-golang
+```
+
+### Usage
+
+Create a JSON file containing your mappings and initialize the module
+
+```golang
+import "github.com/ibm-developer/ibm-cloud-env-golang"
+
+//in main function 
+IBMCloudEnv.init("/path/to/the/mappings/file/relative/to/prject/root")
+```
+
+#### Supported search patterns types
+ibm-cloud-config supports searching for values using three search pattern types - cloudfoundry, env, file. 
+- Using `cloudfoundry` allows to search for values in VCAP_SERVICES and VCAP_APPLICATIONS environment variables
+- Using `env` allows to search for values in environment variables
+- Using `file` allows to search for values in text/json files
+
+#### Example search patterns
+- cloudfoundry:service-instance-name - searches through parsed VCAP_SERVICES environment variable and returns the `credentials` object of the matching service instance name
+- cloudfoundry:$.JSONPath - searches through parsed VCAP_SERVICES and VCAP_APPLICATION environment variables and returns the value that corresponds to JSONPath
+- env:env-var-name - returns environment variable named "env-var-name"
+- env:env-var-name:$.JSONPath - attempts to parse the environment variable "env-var-name" and return a value that corresponds to JSONPath
+- file:/server/config.text - returns content of /server/config.text file
+- file:/server/config.json:$.JSONPath - reads the content of /server/config.json file, tries to parse it, returns the value that corresponds to JSONPath
+
+#### mappings.json file example
+```javascript
+{
+    "service1-credentials": {
+        "searchPatterns": [
+            "cloudfoundry:my-service1-instance-name", 
+            "env:my-service1-credentials", 
+            "file:/localdev/my-service1-credentials.json" 
+        ]
+    },
+    "service2-username": {
+        "searchPatterns":[
+            "cloudfoundry:$.service2[@.name=='my-service2-instance-name'].credentials.username",
+            "env:my-service2-credentials:$.username",
+            "file:/localdev/my-service1-credentials.json:$.username" 
+        ]
+    }
+}
+```
+
+### Using the values in application
+
+In your application retrieve the values using below commands
+
+```golang
+service1credentials := IBMCloudEnv.getDictionary("service1-credentials") // this will be a dictionary
+service2username := IBMCloudEnv.getString("service2-username") // this will be a string
+```
+
+Following the above approach your application can be implemented in an runtime-environment agnostic way, abstracting differences in environment variable management introduced by different cloud compute providers.
+
+
+## Publishing Changes
+
+In order to publish changes, you will need to fork the repository or ask to join the `ibm-developer` org and branch off the `master` branch.
+
+Make sure to follow the [conventional commit specification](https://conventionalcommits.org/) before contributing. To help you with commit a commit template is provide. Run `config.sh` to initialize the commit template to your `.git/config`
+
+Once you are finished with your changes, run `go test` to make sure all tests pass.
+
+Do a pull request against `master`, make sure the build passes. A team member will review and merge your pull request.
diff --git a/config.sh b/config.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+CMD=$(cat .git/config | grep "commit")
+if [ -z $CMD ]; then
+   echo "$(cat .git/config)\n$(cat .gitconfig)" > ./.git/config
+else
+    echo "commit file template already saved"
+fi
diff --git a/main_test.go b/main_test.go
@@ -0,0 +1,162 @@
+/*
+ * © Copyright IBM Corp. 2018
+ *
+ * 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 IBMCloudEnv
+import (
+	"testing" 
+	"os"
+	"github.com/tidwall/gjson"
+)
+
+const jsonObject = 
+`{
+	"service1": [
+		{
+			"name": "service1-name1",
+			"credentials": {
+				"username": "service1-username1"
+			}
+		},
+		{
+			"name": "service1-name2",
+			"credentials": {
+				"username": "service1-username2"
+			}
+		}
+	],
+	"user-provided": [
+		{
+			"name": "service2-name1",
+			"credentials":{
+				"username": "service2-username1"
+			}
+		}
+	]
+}` 
+
+const vcap_application = `{"application_name": "test-application"}`
+const var_string = `test-12345` 
+const credentials = `{"credentials": {
+		"username": "env-var-json-username"
+	}}`
+
+func setEnvVariable() {
+	os.Setenv("VCAP_APPLICATION", vcap_application)
+	os.Setenv("VCAP_SERVICES", jsonObject)
+	os.Setenv("ENV_VAR_STRING", var_string)
+	os.Setenv("ENV_VAR_JSON", credentials)
+
+	Initialize("/invalid-file-name")
+	Initialize("mappings.json")
+}
+
+
+func TestPlainTextFile(t *testing.T) {
+	setEnvVariable()
+	testString, _ := GetString("file_var1")
+	if testString != "plain-text-string" {
+		t.Errorf("testSTring is: " +  testString)
+		t.Errorf("can't read " + testString + " from GetString()")
+	} 
+	result := GetDictionary("file_var1").Get("value")
+	if result.String() != "plain-text-string" {
+		 t.Errorf("can't read " + result.String() + " text from GetDictionary()")
+	} 
+}
+
+func TestJsonFileAndPath(t *testing.T){
+	setEnvVariable()
+	testString, _ := GetString("file_var2")
+	if testString != gjson.Parse("{\"level2\":12345}").String() {
+		t.Errorf("Got: \t%s\n Wanted: \t%s\n", testString, "{\"level2\":12345}")
+	}
+
+	testString = GetDictionary("file_var2").Get("level2").String()
+	if testString != "12345" {
+		t.Errorf("Got: \t%s\n Wanted: \t%s\n", testString, "12345")
+	}
+}
+
+func TestReadVcapsWithJsonPath(t *testing.T){
+	setEnvVariable()
+	testString, _ := GetString("cf_var2")
+
+	if testString != "service1-username1" {
+		t.Errorf("can't read " + testString + " from GetString()")
+	}
+
+	result := GetDictionary("cf_var2").Get("value")
+	if result.String() != "service1-username1" {
+		 t.Errorf("can't read " + result.String() + " text from GetDictionary()")
+	} 
+
+	testString2, _ := GetString("cf_var3")
+	if testString2 != "test-application" {
+		t.Errorf("can't read " + testString2 + " from GetString()")
+	}
+	result2 := GetDictionary("cf_var3").Get("value")
+	if result2.String() != "test-application" {
+		 t.Errorf("can't read " + result2.String() + " text from GetDictionary()")
+	} 
+
+	//removed this test because there wasn't a cf_var4 in mappings.json
+	/*testString3, _ := GetString("cf_var4")
+	if testString3 != "service1-username1" {
+		t.Errorf("can't read " + testString3 + " from GetString()")
+	}
+	result3 := GetDictionary("cf_var4").Get("value")
+	if result3.String() != "service1-username1" {
+		 t.Errorf("can't read " + result3.String() + " text from GetDictionary()")
+	}*/
+}
+
+func TestSimpleStringFromEnvVar(t *testing.T){
+	setEnvVariable()
+	testString, _ := GetString("env_var1")
+	if testString != "test-12345" {
+		t.Errorf("can't read " + testString + " from GetString()")
+	}
+	result := GetDictionary("env_var1").Get("value")
+	if result.String() != "test-12345" {
+		 t.Errorf("can't read " + result.String() + " text from GetDictionary()")
+	} 
+}
+
+func TestJsonFromEnvVar(t *testing.T){
+	setEnvVariable()
+	testString, _ := GetString("env_var2")
+	if testString != credentials {
+		t.Errorf("Got: \t%s\n Wanted: \t%s\n", testString, credentials)
+	}
+
+	testString = GetDictionary("env_var2").Get("credentials").Get("username").String()
+	if testString != "env-var-json-username" {
+		t.Errorf("Got: \t%s\n Wanted: \t%s\n", testString, "env-var-json-username")
+	}
+}
+
+func TestJsonPathFromEnvVar(t *testing.T){
+	setEnvVariable()
+	testString, _ := GetString("env_var3")
+	if testString != "env-var-json-username" {
+		t.Errorf("Got: \t%s\n Wanted: \t%s\n", testString, "env-var-json-username")
+	}
+
+	testString = GetDictionary("env_var3").Get("value").String()
+	if testString != "env-var-json-username" {
+		t.Errorf("Got: \t%s\n Wanted: \t%s\n", testString, "env-var-json-username")
+	}
+}