Skip to content

[TASK] fix relative paths for Mochawesome context screenshots #97

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

Merged
merged 5 commits into from
Nov 2, 2021
Merged

[TASK] fix relative paths for Mochawesome context screenshots #97

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ba8b54
[TASK] fix relative paths for Mochawesome context screenshots
jpmschuler Sep 14, 2021
5a26ff4
[TASK] improve relative path generation for cases where report is not…
jpmschuler Sep 15, 2021
f648f37
[TASK] switch to Path.relative
jpmschuler Sep 15, 2021
e8466e6
[TASK] add more pessimistic check for undefined options
jpmschuler Oct 4, 2021
277b1c6
[TASK] resolveRelativePath should not be public
jpmschuler Oct 28, 2021
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
24 changes: 21 additions & 3 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const getDirName = require('path').dirname;
const AWS = require('aws-sdk');
const path = require('path');
const sizeOf = require('image-size');
const Container = require('codeceptjs/lib/container');

/**
* Resemble.js helper class for CodeceptJS, this allows screen comparison
Expand All @@ -29,6 +30,23 @@ class ResembleHelper extends Helper {
return folderPath;
}

_resolveRelativePath(folderPath) {
let absolutePathOfImage = folderPath;
if (!path.isAbsolute(absolutePathOfImage)) {
absolutePathOfImage = path.resolve(global.codecept_dir, absolutePathOfImage) + "/";
}
let absolutePathOfReportFolder = global.output_dir;
// support mocha
if (Container.mocha() && typeof Container.mocha().options.reporterOptions.reportDir !== 'undefined') {
absolutePathOfReportFolder = Container.mocha().options.reporterOptions.reportDir;
}
// support mocha-multi-reporters
if (Container.mocha() && typeof Container.mocha().options.reporterOptions.mochawesomeReporterOptions.reportDir !== 'undefined') {
absolutePathOfReportFolder = Container.mocha().options.reporterOptions.mochawesomeReporterOptions.reportDir;
}
return path.relative(absolutePathOfReportFolder, absolutePathOfImage);
}

/**
* Compare Images
*
Expand Down Expand Up @@ -170,11 +188,11 @@ class ResembleHelper extends Helper {

if (mocha !== undefined && misMatch >= options.tolerance) {
await mocha.addMochawesomeContext("Base Image");
await mocha.addMochawesomeContext(this._getBaseImagePath(baseImage, options));
await mocha.addMochawesomeContext(this.resolveImagePathRelativeFromReport(this._getBaseImagePath(baseImage, options)));
await mocha.addMochawesomeContext("ScreenShot Image");
await mocha.addMochawesomeContext(this._getActualImagePath(baseImage));
await mocha.addMochawesomeContext(this.resolveImagePathRelativeFromReport(this._getActualImagePath(baseImage)));
await mocha.addMochawesomeContext("Diff Image");
await mocha.addMochawesomeContext(this._getDiffImagePath(baseImage));
await mocha.addMochawesomeContext(this.resolveImagePathRelativeFromReport(this._getDiffImagePath(baseImage)));
}
}

Expand Down