goog.testing.asserts

Provided By	`goog.testing.asserts`

No description available.

VIEW SOURCE

Functions

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Compares two arrays ignoring negative indexes and extra properties on the array objects. Use case: Internet Explorer adds the index, lastIndex and input enumerable fields to the result of string.match(/regexp/g), which makes assertObjectEquals fail.

Parameters

`a`	`*`
	The expected array (2 args) or the debug message (3 args).
`b`	`*`
	The actual array (2 args) or the expected array (3 args).
`opt_c`	`*=`
	The actual array (3 args only).

VIEW SOURCE

Compares two CSS property values to make sure that they represent the same things. This will normalize values in the browser. For example, in Firefox, this assertion will consider "rgb(0, 0, 255)" and "#0000ff" to be identical values for the "color" property. This function won't normalize everything -- for example, in most browsers, "blue" will not match "#0000ff". It is intended only to compensate for unexpected normalizations performed by the browser that should also affect your expected value.

Parameters

`a`	`string`
	Assertion message, or the CSS property name.
`b`	`string`
	CSS property name, or the expected value.
`c`	`string`
	The expected value, or the actual value.
`opt_d`	`string=`
	The actual value.

VIEW SOURCE

Checks if the test value is included in the given container. The container can be a string (where "included" means a substring), an array or any IArrayLike (where "included" means a member), or any type implementing indexOf with similar semantics (returning -1 for not included).

Parameters

`a`	`*`
	Failure message (3 arguments) or the test value (2 arguments).
`b`	`*`
	The test value (3 arguments) or the container (2 arguments).
`opt_c`	`*=`
	The container.

VIEW SOURCE

Compares two objects that can be accessed like an array and assert that each element is equal.

Parameters

`a`	`(string\|Object\|null)`
	Failure message (3 arguments) or object #1 (2 arguments).
`b`	`(Object\|null)`
	Object #2 (2 arguments) or object #1 (3 arguments).
`opt_c`	`(Object\|null)=`
	Object #2 (3 arguments).

VIEW SOURCE

Compares two objects that can be accessed like an array and assert that each element is roughly equal.

Parameters

`a`	`(string\|Object\|null)`
	Failure message (4 arguments) or object #1 (3 arguments).
`b`	`(Object\|null)`
	Object #1 (4 arguments) or object #2 (3 arguments).
`c`	`(Object\|number\|null)`
	Object #2 (4 arguments) or tolerance (3 arguments).
`opt_d`	`number=`
	tolerance (4 arguments).

VIEW SOURCE

Parameters

`a`	`*`
	The expected value (2 args) or the debug message (3 args).
`b`	`*`
	The actual value (2 args) or the expected value (3 args).
