Move files to tools/screenshot-test/functions

Author: tinayuangao

.gitignore

@@ -7,7 +7,7 @@
 /screenshots
 
 # dependencies
-/node_modules
+node_modules
 /bower_components
 
 # Dart

functions/data.ts

@@ -42,6 +42,7 @@
     "@angular/platform-browser-dynamic": "^4.0.0",
     "@angular/platform-server": "^4.0.0",
     "@angular/router": "^4.0.0",
+    "@google-cloud/storage": "^0.8.0",
     "@types/chalk": "^0.4.31",
     "@types/fs-extra": "0.0.37",
     "@types/glob": "^5.0.30",
@@ -61,6 +62,7 @@
     "dgeni": "^0.4.7",
     "dgeni-packages": "^0.16.5",
     "firebase-admin": "^4.1.2",
+    "firebase-functions": "^0.5.2",
     "firebase-tools": "^2.2.1",
     "firebase": "^3.7.2",
     "fs-extra": "^2.0.0",
@@ -86,6 +88,7 @@
     "http-rewrite-middleware": "^0.1.6",
     "image-diff": "^1.6.3",
     "jasmine-core": "^2.5.2",
+    "jsonwebtoken": "^7.3.0",
     "karma": "^1.5.0",
     "karma-browserstack-launcher": "^1.2.0",
     "karma-chrome-launcher": "^2.0.0",
@@ -99,6 +102,7 @@
     "minimist": "^1.2.0",
     "node-sass": "^4.5.0",
     "protractor": "^5.1.1",
+    "request": "^2.81.0",
     "resolve-bin": "^0.4.0",
     "rollup": "^0.41.6",
     "run-sequence": "^1.2.2",

functions/index.js

@@ -1,6 +1,7 @@
 import * as firebaseFunctions from 'firebase-functions';
 import {writeFileSync} from 'fs';
-import {verifySecureTokenAndExecute} from './jwt_util';
+import {verifySecureToken} from './jwt_util';
+import {isCreateEvent} from './util/util';
 
 const gcs = require('@google-cloud/storage')();
 
