feat: Add better error for misshaped credentials (#22)

Author: averikitsch

package.json

@@ -6,8 +6,8 @@
   "scripts": {
     "build": "ncc build src/main.ts",
     "lint": "eslint . --ext .ts,.tsx",
-    "format": "prettier --write **/*.ts",
-    "test": "mocha -r ts-node/register -t 30s 'setupGcloudSDK/tests/*.test.ts'"
+    "format": "prettier --write **/**/*.ts",
+    "test": "mocha -r ts-node/register -t 90s 'setupGcloudSDK/tests/*.test.ts'"
   },
   "repository": {
     "type": "git",

setupGcloudSDK/src/index.ts

@@ -145,7 +145,30 @@ export function parseServiceAccountKey(
   if (!serviceAccountKey.trim().startsWith('{')) {
     serviceAccount = Buffer.from(serviceAccountKey, 'base64').toString('utf8');
   }
-  return JSON.parse(serviceAccount);
+  try {
+    return JSON.parse(serviceAccount);
+  } catch (error) {
+    const keyFormat = `
+    {
+      "type": "service_account",
+      "project_id": "project-id",
+      "private_key_id": "key-id",
+      "private_key": "-----BEGIN PRIVATE KEY-----\\nprivate-key\\n-----END PRIVATE KEY-----\\n",
+      "client_email": "service-account-email",
+      "client_id": "client-id",
+      "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+      "token_uri": "https://accounts.google.com/o/oauth2/token",
+      "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+      "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/service-account-email"
+    }
+    `;
+    const message =
+      'Error parsing credentials: ' +
+      error.message +
+      '\nEnsure your credentials are base64 encoded or validate JSON format: ' +
+      keyFormat;
+    throw new Error(message);
+  }
 }
 
 /**

setupGcloudSDK/tests/download-util.test.ts

@@ -39,8 +39,12 @@ describe('#downloadAndExtractTool', function() {
   });
 
   afterEach(async function() {
-    await io.rmRF(toolDir);
-    await io.rmRF(tempDir);
+    try {
+      await io.rmRF(toolDir);
+      await io.rmRF(tempDir);
+    } catch (err) {
+      console.log('Error occurred during cleanup: ' + err);
+    }
   });
 
   it('downloads and extracts linux version', async function() {