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

fix(publish-metadata): use fail message for rules with reviewOnFail:true #2987

Merged
merged 3 commits into from
Jun 11, 2021
Merged

fix(publish-metadata): use fail message for rules with reviewOnFail:true #2987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a34d17
fix(publish-metadata): use fail message for rules with reviewOnFail:true
straker Jun 10, 2021
3c700c2
revert
straker Jun 10, 2021
b603215
fix tests
straker Jun 10, 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
23 changes: 12 additions & 11 deletions lib/core/utils/publish-metadata.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ function getIncompleteReason(checkData, messages) {
}
if (checkData && checkData.missingData) {
try {
var msg = messages.incomplete[checkData.missingData[0].reason];
const msg = messages.incomplete[checkData.missingData[0].reason];
if (!msg) {
throw new Error();
}
Expand All @@ -46,16 +46,17 @@ function getIncompleteReason(checkData, messages) {
* Extend checksData with the correct result message
* @param {Object} checksData The check result data
* @param {Boolean} shouldBeTrue Result of pass/fail check run
* @param {Object} rule The rule metadata
* @return {Function}
* @private
*/
function extender(checksData, shouldBeTrue) {
function extender(checksData, shouldBeTrue, rule) {
return check => {
var sourceData = checksData[check.id] || {};
var messages = sourceData.messages || {};
var data = Object.assign({}, sourceData);
const sourceData = checksData[check.id] || {};
const messages = sourceData.messages || {};
const data = Object.assign({}, sourceData);
delete data.messages;
if (check.result === undefined) {
if (!rule.reviewOnFail && check.result === undefined) {
// handle old doT template
if (
typeof messages.incomplete === 'object' &&
Expand Down Expand Up @@ -89,14 +90,14 @@ function extender(checksData, shouldBeTrue) {
*/
function publishMetaData(ruleResult) {
// TODO: es-modules_audit
var checksData = axe._audit.data.checks || {};
var rulesData = axe._audit.data.rules || {};
var rule = findBy(axe._audit.rules, 'id', ruleResult.id) || {};
const checksData = axe._audit.data.checks || {};
const rulesData = axe._audit.data.rules || {};
const rule = findBy(axe._audit.rules, 'id', ruleResult.id) || {};

ruleResult.tags = clone(rule.tags || []);

var shouldBeTrue = extender(checksData, true);
var shouldBeFalse = extender(checksData, false);
const shouldBeTrue = extender(checksData, true, rule);
const shouldBeFalse = extender(checksData, false, rule);
ruleResult.nodes.forEach(detail => {
detail.any.forEach(shouldBeTrue);
detail.all.forEach(shouldBeTrue);
Expand Down
104 changes: 104 additions & 0 deletions test/core/utils/publish-metadata.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1136,4 +1136,108 @@ describe('axe.utils.publishMetaData', function() {
});
});
});

it('should use fail message for rules with "reviewOnFaill: true"', function() {
axe._load({
rules: [
{
id: 'cats',
reviewOnFail: true
}
],
data: {
rules: {
cats: {
help: function() {
return 'cats-rule';
}
}
},
checks: {
'cats-NONE': {
messages: {
fail: function() {
return 'fail-NONE';
},
pass: function() {
return 'pass-NONE';
}
}
},
'cats-ANY': {
messages: {
fail: function() {
return 'fail-ANY';
},
pass: function() {
return 'pass-ANY';
}
}
},
'cats-ALL': {
messages: {
fail: function() {
return 'fail-ALL';
},
pass: function() {
return 'pass-ALL';
}
}
}
}
}
});

var result = {
id: 'cats',
nodes: [
{
any: [
{
result: undefined,
id: 'cats-ANY'
}
],
none: [
{
result: undefined,
id: 'cats-NONE'
}
],
all: [
{
result: undefined,
id: 'cats-ALL'
}
]
}
]
};
axe.utils.publishMetaData(result);
assert.deepEqual(result.nodes, [
{
any: [
{
result: undefined,
id: 'cats-ANY',
message: 'fail-ANY'
}
],
none: [
{
result: undefined,
id: 'cats-NONE',
message: 'fail-NONE'
}
],
all: [
{
result: undefined,
id: 'cats-ALL',
message: 'fail-ALL'
}
]
}
]);
});
});