google-closure-library
Version:
Google's common JavaScript library
360 lines (302 loc) • 9.75 kB
JavaScript
/**
* @license
* Copyright The Closure Library Authors.
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Provides test helpers for Soy tests.
*/
goog.provide('goog.soy.testHelper');
goog.setTestOnly('goog.soy.testHelper');
goog.require('goog.dom');
goog.require('goog.dom.TagName');
goog.require('goog.i18n.bidi.Dir');
goog.require('goog.soy.data.SanitizedContent');
goog.require('goog.soy.data.SanitizedContentKind');
goog.require('goog.soy.data.SanitizedCss');
goog.require('goog.soy.data.SanitizedTrustedResourceUri');
goog.require('goog.string');
goog.require('goog.testing.asserts');
goog.require('goog.userAgent');
/**
* Instantiable subclass of SanitizedContent.
*
* This is a spoof for sanitized content that isn't robust enough to get
* through Soy's escaping functions but is good enough for the checks here.
*
* @constructor
* @param {string} content The text.
* @param {goog.soy.data.SanitizedContentKind} kind The kind of safe content.
* @extends {goog.soy.data.SanitizedContent}
*/
function SanitizedContentSubclass(content, kind) {
// IMPORTANT! No superclass chaining to avoid exception being thrown.
this.content = content;
this.contentKind = kind;
}
goog.inherits(SanitizedContentSubclass, goog.soy.data.SanitizedContent);
/**
* Instantiable subclass of SanitizedCss.
* @param {string} content
* @constructor
* @extends {goog.soy.data.SanitizedCss}
*/
function SanitizedCssSubclass(content) {
// IMPORTANT! No superclass chaining to avoid exception being thrown.
this.content = content;
this.contentKind = goog.soy.data.SanitizedContentKind.CSS;
}
goog.inherits(SanitizedCssSubclass, goog.soy.data.SanitizedCss);
/**
* @param {string} content The text.
* @param {goog.soy.data.SanitizedContentKind|string} kind The kind of safe
* content.
* @return {!SanitizedContentSubclass}
*/
function makeSanitizedContent(content, kind) {
return new SanitizedContentSubclass(
content,
/** @type {goog.soy.data.SanitizedContentKind} */ (kind));
}
/**
* Instantiable subclass of SanitizedTrustedResourceUri.
*
* This is a spoof for trusted resource URI that isn't robust enough to get
* through Soy's escaping functions but is good enough for the checks here.
*
* @param {string} content The URI.
* @constructor
* @extends {goog.soy.data.SanitizedTrustedResourceUri}
* @final
*/
function SanitizedTrustedResourceUriSubclass(content) {
// IMPORTANT! No superclass chaining to avoid exception being thrown.
this.content = content;
this.contentKind = goog.soy.data.SanitizedContentKind.TRUSTED_RESOURCE_URI;
}
goog.inherits(
SanitizedTrustedResourceUriSubclass,
goog.soy.data.SanitizedTrustedResourceUri);
//
// Fake Soy-generated template functions.
//
const example = {};
/**
* @param {{name: string}} data
* @param {?Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedContent}
*/
example.textNodeTemplate = function(data, opt_injectedData) {
'use strict';
assertNotNull(data);
assertNotUndefined(data);
return makeSanitizedContent(
goog.string.htmlEscape(data.name),
goog.soy.data.SanitizedContentKind.HTML);
};
/**
* @param {{name: string}} data
* @param {?Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedContent}
*/
example.singleRootTemplate = function(data, opt_injectedData) {
'use strict';
assertNotNull(data);
assertNotUndefined(data);
return makeSanitizedContent(
'<span>' + goog.string.htmlEscape(data.name) + '</span>',
goog.soy.data.SanitizedContentKind.HTML);
};
/**
* @param {{name: string}} data
* @param {?Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedContent}
*/
example.multiRootTemplate = function(data, opt_injectedData) {
'use strict';
assertNotNull(data);
assertNotUndefined(data);
return makeSanitizedContent(
'<div>Hello</div><div>' + goog.string.htmlEscape(data.name) + '</div>',
goog.soy.data.SanitizedContentKind.HTML);
};
/**
* @param {{name: string}} data
* @param {?Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedContent}
* @suppress {strictMissingProperties} Added to tighten compiler checks
*/
example.injectedDataTemplate = function(data, opt_injectedData) {
'use strict';
assertNotNull(data);
assertNotUndefined(data);
return makeSanitizedContent(
goog.string.htmlEscape(data.name) +
goog.string.htmlEscape(opt_injectedData.name),
goog.soy.data.SanitizedContentKind.HTML);
};
/**
* @param {{name: string}} data
* @param {Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedContent}
*/
example.noDataTemplate = function(data, opt_injectedData) {
'use strict';
assertNotNull(data);
assertNotUndefined(data);
return makeSanitizedContent(
'<div>Hello</div>', goog.soy.data.SanitizedContentKind.HTML);
};
/**
* @param {{name: string}} data
* @param {Object<string, *>=} opt_injectedData
* @return {!SanitizedContentSubclass}
*/
example.sanitizedHtmlTemplate = function(data, opt_injectedData) {
'use strict';
// Test the SanitizedContent constructor.
const sanitized = makeSanitizedContent(
'Hello <b>World</b>', goog.soy.data.SanitizedContentKind.HTML);
sanitized.contentDir = goog.i18n.bidi.Dir.LTR;
return sanitized;
};
/**
* @param {{name: string}} data
* @param {Object<string, *>=} opt_injectedData
* @return {!SanitizedContentSubclass}
*/
example.sanitizedHtmlAttributesTemplate = function(data, opt_injectedData) {
'use strict';
return makeSanitizedContent(
'foo="bar"', goog.soy.data.SanitizedContentKind.ATTRIBUTES);
};
/**
* @param {{name: string}} data
* @param {?Object<string, *>=} opt_injectedData
* @return {!SanitizedContentSubclass}
*/
example.sanitizedSmsUrlTemplate = function(data, opt_injectedData) {
'use strict';
// Test the SanitizedContent constructor.
const sanitized = makeSanitizedContent(
'sms:123456789', goog.soy.data.SanitizedContentKind.URI);
return sanitized;
};
/**
* @param {{name: string}} data
* @param {?Object<string, *>=} opt_injectedData
* @return {!SanitizedContentSubclass}
*/
example.sanitizedHttpUrlTemplate = function(data, opt_injectedData) {
'use strict';
// Test the SanitizedContent constructor.
const sanitized = makeSanitizedContent(
'https://google.com/foo?n=917', goog.soy.data.SanitizedContentKind.URI);
return sanitized;
};
/**
* @param {{name: string}} data
* @param {?Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedTrustedResourceUri}
*/
example.sanitizedTrustedResourceUriTemplate = function(data, opt_injectedData) {
'use strict';
return new SanitizedTrustedResourceUriSubclass('https://google.com/a.js');
};
/**
* @param {!Object<string, *>} data
* @param {Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedCss}
*/
example.sanitizedCssTemplate = function(data, opt_injectedData) {
'use strict';
return new SanitizedCssSubclass('html{display:none}');
};
/**
* @param {!Object<string, *>} data
* @param {!Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedCss}
*/
example.sanitizedStyleTemplate = function(data, opt_injectedData) {
'use strict';
return new SanitizedCssSubclass('display:none;');
};
/**
* @param {{name: string}} data
* @param {Object<string, *>=} opt_injectedData
* @return {string}
*/
example.stringTemplate = function(data, opt_injectedData) {
'use strict';
return '<b>XSS</b>';
};
/**
* @param {{name: string}} data
* @param {?Object<string, *>=} opt_injectedData
* @return {!SanitizedContentSubclass}
*/
example.sanitizedUriTemplate = function(data, opt_injectedData) {
'use strict';
return makeSanitizedContent(
'https://example.com', goog.soy.data.SanitizedContentKind.URI);
};
/**
* @param {{name: string}} data
* @param {Object<string, *>=} opt_injectedData
* @return {!SanitizedContentSubclass}
*/
example.templateSpoofingSanitizedContentString = function(
data, opt_injectedData) {
'use strict';
return makeSanitizedContent(
'Hello World',
// This is to ensure we're using triple-equals against a unique JavaScript
// object. For example, in JavaScript, consider ({}) == '[Object object]'
// is true.
goog.soy.data.SanitizedContentKind.HTML.toString());
};
/**
* @param {{name: string}} data
* @param {Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedContent}
*/
example.tableRowTemplate = function(data, opt_injectedData) {
'use strict';
return makeSanitizedContent(
'<tr><td></td></tr>', goog.soy.data.SanitizedContentKind.HTML);
};
/**
* @param {{name: string}} data
* @param {Object<string, *>=} opt_injectedData
* @return {!goog.soy.data.SanitizedContent}
*/
example.colGroupTemplateCaps = function(data, opt_injectedData) {
'use strict';
return makeSanitizedContent(
'<COLGROUP></COLGROUP>', goog.soy.data.SanitizedContentKind.HTML);
};
//
// Test helper functions.
//
/**
* Retrieves the content of document fragment as HTML.
* @param {Node} fragment The document fragment.
* @return {string} Content of the document fragment as HTML.
*/
function fragmentToHtml(fragment) {
const testDiv = goog.dom.createElement(goog.dom.TagName.DIV);
testDiv.appendChild(fragment);
return elementToInnerHtml(testDiv);
}
/**
* Retrieves the content of an element as HTML.
* @param {Element} elem The element.
* @return {string} Content of the element as HTML.
*/
function elementToInnerHtml(elem) {
let innerHtml = elem.innerHTML;
if (goog.userAgent.IE) {
innerHtml = innerHtml.replace(/DIV/g, 'div').replace(/\s/g, '');
}
return innerHtml;
}