BREAKING CHANGE: private repository moved to public github. #2

adamcbrown · 2018-07-18T19:32:42Z

Co-authored-by: sydney-ng sydney.ng@yahoo.com

Co-authored-by: sydney-ng <sydney.ng@yahoo.com>

jkingoliver · 2018-07-19T19:47:58Z

main_test.go

+		 t.Errorf("can't read " + result2.String() + " text from GetDictionary()")
+	} 
+
+	//removed this test because there wasn't a cf_var4 in mappings.json


make sure to delete this block before merging

jkingoliver

You need to add the sample mappings.json that includes user-provided search pattern. Check out here:
https://github.com/ibm-developer/ibm-cloud-env/blob/179d3522ac5e764c46d44c693f45a6cb4eca50cd/test/test.js#L12
how the v1/mappings.json is included for testing.

Also, the README needs to be updated to include user-provided search pattern with samples. I realize the ibm-cloud-env repo that is used for node needs to be updated as well. That's on my todo list and I can help with this one.

…golang

…object. Added test for GetCredentials function

…golang

jkingoliver · 2018-07-24T14:50:58Z

README.md

+- 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
+


add user-provided pattern here too

added user-provided description in supported search patterns types

jkingoliver · 2018-07-24T15:05:21Z

README.md

+            "env:my-service2-credentials:$.username",
+            "file:/localdev/my-service1-credentials.json:$.username",
+            "user-provided:my-service2-instance-name:username"
+


In the above 2 sample search patterns, please add user-provided to both and put that entry in the first spot. The patterns are read in order and should go in this order:
"searchPatterns": [
"user-provided:conversation:url",
"cloudfoundry:$['conversation'][0].credentials.url",
"env:service_watson_conversation:$.url",
"file:/server/localdev-config.json:$.watson_conversation_url"
]

We're not sure how to use user-provided for the first example. The first example grabs all the credentials, but user-provided can only grab a specific credential, not the entire thing

