Implemented reading keyFile/credentials field from config object #315

kjin · 2016-10-27T23:22:43Z

Clients may use config.keyFilename and config.credentialsto supply a key file or its contents in lieu of GCLOUD_APPLICATION_CREDENTIALS.

kjin · 2016-10-27T23:23:04Z

@GoogleCloudPlatform/node-team PTAL

README.md

@@ -84,7 +84,9 @@ If your application is running outside of Google Cloud Platform, such as locally
  2. Copy the key somewhere your application can access it. Be sure not to expose the key publicly.
  3. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the full path to the key. The debug agent will automatically look for this environment variable.


config.js

+
+    // An alias for keyFile. If both keyFile and keyFilename are set, the value
+    // of keyFilename will be ignored.
+    keyFilename: null,


test/standalone/test-config-credentials.js

+
+process.env.GCLOUD_PROJECT = 0;
+
+describe('test-config-credentials', function() {


lib/trace-writer.js

-  this.request_ = utils.authorizedRequestFactory(SCOPES);
+  this.request_ = utils.authorizedRequestFactory(SCOPES, {
+    credentials: config.credentials,
+    keyFile: config.keyFile || config.keyFilename


README.md

-3. Alternatively, if you are running your application on a development machine or test environment where you are using the [`gcloud` command line tools][gcloud-sdk], and are logged using `gcloud beta auth application-default login`, you already have sufficient credentials, and a service account key is not required.
+If you are running your application on a development machine or test environment where you are using the [`gcloud` command line tools][gcloud-sdk], and are logged using `gcloud beta auth application-default login`, you already have sufficient credentials, and a service account key is not required.
+
+Alternatively, you may set the `keyFilename` or `credentials` configuration field to the full path or contents to the key file, respectively. Setting either of these fields will override both of the above options. (See the [default configuration](config.js) for more details.)


README.md

@@ -84,7 +84,9 @@ If your application is running outside of Google Cloud Platform, such as locally
  2. Copy the key somewhere your application can access it. Be sure not to expose the key publicly.
  3. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the full path to the key. The debug agent will automatically look for this environment variable.


kjin · 2016-10-31T17:18:30Z

Appveyor failure seems to be due to an unrelated issue (gRPC 1.0.1 compilation on Windows).

config.js

+    // The contents of a key file. If this field is set, its contents will be
+    // used for authentication instead of your application default credentials.
+    // If keyFilename is also set, the value of credentials will be ignored.
+    credentials: null


kjin added 3 commits October 27, 2016 16:03

Implemented reading keyFile/credentials field from config object

f6b0352

Added keyFile alias and updated config.js docs

de47856

Updated README.md to describe key files

5694ef8

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 27, 2016

matthewloring suggested changes Oct 27, 2016

View reviewed changes

kjin added 2 commits October 27, 2016 17:31

Addressed comments

f9d2ccb

slight test change

67643b3

ofrobots reviewed Oct 28, 2016

View reviewed changes

Updated README.md

63ebb86

ofrobots approved these changes Oct 28, 2016

View reviewed changes

matthewloring approved these changes Oct 29, 2016

View reviewed changes

kjin merged commit f72983f into googleapis:master Oct 31, 2016

kjin mentioned this pull request Nov 1, 2016

Added keyFilename/credentials to config object googleapis/cloud-debug-nodejs#169

Merged

DominicKramer reviewed Nov 1, 2016

View reviewed changes

kjin mentioned this pull request Nov 3, 2016

Add keyFilename/credentials to config object and README changes GoogleCloudPlatform/cloud-errors-nodejs#66

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented reading keyFile/credentials field from config object #315

Implemented reading keyFile/credentials field from config object #315

kjin commented Oct 27, 2016 •

edited

Loading

kjin commented Oct 27, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

kjin commented Oct 31, 2016

This comment was marked as spam.

		@@ -84,7 +84,9 @@ If your application is running outside of Google Cloud Platform, such as locally
		2. Copy the key somewhere your application can access it. Be sure not to expose the key publicly.
		3. Set the environment variable `GOOGLE_APPLICATION_CREDENTIALS` to the full path to the key. The debug agent will automatically look for this environment variable.


		process.env.GCLOUD_PROJECT = 0;

		describe('test-config-credentials', function() {

Implemented reading keyFile/credentials field from config object #315

Implemented reading keyFile/credentials field from config object #315

Conversation

kjin commented Oct 27, 2016 • edited Loading

kjin commented Oct 27, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

kjin commented Oct 31, 2016

This comment was marked as spam.

kjin commented Oct 27, 2016 •

edited

Loading