Merge pull request GoogleCloudPlatform#42 from GoogleCloudPlatform/config-checking

Added user-friendly config checking.

Author: jmdobry

.travis.yml

@@ -30,7 +30,7 @@ cache:
   - 7-gce/node_modules/
 
 env:
-  - PATH=$PATH:$HOME/gcloud/google-cloud-sdk/bin GOOGLE_APPLICATION_CREDENTIALS=$TRAVIS_BUILD_DIR/test/encrypted/nodejs-docs-samples.json TEST_BUCKET_NAME=nodejs-docs-samples GCLOUD_PROJECT=nodejs-docs-samples #Other environment variables on same line
+  - PATH=$PATH:$HOME/gcloud/google-cloud-sdk/bin GOOGLE_APPLICATION_CREDENTIALS=$TRAVIS_BUILD_DIR/test/encrypted/nodejs-docs-samples.json CLOUD_BUCKET=nodejs-docs-samples GCLOUD_PROJECT=nodejs-docs-samples OAUTH_CLIENT_ID=test-id OAUTH_CLIENT_SECRET=test-secret#Other environment variables on same line
 
 before_install:
   - if [ ! -d $HOME/gcloud/google-cloud-sdk ]; then

2-structured-data/config.js

@@ -13,7 +13,7 @@
 
 'use strict';
 
