Skip to content

feat(allure): screen diff plugin support #134

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

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

feat(allure): screen diff plugin support #134

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3cc7351
adding support to allure screen diff plugin
Raytek Jan 9, 2024
13e8850
lint
Raytek Jan 9, 2024
c98ba8a
Merge branch 'master' into master
kobenguyent Jan 23, 2024
90647b1
Merge branch 'master' into master
kobenguyent Jan 23, 2024
045c910
Merge branch 'master' into master
kobenguyent Jan 23, 2024
36992be
Merge branch 'master' into master
kobenguyent Oct 23, 2024
5101f7a
Merge branch 'master' into master
Raytek Jul 28, 2025
5fc2218
Merge branch 'master' into master
Raytek Oct 4, 2025
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
9 changes: 6 additions & 3 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,9 +233,12 @@ class ResembleHelper extends Helper {
const allure: any = require("codeceptjs").container.plugins("allure");

if (allure !== undefined && misMatch >= options.tolerance) {
allure.addAttachment("Base Image", fs.readFileSync(this._getBaseImagePath(baseImage, options)), "image/png");
allure.addAttachment("Screenshot Image", fs.readFileSync(this._getActualImagePath(baseImage)), "image/png");
allure.addAttachment("Diff Image", fs.readFileSync(this._getDiffImagePath(baseImage)), "image/png");
allure.addScreenDiff(
"Screen Diff",
fs.readFileSync(this._getBaseImagePath(baseImage, options), { encoding: "base64" }),
fs.readFileSync(this._getActualImagePath(baseImage), { encoding: "base64" }),
fs.readFileSync(this._getDiffImagePath(baseImage), { encoding: "base64" }),
Comment on lines +238 to +240
Copy link
Preview

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading images as base64 strings increases memory/cpu and bloats attachments by ~33%. Prefer passing Buffers (omit the encoding option) to avoid unnecessary encoding and to keep report size smaller.

Suggested change
fs.readFileSync(this._getBaseImagePath(baseImage, options), { encoding: "base64" }),
fs.readFileSync(this._getActualImagePath(baseImage), { encoding: "base64" }),
fs.readFileSync(this._getDiffImagePath(baseImage), { encoding: "base64" }),
fs.readFileSync(this._getBaseImagePath(baseImage, options)),
fs.readFileSync(this._getActualImagePath(baseImage)),
fs.readFileSync(this._getDiffImagePath(baseImage)),

Copilot uses AI. Check for mistakes.

);
Comment on lines +236 to +241
Copy link
Preview

Copilot AI Oct 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CodeceptJS's Allure plugin does not expose addScreenDiff in supported versions; calling this will throw at runtime. Use standard attachments with the names expected by the Allure screen-diff plugin (expected, actual, diff), or feature-detect and fall back to addAttachment.

Suggested change
allure.addScreenDiff(
"Screen Diff",
fs.readFileSync(this._getBaseImagePath(baseImage, options), { encoding: "base64" }),
fs.readFileSync(this._getActualImagePath(baseImage), { encoding: "base64" }),
fs.readFileSync(this._getDiffImagePath(baseImage), { encoding: "base64" }),
);
allure.addAttachment(
"expected",
fs.readFileSync(this._getBaseImagePath(baseImage, options)),
"image/png"
);
allure.addAttachment(
"actual",
fs.readFileSync(this._getActualImagePath(baseImage)),
"image/png"
);
allure.addAttachment(
"diff",
fs.readFileSync(this._getDiffImagePath(baseImage)),
"image/png"
);

Copilot uses AI. Check for mistakes.

}
}

Expand Down