Use encrypted file to define GCP credentials on CI

Author: Forest Hoffman

.travis.yml

@@ -2,24 +2,27 @@ language: node_js
 node_js:
 - 10.15.1
 env:
+  matrix:
   - VSCODE_VERSION="1.33.1" MAJOR_VERSION="1" VERSION="$MAJOR_VERSION.$TRAVIS_BUILD_NUMBER-vsc$VSCODE_VERSION"
 matrix:
   include:
-    - os: linux
-      dist: trusty
-    - os: osx
+  - os: linux
+    dist: trusty
+  - os: osx
 before_install:
-  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
-    sudo apt-get install -y libxkbfile-dev libsecret-1-dev; fi
-  - npm install -g yarn@1.12.3
+- openssl aes-256-cbc -K $encrypted_31e0a178b4fd_key -iv $encrypted_31e0a178b4fd_iv
+  -in test/.coder-gcp-credentials.json.enc -out test/.coder-gcp-credentials.json -d
+- if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then
+  sudo apt-get install -y libxkbfile-dev libsecret-1-dev; fi
+- npm install -g yarn@1.12.3
 script:
-  - scripts/build.sh
+- scripts/build.sh
 before_deploy:
-  - echo "$VERSION" "$TRAVIS_COMMIT"
-  - git config --local user.name "$USER_NAME"
-  - git config --local user.email "$USER_EMAIL"
-  - git tag "$VERSION" "$TRAVIS_COMMIT"
-  - yarn task package "$VERSION"
+- echo "$VERSION" "$TRAVIS_COMMIT"
+- git config --local user.name "$USER_NAME"
+- git config --local user.email "$USER_EMAIL"
+- git tag "$VERSION" "$TRAVIS_COMMIT"
+- yarn task package "$VERSION"
 deploy:
   provider: releases
   file_glob: true
@@ -31,13 +34,13 @@ deploy:
   api_key:
     secure: YL/x24KjYjgYXPcJWk3FV7FGxI79Mh6gBECQEcdlf3fkLEoKFVgzHBoUNWrFPzyR4tgLyWNAgcpD9Lkme1TRWTom7UPjXcwMNyLcLa+uec7ciSAnYD9ntLTpiCuPDD1u0LtRGclSi/EHQ+F8YVq+HZJpXTsJeAmOmihma3GVbGKSZr+BRum+0YZSG4w+o4TOlYzw/4bLWS52MogZcwpjd+hemBbgXLuGU2ziKv2vEKCZFbEeA16II4x1WLI4mutDdCeh7+3aLzGLwDa49NxtsVYNjyNFF75JhCTCNA55e2YMiLz9Uq69IXe/mi5F7xUaFfhIqqLNyKBnKeEOzu3dYnc+8n3LjnQ+00PmkF05nx9kBn3UfV1kwQGh6QbyDmTtBP07rtUMyI14aeQqHjxsaVRdMnwj9Q2DjXRr8UDqESZF0rmK3pHCXS2fBhIzLE8tLVW5Heiba2pQRFMHMZW+KBE97FzcFh7is90Ait3T8enfcd/PWFPYoBejDAdjwxwOkezh5N5ZkYquEfDYuWrFi6zRFCktsruaAcA+xGtTf9oilBBzUqu8Ie+YFWH5me83xakcblJWdaW/D2rLJAJH3m6LFm8lBqyUgDX5t/etob6CpDuYHu5D1J3XINOj/+aLAcadq6qlh70PMZS3zYffUu3JlzaD2amlSHIT8b5YXFc=
   file:
-    - release/*.tar.gz
-    - release/*.zip
+  - release/*.tar.gz
+  - release/*.zip
   on:
     repo: codercom/code-server
     branch: master
 cache:
   yarn: true
   timeout: 1000
   directories:
-    - .cache
+  - ".cache"

test/.coder-gcp-credentials.json.enc

@@ -1 +1,2 @@
-tmp/
+tmp/
+.*credentials.json

test/.gitignore

@@ -50,4 +50,4 @@
     "jest": "^24.7.1",
     "node-fetch": "^2.3.0"
   }
-}
+}

test/package.json

@@ -155,18 +155,20 @@ export class TestPage {
 		const img = await this.rootPage.screenshot(options);
 		this.screenshotCount++;
 
+		// If this is a Travis CI build, store the screenshots
+		// for later.
 		if (process.env.TRAVIS_OS_NAME && process.env.TRAVIS_BUILD_NUMBER) {
 			const bucketPath = `Travis-${process.env.TRAVIS_BUILD_NUMBER}/${fileName}`;
 			let buf: Buffer = typeof img === "string" ? Buffer.from(img as string) : img;
 			try {
 				const url = await bucket.write(bucketPath, buf);
-				logger.info("captured screenshot",
+				logger.info("stored screenshot",
 					field("localPath", options.path),
 					field("bucketPath", bucketPath),
 					field("url", url),
 				);
 			} catch (ex) {
-				logger.warn("failed to capture screenshot",
+				logger.warn("failed to store screenshot",
 					field("exception", ex),
 					field("targetPath", bucketPath),
 				);

test/src/index.ts

@@ -1,7 +1,14 @@
 import * as Storage from "@google-cloud/storage";
 import { File, Bucket, IMetadata } from "./bucket";
+import * as path from "path";
+import { existsSync } from "fs";
 
-const ScreenshotBucketName = "coder-dev-1-ci-screenshots";
+const screenshotBucketName = "coder-dev-1-ci-screenshots";
+// The path to the credentials must be relative to the environment in
+// which the tests are being run, because the gcloud package
+// relies on the session's $GOOGLE_APPLICATION_CREDENTIALS.
+// Otherwise, this could be statically defined in the CI config.
+const gcpCredentialsPath = path.resolve(__dirname, "../.coder-gcp-credentials.json");
 
 /**
  * GCP Storage Bucket Wrapper.
@@ -14,7 +21,10 @@ export class GoogleCloudBucket extends Bucket {
 		const storage = new Storage.Storage({
 			projectId: "coder-dev-1",
 		});
-		this.bucket = storage.bucket(ScreenshotBucketName);
+		if (!process.env.GOOGLE_APPLICATION_CREDENTIALS && existsSync(gcpCredentialsPath)) {
+			process.env.GOOGLE_APPLICATION_CREDENTIALS = gcpCredentialsPath;
+		}
+		this.bucket = storage.bucket(screenshotBucketName);
 	}
 
 	/**
@@ -93,7 +103,7 @@ export class GoogleCloudBucket extends Bucket {
 						return;
 					}
 				}
-				resolve(makePublic ? `https://storage.googleapis.com/${ScreenshotBucketName}${path}` : undefined);
+				resolve(makePublic ? `https://storage.googleapis.com/${screenshotBucketName}${path}` : undefined);
 			});
 
 			stream.end(data);