Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update visualRegression task to use Handlebars instead of DoT templates. #7524

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@
"babel-eslint": "4.1.8",
"chokidar": "1.4.3",
"chromedriver": "2.21.2",
"dot": "1.0.3",
"elasticdump": "2.1.1",
"eslint": "1.10.3",
"eslint-plugin-mocha": "1.1.0",
Expand All @@ -179,6 +178,7 @@
"grunt-s3": "0.2.0-alpha.3",
"grunt-simple-mocha": "0.4.0",
"gruntify-eslint": "1.0.1",
"handlebars": "4.0.5",
"html-entities": "1.1.3",
"husky": "0.8.1",
"image-diff": "1.6.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,14 @@
</div>

<div class="meta">
{{=it.branch}} - {{=it.date}}
{{branch}} - {{date}}
</div>

{{~it.comparisons :comparison:index}}
<div class="comparison{{? comparison.change <= it.hiddenThreshold }} comparison--collapsed{{?}} {{? comparison.change >= it.warningThreshold }} comparison--warning{{?}}">
{{#each comparisons as |comparison|}}
<div class="comparison{{#lte comparison.change ../hiddenThreshold}} comparison--collapsed{{/lte}} {{#gte comparison.change ../warningThreshold }} comparison--warning{{/gte}}">

<div class="comparison__title">
<span class="comparison__percent">({{=comparison.percentage}}%)</span> {{=comparison.name}}
<span class="comparison__percent">({{comparison.percentage}}%)</span> {{comparison.name}}
</div>

<div class="comparison__subTitle">
Expand All @@ -155,7 +156,7 @@
<div class="comparisonScreenshot">
<img
class="comparisonScreenshot__image"
src="data:image/png;base64,{{=comparison.imageData.diff}}"
src="data:image/png;base64,{{comparison.imageData.diff}}"
/>
</div>

Expand All @@ -166,20 +167,20 @@
>
<img
class="comparisonScreenshot__image"
src="data:image/png;base64,{{=comparison.imageData.session}}"
src="data:image/png;base64,{{comparison.imageData.session}}"
/>
</div>

<!-- Baseline, see what it's supposed to be. -->
<div class="comparisonScreenshot comparisonScreenshot--baseline">
<img
class="comparisonScreenshot__image"
src="data:image/png;base64,{{=comparison.imageData.baseline}}"
src="data:image/png;base64,{{comparison.imageData.baseline}}"
/>
</div>
</div>
</div>
{{~}}
{{/each}}

<script>

Expand Down
53 changes: 31 additions & 22 deletions utilities/visual_regression.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import bluebird, {
fromNode,
promisify,
} from 'bluebird';
import dot from 'dot';
import Handlebars from 'handlebars';
import fs from 'fs';
import path from 'path';
import imageDiff from 'image-diff';
Expand All @@ -15,33 +15,42 @@ const readDirAsync = promisify(fs.readdir);
const readFileAsync = promisify(fs.readFile);
const writeFileAsync = promisify(fs.writeFile);

// Preserve whitespace in our HTML output.
dot.templateSettings.strip = false;

const templates = dot.process({
path: path.resolve('./utilities/templates')
Handlebars.registerHelper('lte', function lessThanEquals(value, threshold, options) {
if (value <= threshold) {
return options.fn(this);
}
return options.inverse(this);
});

function buildGallery(comparisons) {
Handlebars.registerHelper('gte', function greaterThanEquals(value, threshold, options) {
if (value >= threshold) {
return options.fn(this);
}
return options.inverse(this);
});

async function buildGallery(comparisons) {
const simpleGit = new SimpleGit();
const asyncBranch = promisify(simpleGit.branch, simpleGit);

return asyncBranch().then(data => {
const branch = data.current;

const html = templates.visual_regression_gallery({
date: moment().format('MMMM Do YYYY, h:mm:ss a'),
branch,
hiddenThreshold: 0,
warningThreshold: 0.03,
comparisons,
});

return writeFileAsync(
path.resolve('./test/screenshots/visual_regression_gallery.html'),
html
);
const branch = await asyncBranch();

const template = Handlebars.compile(await readFileAsync(
path.resolve('./utilities/templates/visual_regression_gallery.handlebars')
, 'utf8'));

const html = template({
date: moment().format('MMMM Do YYYY, h:mm:ss a'),
branch: branch.current,
hiddenThreshold: 0,
warningThreshold: 0.03,
comparisons,
});

return writeFileAsync(
path.resolve('./test/screenshots/visual_regression_gallery.html'),
html
);
}

async function compareScreenshots() {
Expand Down