Add update status and approve PR functions

Fix convert goldens to data

Author: tinayuangao

functions/data.ts

@@ -0,0 +1,22 @@
+import * as firebaseAdmin from 'firebase-admin';
+import {verifySecureTokenAndExecute} from './jwt_util';
+
+/**
+ * Handle data written to temporary folder. Validate the JWT and move the data out of
+ * temporary folder if the token is valid.
+ * Move the data to 'screenshot/reports/$prNumber/$path
+ */
+export function verifyJWTAndUpdateData(event: any, path: string) {
+  // Only edit data when it is first created. Exit when the data is deleted.
+  if (event.data.previous.exists() || !event.data.exists()) {
+    return;
+  }
+
+  let prNumber = event.params.prNumber;
+  let data = event.data.val();
+
+  return verifySecureTokenAndExecute(event).then(() => {
+    return firebaseAdmin.database().ref().child('screenshot/reports')
+      .child(prNumber).child(path).set(data);
+  });
+};

functions/data_image.ts

@@ -0,0 +1,36 @@
+import * as firebaseFunctions from 'firebase-functions';
+import {writeFileSync} from 'fs';
+import {verifySecureTokenAndExecute} from './jwt_util';
+
+const gcs = require('@google-cloud/storage')();
+
+/** The storage bucket to store the images. The bucket is also used by Firebase Storage. */
+const bucket = gcs.bucket(firebaseFunctions.config().firebase.storageBucket);
+
+/**
+ * Convert data to images. Image data posted to database will be saved as png files
+ * and upload to screenshot/$prNumber/dataType/$filename
+ */
+export function convertTestImageDataToFiles(event: any) {
+  // Only edit data when it is first created. Exit when the data is deleted.
+  if (event.data.previous.exists() || !event.data.exists()) {
+    return;
+  }
+
+  let dataType = event.params.dataType;
+  let prNumber = event.params.prNumber;
+  let data = event.data.val();
+  let saveFilename = `${event.params.filename}.screenshot.png`;
+
+  if (dataType != 'diff' && dataType != 'test') {
+    return;
+  }
+
+  return verifySecureTokenAndExecute(event).then(() => {
+    let tempPath = `/tmp/${dataType}-${saveFilename}`;
+    let filePath = `screenshots/${prNumber}/${dataType}/${saveFilename}`;
+    let binaryData = new Buffer(data, 'base64').toString('binary');
+    writeFileSync(tempPath, binaryData, 'binary');
+    return bucket.upload(tempPath, {destination: filePath});
+  });
+};

functions/github.ts

@@ -0,0 +1,32 @@
+import * as firebaseAdmin from 'firebase-admin';
+import * as firebaseFunctions from 'firebase-functions';
+import {setGithubStatus} from './util/github';
+
+/** Github status update token */
+const token = firebaseFunctions.config().secret.github;
+
+/** The repo slug. This is used to validate the JWT is sent from correct repo. */
+const repoSlug = firebaseFunctions.config().repo.slug;
+
+/** Domain to view the screenshots */
+const authDomain = firebaseFunctions.config().firebase.authDomain;
+
+/** The same of this screenshot testing tool */
+const toolName = firebaseFunctions.config().tool.name;
+
+export function updateGithubStatus(event: firebaseFunctions.Event<any>) {
+  if (!event.data.exists() || typeof event.data.val() != 'boolean') {
+    return;
+  }
+  let result = event.data.val() == true;
+  let prNumber = event.params.prNumber;
+  return event.data.ref.parent.child('sha').once('value').then((sha: firebaseAdmin.database.DataSnapshot) => {
+    return setGithubStatus(sha.val(),
+      result,
+      toolName,
+      `${toolName} ${result ? 'passed' : 'failed'}`,
+      `http://${authDomain}/${prNumber}`,
+      repoSlug,
+      token);
+  });
+}

functions/image_data.ts

@@ -0,0 +1,40 @@
+import * as firebaseFunctions from 'firebase-functions';
+import * as firebaseAdmin from 'firebase-admin';
+import * as path from 'path';
+
+const gcs = require('@google-cloud/storage')();
+
+const FIREBASE_DATA_GOLDENS = 'screenshot/goldens';
+
+/** The storage bucket to store the images. The bucket is also used by Firebase Storage. */
+const bucket = gcs.bucket(firebaseFunctions.config().firebase.storageBucket);
+
+
+/**
+ * Read golden files under /goldens/ and store the image data to
+ * database /screenshot/goldens/$filename
+ */
+export function convertGoldenImagesToData(name: string, resourceState: string, fileBucket: any) {
+  // The name should always look like "goldens/xxx.png"
+  let parsedPath = path.parse(name);
+
+  // Get the file name.
+  if (parsedPath.root != '' || parsedPath.dir != 'goldens' || parsedPath.ext != '.png') {
+    return;
+  }
+  let filenameKey = path.basename(parsedPath.name, '.screenshot');
+  let databaseRef = firebaseAdmin.database().ref(FIREBASE_DATA_GOLDENS).child(filenameKey);
+
+  // When a gold image is deleted, also delete the corresponding record in the firebase database.
+  if (resourceState === 'not_exists') {
+    return databaseRef.set(null);
+  }
+
+  let bucket = gcs.bucket(fileBucket);
+
+  // Download file from bucket.
+  return bucket.file(name).download()
+    .then((data: any) => {
+      return databaseRef.set(data);
+    }).catch((error: any) => console.error(`${filenameKey} ${error}`));
+};