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.

Sign up for GitHub

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

Jump to bottom

Allow overriding of looks-same options #27

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Allow overriding of looks-same options #27

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
e5ed119
Update package-lock.json
Jul 15, 2019
0aab9f4
Don't update golden image if unchanged
Jul 15, 2019
a90ca19
Save current screenshot to output folder
Jul 15, 2019
4e58eef
Allow overriding of looks-same options
Jul 15, 2019
35ce435
Revert "Save current screenshot to output folder"
Jul 15, 2019
4bc903e
Revert "Don't update golden image if unchanged"
Jul 15, 2019
b7ddc52
Revert "Update package-lock.json"
Jul 15, 2019
21ab4ed
Make the override optional
Jul 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 7 additions & 15 deletions screenshot_helper/screenshot_helper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,12 @@
import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import * as looksSame from 'looks-same';

import { browser, ElementFinder, WebElement } from 'protractor';

let mask_fn = require('./mask').MASK_FN;

/*
* Create shim for LooksSame typing.
*/
export interface LooksSame {
(img1: string, img2: string, options: Object, check: (error: any, equal: any) => void);
(img1: string, img2: string, check: (error: any, equal: any) => void);
createDiff(options: Object, err: Function);
}

// Require looks-same casted with shim interface LooksSame typing.
let looksSame: LooksSame = require('looks-same');

/**
* Compare a screenshot to a reference, or "golden" image.
* Returns a Promise that resolves to whether or not the
Expand All @@ -32,7 +21,7 @@ let looksSame: LooksSame = require('looks-same');

* saved.
*/
export async function compareScreenshot(data, golden, outputFolder = undefined): Promise<string> {
export async function compareScreenshot(data, golden, outputFolder = undefined, looksSameOptions: looksSame.LooksSameOptions = {}): Promise<string> {
return new Promise<string>(async (resolve, reject) => {
const tempFolder = createTempFolder();
const screenshotPath = await writeScreenshot(tempFolder, data);
Expand All @@ -45,8 +34,11 @@ export async function compareScreenshot(data, golden, outputFolder = undefined):
}
const goldenName = path.basename(golden);
looksSame(screenshotPath, golden, {
strict: false,
tolerance: 2.5,
...{
strict: false,
tolerance: 2.5,
},
...looksSameOptions,
}, async (error, equal) => {
if (error) {
reject("There has been an error. Error: " + error);
Expand Down