It would probably look like this:
"service1-credentials": {
"searchPatterns": [
"user-provided:my-service1-instance-name:service1-credentials"
"cloudfoundry:my-service1-instance-name",
"env:my-service1-credentials",
"file:/localdev/my-service1-credentials.json"
]
},
"service2-username": {
"searchPatterns":[
---> "user-provided:my-service2-instance-name:username"
"cloudfoundry:$.service2[@.name=='my-service2-instance-name'].credentials.username",
"env:my-service2-credentials:$.username",
"file:/localdev/my-service1-credentials.json:$.username",

jkingoliver · 2018-07-24T15:06:41Z

cloud_env.go

+func processMappingV2(mappingName string, config gjson.Result){
+	config.ForEach(func (key, value gjson.Result) bool {
+		searchPatterns := value.Get("searchPatterns")
+		//fmt.Println("search Patterns: " + searchPatterns.String())


remove comment

jkingoliver · 2018-07-24T15:07:48Z

cloud_env.go

+	var json_data interface{}
+	json.Unmarshal([]byte(jsonString), &json_data)
+	res, err := jsonpath.JsonPathLookup(json_data, jsonPath)
+	// fmt.Println("HERE: ", jsonPath, jsonString, res, err)


remove comment

jkingoliver · 2018-07-24T15:10:06Z

mappingsV1_test.go

+	}
+}
+
+func TestCFServiceCredentialsWithInstanceNameV1 (t *testing.T){


Does this comment need to go or is this method still being worked on?

jkingoliver · 2018-07-24T15:10:43Z

mappingsV1_test.go

+		 t.Errorf("can't read " + result2.String() + " text from GetDictionary()")
+	} 
+
+	//removed this test because there wasn't a cf_var4 in mappings.json


remove comment

jkingoliver · 2018-07-24T15:11:45Z

mappings_test.go

+		 t.Errorf("can't read " + result2.String() + " text from GetDictionary()")
+	} 
+
+	//removed this test because there wasn't a cf_var4 in mappings.json


remove comment

jkingoliver · 2018-07-24T15:17:03Z

mappingsv2_test.go

+import (
+	"testing" 
+	"os"
+	//"fmt"


remove comment

jkingoliver · 2018-07-24T15:18:29Z

mappingsv2_test.go

+	}
+}
+
+func TestCFServiceCredentialsWithServiceInstanceV2 (t *testing.T){


why is this function name orange and the other functions are in purple? Is it because of the space between V2 and the parameters?

jkingoliver · 2018-07-24T15:18:43Z

mappingsv2_test.go

+		 t.Errorf("can't read " + result2 + " text from GetDictionary()")
+	} 
+
+	//removed this test because there wasn't a cf_var4 in mappings.json


remove comment

jkingoliver · 2018-07-24T20:20:39Z

README.md

-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.


rephrase: The ibm-cloud-env-golang module allows for the abstraction of environment variables from various Cloud compute providers, such as, but not limited to, CloudFoundry and Kubernetes, so the application can be environment-agnostic.

We're not sure how to rephrase this. This paragraph was taken from the IBM-Cloud-Env repositiory

jkingoliver · 2018-07-24T20:21:26Z

README.md

+
+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.


rephrase: The module allows for an array of search patterns that will be executed one by one until required value is found.

jkingoliver · 2018-07-24T20:22:28Z

README.md

+- 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
+- Using `user-provided` allows to search for values in VCAP_SERVICES for service credentials


move this to line 26, so it's first. Also, rearrange the list in line 25 so user-provided is first.

jkingoliver · 2018-07-24T20:23:08Z

README.md

+- 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
+- user-provided:service:name - searches through parsed VCAP_SERVICES environment variable and returns the value of the requested service name and credential


move to line 32 so it's first in list

Fixed wording from Pull Request ibm-developer#3

jkingoliver · 2018-07-24T21:29:39Z

cloud_env.go

+package IBMCloudEnv
+
+import ("os"
+		"fmt"


fix indentation in this import

It looks like this whole file needs to be formatted so indentations are consistent and correct.

jkingoliver · 2018-07-24T21:32:35Z

cloud_env.go

+}
+
+func processMappingV2(mappingName string, config gjson.Result){
+	config.ForEach(func (key, value gjson.Result) bool {


Is this syntax right? I'm not familiar, but it looks weird that the bool return type isn't on line 94.

This is actually fine. How that ForEach function works is that it takes a lambda function with a bool return type, so those return bools are for those ForEach lambda functions, not the processMappingV2

jkingoliver · 2018-07-27T18:27:08Z

README.md

+- Using `file` allows to search for values in text/json files
+
+#### Example search patterns
+- user-provided:service:name - searches through parsed VCAP_SERVICES environment variable and returns the value of the requested service name and credential


let's make this user-provided:service-instance-name:credential-key

jkingoliver · 2018-07-27T18:31:17Z

credentials_test.go

@@ -0,0 +1,45 @@
+package IBMCloudEnv


we need a copyright statement here

jkingoliver

see comments

jkingoliver · 2018-07-27T20:42:06Z

cloud_env.go

 	case PREFIX_PATTERN_USER:
 		value, OK = processUserProvidedSearchPattern(patternComponents)
-		break
 	default:
 		log.Warnln("Unknown searchPattern prefix", patternComponents[0], "Supported prefixes: cloudfoundry, env, file")


add user-provided in the warning about supported prefixes

…golang

BREAKING CHANGE: private repository moved to public github.

9454574

Co-authored-by: sydney-ng <sydney.ng@yahoo.com>

jkingoliver reviewed Jul 19, 2018

View reviewed changes

jkingoliver suggested changes Jul 19, 2018

View reviewed changes

adamcbrown and others added 14 commits July 20, 2018 09:20

Updated to have GetCredentials and allows for v2 mappings

59c38de

fix: added tests and renamed files to Go Convention

e44e961

Added Deep Search functionality to parse.go

f957b18

fix: added tests for v2/mappings (untested)

1f7ac07

Merge branch 'master' of https://github.com/adamcbrown/ibm-cloud-env-…

613aba9

…golang

added stuff

076ad93

Properly returns dictionaries in v2

26d83ca

fix: mappingsv2_test.go

4315d67

fix: updated Readme with user provided part

551ce0b

fix: README.md

8609060

fix: Updated GetCredentials to take a json string instead of a gjson …

b85b233

…object. Added test for GetCredentials function

Merge branch 'master' of https://github.com/adamcbrown/ibm-cloud-env-…

6af8834

…golang

fix: renaming functions/files

c1f58f0

Merge branch 'master' of https://github.com/adamcbrown/ibm-cloud-env-…

f753dfc

…golang