-module.exports = {
+var config = module.exports = {
   port: process.env.PORT || 8080,
 
   // dataBackend can be 'datastore', 'cloudsql', or 'mongodb'. Be sure to
@@ -38,3 +38,10 @@ module.exports = {
     collection: process.env.MONGO_COLLECTION || 'books'
   }
 };
+
+var projectId = config.gcloud.projectId;
+
+if (!projectId || projectId === 'your-project-id') {
+  throw new Error('You must set the GCLOUD_PROJECT env var or add your ' +
+    'project id to config.js!');
+}

3-binary-data/config.js

@@ -13,8 +13,7 @@
 
 'use strict';
 
-
-module.exports = {
+var config = module.exports = {
   port: process.env.PORT || 8080,
 
   // dataBackend can be 'datastore', 'cloudsql', or 'mongodb'. Be sure to
@@ -42,3 +41,16 @@ module.exports = {
     collection: process.env.MONGO_COLLECTION || 'books'
   }
 };
+
+var projectId = config.gcloud.projectId;
+var cloudStorageBucket = config.cloudStorageBucket;
+
+if (!projectId || projectId === 'your-project-id') {
+  throw new Error('You must set the GCLOUD_PROJECT env var or add your ' +
+    'project id to config.js!');
+}
+
+if (!cloudStorageBucket || cloudStorageBucket === 'your-bucket-name') {
+  throw new Error('You must set the CLOUD_BUCKET env var or add your ' +
+    'bucket name to config.js!');
+}

4-auth/config.js

@@ -14,7 +14,7 @@
 'use strict';
 
 
-module.exports = {
+var config = module.exports = {
   port: process.env.PORT || 8080,
 
   // Secret is used by sessions to encrypt the cookie.
@@ -55,3 +55,28 @@ module.exports = {
     scopes: ['email', 'profile']
   }
 };
+
+var projectId = config.gcloud.projectId;
+var cloudStorageBucket = config.cloudStorageBucket;
+var clientId = config.oauth2.clientId;
+var clientSecret = config.oauth2.clientSecret;
+
+if (!projectId || projectId === 'your-project-id') {
+  throw new Error('You must set the GCLOUD_PROJECT env var or add your ' +
+    'project id to config.js!');
+}
+
+if (!cloudStorageBucket || cloudStorageBucket === 'your-bucket-name') {
+  throw new Error('You must set the CLOUD_BUCKET env var or add your ' +
+    'bucket name to config.js!');
+}
+
+if (!clientId || clientId === 'your-client-id') {
+  throw new Error('You must set the OAUTH_CLIENT_ID env var or add your ' +
+    'client id to config.js!');
+}
+
+if (!clientSecret || clientSecret === 'your-client-secret') {
+  throw new Error('You must set the OAUTH_CLIENT_SECRET env var or add your ' +
+    'client secret config.js!');
+}

5-logging/config.js

@@ -14,7 +14,7 @@
 'use strict';
 
 
-module.exports = {
+var config = module.exports = {
   port: process.env.PORT || 8080,
 
   // Secret is used by sessions to encrypt the cookie.
@@ -55,3 +55,28 @@ module.exports = {
     scopes: ['email', 'profile']
   }
 };
+
+var projectId = config.gcloud.projectId;
+var cloudStorageBucket = config.cloudStorageBucket;
+var clientId = config.oauth2.clientId;
+var clientSecret = config.oauth2.clientSecret;
+
+if (!projectId || projectId === 'your-project-id') {
+  throw new Error('You must set the GCLOUD_PROJECT env var or add your ' +
+    'project id to config.js!');
+}
+
+if (!cloudStorageBucket || cloudStorageBucket === 'your-bucket-name') {
+  throw new Error('You must set the CLOUD_BUCKET env var or add your ' +
+    'bucket name to config.js!');
+}
+
+if (!clientId || clientId === 'your-client-id') {
+  throw new Error('You must set the OAUTH_CLIENT_ID env var or add your ' +
+    'client id to config.js!');
+}
+
+if (!clientSecret || clientSecret === 'your-client-secret') {
+  throw new Error('You must set the OAUTH_CLIENT_SECRET env var or add your ' +
+    'client secret config.js!');
+}

6-pubsub/config.js

@@ -14,7 +14,7 @@
 'use strict';
 
 
-module.exports = {
+var config = module.exports = {
   port: process.env.PORT || 8080,
 
   // Secret is used by sessions to encrypt the cookie.
@@ -55,3 +55,28 @@ module.exports = {
     scopes: ['email', 'profile']
   }
 };
+
+var projectId = config.gcloud.projectId;
+var cloudStorageBucket = config.cloudStorageBucket;
+var clientId = config.oauth2.clientId;
+var clientSecret = config.oauth2.clientSecret;
+
+if (!projectId || projectId === 'your-project-id') {
+  throw new Error('You must set the GCLOUD_PROJECT env var or add your ' +
+    'project id to config.js!');
+}
+
+if (!cloudStorageBucket || cloudStorageBucket === 'your-bucket-name') {
+  throw new Error('You must set the CLOUD_BUCKET env var or add your ' +
+    'bucket name to config.js!');
+}
+
+if (!clientId || clientId === 'your-client-id') {
+  throw new Error('You must set the OAUTH_CLIENT_ID env var or add your ' +
+    'client id to config.js!');
+}
+
+if (!clientSecret || clientSecret === 'your-client-secret') {
+  throw new Error('You must set the OAUTH_CLIENT_SECRET env var or add your ' +
+    'client secret config.js!');
+}

7-gce/config.js

@@ -14,7 +14,7 @@
 'use strict';
 
 
-module.exports = {
+var config = module.exports = {
   port: process.env.PORT || 8080,
 
   // Secret is used by sessions to encrypt the cookie.
@@ -55,3 +55,28 @@ module.exports = {
     scopes: ['email', 'profile']
   }
 };
+
+var projectId = config.gcloud.projectId;
+var cloudStorageBucket = config.cloudStorageBucket;
+var clientId = config.oauth2.clientId;
+var clientSecret = config.oauth2.clientSecret;
+
+if (!projectId || projectId === 'your-project-id') {
+  throw new Error('You must set the GCLOUD_PROJECT env var or add your ' +
+    'project id to config.js!');
+}
+
+if (!cloudStorageBucket || cloudStorageBucket === 'your-bucket-name') {
+  throw new Error('You must set the CLOUD_BUCKET env var or add your ' +
+    'bucket name to config.js!');
+}
+
+if (!clientId || clientId === 'your-client-id') {
+  throw new Error('You must set the OAUTH_CLIENT_ID env var or add your ' +
+    'client id to config.js!');
+}
+
+if (!clientSecret || clientSecret === 'your-client-secret') {
+  throw new Error('You must set the OAUTH_CLIENT_SECRET env var or add your ' +
+    'client secret config.js!');
+}

README.md

@@ -27,6 +27,8 @@ Tutorial | Folder
 
 * Make sure you're authenticated with the gcloud sdk and your gcloud project
 has enabled all the APIs used by these tutorials.
+* Make sure you've got the required environment variables set. (Take a look at
+the various config.js files.)
 * `git clone git@github.com:GoogleCloudPlatform/nodejs-getting-started.git`
 * `cd nodejs-getting-started`
 * `npm install`