fix: add noHtml to axe.configure

Author: straker

axe.d.ts

@@ -79,7 +79,8 @@ declare module axe {
 		},
 		reporter?: ReporterVersion,
 		checks?: Check[],
-		rules?: Rule[]
+		rules?: Rule[],
+		noHtml?: boolean
 	}
 	interface Check {
 		id: string,

doc/API.md

@@ -145,7 +145,8 @@ axe.configure({
   },
   reporter: "option",
   checks: [Object],
-  rules: [Object]});
+  rules: [Object],
+  noHtml: Boolean});
 ```
 
 #### Parameters
@@ -179,6 +180,7 @@ axe.configure({
       * `tags` - array(optional, default `[]`). A list if the tags that "classify" the rule. In practice, you must supply some valid tags or the default evaluation will not invoke the rule. The convention is to include the standard (WCAG 2 and/or section 508), the WCAG 2 level, Section 508 paragraph, and the WCAG 2 success criteria. Tags are constructed by converting all letters to lower case, removing spaces and periods and concatinating the result. E.g. WCAG 2 A success criteria 1.1.1 would become ["wcag2a", "wcag111"]
       * `matches` - string(optional, default `*`). A filtering CSS selector that will exclude elements that do not match the CSS selector.
   * `disableOtherRules` - Disables all rules not included in the `rules` property.
+  * `noHtml` - Disables the HTML output of nodes from rules.
 
 **Returns:** Nothing
 

lib/core/base/audit.js

@@ -14,6 +14,7 @@ function getDefaultConfiguration(audit) {
 	}
 
 	config.reporter = config.reporter || null;
+	config.noHtml = config.noHtml || false;
 	config.rules = config.rules || [];
 	config.checks = config.checks || [];
 	config.data = Object.assign({
@@ -58,7 +59,7 @@ Audit.prototype._init = function () {
 	this.commands = {};
 	this.rules = [];
 	this.checks = {};
-
+	this.noHtml = audit.noHtml;
 	unpackToObject(audit.rules, this, 'addRule');
 	unpackToObject(audit.checks, this, 'addCheck');
 

lib/core/public/configure.js

@@ -1,6 +1,6 @@
 /* global reporters */
 function configureChecksRulesAndBranding(spec) {
-	 /*eslint max-statements: ["error",20]*/
+	 /*eslint max-statements: ["error",21]*/
 	'use strict';
 	var audit;
 
@@ -44,6 +44,10 @@ function configureChecksRulesAndBranding(spec) {
 	if (spec.tagExclude) {
 		audit.tagExclude = spec.tagExclude;
 	}
+
+	if (spec.noHtml) {
+		audit.noHtml = true;
+	}
 }
 
 axe.configure = configureChecksRulesAndBranding;

lib/core/utils/dq-element.js

@@ -37,7 +37,13 @@ function DqElement(element, options, spec) {
 	 * The generated HTML source code of the element
 	 * @type {String}
 	 */
-	this.source = this.spec.source !== undefined ? this.spec.source : getSource(element);
+	if (axe._audit && axe._audit.noHtml) {
+		this.source = null;
+	} else if (this.spec.source !== undefined) {
+		this.source = this.spec.source;
+	} else {
+		this.source = getSource(element);
+	}
 
 	/**
 	 * The element which this object is based off or the containing frame, used for sorting.

package.json

@@ -99,6 +99,5 @@
     "selenium-webdriver": "~3.6.0",
     "sri-toolbox": "^0.2.0",
     "standard-version": "^4.2.0"
-  },
-  "dependencies": {}
+  }
 }

test/core/base/audit.js

@@ -76,6 +76,13 @@ describe('Audit', function () {
 		assert.isFunction(Audit);
 	});
 
+	describe('defaults', function() {
+		it('should set noHtml', function() {
+			var audit = new Audit();
+			assert.isFalse(audit.noHtml);
+		});
+	});
+
 	describe('Audit#_constructHelpUrls', function () {
 		it('should create default help URLS', function () {
 			var audit = new Audit();
@@ -337,6 +344,13 @@ describe('Audit', function () {
 			audit.resetRulesAndChecks();
 			assert.equal(audit.checks.target, undefined);
 		});
+
+		it('should reset noHtml', function() {
+			var audit = new Audit();
+			audit.noHtml = true;
+			audit.resetRulesAndChecks();
+			assert.isFalse(audit.noHtml);
+		});
 	});
 
 	describe('Audit#addCheck', function () {

test/core/public/configure.js

@@ -222,4 +222,12 @@ describe('axe.configure', function() {
 		assert.equal(axe._audit.rules[3].id, 'black-panther');
 		assert.equal(axe._audit.rules[3].enabled, true);
 	});
+
+	it('should allow overriding an audit\'s noHtml', function() {
+		axe._load({});
+		assert.isFalse(axe._audit.noHtml);
+
+		axe.configure({ noHtml: true });
+		assert.isTrue(axe._audit.noHtml);
+	});
 });

test/core/utils/dq-element.js

@@ -5,6 +5,10 @@ describe('DqElement', function () {
 	var fixture = document.getElementById('fixture');
 	var fixtureSetup = axe.testUtils.fixtureSetup;
 
+	beforeEach(function() {
+		axe._load({});
+	});
+
 	afterEach(function () {
 		fixture.innerHTML = '';
 		axe._tree = undefined;
@@ -82,6 +86,26 @@ describe('DqElement', function () {
 			});
 			assert.equal(result.source, 'woot');
 		});
+
+		it('should return null if audit.noHtml is set', function() {
+			axe.configure({ noHtml: true });
+			fixture.innerHTML = '<div class="bar" id="foo">Hello!</div>';
+			var result = new DqElement(fixture.firstChild);
+			assert.isNull(result.source);
+		});
+
+		it('should not use spec object over passed element if audit.noHtml is set', function() {
+			axe.configure({ noHtml: true });
+			fixture.innerHTML = '<div id="foo" class="bar">Hello!</div>';
+			var result = new DqElement(
+				fixture.firstChild,
+				{},
+				{
+					source: 'woot'
+				}
+			);
+			assert.isNull(result.source);
+		});
 	});
 
 	describe('selector', function () {

test/integration/full/configure-options/configure-options.js

@@ -1,13 +1,15 @@
 describe('Configure Options', function() {
 	'use strict';
 
+	var target = document.querySelector('#target');
+
 	afterEach(function () {
 		axe.reset();
+		target.innerHTML = '';
 	});
 
 	describe('Check', function() {
 
-		var target = document.querySelector('#target');
 		describe('aria-allowed-attr', function() {
 			it('should allow an attribute supplied in options', function(done) {
 				target.setAttribute('role', 'separator');
@@ -21,9 +23,9 @@ describe('Configure Options', function() {
 				});
 				axe.run(target, {
 					runOnly: {
-				    type: 'rule',
-				    values: [ 'aria-allowed-attr' ]
-				  }
+						type: 'rule',
+						values: [ 'aria-allowed-attr' ]
+					}
 				}, function(error, results) {
 					assert.lengthOf(results.violations, 0, 'violations');
 					done();
@@ -42,9 +44,9 @@ describe('Configure Options', function() {
 				});
 				axe.run('#target',  {
 					runOnly: {
-				    type: 'rule',
-				    values: [ 'aria-required-attr' ]
-				  }
+						type: 'rule',
+						values: [ 'aria-required-attr' ]
+					}
 				}, function(error, results) {
 					assert.lengthOf(results.violations, 1, 'violations');
 					assert.sameMembers(results.violations[0].nodes[0].any[0].data, ['aria-valuemax', 'aria-valuemin', 'aria-snuggles']);
@@ -54,8 +56,8 @@ describe('Configure Options', function() {
 		});
 	});
 
-	describe('disableOtherRules', function (done) {
-		it('disables rules that are not in the `rules` array', function () {
+	describe('disableOtherRules', function () {
+		it('disables rules that are not in the `rules` array', function (done) {
 			axe.configure({
 				disableOtherRules: true,
 				rules: [{
@@ -79,4 +81,115 @@ describe('Configure Options', function() {
 			});
 		});
 	});
+
+	describe('noHtml', function() {
+		it('prevents html property on nodes', function(done) {
+			target.setAttribute('role', 'slider');
+			axe.configure({
+				noHtml: true,
+				checks: [
+					{
+						id: 'aria-required-attr',
+						options: { slider: ['aria-snuggles'] }
+					}
+				]
+			});
+			axe.run(
+				'#target',
+				{
+					runOnly: {
+						type: 'rule',
+						values: ['aria-required-attr']
+					}
+				},
+				function(error, results) {
+					try {
+						assert.isNull(results.violations[0].nodes[0].html);
+						done();
+					} catch (e) {
+						done(e);
+					}
+				}
+			);
+		});
+
+		it('prevents html property on nodes from iframes', function(done) {
+			axe.configure({
+				noHtml: true,
+				rules: [
+					{
+						id: 'div#target',
+						// purposefully don't match so the first result is from
+						// the iframe
+						selector: 'foo'
+					}
+				]
+			});
+
+			var iframe = document.createElement('iframe');
+			iframe.src = '/test/mock/frames/context.html';
+			iframe.onload = function() {
+				axe.run(
+					'#target',
+					{
+						runOnly: {
+							type: 'rule',
+							values: ['div#target']
+						}
+					},
+					function(error, results) {
+						try {
+							assert.deepEqual(results.passes[0].nodes[0].target, [
+								'iframe',
+								'#target'
+							]);
+							assert.isNull(results.passes[0].nodes[0].html);
+							done();
+						} catch (e) {
+							done(e);
+						}
+					}
+				);
+			};
+			target.appendChild(iframe);
+		});
+
+		it('prevents html property in postMesage', function(done) {
+			axe.configure({
+				noHtml: true,
+				rules: [
+					{
+						id: 'div#target',
+						// purposefully don't match so the first result is from
+						// the iframe
+						selector: 'foo'
+					}
+				]
+			});
+
+			var iframe = document.createElement('iframe');
+			iframe.src = '/test/mock/frames/noHtml-config.html';
+			iframe.onload = function() {
+				axe.run('#target', {
+					runOnly: {
+						type: 'rule',
+						values: ['div#target']
+					}
+				});
+			};
+			target.appendChild(iframe);
+
+			window.addEventListener('message', function(e) {
+				var data = JSON.parse(e.data);
+				if (Array.isArray(data.message)) {
+					try {
+						assert.isNull(data.message[0].nodes[0].node.source);
+						done();
+					} catch (e) {
+						done(e);
+					}
+				}
+			});
+		});
+	});
 });