|
| 1 | +import {task} from 'gulp'; |
| 2 | +import {readdirSync, statSync, existsSync, mkdirp} from 'fs-extra'; |
| 3 | +import * as path from 'path'; |
| 4 | +import * as admin from 'firebase-admin'; |
| 5 | +import {openScreenshotsBucket, openFirebaseScreenshotsDatabase} from '../task_helpers'; |
| 6 | +import {updateGithubStatus} from '../util-functions'; |
| 7 | + |
| 8 | +const request = require('request'); |
| 9 | +const imageDiff = require('image-diff'); |
| 10 | + |
| 11 | +const SCREENSHOT_DIR = './screenshots'; |
| 12 | +const FIREBASE_REPORT = 'screenshot/reports'; |
| 13 | +const FIREBASE_FILELIST = 'screenshot/filenames'; |
| 14 | + |
| 15 | +/** Task which upload screenshots generated from e2e test. */ |
| 16 | +task('screenshots', () => { |
| 17 | + let prNumber = process.env['TRAVIS_PULL_REQUEST']; |
| 18 | + if (prNumber) { |
| 19 | + let database = openFirebaseScreenshotsDatabase(); |
| 20 | + return getScreenshotFiles(database) |
| 21 | + .then((files: any[]) => downloadAllGoldsAndCompare(files, database, prNumber)) |
| 22 | + .then((results: boolean) => updateResult(database, prNumber, results)) |
| 23 | + .then((result: boolean) => updateGithubStatus(result, prNumber)) |
| 24 | + .then(() => uploadScreenshots(prNumber, 'diff')) |
| 25 | + .then(() => uploadScreenshots(prNumber, 'test')) |
| 26 | + .then(() => updateTravis(database, prNumber)) |
| 27 | + .then(() => setScreenFilenames(database, prNumber)) |
| 28 | + .then(() => database.goOffline(), () => database.goOffline()); |
| 29 | + } |
| 30 | +}); |
| 31 | + |
| 32 | +function updateFileResult(database: admin.database.Database, prNumber: string, |
| 33 | + filenameKey: string, result: boolean) { |
| 34 | + return database.ref(FIREBASE_REPORT).child(prNumber).child('results').child(filenameKey).set(result); |
| 35 | +} |
| 36 | + |
| 37 | +function updateResult(database: admin.database.Database, prNumber: string, |
| 38 | + result: boolean) { |
| 39 | + return database.ref(FIREBASE_REPORT).child(prNumber).child('result').set(result).then(() => result); |
| 40 | +} |
| 41 | + |
| 42 | +function updateTravis(database: admin.database.Database, |
| 43 | + prNumber: string) { |
| 44 | + return database.ref(FIREBASE_REPORT).child(prNumber).update({ |
| 45 | + commit: process.env['TRAVIS_COMMIT'], |
| 46 | + sha: process.env['TRAVIS_PULL_REQUEST_SHA'], |
| 47 | + travis: process.env['TRAVIS_JOB_ID'], |
| 48 | + }); |
| 49 | +} |
| 50 | + |
| 51 | +/** Get a list of filenames from firebase database. */ |
| 52 | +function getScreenshotFiles(database: admin.database.Database) { |
| 53 | + let bucket = openScreenshotsBucket(); |
| 54 | + return bucket.getFiles({ prefix: 'golds/' }).then(function(data: any) { |
| 55 | + return data[0].filter((file:any) => file.name.endsWith('.screenshot.png')); |
| 56 | + }); |
| 57 | +} |
| 58 | + |
| 59 | +function extractScreenshotName(fileName: string) { |
| 60 | + return path.basename(fileName, '.screenshot.png'); |
| 61 | +} |
| 62 | + |
| 63 | +function getLocalScreenshotFiles(dir: string): string[] { |
| 64 | + return readdirSync(dir) |
| 65 | + .filter((fileName: string) => !statSync(path.join(SCREENSHOT_DIR, fileName)).isDirectory()) |
| 66 | + .filter((fileName: string) => fileName.endsWith('.screenshot.png')); |
| 67 | +} |
| 68 | + |
| 69 | +/** |
| 70 | + * Upload screenshots to google cloud storage. |
| 71 | + * @param prNumber - The key used in firebase. Here it is the PR number. |
| 72 | + * If there's no prNumber, we will upload images to 'golds/' folder |
| 73 | + * @param mode - Can be 'test' or 'diff' or null. |
| 74 | + * If the images are the test results, mode should be 'test'. |
| 75 | + * If the images are the diff images generated, mode should be 'diff'. |
| 76 | + * For golds mode should be null. |
| 77 | + */ |
| 78 | +function uploadScreenshots(prNumber?: string, mode?: 'test' | 'diff') { |
| 79 | + let bucket = openScreenshotsBucket(); |
| 80 | + |
| 81 | + let promises: any[] = []; |
| 82 | + let localDir = mode == 'diff' ? path.join(SCREENSHOT_DIR, 'diff') : SCREENSHOT_DIR; |
| 83 | + getLocalScreenshotFiles(localDir).forEach((file: string) => { |
| 84 | + let fileName = path.join(localDir, file); |
| 85 | + let destination = (mode == null || !prNumber) ? |
| 86 | + `golds/${file}` : `screenshots/${prNumber}/${mode}/${file}`; |
| 87 | + promises.push(bucket.upload(fileName, { destination: destination })); |
| 88 | + }); |
| 89 | + return Promise.all(promises); |
| 90 | +} |
| 91 | + |
| 92 | +/** Download golds screenshots. */ |
| 93 | +function downloadAllGoldsAndCompare( |
| 94 | + files: any[], database: admin.database.Database, |
| 95 | + prNumber: string) { |
| 96 | + |
| 97 | + mkdirp(path.join(SCREENSHOT_DIR, `golds`)); |
| 98 | + mkdirp(path.join(SCREENSHOT_DIR, `diff`)); |
| 99 | + |
| 100 | + return Promise.all(files.map((file: any) => { |
| 101 | + return downloadGold(file).then(() => diffScreenshot(file.name, database, prNumber)); |
| 102 | + })).then((results: boolean[]) => results.every((value: boolean) => value == true)); |
| 103 | +} |
| 104 | + |
| 105 | +/** Download one gold screenshot */ |
| 106 | +function downloadGold(file: any) { |
| 107 | + return file.download({ |
| 108 | + destination: path.join(SCREENSHOT_DIR, file.name) |
| 109 | + }); |
| 110 | +} |
| 111 | + |
| 112 | +function diffScreenshot(filename: string, database: admin.database.Database, |
| 113 | + prNumber: string) { |
| 114 | + // TODO(tinayuangao): Run the downloads and diffs in parallel. |
| 115 | + filename = path.basename(filename); |
| 116 | + let goldUrl = path.join(SCREENSHOT_DIR, `golds`, filename); |
| 117 | + let pullRequestUrl = path.join(SCREENSHOT_DIR, filename); |
| 118 | + let diffUrl = path.join(SCREENSHOT_DIR, `diff`, filename); |
| 119 | + let filenameKey = extractScreenshotName(filename); |
| 120 | + |
| 121 | + if (existsSync(goldUrl) && existsSync(pullRequestUrl)) { |
| 122 | + return new Promise((resolve: any, reject: any) => { |
| 123 | + imageDiff({ |
| 124 | + actualImage: pullRequestUrl, |
| 125 | + expectedImage: goldUrl, |
| 126 | + diffImage: diffUrl, |
| 127 | + }, (err: any, imagesAreSame: boolean) => { |
| 128 | + if (err) { |
| 129 | + console.log(err); |
| 130 | + imagesAreSame = false; |
| 131 | + reject(err); |
| 132 | + } |
| 133 | + resolve(imagesAreSame); |
| 134 | + return updateFileResult(database, prNumber, filenameKey, imagesAreSame); |
| 135 | + }); |
| 136 | + }); |
| 137 | + } else { |
| 138 | + return updateFileResult(database, prNumber, filenameKey, false).then(() => false); |
| 139 | + } |
| 140 | +} |
| 141 | + |
| 142 | +/** |
| 143 | + * Upload a list of filenames to firebase database as gold. |
| 144 | + * This is necessary for control panel since google-cloud is not available to client side. |
| 145 | + */ |
| 146 | +function setScreenFilenames(database: admin.database.Database, |
| 147 | + prNumber?: string) { |
| 148 | + let filenames: string[] = getLocalScreenshotFiles(SCREENSHOT_DIR); |
| 149 | + let filelistDatabase = prNumber ? |
| 150 | + database.ref(FIREBASE_REPORT).child(prNumber).child('filenames') : |
| 151 | + database.ref(FIREBASE_FILELIST); |
| 152 | + return filelistDatabase.set(filenames); |
| 153 | +} |
0 commit comments