chore: use sinon to mock in some cases (#303)

googleapis · Feb 26, 2018 · 1848552 · 1848552
1 parent faf494a
commit 1848552
Show file tree

Hide file tree

Showing 4 changed files with 175 additions and 75 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -38,6 +38,7 @@
     "@types/nock": "^9.1.2",
     "@types/node": "^9.4.6",
     "@types/pify": "^3.0.0",
+    "@types/sinon": "^4.1.3",
     "@types/tmp": "0.0.33",
     "clang-format": "^1.2.2",
     "codecov": "^3.0.0",
@@ -52,6 +53,7 @@
     "opn": "^5.2.0",
     "pify": "^3.0.0",
     "prettier": "^1.10.2",
+    "sinon": "^4.4.2",
     "source-map-support": "^0.5.3",
     "tmp": "0.0.33",
     "typescript": "~2.7.0"

diff --git a/src/auth/googleauth.ts b/src/auth/googleauth.ts
@@ -146,21 +146,16 @@ export class GoogleAuth {
   }
 
   private getDefaultProjectIdAsync(): Promise<string|null> {
-    // In implicit case, supports three environments. In order of precedence,
-    // the implicit environments are:
-    //
-    // * GCLOUD_PROJECT or GOOGLE_CLOUD_PROJECT environment variable
-    // * GOOGLE_APPLICATION_CREDENTIALS JSON file
-    // * Get default service project from
-    //  ``$ gcloud beta auth application-default login``
-    // * Google App Engine application ID (Not implemented yet)
-    // * Google Compute Engine project ID (from metadata server) (Not
-    // implemented yet)
-
     if (this._cachedProjectId) {
       return Promise.resolve(this._cachedProjectId);
     }
 
+    // In implicit case, supports three environments. In order of precedence,
+    // the implicit environments are:
+    // - GCLOUD_PROJECT or GOOGLE_CLOUD_PROJECT environment variable
+    // - GOOGLE_APPLICATION_CREDENTIALS JSON file
+    // - Cloud SDK: `gcloud config config-helper --format json`
+    // - GCE project ID from metadata server)
     if (!this._getDefaultProjectIdPromise) {
       this._getDefaultProjectIdPromise =
           new Promise(async (resolve, reject) => {
@@ -179,25 +174,6 @@ export class GoogleAuth {
     return this._getDefaultProjectIdPromise;
   }
 
-  /**
-   * Run the Google Cloud SDK command that prints the default project ID
-   */
-  _getSDKDefaultProjectId():
-      Promise<{stdout: string | null, stderr: string|null}> {
-    // TODO: make this a proper async function
-    return new Promise((resolve, reject) => {
-      exec(
-          'gcloud config config-helper --format json',
-          (err, stdout, stderr) => {
-            if (err) {
-              reject(err);
-            } else {
-              resolve({stdout, stderr});
-            }
-          });
-    });
-  }
-
   /**
    * Obtains the default service-level credentials for the application.
    * @param callback Optional callback.
@@ -555,19 +531,26 @@ export class GoogleAuth {
   }
 
   /**
-   * Loads the default project of the Google Cloud SDK.
-   * @api private
+   * Run the Google Cloud SDK command that prints the default project ID
    */
   private async getDefaultServiceProjectId(): Promise<string|null> {
-    try {
-      const r = await this._getSDKDefaultProjectId();
-      if (r.stdout) {
-        return JSON.parse(r.stdout).configuration.properties.core.project;
-      }
-    } catch (e) {
-      // Ignore any errors
-    }
-    return null;
+    return new Promise<string|null>(resolve => {
+      exec(
+          'gcloud config config-helper --format json',
+          (err, stdout, stderr) => {
+            if (!err && stdout) {
+              try {
+                const projectId =
+                    JSON.parse(stdout).configuration.properties.core.project;
+                resolve(projectId);
+                return;
+              } catch (e) {
+                // ignore errors
+              }
+            }
+            resolve(null);
+          });
+    });
   }
 
   /**