`opt_c`	`*=`
	The actual value (3 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Compares two HTML snippets.

Take extra care if attributes are involved. assertHTMLEquals's implementation isn't prepared for complex cases. For example, the following comparisons erroneously fail:

 assertHTMLEquals('', '');
 assertHTMLEquals('', '');
 assertHTMLEquals('', '');

When in doubt, use goog.testing.dom.assertHtmlMatches.

Parameters

`a`	`*`
	The expected value (2 args) or the debug message (3 args).
`b`	`*`
	The actual value (2 args) or the expected value (3 args).
`opt_c`	`*=`
	The actual value (3 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The expected value (2 args) or the debug message (3 args).
`b`	`*`
	The actual value (2 args) or the expected value (3 args).
`opt_c`	`*=`
	The actual value (3 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Checks if the test value is not included in the given container. The container can be a string (where "included" means a substring), an array or any IArrayLike (where "included" means a member), or any type implementing indexOf with similar semantics (returning -1 for not included).

Parameters

`a`	`*`
	Failure message (3 arguments) or the contained element (2 arguments).
`b`	`*`
	The contained element (3 arguments) or the container (2 arguments).
`opt_c`	`*=`
	The container.

VIEW SOURCE

Parameters

`a`	`*`
	The expected value (2 args) or the debug message (3 args).
`b`	`*`
	The actual value (2 args) or the expected value (3 args).
`opt_c`	`*=`
	The actual value (3 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Asserts that the function does not throw an error.

Parameters

`a`	`(string\|Function)`
	The assertion comment or the function to call.
`opt_b`	`Function=`
	The function to call (if the first argument of `assertNotThrows` was the comment).

Returns

*

The return value of the function.

Throws

{goog.testing.JsUnitException} If the assertion failed.

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Notes: Object equality has some nasty browser quirks, and this implementation is not 100% correct. For example,


 var a = [0, 1, 2];
 var b = [0, 1, 2];
 delete a[1];
 b[1] = undefined;
 assertObjectEquals(a, b); // should fail, but currently passes

See asserts_test.html for more interesting edge cases.

The first comparison object provided is the expected value, the second is the actual.

Parameters

`a`	`*`
	Assertion message or comparison object.
`b`	`*`
	Comparison object.
`opt_c`	`*=`
	Comparison object, if an assertion message was provided.

VIEW SOURCE

Compares two arbitrary objects for non-equalness.

All the same caveats as for assertObjectEquals apply here: Undefined values may be confused for missing values, or vice versa.

Parameters

`a`	`*`
	Assertion message or comparison object.
`b`	`*`
	Comparison object.
`opt_c`	`*=`
	Comparison object, if an assertion message was provided.

VIEW SOURCE

Similar to assertObjectEquals above, but accepts a tolerance margin.

Parameters

`a`	`*`
	Assertion message or comparison object.
`b`	`*`
	Comparison object.
`c`	`*`
	Comparison object or tolerance.
`opt_d`	`*=`
	Tolerance, if an assertion message was provided.

VIEW SOURCE

Checks if the given string matches the given regular expression.

Parameters

`a`	`*`
	Failure message (3 arguments) or the expected regular expression as a string or RegExp (2 arguments).
`b`	`*`
	The regular expression (3 arguments) or the string to test (2 arguments).
`opt_c`	`*=`
	The string to test.

VIEW SOURCE

Asserts that the IThenable rejects.

This is useful for asserting that async functions throw, like an asynchronous assertThrows. Example:

  async function shouldThrow() { throw new Error('error!'); }
  async function testShouldThrow() {
    const error = await assertRejects(shouldThrow());
    assertEquals('error!', error.message);
  }

Parameters

`a`	`(string\|IThenable)`
	The assertion comment or the IThenable.
`opt_b`	`IThenable=`
	The IThenable (if the first argument of `assertRejects` was the comment).

Returns

IThenable<*>

A child IThenable which resolves with the error that the passed in IThenable rejects with. This IThenable will reject if the passed in IThenable does not reject.

VIEW SOURCE

Parameters

`a`	`*`
	The expected value (3 args) or the debug message (4 args).
`b`	`*`
	The actual value (3 args) or the expected value (4 args).
`c`	`*`
	The tolerance (3 args) or the actual value (4 args).
`opt_d`	`*=`
	The tolerance (4 args only).

VIEW SOURCE

Compares elements of two array-like or iterable objects using strict equality without taking their order into account.

Parameters

`a`	`(string\|IArrayLike\|Iterable)`
	Assertion message or the expected elements.
`b`	`(IArrayLike\|Iterable)`
	Expected elements or the actual elements.
`opt_c`	`(IArrayLike\|Iterable)=`
	Actual elements.

VIEW SOURCE

Asserts that the function throws an error.

Parameters

`a`	`(string\|Function)`
	The assertion comment or the function to call.
`opt_b`	`Function=`
	The function to call (if the first argument of `assertThrows` was the comment).

Returns

Error

The error thrown by the function. Beware that code may throw other types in strange scenarios.

Throws

{goog.testing.JsUnitException} If the assertion failed.

VIEW SOURCE

Asserts that the given callback function results in a JsUnitException when called, and that the resulting failure message matches the given expected message.

Parameters

`callback`	`function(): undefined`
	Function to be run expected to result in a JsUnitException (usually contains a call to an assert).
`opt_expectedMessage`	`string=`
	Failure message expected to be given with the exception.

Returns

goog.testing.JsUnitException

The error thrown by the function.

Throws

{goog.testing.JsUnitException} If the function did not throw a JsUnitException.

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Parameters

`a`	`*`
	The value to assert (1 arg) or debug message (2 args).
`opt_b`	`*=`
	The value to assert (2 args only).

VIEW SOURCE

Clears the custom equality function currently applied to the given prototype. Returns true if a function was removed.

Parameters

`prototype`	`Object`

Returns

boolean

whether a comparator was removed.

VIEW SOURCE

Parameters

`failureMessage`	`?`

VIEW SOURCE

Determines if two items of any type match, and formulates an error message if not.

Parameters

`expected`	`*`
	Expected argument to match.
`actual`	`*`
	Argument as a result of performing the test.
`opt_equalityPredicate`	`function(string, , ): (string\|null)=`
	An optional function that can be used to check equality of variables. It accepts 3 arguments: type-of-variables, var1, var2 (in that order) and returns an error message if the variables are not equal, goog.testing.asserts.EQUALITY_PREDICATE_VARS_ARE_EQUAL if the variables are equal, or goog.testing.asserts.EQUALITY_PREDICATE_CANT_PROCESS if the predicate couldn't check the input variables. The function will be called only if the types of var1 and var2 are identical.

Returns

(string|null)

Null on success, error message on failure.

VIEW SOURCE

Raises a JsUnit exception with the given comment. If the exception is unexpectedly caught during a unit test, it will be rethrown so that it is seen by the test framework.

Parameters

`comment`	`string`
	A summary for the exception.
`opt_message`	`string=`
	A description of the exception.

VIEW SOURCE

Marks the given prototype as having equality semantics provided by the given custom equality function.

This will cause findDifferences and assertObjectEquals to use the given function when comparing objects with this prototype. When comparing two objects with different prototypes, the equality (if any) attached to their lowest common ancestor in the prototype hierarchy will be used.

Parameters

`prototype`	`Object`

`fn`	`function(?, ?, ?): (string\|null\|undefined)`

VIEW SOURCE

Properties

No information.

VIEW SOURCE

The result of a comparison performed by an EqualityFunction: if undefined, the inputs are equal; otherwise, a human-readable description of their inequality.

VIEW SOURCE

A equality predicate.

The first two arguments are the values to be compared. The third is an equality function which can be used to recursively apply findDifferences.

An example comparison implementation for Array could be:

function arrayEq(a, b, eq) { if (a.length !== b.length) { return "lengths unequal"; }

const differences = []; for (let i = 0; i < a.length; i++) { // Use the findDifferences implementation to perform recursive // comparisons. const diff = eq(a[i], b[i], eq); if (diff) { differences[i] = diff; } }

if (differences) { return found array differences: ${differences}; }

// Otherwise return undefined, indicating no differences. return undefined; }

VIEW SOURCE

goog.testing.asserts

Functions

assert( a, opt_b ) → void

assertArrayEquals( a, b, opt_c ) → void

assertCSSValueEquals( a, b, c, opt_d ) → void

assertContains( a, b, opt_c ) → void

assertElementsEquals( a, b, opt_c ) → void

assertElementsRoughlyEqual( a, b, c, opt_d ) → void

assertEquals( a, b, opt_c ) → void

assertEvaluatesToFalse( a, opt_b ) → void

assertEvaluatesToTrue( a, opt_b ) → void

assertFalse( a, opt_b ) → void

assertHTMLEquals( a, b, opt_c ) → void

assertHashEquals( a, b, opt_c ) → void

assertNaN( a, opt_b ) → void

assertNonEmptyString( a, opt_b ) → void

assertNotContains( a, b, opt_c ) → void

assertNotEquals( a, b, opt_c ) → void

assertNotNaN( a, opt_b ) → void

assertNotNull( a, opt_b ) → void

assertNotNullNorUndefined( a, opt_b ) → void

assertNotThrows( a, opt_b ) → *

assertNotUndefined( a, opt_b ) → void

assertNull( a, opt_b ) → void

assertNullOrUndefined( a, opt_b ) → void

assertObjectEquals( a, b, opt_c ) → void

assertObjectNotEquals( a, b, opt_c ) → void

assertObjectRoughlyEquals( a, b, c, opt_d ) → void

assertRegExp( a, b, opt_c ) → void

assertRejects( a, opt_b ) → IThenable<*>

assertRoughlyEquals( a, b, c, opt_d ) → void

assertSameElements( a, b, opt_c ) → void

assertThrows( a, opt_b ) → Error

assertThrowsJsUnitException( callback, opt_expectedMessage ) → goog.testing.JsUnitException

assertTrue( a, opt_b ) → void

assertUndefined( a, opt_b ) → void

clearCustomComparator( prototype ) → boolean

fail( failureMessage ) → void

findDifferences( expected, actual, opt_equalityPredicate ) → (string|null)

raiseException( comment, opt_message ) → void

registerComparator( prototype, fn ) → void

Properties

ARRAY_TYPES → Object<string, boolean>

ComparisonResult → (string|undefined)

EqualityFunction → function(?, ?, function(?, ?, ?): (string|null|undefined)): (string|null|undefined)

assert( `a`, `opt_b` ) `→` `void`

assertArrayEquals( `a`, `b`, `opt_c` ) `→` `void`

assertCSSValueEquals( `a`, `b`, `c`, `opt_d` ) `→` `void`

assertContains( `a`, `b`, `opt_c` ) `→` `void`

assertElementsEquals( `a`, `b`, `opt_c` ) `→` `void`

assertElementsRoughlyEqual( `a`, `b`, `c`, `opt_d` ) `→` `void`

assertEquals( `a`, `b`, `opt_c` ) `→` `void`

assertEvaluatesToFalse( `a`, `opt_b` ) `→` `void`

assertEvaluatesToTrue( `a`, `opt_b` ) `→` `void`

assertFalse( `a`, `opt_b` ) `→` `void`

assertHTMLEquals( `a`, `b`, `opt_c` ) `→` `void`

assertHashEquals( `a`, `b`, `opt_c` ) `→` `void`

assertNaN( `a`, `opt_b` ) `→` `void`

assertNonEmptyString( `a`, `opt_b` ) `→` `void`

assertNotContains( `a`, `b`, `opt_c` ) `→` `void`

assertNotEquals( `a`, `b`, `opt_c` ) `→` `void`

assertNotNaN( `a`, `opt_b` ) `→` `void`

assertNotNull( `a`, `opt_b` ) `→` `void`

assertNotNullNorUndefined( `a`, `opt_b` ) `→` `void`

assertNotThrows( `a`, `opt_b` ) `→` `*`

assertNotUndefined( `a`, `opt_b` ) `→` `void`

assertNull( `a`, `opt_b` ) `→` `void`

assertNullOrUndefined( `a`, `opt_b` ) `→` `void`

assertObjectEquals( `a`, `b`, `opt_c` ) `→` `void`

assertObjectNotEquals( `a`, `b`, `opt_c` ) `→` `void`

assertObjectRoughlyEquals( `a`, `b`, `c`, `opt_d` ) `→` `void`

assertRegExp( `a`, `b`, `opt_c` ) `→` `void`

assertRejects( `a`, `opt_b` ) `→` `IThenable<*>`

assertRoughlyEquals( `a`, `b`, `c`, `opt_d` ) `→` `void`

assertSameElements( `a`, `b`, `opt_c` ) `→` `void`

assertThrows( `a`, `opt_b` ) `→` `Error`

assertThrowsJsUnitException( `callback`, `opt_expectedMessage` ) `→` `goog.testing.JsUnitException`

assertTrue( `a`, `opt_b` ) `→` `void`

assertUndefined( `a`, `opt_b` ) `→` `void`

clearCustomComparator( `prototype` ) `→` `boolean`

fail( `failureMessage` ) `→` `void`

findDifferences( `expected`, `actual`, `opt_equalityPredicate` ) `→` `(string|null)`

raiseException( `comment`, `opt_message` ) `→` `void`

registerComparator( `prototype`, `fn` ) `→` `void`

ARRAY_TYPES `→` `Object<string, boolean>`

ComparisonResult `→` `(string|undefined)`

EqualityFunction `→` `function(?, ?, function(?, ?, ?): (string|null|undefined)): (string|null|undefined)`