wdio-visual-regression-tracker-service
Version:
WDIO Service for the Visual Regression Tracker
224 lines • 13.8 kB
JavaScript
"use strict";
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
exports.__esModule = true;
var fs = require("fs");
var logger_1 = require("@wdio/logger");
var sdk_js_1 = require("@visual-regression-tracker/sdk-js");
var WDIOServiceService = (function () {
function WDIOServiceService(serviceOptions, _caps, config) {
this.options = serviceOptions;
this.log = (0, logger_1["default"])('visual-regression-tracker-service');
this.log.info('Visual Regression Tracker Service Added');
this.log.debug("Using Visual Regression Tracker config ".concat(this.options));
this.vrtCiName = config.vrtCiName;
}
WDIOServiceService.prototype.takeScreenshotFullPage = function () {
return __awaiter(this, void 0, void 0, function () {
var isHtml2CanvasRegistered, html2canvasjs, image, validImageBase64;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
isHtml2CanvasRegistered = function () { return __awaiter(_this, void 0, void 0, function () {
var result, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_b.trys.push([0, 2, , 3]);
return [4, browser.execute('return typeof html2canvas !== "undefined"')];
case 1:
result = _b.sent();
return [2, result];
case 2:
_a = _b.sent();
return [2, false];
case 3: return [2];
}
});
}); };
return [4, isHtml2CanvasRegistered()];
case 1:
if (!!(_a.sent())) return [3, 3];
html2canvasjs = fs
.readFileSync(require.resolve('html2canvas').replace('html2canvas.js', 'html2canvas.min.js'))
.toString();
return [4, browser.execute(html2canvasjs)];
case 2:
_a.sent();
_a.label = 3;
case 3: return [4, browser.execute("\n function genScreenshot() {\n let canvasImgContentDecoded;\n html2canvas(document.body).then(function (canvas) {\n window.canvasImgContentDecoded = canvas.toDataURL('image/png');\n });\n }\n \n genScreenshot();\n ")];
case 4:
_a.sent();
return [4, browser.waitUntil(function () { return __awaiter(_this, void 0, void 0, function () {
var result, _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_b.trys.push([0, 2, , 3]);
return [4, browser.execute('return typeof canvasImgContentDecoded !== "undefined"')];
case 1:
result = _b.sent();
return [2, result];
case 2:
_a = _b.sent();
return [2, false];
case 3: return [2];
}
});
}); })];
case 5:
_a.sent();
return [4, browser.execute('return canvasImgContentDecoded')];
case 6:
image = _a.sent();
validImageBase64 = image.replace('data:image/png;base64,', '');
return [2, validImageBase64];
}
});
});
};
WDIOServiceService.prototype.before = function (_caps, _specs, browser) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
this.browser = browser;
this.log.debug('Connecting to Visual Regression Tracker');
this.vrt = new sdk_js_1.VisualRegressionTracker(__assign(__assign({}, this.options), { ciBuildId: this.vrtCiName }));
this.log.debug('Adding vrtSnapshotPage command to browser');
this.browser.addCommand('vrtTrackPage', function (name, options) { return __awaiter(_this, void 0, void 0, function () {
var imageBase64, _a, result;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!(options === null || options === void 0 ? void 0 : options.captureFullPage)) return [3, 2];
return [4, this.takeScreenshotFullPage()];
case 1:
_a = _b.sent();
return [3, 4];
case 2: return [4, browser.takeScreenshot()];
case 3:
_a = _b.sent();
_b.label = 4;
case 4:
imageBase64 = _a;
this.log.debug("Uploading snapshot for test ".concat(name));
return [4, this.vrt.track({
name: name,
imageBase64: imageBase64,
diffTollerancePercent: (options === null || options === void 0 ? void 0 : options.diffTolerancePercent) || this.options.diffTolerancePercent,
os: options === null || options === void 0 ? void 0 : options.os,
browser: options === null || options === void 0 ? void 0 : options.browser,
viewport: options === null || options === void 0 ? void 0 : options.viewport,
device: options === null || options === void 0 ? void 0 : options.device,
ignoreAreas: options === null || options === void 0 ? void 0 : options.ignoreAreas
})];
case 5:
result = _b.sent();
if (result.testRunResponse.status === sdk_js_1.TestStatus.unresolved) {
this.log.warn("Snapshot for ".concat(name, " showed ").concat(result.testRunResponse.pixelMisMatchCount, " pixel mismatch count.\nView the result at ").concat(result.testRunResponse.url));
}
else if (result.testRunResponse.status === sdk_js_1.TestStatus["new"]) {
this.log.warn("Snapshot for ".concat(name, " has no baseline image set\nUpdate the baseline at ").concat(result.testRunResponse.url));
}
this.log.debug("Test ".concat(name, " returned with status ").concat(result.testRunResponse.status));
return [2, result];
}
});
}); });
this.browser.addCommand('vrtTrackElement', function (name, options) {
return __awaiter(this, void 0, void 0, function () {
var vrt, imageBase64, result;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4, browser.vrtInstance()];
case 1:
vrt = _a.sent();
if (!this.isExisting()) {
throw new Error("Unable to find element ".concat(this, " for snapshot test ").concat(name));
}
return [4, browser.takeElementScreenshot(this.elementId)];
case 2:
imageBase64 = _a.sent();
return [4, vrt.track({
name: name,
imageBase64: imageBase64,
diffTollerancePercent: (options === null || options === void 0 ? void 0 : options.diffTolerancePercent) || this.options.diffTolerancePercent,
os: options === null || options === void 0 ? void 0 : options.os,
browser: options === null || options === void 0 ? void 0 : options.browser,
viewport: options === null || options === void 0 ? void 0 : options.viewport,
device: options === null || options === void 0 ? void 0 : options.device,
ignoreAreas: options === null || options === void 0 ? void 0 : options.ignoreAreas
})];
case 3:
result = _a.sent();
return [2, result];
}
});
});
}, true);
this.browser.addCommand('vrtInstance', function () {
return _this.vrt;
});
this.log.info('Starting Visual Regression Tracker');
return [2, this.vrt.start()];
});
});
};
WDIOServiceService.prototype.after = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
this.log.info('Stopping Visual Regression Tracker');
return [2, this.vrt.stop()];
});
});
};
return WDIOServiceService;
}());
exports["default"] = WDIOServiceService;
//# sourceMappingURL=service.js.map