@@ -10,10 +11,11 @@ const bucket = gcs.bucket(firebaseFunctions.config().firebase.storageBucket);
 /**
  * Convert data to images. Image data posted to database will be saved as png files
  * and uploaded to screenshot/$prNumber/dataType/$filename
+ * Convert BufferArray to .png image file
  */
 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()) {
+  if (!isCreateEvent(event)) {
     return;
   }
 
@@ -22,11 +24,12 @@ export function convertTestImageDataToFiles(event: any) {
   let data = event.data.val();
   let saveFilename = `${event.params.filename}.screenshot.png`;
 
+  // Check it's either diff images generated by screenshot comparison, or the test image results
   if (dataType !== 'diff' && dataType !== 'test') {
     return;
   }
 
-  return verifySecureTokenAndExecute(event).then(() => {
+  return verifySecureToken(event).then(() => {
     let tempPath = `/tmp/${dataType}-${saveFilename}`;
     let filePath = `screenshots/${prNumber}/${dataType}/${saveFilename}`;
     let binaryData = new Buffer(data, 'base64').toString('binary');

package.json

@@ -1,4 +1,3 @@
-import * as firebaseAdmin from 'firebase-admin';
 import * as firebaseFunctions from 'firebase-functions';
 import {setGithubStatus} from './util/github';
 

functions/data_image.ts renamed to tools/screenshot-test/functions/data_image.ts

@@ -4,17 +4,21 @@ import {readFileSync} from 'fs';
 
 const gcs = require('@google-cloud/storage')();
 
+/** Folder on Firebase database to store golden images data */
 const FIREBASE_DATA_GOLDENS = 'screenshot/goldens';
 
 /**
  * Read golden files under /goldens/ and store the image data to
  * database /screenshot/goldens/$filename
+ * Convert png image files to BufferArray data
  */
 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') {
+  if (parsedPath.root != '' ||
+    parsedPath.dir != 'goldens' ||
+    parsedPath.ext.toLowerCase() != '.png') {
     return;
   }
 

functions/github.ts renamed to tools/screenshot-test/functions/github.ts

@@ -3,37 +3,45 @@
 import * as firebaseFunctions from 'firebase-functions';
 import * as firebaseAdmin from 'firebase-admin';
 
-import {verifyJWTAndUpdateData} from './data';
+import {verifyJwtAndTransferResultToTrustedLocation} from './verify-and-copy-report';
 import {convertGoldenImagesToData} from './image_data';
 import {convertTestImageDataToFiles} from './data_image';
 import {copyTestImagesToGoldens} from './test_goldens';
 import {updateGithubStatus} from './github';
 
 /**
  * Usage: Firebase functions only accept javascript file index.js
- *   tsc
+ *   tsc -p tools/screenshot-test/functions/tsconfig.json
+ *   cd functions
+ *   npm install
  *   firebase deploy --only functions
  *
  *
  * Data and images handling for Screenshot test.
  *
- * All users can post data to temporary folder. These Functions will check the data with JsonWebToken and
- * move the valid data out of temporary folder.
+ * All users can post data to temporary folder. These Functions will check the data with
+ * JsonWebToken and move the valid data out of temporary folder.
  *
  * For valid data posted to database /$temp/screenshot/reports/$prNumber/$secureToken, move it to
  * /screenshot/reports/$prNumber.
- * These are data for screenshot results (success or failure), GitHub PR/commit and TravisCI job information
+ * These are data for screenshot results (success or failure), GitHub PR/commit and TravisCI job
+ * information.
  *
- * For valid image results written to database /$temp/screenshot/images/$prNumber/$secureToken/, save the image
- * data to image files and upload to google cloud storage under location /screenshots/$prNumber
- * These are screenshot test result images, and difference images generated from screenshot comparison.
+ * For valid image results written to database /$temp/screenshot/images/$prNumber/$secureToken/,
+ * save the image data to image files and upload to google cloud storage under
+ * location /screenshots/$prNumber
+ * These are screenshot test result images, and difference images generated from screenshot
+ * comparison.
  *
- * For golden images uploaded to /goldens, read the data from images files and write the data to Firebase database
- * under location /screenshot/goldens
- * Screenshot tests can only read restricted database data with no credentials, and they cannot access
- * Google Cloud Storage. Therefore we copy the image data to database to make it available to screenshot tests.
+ * For golden images uploaded to /goldens, read the data from images files and write the data to
+ * Firebase database under location /screenshot/goldens
+ * Screenshot tests can only read restricted database data with no credentials, and they cannot
+ * access.
+ * Google Cloud Storage. Therefore we copy the image data to database to make it available to
+ * screenshot tests.
  *
- * The JWT is stored in the data path, so every write to database needs a valid JWT to be copied to database/storage.
+ * The JWT is stored in the data path, so every write to database needs a valid JWT to be copied to
+ * database/storage.
  * All invalid data will be removed.
  * The JWT has 3 parts: header, payload and signature. These three parts are joint by '/' in path.
  */
@@ -65,11 +73,11 @@ const trustedReportPath = `screenshot/reports/{prNumber}`;
  *     sha (github PR info), result (true or false for all the tests), travis job number
  */
 const testDataPath = `${reportPath}/{dataType}`;
-exports.testData = firebaseFunctions.database.ref(testDataPath)
+export let testData = firebaseFunctions.database.ref(testDataPath)
     .onWrite((event: any) => {
   const dataType = event.params.dataType;
   if (dataTypes.includes(dataType)) {
-    return verifyJWTAndUpdateData(event, dataType);
+    return verifyJwtAndTransferResultToTrustedLocation(event, dataType);
   }
 });
 
@@ -79,9 +87,9 @@ exports.testData = firebaseFunctions.database.ref(testDataPath)
  * Data copied: test result for each file/test with ${filename}. The value should be true or false.
  */
 const testResultsPath = `${reportPath}/results/{filename}`;
-exports.testResults = firebaseFunctions.database.ref(testResultsPath)
+export let testResults = firebaseFunctions.database.ref(testResultsPath)
     .onWrite((event: any) => {
-  return verifyJWTAndUpdateData(event, `results/${event.params.filename}`);
+  return verifyJwtAndTransferResultToTrustedLocation(event, `results/${event.params.filename}`);
 });
 
 /**
@@ -90,14 +98,14 @@ exports.testResults = firebaseFunctions.database.ref(testResultsPath)
  * Data copied: test result images. Convert from data to image files in storage.
  */
 const imageDataToFilePath = `${imagePath}/{dataType}/{filename}`;
-exports.imageDataToFile = firebaseFunctions.database.ref(imageDataToFilePath)
+export let imageDataToFile = firebaseFunctions.database.ref(imageDataToFilePath)
   .onWrite(convertTestImageDataToFiles);
 
 /**
  * Copy valid goldens from storage /goldens/ to database /screenshot/goldens/
  * so we can read the goldens without credentials.
  */
-exports.goldenImageToData = firebaseFunctions.storage.bucket(
+export let goldenImageToData = firebaseFunctions.storage.bucket(
     firebaseFunctions.config().firebase.storageBucket).object().onChange((event: any) => {
   return convertGoldenImagesToData(event.data.name, event.data.resourceState, event.data.bucket);
 });
@@ -107,7 +115,8 @@ exports.goldenImageToData = firebaseFunctions.storage.bucket(
  * Copy images from /screenshot/$prNumber/test/ to /goldens/
  */
 const approveImagesPath = `${trustedReportPath}/approved`;
-exports.approveImages = firebaseFunctions.database.ref(approveImagesPath).onWrite((event: any) => {
+export let approveImages = firebaseFunctions.database.ref(approveImagesPath)
+    .onWrite((event: any) => {
   return copyTestImagesToGoldens(event.params.prNumber);
 });
 
@@ -117,4 +126,5 @@ exports.approveImages = firebaseFunctions.database.ref(approveImagesPath).onWrit
  * The Github Status Token is set in config.secret.github
  */
 const githubStatusPath = `${trustedReportPath}/result/{sha}`;
-exports.githubStatus = firebaseFunctions.database.ref(githubStatusPath).onWrite(updateGithubStatus);
+export let githubStatus = firebaseFunctions.database.ref(githubStatusPath)
+    .onWrite(updateGithubStatus);

functions/image_data.ts renamed to tools/screenshot-test/functions/image_data.ts

@@ -1,5 +1,5 @@
 import * as firebaseFunctions from 'firebase-functions';
-import {verifySecureToken} from './util/jwt';
+import {verifyJWT} from './util/jwt';
 
 /** The repo slug. This is used to validate the JWT is sent from correct repo. */
 const repoSlug = firebaseFunctions.config().repo.slug;
@@ -17,15 +17,15 @@ function getSecureToken(event: firebaseFunctions.Event<any>) {
 };
 
 /**
- * Verify event params have correct JsonWebToken, and execute callback when the JWT is verified.
- * Delete the data if there's an error or the callback is done
+ * Verify that the event has a valid JsonWebToken. If the token is *not* valid,
+ * the data tied to the event will be deleted and the function will return a rejected promise.
  */
-export function verifySecureTokenAndExecute(event: firebaseFunctions.Event<any>) {
+export function verifySecureToken(event: firebaseFunctions.Event<any>) {
   return new Promise((resolve, reject) => {
     const prNumber = event.params.prNumber;
     const secureToken = getSecureToken(event);
 
-    return verifySecureToken(secureToken, prNumber, secret, repoSlug).then(() => {
+    return verifyJWT(secureToken, prNumber, secret, repoSlug).then(() => {
       resolve();
       event.data.ref.parent.set(null);
     }).catch((error: any) => {