diff --git a/.eslintrc.yml b/.eslintrc.yml index 45be857..c6ef6ab 100644 --- a/.eslintrc.yml +++ b/.eslintrc.yml @@ -223,12 +223,13 @@ globals: ARGV: readonly Debugger: readonly GIRepositoryGType: readonly + globalThis: readonly imports: readonly Intl: readonly log: readonly logError: readonly print: readonly printerr: readonly - window: readonly parserOptions: ecmaVersion: 2020 + sourceType: module diff --git a/bin/jasmine-runner.in b/bin/jasmine-runner.in index 6432613..bd2efe5 100755 --- a/bin/jasmine-runner.in +++ b/bin/jasmine-runner.in @@ -1,8 +1,8 @@ -#!/usr/bin/env gjs +#!/usr/bin/env -S gjs -m /* global jasmineImporter */ -const {GLib} = imports.gi; +import GLib from 'gi://GLib'; // Create a separate GJS importer object for Jasmine modules, so that Jasmine's // modules are not exposed to test code (e.g. client code might have its own @@ -13,30 +13,29 @@ const {GLib} = imports.gi; // registers a GType, and we cannot register two GTypes with the same name in // the same process. +let base; if (GLib.getenv('JASMINE_UNINSTALLED')) { // Trick to use the uninstalled copy of Jasmine when running "make check". const srcdir = GLib.getenv('SRCDIR'); - window.jasmineImporter = imports['.']; + globalThis.jasmineImporter = imports['.']; jasmineImporter.searchPath = [ - GLib.build_filenamev([srcdir, 'src']), GLib.build_filenamev([srcdir, 'lib']), ]; + base = `file://${GLib.build_filenamev([srcdir, 'src'])}`; } else { const oldSearchPath = imports.searchPath.slice(); // make a copy imports.searchPath.unshift('@datadir@'); - window.jasmineImporter = imports['jasmine-gjs']; + globalThis.jasmineImporter = imports['jasmine-gjs']; imports.searchPath = oldSearchPath; + base = 'file://@datadir@/jasmine-gjs'; } -const Command = jasmineImporter.command; -const Timer = jasmineImporter.timer; -const JasmineBoot = jasmineImporter.jasmineBoot; - -Timer.installAPI(window); +const Command = await import(`${base}/command.js`); +const JasmineBoot = await import(`${base}/jasmineBoot.js`); // Do not conflict with global "jasmine" object const _jasmine = new JasmineBoot.Jasmine(); -_jasmine.installAPI(window); +_jasmine.installAPI(globalThis); // Don't put any code after this; the return value is used as the exit code. -Command.run(_jasmine, ARGV, 10); +await Command.run(_jasmine, ARGV, 10); diff --git a/bin/jasmine.in b/bin/jasmine.in index 1f0953a..fa3be3a 100755 --- a/bin/jasmine.in +++ b/bin/jasmine.in @@ -1,21 +1,22 @@ -#!/usr/bin/env gjs +#!/usr/bin/env -S gjs -m -const {GLib} = imports.gi; -const System = imports.system; +import GLib from 'gi://GLib'; +import * as System from 'system'; let runnerPath = '@pkglibexecdir@/jasmine-runner'; +let base; if (GLib.getenv('JASMINE_UNINSTALLED')) { // Trick to use the uninstalled copy of Jasmine when running "make check". const srcdir = GLib.getenv('SRCDIR'); - imports.searchPath.unshift(GLib.build_filenamev([srcdir, 'src'])); + base = `file://${GLib.build_filenamev([srcdir, 'src'])}`; const builddir = GLib.getenv('BUILDDIR'); runnerPath = GLib.build_filenamev([builddir, 'jasmine-runner']); } else { - imports.searchPath.unshift('@datadir@/jasmine-gjs'); + base = 'file://@datadir@/jasmine-gjs'; } -const Config = imports.config; -const Options = imports.options; +const Config = await import(`${base}/config.js`); +const Options = await import(`${base}/options.js`); const [files, options] = Options.parseOptions(ARGV); diff --git a/lib/jasmine.js b/lib/jasmine.js index c0c147a..007712b 100644 --- a/lib/jasmine.js +++ b/lib/jasmine.js @@ -1,6 +1,6 @@ /* jscs:disable */ /* -Copyright (c) 2008-2017 Pivotal Labs +Copyright (c) 2008-2021 Pivotal Labs Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -21,10 +21,15 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ -var getJasmineRequireObj = (function (jasmineGlobal) { +// eslint-disable-next-line no-unused-vars +var getJasmineRequireObj = (function(jasmineGlobal) { var jasmineRequire; - if (typeof module !== 'undefined' && module.exports && typeof exports !== 'undefined') { + if ( + typeof module !== 'undefined' && + module.exports && + typeof exports !== 'undefined' + ) { if (typeof global !== 'undefined') { jasmineGlobal = global; } else { @@ -32,10 +37,14 @@ var getJasmineRequireObj = (function (jasmineGlobal) { } jasmineRequire = exports; } else { - if (typeof window !== 'undefined' && typeof window.toString === 'function' && window.toString() === '[object GjsGlobal]') { + if ( + typeof window !== 'undefined' && + typeof window.toString === 'function' && + window.toString() === '[object GjsGlobal]' + ) { jasmineGlobal = window; } - jasmineRequire = jasmineGlobal.jasmineRequire = jasmineGlobal.jasmineRequire || {}; + jasmineRequire = jasmineGlobal.jasmineRequire = {}; } function getJasmineRequire() { @@ -46,7 +55,7 @@ var getJasmineRequireObj = (function (jasmineGlobal) { var j$ = {}; jRequire.base(j$, jasmineGlobal); - j$.util = jRequire.util(); + j$.util = jRequire.util(j$); j$.errors = jRequire.errors(); j$.formatErrorMsg = jRequire.formatErrorMsg(); j$.Any = jRequire.Any(j$); @@ -55,23 +64,41 @@ var getJasmineRequireObj = (function (jasmineGlobal) { j$.MockDate = jRequire.MockDate(); j$.getClearStack = jRequire.clearStack(j$); j$.Clock = jRequire.Clock(); - j$.DelayedFunctionScheduler = jRequire.DelayedFunctionScheduler(); + j$.DelayedFunctionScheduler = jRequire.DelayedFunctionScheduler(j$); j$.Env = jRequire.Env(j$); - j$.ExceptionFormatter = jRequire.ExceptionFormatter(); - j$.Expectation = jRequire.Expectation(); - j$.buildExpectationResult = jRequire.buildExpectationResult(); - j$.JsApiReporter = jRequire.JsApiReporter(); - j$.matchersUtil = jRequire.matchersUtil(j$); + j$.StackTrace = jRequire.StackTrace(j$); + j$.ExceptionFormatter = jRequire.ExceptionFormatter(j$); + j$.ExpectationFilterChain = jRequire.ExpectationFilterChain(); + j$.Expector = jRequire.Expector(j$); + j$.Expectation = jRequire.Expectation(j$); + j$.buildExpectationResult = jRequire.buildExpectationResult(j$); + j$.JsApiReporter = jRequire.JsApiReporter(j$); + j$.asymmetricEqualityTesterArgCompatShim = jRequire.asymmetricEqualityTesterArgCompatShim( + j$ + ); + j$.makePrettyPrinter = jRequire.makePrettyPrinter(j$); + j$.pp = j$.makePrettyPrinter(); + j$.MatchersUtil = jRequire.MatchersUtil(j$); + j$.matchersUtil = new j$.MatchersUtil({ + customTesters: [], + pp: j$.pp + }); + j$.ObjectContaining = jRequire.ObjectContaining(j$); j$.ArrayContaining = jRequire.ArrayContaining(j$); - j$.pp = jRequire.pp(j$); + j$.ArrayWithExactContents = jRequire.ArrayWithExactContents(j$); + j$.MapContaining = jRequire.MapContaining(j$); + j$.SetContaining = jRequire.SetContaining(j$); j$.QueueRunner = jRequire.QueueRunner(j$); - j$.ReportDispatcher = jRequire.ReportDispatcher(); + j$.ReportDispatcher = jRequire.ReportDispatcher(j$); j$.Spec = jRequire.Spec(j$); j$.Spy = jRequire.Spy(j$); + j$.SpyFactory = jRequire.SpyFactory(j$); j$.SpyRegistry = jRequire.SpyRegistry(j$); j$.SpyStrategy = jRequire.SpyStrategy(j$); j$.StringMatching = jRequire.StringMatching(j$); + j$.StringContaining = jRequire.StringContaining(j$); + j$.UserContext = jRequire.UserContext(j$); j$.Suite = jRequire.Suite(j$); j$.Timer = jRequire.Timer(); j$.TreeProcessor = jRequire.TreeProcessor(); @@ -80,9 +107,16 @@ var getJasmineRequireObj = (function (jasmineGlobal) { j$.DiffBuilder = jRequire.DiffBuilder(j$); j$.NullDiffBuilder = jRequire.NullDiffBuilder(j$); j$.ObjectPath = jRequire.ObjectPath(j$); + j$.MismatchTree = jRequire.MismatchTree(j$); j$.GlobalErrors = jRequire.GlobalErrors(j$); + j$.Truthy = jRequire.Truthy(j$); + j$.Falsy = jRequire.Falsy(j$); + j$.Empty = jRequire.Empty(j$); + j$.NotEmpty = jRequire.NotEmpty(j$); + j$.matchers = jRequire.requireMatchers(jRequire, j$); + j$.asyncMatchers = jRequire.requireAsyncMatchers(jRequire, j$); return j$; }; @@ -92,9 +126,12 @@ var getJasmineRequireObj = (function (jasmineGlobal) { getJasmineRequireObj().requireMatchers = function(jRequire, j$) { var availableMatchers = [ + 'nothing', 'toBe', 'toBeCloseTo', 'toBeDefined', + 'toBeInstanceOf', + 'toBeFalse', 'toBeFalsy', 'toBeGreaterThan', 'toBeGreaterThanOrEqual', @@ -104,17 +141,22 @@ getJasmineRequireObj().requireMatchers = function(jRequire, j$) { 'toBeNegativeInfinity', 'toBeNull', 'toBePositiveInfinity', + 'toBeTrue', 'toBeTruthy', 'toBeUndefined', 'toContain', 'toEqual', + 'toHaveSize', 'toHaveBeenCalled', 'toHaveBeenCalledBefore', + 'toHaveBeenCalledOnceWith', 'toHaveBeenCalledTimes', 'toHaveBeenCalledWith', + 'toHaveClass', 'toMatch', 'toThrow', - 'toThrowError' + 'toThrowError', + 'toThrowMatching' ], matchers = {}; @@ -135,19 +177,52 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { * Maximum object depth the pretty printer will print to. * Set this to a lower value to speed up pretty printing if you have large objects. * @name jasmine.MAX_PRETTY_PRINT_DEPTH + * @default 8 + * @since 1.3.0 */ - j$.MAX_PRETTY_PRINT_DEPTH = 40; + j$.MAX_PRETTY_PRINT_DEPTH = 8; /** * Maximum number of array elements to display when pretty printing objects. + * This will also limit the number of keys and values displayed for an object. * Elements past this number will be ellipised. * @name jasmine.MAX_PRETTY_PRINT_ARRAY_LENGTH + * @default 50 + * @since 2.7.0 + */ + j$.MAX_PRETTY_PRINT_ARRAY_LENGTH = 50; + /** + * Maximum number of characters to display when pretty printing objects. + * Characters past this number will be ellipised. + * @name jasmine.MAX_PRETTY_PRINT_CHARS + * @default 100 + * @since 2.9.0 */ - j$.MAX_PRETTY_PRINT_ARRAY_LENGTH = 100; + j$.MAX_PRETTY_PRINT_CHARS = 1000; /** - * Default number of milliseconds Jasmine will wait for an asynchronous spec to complete. + * Default number of milliseconds Jasmine will wait for an asynchronous spec, + * before, or after function to complete. This can be overridden on a case by + * case basis by passing a time limit as the third argument to {@link it}, + * {@link beforeEach}, {@link afterEach}, {@link beforeAll}, or + * {@link afterAll}. The value must be no greater than the largest number of + * milliseconds supported by setTimeout, which is usually 2147483647. + * + * While debugging tests, you may want to set this to a large number (or pass + * a large number to one of the functions mentioned above) so that Jasmine + * does not move on to after functions or the next spec while you're debugging. * @name jasmine.DEFAULT_TIMEOUT_INTERVAL + * @default 5000 + * @since 1.3.0 */ - j$.DEFAULT_TIMEOUT_INTERVAL = 5000; + var DEFAULT_TIMEOUT_INTERVAL = 5000; + Object.defineProperty(j$, 'DEFAULT_TIMEOUT_INTERVAL', { + get: function() { + return DEFAULT_TIMEOUT_INTERVAL; + }, + set: function(newValue) { + j$.util.validateTimeout(newValue, 'jasmine.DEFAULT_TIMEOUT_INTERVAL'); + DEFAULT_TIMEOUT_INTERVAL = newValue; + } + }); j$.getGlobal = function() { return jasmineGlobal; @@ -157,11 +232,12 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { * Get the currently booted Jasmine Environment. * * @name jasmine.getEnv + * @since 1.3.0 * @function * @return {Env} */ j$.getEnv = function(options) { - var env = j$.currentEnv_ = j$.currentEnv_ || new j$.Env(options); + var env = (j$.currentEnv_ = j$.currentEnv_ || new j$.Env(options)); //jasmine. singletons in here (setTimeout blah blah). return env; }; @@ -171,7 +247,9 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { }; j$.isObject_ = function(value) { - return !j$.util.isUndefined(value) && value !== null && j$.isA_('Object', value); + return ( + !j$.util.isUndefined(value) && value !== null && j$.isA_('Object', value) + ); }; j$.isString_ = function(value) { @@ -186,16 +264,135 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { return j$.isA_('Function', value); }; + j$.isAsyncFunction_ = function(value) { + return j$.isA_('AsyncFunction', value); + }; + + j$.isGeneratorFunction_ = function(value) { + return j$.isA_('GeneratorFunction', value); + }; + + j$.isTypedArray_ = function(value) { + return ( + j$.isA_('Float32Array', value) || + j$.isA_('Float64Array', value) || + j$.isA_('Int16Array', value) || + j$.isA_('Int32Array', value) || + j$.isA_('Int8Array', value) || + j$.isA_('Uint16Array', value) || + j$.isA_('Uint32Array', value) || + j$.isA_('Uint8Array', value) || + j$.isA_('Uint8ClampedArray', value) + ); + }; + j$.isA_ = function(typeName, value) { return j$.getType_(value) === '[object ' + typeName + ']'; }; + j$.isError_ = function(value) { + if (!value) { + return false; + } + + if (value instanceof Error) { + return true; + } + if ( + typeof window !== 'undefined' && + typeof window.trustedTypes !== 'undefined' + ) { + return ( + typeof value.stack === 'string' && typeof value.message === 'string' + ); + } + if (value && value.constructor && value.constructor.constructor) { + var valueGlobal = value.constructor.constructor('return this'); + if (j$.isFunction_(valueGlobal)) { + valueGlobal = valueGlobal(); + } + + if (valueGlobal.Error && value instanceof valueGlobal.Error) { + return true; + } + } + return false; + }; + + j$.isAsymmetricEqualityTester_ = function(obj) { + return obj?.asymmetricMatch ? j$.isA_('Function', obj.asymmetricMatch) : false; + }; + j$.getType_ = function(value) { return Object.prototype.toString.apply(value); }; j$.isDomNode = function(obj) { - return obj.nodeType && obj.nodeType > 0; + // Node is a function, because constructors + return typeof jasmineGlobal.Node !== 'undefined' + ? obj instanceof jasmineGlobal.Node + : obj !== null && + typeof obj === 'object' && + typeof obj.nodeType === 'number' && + typeof obj.nodeName === 'string'; + // return obj.nodeType > 0; + }; + + j$.isMap = function(obj) { + return ( + obj !== null && + typeof obj !== 'undefined' && + typeof jasmineGlobal.Map !== 'undefined' && + obj.constructor === jasmineGlobal.Map + ); + }; + + j$.isSet = function(obj) { + return ( + obj !== null && + typeof obj !== 'undefined' && + typeof jasmineGlobal.Set !== 'undefined' && + obj.constructor === jasmineGlobal.Set + ); + }; + + j$.isWeakMap = function(obj) { + return ( + obj !== null && + typeof obj !== 'undefined' && + typeof jasmineGlobal.WeakMap !== 'undefined' && + obj.constructor === jasmineGlobal.WeakMap + ); + }; + + j$.isURL = function(obj) { + return ( + obj !== null && + typeof obj !== 'undefined' && + typeof jasmineGlobal.URL !== 'undefined' && + obj.constructor === jasmineGlobal.URL + ); + }; + + j$.isDataView = function(obj) { + return ( + obj !== null && + typeof obj !== 'undefined' && + typeof jasmineGlobal.DataView !== 'undefined' && + obj.constructor === jasmineGlobal.DataView + ); + }; + + j$.isPromise = function(obj) { + return ( + typeof jasmineGlobal.Promise !== 'undefined' && + !!obj && + obj.constructor === jasmineGlobal.Promise + ); + }; + + j$.isPromiseLike = function(obj) { + return !!obj && j$.isFunction_(obj.then); }; j$.fnNameFor = function(func) { @@ -203,14 +400,31 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { return func.name; } - var matches = func.toString().match(/^\s*function\s*(\w*)\s*\(/); + var matches = + func.toString().match(/^\s*function\s*(\w+)\s*\(/) || + func.toString().match(/^\s*\[object\s*(\w+)Constructor\]/); + return matches ? matches[1] : ''; }; + j$.isPending_ = function(promise) { + var sentinel = {}; + // eslint-disable-next-line compat/compat + return Promise.race([promise, Promise.resolve(sentinel)]).then( + function(result) { + return result === sentinel; + }, + function() { + return false; + } + ); + }; + /** - * Get a matcher, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), * that will succeed if the actual value being compared is an instance of the specified class/constructor. * @name jasmine.any + * @since 1.3.0 * @function * @param {Constructor} clazz - The constructor to check against. */ @@ -219,9 +433,10 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { }; /** - * Get a matcher, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), * that will succeed if the actual value being compared is not `null` and not `undefined`. * @name jasmine.anything + * @since 2.2.0 * @function */ j$.anything = function() { @@ -229,9 +444,54 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { }; /** - * Get a matcher, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * that will succeed if the actual value being compared is `true` or anything truthy. + * @name jasmine.truthy + * @since 3.1.0 + * @function + */ + j$.truthy = function() { + return new j$.Truthy(); + }; + + /** + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * that will succeed if the actual value being compared is `null`, `undefined`, `0`, `false` or anything falsey. + * @name jasmine.falsy + * @since 3.1.0 + * @function + */ + j$.falsy = function() { + return new j$.Falsy(); + }; + + /** + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * that will succeed if the actual value being compared is empty. + * @name jasmine.empty + * @since 3.1.0 + * @function + */ + j$.empty = function() { + return new j$.Empty(); + }; + + /** + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * that will succeed if the actual value being compared is not empty. + * @name jasmine.notEmpty + * @since 3.1.0 + * @function + */ + j$.notEmpty = function() { + return new j$.NotEmpty(); + }; + + /** + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), * that will succeed if the actual value being compared contains at least the keys and values. * @name jasmine.objectContaining + * @since 1.3.0 * @function * @param {Object} sample - The subset of properties that _must_ be in the actual. */ @@ -240,9 +500,10 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { }; /** - * Get a matcher, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), * that will succeed if the actual value is a `String` that matches the `RegExp` or `String`. * @name jasmine.stringMatching + * @since 2.2.0 * @function * @param {RegExp|String} expected */ @@ -251,9 +512,22 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { }; /** - * Get a matcher, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * that will succeed if the actual value is a `String` that contains the specified `String`. + * @name jasmine.stringContaining + * @since 3.10.0 + * @function + * @param {String} expected + */ + j$.stringContaining = function(expected) { + return new j$.StringContaining(expected); + }; + + /** + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), * that will succeed if the actual value is an `Array` that contains at least the elements in the sample. * @name jasmine.arrayContaining + * @since 2.2.0 * @function * @param {Array} sample */ @@ -262,87 +536,71 @@ getJasmineRequireObj().base = function(j$, jasmineGlobal) { }; /** - * Create a bare {@link Spy} object. This won't be installed anywhere and will not have any implementation behind it. - * @name jasmine.createSpy + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * that will succeed if the actual value is an `Array` that contains all of the elements in the sample in any order. + * @name jasmine.arrayWithExactContents + * @since 2.8.0 * @function - * @param {String} [name] - Name to give the spy. This will be displayed in failure messages. - * @param {Function} [originalFn] - Function to act as the real implementation. - * @return {Spy} + * @param {Array} sample */ - j$.createSpy = function(name, originalFn) { - return j$.Spy(name, originalFn); + j$.arrayWithExactContents = function(sample) { + return new j$.ArrayWithExactContents(sample); }; - j$.isSpy = function(putativeSpy) { - if (!putativeSpy || !putativeSpy.and) { - return false; - } - return putativeSpy.and instanceof j$.SpyStrategy && - putativeSpy.calls instanceof j$.CallTracker; + /** + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * that will succeed if every key/value pair in the sample passes the deep equality comparison + * with at least one key/value pair in the actual value being compared + * @name jasmine.mapContaining + * @since 3.5.0 + * @function + * @param {Map} sample - The subset of items that _must_ be in the actual. + */ + j$.mapContaining = function(sample) { + return new j$.MapContaining(sample); }; /** - * Create an object with multiple {@link Spy}s as its members. - * @name jasmine.createSpyObj + * Get an {@link AsymmetricEqualityTester}, usable in any {@link matchers|matcher} that uses Jasmine's equality (e.g. {@link matchers#toEqual|toEqual}, {@link matchers#toContain|toContain}, or {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}), + * that will succeed if every item in the sample passes the deep equality comparison + * with at least one item in the actual value being compared + * @name jasmine.setContaining + * @since 3.5.0 * @function - * @param {String} [baseName] - Base name for the spies in the object. - * @param {String[]|Object} methodNames - Array of method names to create spies for, or Object whose keys will be method names and values the {@link Spy#and#returnValue|returnValue}. - * @return {Object} + * @param {Set} sample - The subset of items that _must_ be in the actual. */ - j$.createSpyObj = function(baseName, methodNames) { - var baseNameIsCollection = j$.isObject_(baseName) || j$.isArray_(baseName); - - if (baseNameIsCollection && j$.util.isUndefined(methodNames)) { - methodNames = baseName; - baseName = 'unknown'; - } - - var obj = {}; - var spiesWereSet = false; - - if (j$.isArray_(methodNames)) { - for (var i = 0; i < methodNames.length; i++) { - obj[methodNames[i]] = j$.createSpy(baseName + '.' + methodNames[i]); - spiesWereSet = true; - } - } else if (j$.isObject_(methodNames)) { - for (var key in methodNames) { - if (methodNames.hasOwnProperty(key)) { - obj[key] = j$.createSpy(baseName + '.' + key); - obj[key].and.returnValue(methodNames[key]); - spiesWereSet = true; - } - } - } + j$.setContaining = function(sample) { + return new j$.SetContaining(sample); + }; - if (!spiesWereSet) { - throw 'createSpyObj requires a non-empty array or object of method names to create spies for'; + /** + * Determines whether the provided function is a Jasmine spy. + * @name jasmine.isSpy + * @since 2.0.0 + * @function + * @param {Function} putativeSpy - The function to check. + * @return {Boolean} + */ + j$.isSpy = function(putativeSpy) { + if (!putativeSpy || !putativeSpy.and) { + return false; } - - return obj; + return ( + putativeSpy.and instanceof j$.SpyStrategy && + putativeSpy.calls instanceof j$.CallTracker + ); }; }; -getJasmineRequireObj().util = function() { - +getJasmineRequireObj().util = function(j$) { var util = {}; util.inherit = function(childClass, parentClass) { - var Subclass = function() { - }; + var Subclass = function() {}; Subclass.prototype = parentClass.prototype; childClass.prototype = new Subclass(); }; - util.htmlEscape = function(str) { - if (!str) { - return str; - } - return str.replace(/&/g, '&') - .replace(//g, '>'); - }; - util.argsToArray = function(args) { var arrayOfArgs = []; for (var i = 0; i < args.length; i++) { @@ -380,6 +638,23 @@ getJasmineRequireObj().util = function() { return cloned; }; + util.cloneArgs = function(args) { + var clonedArgs = []; + var argsAsArray = j$.util.argsToArray(args); + for (var i = 0; i < argsAsArray.length; i++) { + var str = Object.prototype.toString.apply(argsAsArray[i]), + primitives = /^\[object (Boolean|String|RegExp|Number)/; + + // All falsey values are either primitives, `null`, or `undefined. + if (!argsAsArray[i] || str.match(primitives)) { + clonedArgs.push(argsAsArray[i]); + } else { + clonedArgs.push(j$.util.clone(argsAsArray[i])); + } + } + return clonedArgs; + }; + util.getPropertyDescriptor = function(obj, methodName) { var descriptor, proto = obj; @@ -408,36 +683,161 @@ getJasmineRequireObj().util = function() { return Object.prototype.hasOwnProperty.call(obj, key); }; + util.errorWithStack = function errorWithStack() { + // Don't throw and catch if we don't have to, because it makes it harder + // for users to debug their code with exception breakpoints. + var error = new Error(); + + if (error.stack) { + return error; + } + + // But some browsers (e.g. Phantom) only provide a stack trace if we throw. + try { + throw new Error(); + } catch (e) { + return e; + } + }; + + function callerFile() { + var trace = new j$.StackTrace(util.errorWithStack()); + return trace.frames[2].file; + } + + util.jasmineFile = (function() { + var result; + + return function() { + if (!result) { + result = callerFile(); + } + + return result; + }; + })(); + + function StopIteration() {} + StopIteration.prototype = Object.create(Error.prototype); + StopIteration.prototype.constructor = StopIteration; + + // useful for maps and sets since `forEach` is the only IE11-compatible way to iterate them + util.forEachBreakable = function(iterable, iteratee) { + function breakLoop() { + throw new StopIteration(); + } + + try { + iterable.forEach(function(value, key) { + iteratee(breakLoop, value, key, iterable); + }); + } catch (error) { + if (!(error instanceof StopIteration)) throw error; + } + }; + + util.validateTimeout = function(timeout, msgPrefix) { + // Timeouts are implemented with setTimeout, which only supports a limited + // range of values. The limit is unspecified, as is the behavior when it's + // exceeded. But on all currently supported JS runtimes, setTimeout calls + // the callback immediately when the timeout is greater than 2147483647 + // (the maximum value of a signed 32 bit integer). + var max = 2147483647; + + if (timeout > max) { + throw new Error( + (msgPrefix || 'Timeout value') + ' cannot be greater than ' + max + ); + } + }; + return util; }; getJasmineRequireObj().Spec = function(j$) { + /** + * @interface Spec + * @see Configuration#specFilter + * @since 2.0.0 + */ function Spec(attrs) { this.expectationFactory = attrs.expectationFactory; + this.asyncExpectationFactory = attrs.asyncExpectationFactory; this.resultCallback = attrs.resultCallback || function() {}; + /** + * The unique ID of this spec. + * @name Spec#id + * @readonly + * @type {string} + * @since 2.0.0 + */ this.id = attrs.id; + /** + * The description passed to the {@link it} that created this spec. + * @name Spec#description + * @readonly + * @type {string} + * @since 2.0.0 + */ this.description = attrs.description || ''; this.queueableFn = attrs.queueableFn; - this.beforeAndAfterFns = attrs.beforeAndAfterFns || function() { return {befores: [], afters: []}; }; - this.userContext = attrs.userContext || function() { return {}; }; + this.beforeAndAfterFns = + attrs.beforeAndAfterFns || + function() { + return { befores: [], afters: [] }; + }; + this.userContext = + attrs.userContext || + function() { + return {}; + }; this.onStart = attrs.onStart || function() {}; - this.getSpecName = attrs.getSpecName || function() { return ''; }; - this.expectationResultFactory = attrs.expectationResultFactory || function() { }; + this.autoCleanClosures = + attrs.autoCleanClosures === undefined ? true : !!attrs.autoCleanClosures; + this.getSpecName = + attrs.getSpecName || + function() { + return ''; + }; + this.expectationResultFactory = + attrs.expectationResultFactory || function() {}; this.queueRunnerFactory = attrs.queueRunnerFactory || function() {}; - this.catchingExceptions = attrs.catchingExceptions || function() { return true; }; + this.catchingExceptions = + attrs.catchingExceptions || + function() { + return true; + }; this.throwOnExpectationFailure = !!attrs.throwOnExpectationFailure; + this.timer = attrs.timer || new j$.Timer(); if (!this.queueableFn.fn) { - this.pend(); + this.exclude(); } + /** + * @typedef SpecResult + * @property {Int} id - The unique id of this spec. + * @property {String} description - The description passed to the {@link it} that created this spec. + * @property {String} fullName - The full description including all ancestors of this spec. + * @property {Expectation[]} failedExpectations - The list of expectations that failed during execution of this spec. + * @property {Expectation[]} passedExpectations - The list of expectations that passed during execution of this spec. + * @property {Expectation[]} deprecationWarnings - The list of deprecation warnings that occurred during execution this spec. + * @property {String} pendingReason - If the spec is {@link pending}, this will be the reason. + * @property {String} status - Once the spec has completed, this string represents the pass/fail status of this spec. + * @property {number} duration - The time in ms used by the spec execution, including any before/afterEach. + * @property {Object} properties - User-supplied properties, if any, that were set using {@link Env#setSpecProperty} + * @since 2.0.0 +x */ this.result = { id: this.id, description: this.description, fullName: this.getFullName(), failedExpectations: [], passedExpectations: [], - pendingReason: '' + deprecationWarnings: [], + pendingReason: '', + duration: null, + properties: null }; } @@ -454,38 +854,98 @@ getJasmineRequireObj().Spec = function(j$) { } }; + Spec.prototype.setSpecProperty = function(key, value) { + this.result.properties = this.result.properties || {}; + this.result.properties[key] = value; + }; + Spec.prototype.expect = function(actual) { return this.expectationFactory(actual, this); }; - Spec.prototype.execute = function(onComplete, enabled) { + Spec.prototype.expectAsync = function(actual) { + return this.asyncExpectationFactory(actual, this); + }; + + Spec.prototype.execute = function(onComplete, excluded, failSpecWithNoExp) { var self = this; - this.onStart(this); + var onStart = { + fn: function(done) { + self.timer.start(); + self.onStart(self, done); + } + }; - if (!this.isExecutable() || this.markedPending || enabled === false) { - complete(enabled); - return; - } + var complete = { + fn: function(done) { + if (self.autoCleanClosures) { + self.queueableFn.fn = null; + } + self.result.status = self.status(excluded, failSpecWithNoExp); + self.result.duration = self.timer.elapsed(); + self.resultCallback(self.result, done); + } + }; var fns = this.beforeAndAfterFns(); - var allFns = fns.befores.concat(this.queueableFn).concat(fns.afters); - - this.queueRunnerFactory({ - queueableFns: allFns, - onException: function() { self.onException.apply(self, arguments); }, - onComplete: complete, + var regularFns = fns.befores.concat(this.queueableFn); + + var runnerConfig = { + isLeaf: true, + queueableFns: regularFns, + cleanupFns: fns.afters, + onException: function() { + self.onException.apply(self, arguments); + }, + onComplete: function() { + onComplete( + self.result.status === 'failed' && + new j$.StopExecutionError('spec failed') + ); + }, userContext: this.userContext() - }); - - function complete(enabledAgain) { - self.result.status = self.status(enabledAgain); - self.resultCallback(self.result); + }; - if (onComplete) { - onComplete(); - } + if (this.markedPending || excluded === true) { + runnerConfig.queueableFns = []; + runnerConfig.cleanupFns = []; } + + runnerConfig.queueableFns.unshift(onStart); + runnerConfig.cleanupFns.push(complete); + + this.queueRunnerFactory(runnerConfig); + }; + + Spec.prototype.reset = function() { + /** + * @typedef SpecResult + * @property {Int} id - The unique id of this spec. + * @property {String} description - The description passed to the {@link it} that created this spec. + * @property {String} fullName - The full description including all ancestors of this spec. + * @property {Expectation[]} failedExpectations - The list of expectations that failed during execution of this spec. + * @property {Expectation[]} passedExpectations - The list of expectations that passed during execution of this spec. + * @property {Expectation[]} deprecationWarnings - The list of deprecation warnings that occurred during execution this spec. + * @property {String} pendingReason - If the spec is {@link pending}, this will be the reason. + * @property {String} status - Once the spec has completed, this string represents the pass/fail status of this spec. + * @property {number} duration - The time in ms used by the spec execution, including any before/afterEach. + * @property {Object} properties - User-supplied properties, if any, that were set using {@link Env#setSpecProperty} + * @since 2.0.0 + */ + this.result = { + id: this.id, + description: this.description, + fullName: this.getFullName(), + failedExpectations: [], + passedExpectations: [], + deprecationWarnings: [], + pendingReason: this.excludeMessage, + duration: null, + properties: null, + trace: null + }; + this.markedPending = this.markedExcluding; }; Spec.prototype.onException = function onException(e) { @@ -498,19 +958,23 @@ getJasmineRequireObj().Spec = function(j$) { return; } - this.addExpectationResult(false, { - matcherName: '', - passed: false, - expected: '', - actual: '', - error: e - }, true); - }; - - Spec.prototype.disable = function() { - this.disabled = true; + this.addExpectationResult( + false, + { + matcherName: '', + passed: false, + expected: '', + actual: '', + error: e + }, + true + ); }; + /* + * Marks state as pending + * @param {string} [message] An optional reason message + */ Spec.prototype.pend = function(message) { this.markedPending = true; if (message) { @@ -518,39 +982,71 @@ getJasmineRequireObj().Spec = function(j$) { } }; + /* + * Like {@link Spec#pend}, but pending state will survive {@link Spec#reset} + * Useful for fit, xit, where pending state remains. + * @param {string} [message] An optional reason message + */ + Spec.prototype.exclude = function(message) { + this.markedExcluding = true; + if (this.message) { + this.excludeMessage = message; + } + this.pend(message); + }; + Spec.prototype.getResult = function() { this.result.status = this.status(); return this.result; }; - Spec.prototype.status = function(enabled) { - if (this.disabled || enabled === false) { - return 'disabled'; + Spec.prototype.status = function(excluded, failSpecWithNoExpectations) { + if (excluded === true) { + return 'excluded'; } if (this.markedPending) { return 'pending'; } - if (this.result.failedExpectations.length > 0) { + if ( + this.result.failedExpectations.length > 0 || + (failSpecWithNoExpectations && + this.result.failedExpectations.length + + this.result.passedExpectations.length === + 0) + ) { return 'failed'; - } else { - return 'passed'; } - }; - Spec.prototype.isExecutable = function() { - return !this.disabled; + return 'passed'; }; + /** + * The full description including all ancestors of this spec. + * @name Spec#getFullName + * @function + * @returns {string} + * @since 2.0.0 + */ Spec.prototype.getFullName = function() { return this.getSpecName(this); }; + Spec.prototype.addDeprecationWarning = function(deprecation) { + if (typeof deprecation === 'string') { + deprecation = { message: deprecation }; + } + this.result.deprecationWarnings.push( + this.expectationResultFactory(deprecation) + ); + }; + var extractCustomPendingMessage = function(e) { var fullMessage = e.toString(), - boilerplateStart = fullMessage.indexOf(Spec.pendingSpecExceptionMessage), - boilerplateEnd = boilerplateStart + Spec.pendingSpecExceptionMessage.length; + boilerplateStart = fullMessage.indexOf(Spec.pendingSpecExceptionMessage), + boilerplateEnd = + boilerplateStart + Spec.pendingSpecExceptionMessage.length; return fullMessage.substr(boilerplateEnd); }; @@ -558,13 +1054,18 @@ getJasmineRequireObj().Spec = function(j$) { Spec.pendingSpecExceptionMessage = '=> marked Pending'; Spec.isPendingSpecException = function(e) { - return !!(e && e.toString && e.toString().indexOf(Spec.pendingSpecExceptionMessage) !== -1); + return !!( + e && + e.toString && + e.toString().indexOf(Spec.pendingSpecExceptionMessage) !== -1 + ); }; return Spec; }; if (typeof window == void 0 && typeof exports == 'object') { + /* globals exports */ exports.Spec = jasmineRequire.Spec; } @@ -573,7 +1074,7 @@ if (typeof window == void 0 && typeof exports == 'object') { getJasmineRequireObj().Order = function() { function Order(options) { this.random = 'random' in options ? options.random : true; - var seed = this.seed = options.seed || generateSeed(); + var seed = (this.seed = options.seed || generateSeed()); this.sort = this.random ? randomOrder : naturalOrder; function naturalOrder(items) { @@ -593,23 +1094,22 @@ getJasmineRequireObj().Order = function() { } // Bob Jenkins One-at-a-Time Hash algorithm is a non-cryptographic hash function - // used to get a different output when the key changes slighly. + // used to get a different output when the key changes slightly. // We use your return to sort the children randomly in a consistent way when // used in conjunction with a seed function jenkinsHash(key) { var hash, i; - for(hash = i = 0; i < key.length; ++i) { + for (hash = i = 0; i < key.length; ++i) { hash += key.charCodeAt(i); - hash += (hash << 10); - hash ^= (hash >> 6); + hash += hash << 10; + hash ^= hash >> 6; } - hash += (hash << 3); - hash ^= (hash >> 11); - hash += (hash << 15); + hash += hash << 3; + hash ^= hash >> 11; + hash += hash << 15; return hash; } - } return Order; @@ -617,34 +1117,155 @@ getJasmineRequireObj().Order = function() { getJasmineRequireObj().Env = function(j$) { /** - * _Note:_ Do not construct this directly, Jasmine will make one during booting. - * @name Env - * @classdesc The Jasmine environment - * @constructor + * @class Env + * @since 2.0.0 + * @classdesc The Jasmine environment.
+ * _Note:_ Do not construct this directly. You can obtain the Env instance by + * calling {@link jasmine.getEnv}. + * @hideconstructor */ function Env(options) { options = options || {}; var self = this; var global = options.global || j$.getGlobal(); + var customPromise; var totalSpecsDefined = 0; - var catchExceptions = true; - - var realSetTimeout = j$.getGlobal().setTimeout; - var realClearTimeout = j$.getGlobal().clearTimeout; - var clearStack = j$.getClearStack(j$.getGlobal()); - this.clock = new j$.Clock(global, function () { return new j$.DelayedFunctionScheduler(); }, new j$.MockDate(global)); + var realSetTimeout = global.setTimeout; + var realClearTimeout = global.clearTimeout; + var clearStack = j$.getClearStack(global); + this.clock = new j$.Clock( + global, + function() { + return new j$.DelayedFunctionScheduler(); + }, + new j$.MockDate(global) + ); var runnableResources = {}; var currentSpec = null; var currentlyExecutingSuites = []; var currentDeclarationSuite = null; - var throwOnExpectationFailure = false; - var random = false; - var seed = null; + var hasFailures = false; + + /** + * This represents the available options to configure Jasmine. + * Options that are not provided will use their default values. + * @see Env#configure + * @interface Configuration + * @since 3.3.0 + */ + var config = { + /** + * Whether to randomize spec execution order + * @name Configuration#random + * @since 3.3.0 + * @type Boolean + * @default true + */ + random: true, + /** + * Seed to use as the basis of randomization. + * Null causes the seed to be determined randomly at the start of execution. + * @name Configuration#seed + * @since 3.3.0 + * @type (number|string) + * @default null + */ + seed: null, + /** + * Whether to stop execution of the suite after the first spec failure + * @name Configuration#failFast + * @since 3.3.0 + * @type Boolean + * @default false + * @deprecated Use the `stopOnSpecFailure` config property instead. + */ + failFast: false, + /** + * Whether to stop execution of the suite after the first spec failure + * @name Configuration#stopOnSpecFailure + * @since 3.9.0 + * @type Boolean + * @default false + */ + stopOnSpecFailure: false, + /** + * Whether to fail the spec if it ran no expectations. By default + * a spec that ran no expectations is reported as passed. Setting this + * to true will report such spec as a failure. + * @name Configuration#failSpecWithNoExpectations + * @since 3.5.0 + * @type Boolean + * @default false + */ + failSpecWithNoExpectations: false, + /** + * Whether to cause specs to only have one expectation failure. + * @name Configuration#oneFailurePerSpec + * @since 3.3.0 + * @type Boolean + * @default false + * @deprecated Use the `stopSpecOnExpectationFailure` config property instead. + */ + oneFailurePerSpec: false, + /** + * Whether to cause specs to only have one expectation failure. + * @name Configuration#stopSpecOnExpectationFailure + * @since 3.3.0 + * @type Boolean + * @default false + */ + stopSpecOnExpectationFailure: false, + /** + * A function that takes a spec and returns true if it should be executed + * or false if it should be skipped. + * @callback SpecFilter + * @param {Spec} spec - The spec that the filter is being applied to. + * @return boolean + */ + /** + * Function to use to filter specs + * @name Configuration#specFilter + * @since 3.3.0 + * @type SpecFilter + * @default A function that always returns true. + */ + specFilter: function() { + return true; + }, + /** + * Whether or not reporters should hide disabled specs from their output. + * Currently only supported by Jasmine's HTMLReporter + * @name Configuration#hideDisabled + * @since 3.3.0 + * @type Boolean + * @default false + */ + hideDisabled: false, + /** + * Set to provide a custom promise library that Jasmine will use if it needs + * to create a promise. If not set, it will default to whatever global Promise + * library is available (if any). + * @name Configuration#Promise + * @since 3.5.0 + * @type function + * @default undefined + */ + Promise: undefined, + /** + * Clean closures when a suite is done running (done by clearing the stored function reference). + * This prevents memory leaks, but you won't be able to run jasmine multiple times. + * @name Configuration#autoCleanClosures + * @since 3.10.0 + * @type boolean + * @default true + */ + autoCleanClosures: true + }; var currentSuite = function() { return currentlyExecutingSuites[currentlyExecutingSuites.length - 1]; @@ -654,54 +1275,259 @@ getJasmineRequireObj().Env = function(j$) { return currentSpec || currentSuite(); }; - var reporter = new j$.ReportDispatcher([ - 'jasmineStarted', - 'jasmineDone', - 'suiteStarted', - 'suiteDone', - 'specStarted', - 'specDone' - ]); - - var globalErrors = new j$.GlobalErrors(); - - this.specFilter = function() { - return true; - }; + var globalErrors = null; - this.addCustomEqualityTester = function(tester) { - if(!currentRunnable()) { - throw new Error('Custom Equalities must be added in a before function or a spec'); + var installGlobalErrors = function() { + if (globalErrors) { + return; } - runnableResources[currentRunnable().id].customEqualityTesters.push(tester); - }; - this.addMatchers = function(matchersToAdd) { - if(!currentRunnable()) { - throw new Error('Matchers must be added in a before function or a spec'); - } - var customMatchers = runnableResources[currentRunnable().id].customMatchers; - for (var matcherName in matchersToAdd) { - customMatchers[matcherName] = matchersToAdd[matcherName]; - } + globalErrors = new j$.GlobalErrors(); + globalErrors.install(); }; - j$.Expectation.addCoreMatchers(j$.matchers); - - var nextSpecId = 0; - var getNextSpecId = function() { - return 'spec' + nextSpecId++; - }; + if (!options.suppressLoadErrors) { + installGlobalErrors(); + globalErrors.pushListener(function( + message, + filename, + lineno, + colNo, + err + ) { + topSuite.result.failedExpectations.push({ + passed: false, + globalErrorType: 'load', + message: message, + stack: err && err.stack, + filename: filename, + lineno: lineno + }); + }); + } + + /** + * Configure your jasmine environment + * @name Env#configure + * @since 3.3.0 + * @argument {Configuration} configuration + * @function + */ + this.configure = function(configuration) { + var booleanProps = [ + 'random', + 'failSpecWithNoExpectations', + 'hideDisabled', + 'autoCleanClosures' + ]; + + booleanProps.forEach(function(prop) { + if (typeof configuration[prop] !== 'undefined') { + config[prop] = !!configuration[prop]; + } + }); + + if (typeof configuration.failFast !== 'undefined') { + if (typeof configuration.stopOnSpecFailure !== 'undefined') { + if (configuration.stopOnSpecFailure !== configuration.failFast) { + throw new Error( + 'stopOnSpecFailure and failFast are aliases for ' + + "each other. Don't set failFast if you also set stopOnSpecFailure." + ); + } + } + + config.failFast = configuration.failFast; + config.stopOnSpecFailure = configuration.failFast; + } else if (typeof configuration.stopOnSpecFailure !== 'undefined') { + config.failFast = configuration.stopOnSpecFailure; + config.stopOnSpecFailure = configuration.stopOnSpecFailure; + } + + if (typeof configuration.oneFailurePerSpec !== 'undefined') { + if (typeof configuration.stopSpecOnExpectationFailure !== 'undefined') { + if ( + configuration.stopSpecOnExpectationFailure !== + configuration.oneFailurePerSpec + ) { + throw new Error( + 'stopSpecOnExpectationFailure and oneFailurePerSpec are aliases for ' + + "each other. Don't set oneFailurePerSpec if you also set stopSpecOnExpectationFailure." + ); + } + } + + config.oneFailurePerSpec = configuration.oneFailurePerSpec; + config.stopSpecOnExpectationFailure = configuration.oneFailurePerSpec; + } else if ( + typeof configuration.stopSpecOnExpectationFailure !== 'undefined' + ) { + config.oneFailurePerSpec = configuration.stopSpecOnExpectationFailure; + config.stopSpecOnExpectationFailure = + configuration.stopSpecOnExpectationFailure; + } + + if (configuration.specFilter) { + config.specFilter = configuration.specFilter; + } + + if (typeof configuration.seed !== 'undefined') { + config.seed = configuration.seed; + } + + // Don't use hasOwnProperty to check for Promise existence because Promise + // can be initialized to undefined, either explicitly or by using the + // object returned from Env#configuration. In particular, Karma does this. + if (configuration.Promise) { + if ( + typeof configuration.Promise.resolve === 'function' && + typeof configuration.Promise.reject === 'function' + ) { + customPromise = configuration.Promise; + } else { + throw new Error( + 'Custom promise library missing `resolve`/`reject` functions' + ); + } + } + }; + + /** + * Get the current configuration for your jasmine environment + * @name Env#configuration + * @since 3.3.0 + * @function + * @returns {Configuration} + */ + this.configuration = function() { + var result = {}; + for (var property in config) { + result[property] = config[property]; + } + return result; + }; + + Object.defineProperty(this, 'specFilter', { + get: function() { + self.deprecated( + 'Getting specFilter directly from Env is deprecated and will be removed in a future version of Jasmine, please check the specFilter option from `configuration`' + ); + return config.specFilter; + }, + set: function(val) { + self.deprecated( + 'Setting specFilter directly on Env is deprecated and will be removed in a future version of Jasmine, please use the specFilter option in `configure`' + ); + config.specFilter = val; + } + }); + + this.setDefaultSpyStrategy = function(defaultStrategyFn) { + if (!currentRunnable()) { + throw new Error( + 'Default spy strategy must be set in a before function or a spec' + ); + } + runnableResources[ + currentRunnable().id + ].defaultStrategyFn = defaultStrategyFn; + }; + + this.addSpyStrategy = function(name, fn) { + if (!currentRunnable()) { + throw new Error( + 'Custom spy strategies must be added in a before function or a spec' + ); + } + runnableResources[currentRunnable().id].customSpyStrategies[name] = fn; + }; + + this.addCustomEqualityTester = function(tester) { + if (!currentRunnable()) { + throw new Error( + 'Custom Equalities must be added in a before function or a spec' + ); + } + runnableResources[currentRunnable().id].customEqualityTesters.push( + tester + ); + }; + + this.addMatchers = function(matchersToAdd) { + if (!currentRunnable()) { + throw new Error( + 'Matchers must be added in a before function or a spec' + ); + } + var customMatchers = + runnableResources[currentRunnable().id].customMatchers; + + for (var matcherName in matchersToAdd) { + customMatchers[matcherName] = matchersToAdd[matcherName]; + } + }; + + this.addAsyncMatchers = function(matchersToAdd) { + if (!currentRunnable()) { + throw new Error( + 'Async Matchers must be added in a before function or a spec' + ); + } + var customAsyncMatchers = + runnableResources[currentRunnable().id].customAsyncMatchers; + + for (var matcherName in matchersToAdd) { + customAsyncMatchers[matcherName] = matchersToAdd[matcherName]; + } + }; + + this.addCustomObjectFormatter = function(formatter) { + if (!currentRunnable()) { + throw new Error( + 'Custom object formatters must be added in a before function or a spec' + ); + } + + runnableResources[currentRunnable().id].customObjectFormatters.push( + formatter + ); + }; + + j$.Expectation.addCoreMatchers(j$.matchers); + j$.Expectation.addAsyncCoreMatchers(j$.asyncMatchers); + + var nextSpecId = 0; + var getNextSpecId = function() { + return 'spec' + nextSpecId++; + }; var nextSuiteId = 0; var getNextSuiteId = function() { return 'suite' + nextSuiteId++; }; + var makePrettyPrinter = function() { + var customObjectFormatters = + runnableResources[currentRunnable().id].customObjectFormatters; + return j$.makePrettyPrinter(customObjectFormatters); + }; + + var makeMatchersUtil = function() { + var customEqualityTesters = + runnableResources[currentRunnable().id].customEqualityTesters; + return new j$.MatchersUtil({ + customTesters: customEqualityTesters, + pp: makePrettyPrinter() + }); + }; + var expectationFactory = function(actual, spec) { - return j$.Expectation.Factory({ - util: j$.matchersUtil, - customEqualityTesters: runnableResources[spec.id].customEqualityTesters, + var customEqualityTesters = + runnableResources[spec.id].customEqualityTesters; + + return j$.Expectation.factory({ + matchersUtil: makeMatchersUtil(), + customEqualityTesters: customEqualityTesters, customMatchers: runnableResources[spec.id].customMatchers, actual: actual, addExpectationResult: addExpectationResult @@ -712,28 +1538,101 @@ getJasmineRequireObj().Env = function(j$) { } }; + function recordLateExpectation(runable, runableType, result) { + var delayedExpectationResult = {}; + Object.keys(result).forEach(function(k) { + delayedExpectationResult[k] = result[k]; + }); + delayedExpectationResult.passed = false; + delayedExpectationResult.globalErrorType = 'lateExpectation'; + delayedExpectationResult.message = + runableType + + ' "' + + runable.getFullName() + + '" ran a "' + + result.matcherName + + '" expectation after it finished.\n'; + + if (result.message) { + delayedExpectationResult.message += + 'Message: "' + result.message + '"\n'; + } + + delayedExpectationResult.message += + '1. Did you forget to return or await the result of expectAsync?\n' + + '2. Was done() invoked before an async operation completed?\n' + + '3. Did an expectation follow a call to done()?'; + + topSuite.result.failedExpectations.push(delayedExpectationResult); + } + + var asyncExpectationFactory = function(actual, spec, runableType) { + return j$.Expectation.asyncFactory({ + matchersUtil: makeMatchersUtil(), + customEqualityTesters: runnableResources[spec.id].customEqualityTesters, + customAsyncMatchers: runnableResources[spec.id].customAsyncMatchers, + actual: actual, + addExpectationResult: addExpectationResult + }); + + function addExpectationResult(passed, result) { + if (currentRunnable() !== spec) { + recordLateExpectation(spec, runableType, result); + } + return spec.addExpectationResult(passed, result); + } + }; + var suiteAsyncExpectationFactory = function(actual, suite) { + return asyncExpectationFactory(actual, suite, 'Suite'); + }; + + var specAsyncExpectationFactory = function(actual, suite) { + return asyncExpectationFactory(actual, suite, 'Spec'); + }; + var defaultResourcesForRunnable = function(id, parentRunnableId) { - var resources = {spies: [], customEqualityTesters: [], customMatchers: {}}; + var resources = { + spies: [], + customEqualityTesters: [], + customMatchers: {}, + customAsyncMatchers: {}, + customSpyStrategies: {}, + defaultStrategyFn: undefined, + customObjectFormatters: [] + }; - if(runnableResources[parentRunnableId]){ - resources.customEqualityTesters = j$.util.clone(runnableResources[parentRunnableId].customEqualityTesters); - resources.customMatchers = j$.util.clone(runnableResources[parentRunnableId].customMatchers); + if (runnableResources[parentRunnableId]) { + resources.customEqualityTesters = j$.util.clone( + runnableResources[parentRunnableId].customEqualityTesters + ); + resources.customMatchers = j$.util.clone( + runnableResources[parentRunnableId].customMatchers + ); + resources.customAsyncMatchers = j$.util.clone( + runnableResources[parentRunnableId].customAsyncMatchers + ); + resources.customObjectFormatters = j$.util.clone( + runnableResources[parentRunnableId].customObjectFormatters + ); + resources.defaultStrategyFn = + runnableResources[parentRunnableId].defaultStrategyFn; } runnableResources[id] = resources; }; var clearResourcesForRunnable = function(id) { - spyRegistry.clearSpies(); - delete runnableResources[id]; + spyRegistry.clearSpies(); + delete runnableResources[id]; }; - var beforeAndAfterFns = function(suite) { + var beforeAndAfterFns = function(targetSuite) { return function() { var befores = [], - afters = []; + afters = [], + suite = targetSuite; - while(suite) { + while (suite) { befores = befores.concat(suite.beforeFns); afters = afters.concat(suite.afterFns); @@ -749,7 +1648,7 @@ getJasmineRequireObj().Env = function(j$) { var getSpecName = function(spec, suite) { var fullName = [spec.description], - suiteFullName = suite.getFullName(); + suiteFullName = suite.getFullName(); if (suiteFullName !== '') { fullName.unshift(suiteFullName); @@ -759,62 +1658,171 @@ getJasmineRequireObj().Env = function(j$) { // TODO: we may just be able to pass in the fn instead of wrapping here var buildExpectationResult = j$.buildExpectationResult, - exceptionFormatter = new j$.ExceptionFormatter(), - expectationResultFactory = function(attrs) { - attrs.messageFormatter = exceptionFormatter.message; - attrs.stackFormatter = exceptionFormatter.stack; - - return buildExpectationResult(attrs); - }; + exceptionFormatter = new j$.ExceptionFormatter(), + expectationResultFactory = function(attrs) { + attrs.messageFormatter = exceptionFormatter.message; + attrs.stackFormatter = exceptionFormatter.stack; - // TODO: fix this naming, and here's where the value comes in - this.catchExceptions = function(value) { - catchExceptions = !!value; - return catchExceptions; - }; + return buildExpectationResult(attrs); + }; - this.catchingExceptions = function() { - return catchExceptions; + /** + * Sets whether Jasmine should throw an Error when an expectation fails. + * This causes a spec to only have one expectation failure. + * @name Env#throwOnExpectationFailure + * @since 2.3.0 + * @function + * @param {Boolean} value Whether to throw when a expectation fails + * @deprecated Use the `stopSpecOnExpectationFailure` option with {@link Env#configure} + */ + this.throwOnExpectationFailure = function(value) { + this.deprecated( + 'Setting throwOnExpectationFailure directly on Env is deprecated and ' + + 'will be removed in a future version of Jasmine. Please use the ' + + 'stopSpecOnExpectationFailure option in `configure`.' + ); + this.configure({ oneFailurePerSpec: !!value }); }; - var maximumSpecCallbackDepth = 20; - var currentSpecCallbackDepth = 0; - - var catchException = function(e) { - return j$.Spec.isPendingSpecException(e) || catchExceptions; + this.throwingExpectationFailures = function() { + this.deprecated( + 'Getting throwingExpectationFailures directly from Env is deprecated ' + + 'and will be removed in a future version of Jasmine. Please check ' + + 'the stopSpecOnExpectationFailure option from `configuration`.' + ); + return config.oneFailurePerSpec; }; - this.throwOnExpectationFailure = function(value) { - throwOnExpectationFailure = !!value; + /** + * Set whether to stop suite execution when a spec fails + * @name Env#stopOnSpecFailure + * @since 2.7.0 + * @function + * @param {Boolean} value Whether to stop suite execution when a spec fails + * @deprecated Use the `stopOnSpecFailure` option with {@link Env#configure} + */ + this.stopOnSpecFailure = function(value) { + this.deprecated( + 'Setting stopOnSpecFailure directly is deprecated and will be ' + + 'removed in a future version of Jasmine. Please use the ' + + 'stopOnSpecFailure option in `configure`.' + ); + this.configure({ stopOnSpecFailure: !!value }); }; - this.throwingExpectationFailures = function() { - return throwOnExpectationFailure; + this.stoppingOnSpecFailure = function() { + this.deprecated( + 'Getting stoppingOnSpecFailure directly from Env is deprecated and ' + + 'will be removed in a future version of Jasmine. Please check the ' + + 'stopOnSpecFailure option from `configuration`.' + ); + return config.failFast; }; + /** + * Set whether to randomize test execution order + * @name Env#randomizeTests + * @since 2.4.0 + * @function + * @param {Boolean} value Whether to randomize execution order + * @deprecated Use the `random` option with {@link Env#configure} + */ this.randomizeTests = function(value) { - random = !!value; + this.deprecated( + 'Setting randomizeTests directly is deprecated and will be removed in a future version of Jasmine, please use the random option in `configure`' + ); + config.random = !!value; }; this.randomTests = function() { - return random; + this.deprecated( + 'Getting randomTests directly from Env is deprecated and will be removed in a future version of Jasmine, please check the random option from `configuration`' + ); + return config.random; }; + /** + * Set the random number seed for spec randomization + * @name Env#seed + * @since 2.4.0 + * @function + * @param {Number} value The seed value + * @deprecated Use the `seed` option with {@link Env#configure} + */ this.seed = function(value) { + this.deprecated( + 'Setting seed directly is deprecated and will be removed in a future version of Jasmine, please use the seed option in `configure`' + ); if (value) { - seed = value; + config.seed = value; + } + return config.seed; + }; + + this.hidingDisabled = function(value) { + this.deprecated( + 'Getting hidingDisabled directly from Env is deprecated and will be removed in a future version of Jasmine, please check the hideDisabled option from `configuration`' + ); + return config.hideDisabled; + }; + + /** + * @name Env#hideDisabled + * @since 3.2.0 + * @function + * @deprecated Use the `hideDisabled` option with {@link Env#configure} + */ + this.hideDisabled = function(value) { + this.deprecated( + 'Setting hideDisabled directly is deprecated and will be removed in a future version of Jasmine, please use the hideDisabled option in `configure`' + ); + config.hideDisabled = !!value; + }; + + this.deprecated = function(deprecation) { + var runnable = currentRunnable() || topSuite; + var context; + + if (runnable === topSuite) { + context = ''; + } else if (runnable === currentSuite()) { + context = ' (in suite: ' + runnable.getFullName() + ')'; + } else { + context = ' (in spec: ' + runnable.getFullName() + ')'; + } + + runnable.addDeprecationWarning(deprecation); + if ( + typeof console !== 'undefined' && + typeof console.error === 'function' + ) { + console.error('DEPRECATION: ' + deprecation + context); } - return seed; }; - var queueRunnerFactory = function(options) { - options.catchException = catchException; + var queueRunnerFactory = function(options, args) { + var failFast = false; + if (options.isLeaf) { + failFast = config.stopSpecOnExpectationFailure; + } else if (!options.isReporter) { + failFast = config.stopOnSpecFailure; + } options.clearStack = options.clearStack || clearStack; - options.timeout = {setTimeout: realSetTimeout, clearTimeout: realClearTimeout}; + options.timeout = { + setTimeout: realSetTimeout, + clearTimeout: realClearTimeout + }; options.fail = self.fail; options.globalErrors = globalErrors; + options.completeOnFirstError = failFast; + options.onException = + options.onException || + function(e) { + (currentRunnable() || topSuite).onException(e); + }; + options.deprecated = self.deprecated; - new j$.QueueRunner(options).execute(); + new j$.QueueRunner(options).execute(args); }; var topSuite = new j$.Suite({ @@ -822,17 +1830,135 @@ getJasmineRequireObj().Env = function(j$) { id: getNextSuiteId(), description: 'Jasmine__TopLevel__Suite', expectationFactory: expectationFactory, - expectationResultFactory: expectationResultFactory + asyncExpectationFactory: suiteAsyncExpectationFactory, + expectationResultFactory: expectationResultFactory, + autoCleanClosures: config.autoCleanClosures }); - defaultResourcesForRunnable(topSuite.id); currentDeclarationSuite = topSuite; + /** + * Provides the root suite, through which all suites and specs can be + * accessed. + * @function + * @name Env#topSuite + * @return {Suite} the root suite + * @since 2.0.0 + */ this.topSuite = function() { return topSuite; }; - this.execute = function(runnablesToRun) { - if(!runnablesToRun) { + /** + * This represents the available reporter callback for an object passed to {@link Env#addReporter}. + * @interface Reporter + * @see custom_reporter + */ + var reporter = new j$.ReportDispatcher( + [ + /** + * `jasmineStarted` is called after all of the specs have been loaded, but just before execution starts. + * @function + * @name Reporter#jasmineStarted + * @param {JasmineStartedInfo} suiteInfo Information about the full Jasmine suite that is being run + * @param {Function} [done] Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. + * @returns {} Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion. + * @see async + */ + 'jasmineStarted', + /** + * When the entire suite has finished execution `jasmineDone` is called + * @function + * @name Reporter#jasmineDone + * @param {JasmineDoneInfo} suiteInfo Information about the full Jasmine suite that just finished running. + * @param {Function} [done] Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. + * @returns {} Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion. + * @see async + */ + 'jasmineDone', + /** + * `suiteStarted` is invoked when a `describe` starts to run + * @function + * @name Reporter#suiteStarted + * @param {SuiteResult} result Information about the individual {@link describe} being run + * @param {Function} [done] Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. + * @returns {} Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion. + * @see async + */ + 'suiteStarted', + /** + * `suiteDone` is invoked when all of the child specs and suites for a given suite have been run + * + * While jasmine doesn't require any specific functions, not defining a `suiteDone` will make it impossible for a reporter to know when a suite has failures in an `afterAll`. + * @function + * @name Reporter#suiteDone + * @param {SuiteResult} result + * @param {Function} [done] Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. + * @returns {} Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion. + * @see async + */ + 'suiteDone', + /** + * `specStarted` is invoked when an `it` starts to run (including associated `beforeEach` functions) + * @function + * @name Reporter#specStarted + * @param {SpecResult} result Information about the individual {@link it} being run + * @param {Function} [done] Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. + * @returns {} Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion. + * @see async + */ + 'specStarted', + /** + * `specDone` is invoked when an `it` and its associated `beforeEach` and `afterEach` functions have been run. + * + * While jasmine doesn't require any specific functions, not defining a `specDone` will make it impossible for a reporter to know when a spec has failed. + * @function + * @name Reporter#specDone + * @param {SpecResult} result + * @param {Function} [done] Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. + * @returns {} Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion. + * @see async + */ + 'specDone' + ], + queueRunnerFactory + ); + + /** + * Executes the specs. + * + * If called with no parameters or with a falsy value as the first parameter, + * all specs will be executed except those that are excluded by a + * [spec filter]{@link Configuration#specFilter} or other mechanism. If the + * first parameter is a list of spec/suite IDs, only those specs/suites will + * be run. + * + * Both parameters are optional, but a completion callback is only valid as + * the second parameter. To specify a completion callback but not a list of + * specs/suites to run, pass null or undefined as the first parameter. + * + * execute should not be called more than once. + * + * If the environment supports promises, execute will return a promise that + * is resolved after the suite finishes executing. The promise will be + * resolved (not rejected) as long as the suite runs to completion. Use a + * {@link Reporter} to determine whether or not the suite passed. + * + * @name Env#execute + * @since 2.0.0 + * @function + * @param {(string[])=} runnablesToRun IDs of suites and/or specs to run + * @param {Function=} onComplete Function that will be called after all specs have run + * @return {Promise} + */ + this.execute = function(runnablesToRun, onComplete) { + if (this._executedBefore) { + topSuite.reset(); + } + this._executedBefore = true; + defaultResourcesForRunnable(topSuite.id); + installGlobalErrors(); + + if (!runnablesToRun) { if (focusedRunnables.length) { runnablesToRun = focusedRunnables; } else { @@ -841,84 +1967,218 @@ getJasmineRequireObj().Env = function(j$) { } var order = new j$.Order({ - random: random, - seed: seed + random: config.random, + seed: config.seed }); var processor = new j$.TreeProcessor({ tree: topSuite, runnableIds: runnablesToRun, queueRunnerFactory: queueRunnerFactory, - nodeStart: function(suite) { + failSpecWithNoExpectations: config.failSpecWithNoExpectations, + nodeStart: function(suite, next) { currentlyExecutingSuites.push(suite); defaultResourcesForRunnable(suite.id, suite.parentSuite.id); - reporter.suiteStarted(suite.result); + reporter.suiteStarted(suite.result, next); + suite.startTimer(); }, - nodeComplete: function(suite, result) { + nodeComplete: function(suite, result, next) { if (suite !== currentSuite()) { throw new Error('Tried to complete the wrong suite'); } - if (!suite.markedPending) { - clearResourcesForRunnable(suite.id); - } + clearResourcesForRunnable(suite.id); currentlyExecutingSuites.pop(); - reporter.suiteDone(result); + + if (result.status === 'failed') { + hasFailures = true; + } + suite.endTimer(); + reporter.suiteDone(result, next); }, orderChildren: function(node) { return order.sort(node.children); + }, + excludeNode: function(spec) { + return !config.specFilter(spec); } }); - if(!processor.processTree().valid) { - throw new Error('Invalid order: would cause a beforeAll or afterAll to be run multiple times'); + if (!processor.processTree().valid) { + throw new Error( + 'Invalid order: would cause a beforeAll or afterAll to be run multiple times' + ); } - reporter.jasmineStarted({ - totalSpecsDefined: totalSpecsDefined - }); + var jasmineTimer = new j$.Timer(); + jasmineTimer.start(); - currentlyExecutingSuites.push(topSuite); + var Promise = customPromise || global.Promise; - globalErrors.install(); - processor.execute(function() { - clearResourcesForRunnable(topSuite.id); - currentlyExecutingSuites.pop(); - globalErrors.uninstall(); + if (Promise) { + return new Promise(function(resolve) { + runAll(function() { + if (onComplete) { + onComplete(); + } - reporter.jasmineDone({ - order: order, - failedExpectations: topSuite.result.failedExpectations + resolve(); + }); }); - }); + } else { + runAll(function() { + if (onComplete) { + onComplete(); + } + }); + } + + function runAll(done) { + /** + * Information passed to the {@link Reporter#jasmineStarted} event. + * @typedef JasmineStartedInfo + * @property {Int} totalSpecsDefined - The total number of specs defined in this suite. + * @property {Order} order - Information about the ordering (random or not) of this execution of the suite. + * @since 2.0.0 + */ + reporter.jasmineStarted( + { + totalSpecsDefined: totalSpecsDefined, + order: order + }, + function() { + currentlyExecutingSuites.push(topSuite); + + processor.execute(function() { + clearResourcesForRunnable(topSuite.id); + currentlyExecutingSuites.pop(); + var overallStatus, incompleteReason; + + if ( + hasFailures || + topSuite.result.failedExpectations.length > 0 + ) { + overallStatus = 'failed'; + } else if (focusedRunnables.length > 0) { + overallStatus = 'incomplete'; + incompleteReason = 'fit() or fdescribe() was found'; + } else if (totalSpecsDefined === 0) { + overallStatus = 'incomplete'; + incompleteReason = 'No specs found'; + } else { + overallStatus = 'passed'; + } + + /** + * Information passed to the {@link Reporter#jasmineDone} event. + * @typedef JasmineDoneInfo + * @property {OverallStatus} overallStatus - The overall result of the suite: 'passed', 'failed', or 'incomplete'. + * @property {Int} totalTime - The total time (in ms) that it took to execute the suite + * @property {IncompleteReason} incompleteReason - Explanation of why the suite was incomplete. + * @property {Order} order - Information about the ordering (random or not) of this execution of the suite. + * @property {Expectation[]} failedExpectations - List of expectations that failed in an {@link afterAll} at the global level. + * @property {Expectation[]} deprecationWarnings - List of deprecation warnings that occurred at the global level. + * @since 2.4.0 + */ + reporter.jasmineDone( + { + overallStatus: overallStatus, + totalTime: jasmineTimer.elapsed(), + incompleteReason: incompleteReason, + order: order, + failedExpectations: topSuite.result.failedExpectations, + deprecationWarnings: topSuite.result.deprecationWarnings + }, + done + ); + }); + } + ); + } }; /** * Add a custom reporter to the Jasmine environment. * @name Env#addReporter + * @since 2.0.0 * @function + * @param {Reporter} reporterToAdd The reporter to be added. * @see custom_reporter */ this.addReporter = function(reporterToAdd) { reporter.addReporter(reporterToAdd); }; + /** + * Provide a fallback reporter if no other reporters have been specified. + * @name Env#provideFallbackReporter + * @since 2.5.0 + * @function + * @param {Reporter} reporterToAdd The reporter + * @see custom_reporter + */ this.provideFallbackReporter = function(reporterToAdd) { reporter.provideFallbackReporter(reporterToAdd); }; + /** + * Clear all registered reporters + * @name Env#clearReporters + * @since 2.5.2 + * @function + */ this.clearReporters = function() { reporter.clearReporters(); }; - var spyRegistry = new j$.SpyRegistry({currentSpies: function() { - if(!currentRunnable()) { - throw new Error('Spies must be created in a before function or a spec'); + var spyFactory = new j$.SpyFactory( + function getCustomStrategies() { + var runnable = currentRunnable(); + + if (runnable) { + return runnableResources[runnable.id].customSpyStrategies; + } + + return {}; + }, + function getDefaultStrategyFn() { + var runnable = currentRunnable(); + + if (runnable) { + return runnableResources[runnable.id].defaultStrategyFn; + } + + return undefined; + }, + function getPromise() { + return customPromise || global.Promise; + } + ); + + var spyRegistry = new j$.SpyRegistry({ + currentSpies: function() { + if (!currentRunnable()) { + throw new Error( + 'Spies must be created in a before function or a spec' + ); + } + return runnableResources[currentRunnable().id].spies; + }, + createSpy: function(name, originalFn) { + return self.createSpy(name, originalFn); } - return runnableResources[currentRunnable().id].spies; - }}); + }); - this.allowRespy = function(allow){ + /** + * Configures whether Jasmine should allow the same function to be spied on + * more than once during the execution of a spec. By default, spying on + * a function that is already a spy will cause an error. + * @name Env#allowRespy + * @function + * @since 2.5.0 + * @param {boolean} allow Whether to allow respying + */ + this.allowRespy = function(allow) { spyRegistry.allowRespy(allow); }; @@ -930,43 +2190,84 @@ getJasmineRequireObj().Env = function(j$) { return spyRegistry.spyOnProperty.apply(spyRegistry, arguments); }; + this.spyOnAllFunctions = function() { + return spyRegistry.spyOnAllFunctions.apply(spyRegistry, arguments); + }; + + this.createSpy = function(name, originalFn) { + if (arguments.length === 1 && j$.isFunction_(name)) { + originalFn = name; + name = originalFn.name; + } + + return spyFactory.createSpy(name, originalFn); + }; + + this.createSpyObj = function(baseName, methodNames, propertyNames) { + return spyFactory.createSpyObj(baseName, methodNames, propertyNames); + }; + var ensureIsFunction = function(fn, caller) { if (!j$.isFunction_(fn)) { - throw new Error(caller + ' expects a function argument; received ' + j$.getType_(fn)); + throw new Error( + caller + ' expects a function argument; received ' + j$.getType_(fn) + ); + } + }; + + var ensureIsFunctionOrAsync = function(fn, caller) { + if (!j$.isFunction_(fn) && !j$.isAsyncFunction_(fn)) { + throw new Error( + caller + ' expects a function argument; received ' + j$.getType_(fn) + ); } }; + function ensureIsNotNested(method) { + var runnable = currentRunnable(); + if (runnable !== null && runnable !== undefined) { + throw new Error( + "'" + method + "' should only be used in 'describe' function" + ); + } + } + var suiteFactory = function(description) { var suite = new j$.Suite({ env: self, id: getNextSuiteId(), description: description, parentSuite: currentDeclarationSuite, + timer: new j$.Timer(), expectationFactory: expectationFactory, + asyncExpectationFactory: suiteAsyncExpectationFactory, expectationResultFactory: expectationResultFactory, - throwOnExpectationFailure: throwOnExpectationFailure + throwOnExpectationFailure: config.oneFailurePerSpec, + autoCleanClosures: config.autoCleanClosures }); return suite; }; this.describe = function(description, specDefinitions) { + //ensureIsNotNested('describe'); ensureIsFunction(specDefinitions, 'describe'); var suite = suiteFactory(description); if (specDefinitions.length > 0) { throw new Error('describe does not expect any arguments'); } - if (currentDeclarationSuite.markedPending) { - suite.pend(); + if (currentDeclarationSuite.markedExcluding) { + suite.exclude(); } addSpecsToSuite(suite, specDefinitions); return suite; }; this.xdescribe = function(description, specDefinitions) { + ensureIsNotNested('xdescribe'); ensureIsFunction(specDefinitions, 'xdescribe'); var suite = suiteFactory(description); - suite.pend(); + suite.exclude(); addSpecsToSuite(suite, specDefinitions); return suite; }; @@ -974,6 +2275,7 @@ getJasmineRequireObj().Env = function(j$) { var focusedRunnables = []; this.fdescribe = function(description, specDefinitions) { + ensureIsNotNested('fdescribe'); ensureIsFunction(specDefinitions, 'fdescribe'); var suite = suiteFactory(description); suite.isFocused = true; @@ -998,9 +2300,7 @@ getJasmineRequireObj().Env = function(j$) { } if (declarationError) { - self.it('encountered a declaration exception', function() { - throw declarationError; - }); + suite.onException(declarationError); } currentDeclarationSuite = parentSuite; @@ -1035,6 +2335,7 @@ getJasmineRequireObj().Env = function(j$) { id: getNextSpecId(), beforeAndAfterFns: beforeAndAfterFns(suite), expectationFactory: expectationFactory, + asyncExpectationFactory: specAsyncExpectationFactory, resultCallback: specResultCallback, getSpecName: function(spec) { return getSpecName(spec, suite); @@ -1043,60 +2344,76 @@ getJasmineRequireObj().Env = function(j$) { description: description, expectationResultFactory: expectationResultFactory, queueRunnerFactory: queueRunnerFactory, - userContext: function() { return suite.clonedSharedUserContext(); }, + userContext: function() { + return suite.clonedSharedUserContext(); + }, queueableFn: { fn: fn, - timeout: function() { return timeout || j$.DEFAULT_TIMEOUT_INTERVAL; } + timeout: timeout || 0 }, - throwOnExpectationFailure: throwOnExpectationFailure + throwOnExpectationFailure: config.oneFailurePerSpec, + autoCleanClosures: config.autoCleanClosures, + timer: new j$.Timer() }); - - if (!self.specFilter(spec)) { - spec.disable(); - } - return spec; - function specResultCallback(result) { + function specResultCallback(result, next) { clearResourcesForRunnable(spec.id); currentSpec = null; - reporter.specDone(result); + + if (result.status === 'failed') { + hasFailures = true; + } + + reporter.specDone(result, next); } - function specStarted(spec) { + function specStarted(spec, next) { currentSpec = spec; defaultResourcesForRunnable(spec.id, suite.id); - reporter.specStarted(spec.result); + reporter.specStarted(spec.result, next); } }; this.it = function(description, fn, timeout) { + ensureIsNotNested('it'); // it() sometimes doesn't have a fn argument, so only check the type if // it's given. if (arguments.length > 1 && typeof fn !== 'undefined') { - ensureIsFunction(fn, 'it'); + ensureIsFunctionOrAsync(fn, 'it'); } + + if (timeout) { + j$.util.validateTimeout(timeout); + } + var spec = specFactory(description, fn, currentDeclarationSuite, timeout); - if (currentDeclarationSuite.markedPending) { - spec.pend(); + if (currentDeclarationSuite.markedExcluding) { + spec.exclude(); } currentDeclarationSuite.addChild(spec); return spec; }; this.xit = function(description, fn, timeout) { + ensureIsNotNested('xit'); // xit(), like it(), doesn't always have a fn argument, so only check the // type when needed. if (arguments.length > 1 && typeof fn !== 'undefined') { - ensureIsFunction(fn, 'xit'); + ensureIsFunctionOrAsync(fn, 'xit'); } var spec = this.it.apply(this, arguments); - spec.pend('Temporarily disabled with xit'); + spec.exclude('Temporarily disabled with xit'); return spec; }; - this.fit = function(description, fn, timeout){ - ensureIsFunction(fn, 'fit'); + this.fit = function(description, fn, timeout) { + ensureIsNotNested('fit'); + ensureIsFunctionOrAsync(fn, 'fit'); + + if (timeout) { + j$.util.validateTimeout(timeout); + } var spec = specFactory(description, fn, currentDeclarationSuite, timeout); currentDeclarationSuite.addChild(spec); focusedRunnables.push(spec.id); @@ -1104,49 +2421,120 @@ getJasmineRequireObj().Env = function(j$) { return spec; }; - this.expect = function(actual) { - if (!currentRunnable()) { - throw new Error('\'expect\' was used when there was no current spec, this could be because an asynchronous test timed out'); - } + /** + * Sets a user-defined property that will be provided to reporters as part of the properties field of {@link SpecResult} + * @name Env#setSpecProperty + * @since 3.6.0 + * @function + * @param {String} key The name of the property + * @param {*} value The value of the property + */ + this.setSpecProperty = function(key, value) { + if (!currentRunnable() || currentRunnable() == currentSuite()) { + throw new Error( + "'setSpecProperty' was used when there was no current spec" + ); + } + currentRunnable().setSpecProperty(key, value); + }; + + /** + * Sets a user-defined property that will be provided to reporters as part of the properties field of {@link SuiteResult} + * @name Env#setSuiteProperty + * @since 3.6.0 + * @function + * @param {String} key The name of the property + * @param {*} value The value of the property + */ + this.setSuiteProperty = function(key, value) { + if (!currentSuite()) { + throw new Error( + "'setSuiteProperty' was used when there was no current suite" + ); + } + currentSuite().setSuiteProperty(key, value); + }; + + this.expect = function(actual) { + if (!currentRunnable()) { + throw new Error( + "'expect' was used when there was no current spec, this could be because an asynchronous test timed out" + ); + } return currentRunnable().expect(actual); }; + this.expectAsync = function(actual) { + if (!currentRunnable()) { + throw new Error( + "'expectAsync' was used when there was no current spec, this could be because an asynchronous test timed out" + ); + } + + return currentRunnable().expectAsync(actual); + }; + this.beforeEach = function(beforeEachFunction, timeout) { - ensureIsFunction(beforeEachFunction, 'beforeEach'); + ensureIsNotNested('beforeEach'); + ensureIsFunctionOrAsync(beforeEachFunction, 'beforeEach'); + + if (timeout) { + j$.util.validateTimeout(timeout); + } + currentDeclarationSuite.beforeEach({ fn: beforeEachFunction, - timeout: function() { return timeout || j$.DEFAULT_TIMEOUT_INTERVAL; } + timeout: timeout || 0 }); }; this.beforeAll = function(beforeAllFunction, timeout) { - ensureIsFunction(beforeAllFunction, 'beforeAll'); + ensureIsNotNested('beforeAll'); + ensureIsFunctionOrAsync(beforeAllFunction, 'beforeAll'); + + if (timeout) { + j$.util.validateTimeout(timeout); + } + currentDeclarationSuite.beforeAll({ fn: beforeAllFunction, - timeout: function() { return timeout || j$.DEFAULT_TIMEOUT_INTERVAL; } + timeout: timeout || 0 }); }; this.afterEach = function(afterEachFunction, timeout) { - ensureIsFunction(afterEachFunction, 'afterEach'); + ensureIsNotNested('afterEach'); + ensureIsFunctionOrAsync(afterEachFunction, 'afterEach'); + + if (timeout) { + j$.util.validateTimeout(timeout); + } + + afterEachFunction.isCleanup = true; currentDeclarationSuite.afterEach({ fn: afterEachFunction, - timeout: function() { return timeout || j$.DEFAULT_TIMEOUT_INTERVAL; } + timeout: timeout || 0 }); }; this.afterAll = function(afterAllFunction, timeout) { - ensureIsFunction(afterAllFunction, 'afterAll'); + ensureIsNotNested('afterAll'); + ensureIsFunctionOrAsync(afterAllFunction, 'afterAll'); + + if (timeout) { + j$.util.validateTimeout(timeout); + } + currentDeclarationSuite.afterAll({ fn: afterAllFunction, - timeout: function() { return timeout || j$.DEFAULT_TIMEOUT_INTERVAL; } + timeout: timeout || 0 }); }; this.pending = function(message) { var fullMessage = j$.Spec.pendingSpecExceptionMessage; - if(message) { + if (message) { fullMessage += message; } throw fullMessage; @@ -1154,7 +2542,9 @@ getJasmineRequireObj().Env = function(j$) { this.fail = function(error) { if (!currentRunnable()) { - throw new Error('\'fail\' was used when there was no current spec, this could be because an asynchronous test timed out'); + throw new Error( + "'fail' was used when there was no current spec, this could be because an asynchronous test timed out" + ); } var message = 'Failed'; @@ -1162,11 +2552,11 @@ getJasmineRequireObj().Env = function(j$) { message += ': '; if (error.message) { message += error.message; - } else if (jasmine.isString_(error)) { + } else if (j$.isString_(error)) { message += error; } else { // pretty print all kind of objects. This includes arrays. - message += jasmine.pp(error); + message += makePrettyPrinter()(error); } } @@ -1178,29 +2568,32 @@ getJasmineRequireObj().Env = function(j$) { message: message, error: error && error.message ? error : null }); + + if (config.oneFailurePerSpec) { + throw new Error(message); + } + }; + + this.cleanup_ = function() { + if (globalErrors) { + globalErrors.uninstall(); + } }; } return Env; }; -getJasmineRequireObj().JsApiReporter = function() { - - var noopTimer = { - start: function(){}, - elapsed: function(){ return 0; } - }; - +getJasmineRequireObj().JsApiReporter = function(j$) { /** - * _Note:_ Do not construct this directly, use the global `jsApiReporter` to retrieve the instantiated object. - * * @name jsApiReporter - * @classdesc Reporter added by default in `boot.js` to record results for retrieval in javascript code. + * @classdesc {@link Reporter} added by default in `boot.js` to record results for retrieval in javascript code. An instance is made available as `jsApiReporter` on the global object. * @class + * @hideconstructor */ function JsApiReporter(options) { - var timer = options.timer || noopTimer, - status = 'loaded'; + var timer = options.timer || new j$.Timer(), + status = 'loaded'; this.started = false; this.finished = false; @@ -1224,6 +2617,7 @@ getJasmineRequireObj().JsApiReporter = function() { /** * Get the current status for the Jasmine environment. * @name jsApiReporter#status + * @since 2.0.0 * @function * @return {String} - One of `loaded`, `started`, or `done` */ @@ -1247,10 +2641,11 @@ getJasmineRequireObj().JsApiReporter = function() { * * Retrievable in slices for easier serialization. * @name jsApiReporter#suiteResults + * @since 2.1.0 * @function * @param {Number} index - The position in the suites list to start from. * @param {Number} length - Maximum number of suite results to return. - * @return {Object[]} + * @return {SuiteResult[]} */ this.suiteResults = function(index, length) { return suites.slice(index, index + length); @@ -1264,8 +2659,9 @@ getJasmineRequireObj().JsApiReporter = function() { /** * Get all of the suites in a single object, with their `id` as the key. * @name jsApiReporter#suites + * @since 2.0.0 * @function - * @return {Object} + * @return {Object} - Map of suite id to {@link SuiteResult} */ this.suites = function() { return suites_hash; @@ -1282,10 +2678,11 @@ getJasmineRequireObj().JsApiReporter = function() { * * Retrievable in slices for easier serialization. * @name jsApiReporter#specResults + * @since 2.0.0 * @function * @param {Number} index - The position in the specs list to start from. * @param {Number} length - Maximum number of specs results to return. - * @return {Object[]} + * @return {SpecResult[]} */ this.specResults = function(index, length) { return specs.slice(index, index + length); @@ -1294,8 +2691,9 @@ getJasmineRequireObj().JsApiReporter = function() { /** * Get all spec results. * @name jsApiReporter#specs + * @since 2.0.0 * @function - * @return {Object[]} + * @return {SpecResult[]} */ this.specs = function() { return specs; @@ -1304,25 +2702,24 @@ getJasmineRequireObj().JsApiReporter = function() { /** * Get the number of milliseconds it took for the full Jasmine suite to run. * @name jsApiReporter#executionTime + * @since 2.0.0 * @function * @return {Number} */ this.executionTime = function() { return executionTime; }; - } return JsApiReporter; }; getJasmineRequireObj().Any = function(j$) { - function Any(expectedObject) { if (typeof expectedObject === 'undefined') { throw new TypeError( 'jasmine.any() expects to be passed a constructor function. ' + - 'Please pass one or use jasmine.anything() to match any object.' + 'Please pass one or use jasmine.anything() to match any object.' ); } this.expectedObject = expectedObject; @@ -1342,13 +2739,20 @@ getJasmineRequireObj().Any = function(j$) { } if (this.expectedObject == Object) { - return typeof other == 'object'; + return other !== null && typeof other == 'object'; } if (this.expectedObject == Boolean) { return typeof other == 'boolean'; } + /* jshint -W122 */ + /* global Symbol */ + if (typeof Symbol != 'undefined' && this.expectedObject == Symbol) { + return typeof other == 'symbol'; + } + /* jshint +W122 */ + return other instanceof this.expectedObject; }; @@ -1360,7 +2764,6 @@ getJasmineRequireObj().Any = function(j$) { }; getJasmineRequireObj().Anything = function(j$) { - function Anything() {} Anything.prototype.asymmetricMatch = function(other) { @@ -1379,13 +2782,25 @@ getJasmineRequireObj().ArrayContaining = function(j$) { this.sample = sample; } - ArrayContaining.prototype.asymmetricMatch = function(other, customTesters) { - var className = Object.prototype.toString.call(this.sample); - if (className !== '[object Array]') { throw new Error('You must provide an array to arrayContaining, not \'' + this.sample + '\'.'); } + ArrayContaining.prototype.asymmetricMatch = function(other, matchersUtil) { + if (!j$.isArray_(this.sample)) { + throw new Error( + 'You must provide an array to arrayContaining, not ' + + j$.pp(this.sample) + + '.' + ); + } + + // If the actual parameter is not an array, we can fail immediately, since it couldn't + // possibly be an "array containing" anything. However, we also want an empty sample + // array to match anything, so we need to double-check we aren't in that case + if (!j$.isArray_(other) && this.sample.length > 0) { + return false; + } for (var i = 0; i < this.sample.length; i++) { var item = this.sample[i]; - if (!j$.matchersUtil.contains(other, item, customTesters)) { + if (!matchersUtil.contains(other, item)) { return false; } } @@ -1393,15 +2808,161 @@ getJasmineRequireObj().ArrayContaining = function(j$) { return true; }; - ArrayContaining.prototype.jasmineToString = function () { - return ''; + ArrayContaining.prototype.jasmineToString = function(pp) { + return ''; }; return ArrayContaining; }; -getJasmineRequireObj().ObjectContaining = function(j$) { +getJasmineRequireObj().ArrayWithExactContents = function(j$) { + function ArrayWithExactContents(sample) { + this.sample = sample; + } + + ArrayWithExactContents.prototype.asymmetricMatch = function( + other, + matchersUtil + ) { + if (!j$.isArray_(this.sample)) { + throw new Error( + 'You must provide an array to arrayWithExactContents, not ' + + j$.pp(this.sample) + + '.' + ); + } + + if (this.sample.length !== other.length) { + return false; + } + + for (var i = 0; i < this.sample.length; i++) { + var item = this.sample[i]; + if (!matchersUtil.contains(other, item)) { + return false; + } + } + + return true; + }; + + ArrayWithExactContents.prototype.jasmineToString = function(pp) { + return ''; + }; + + return ArrayWithExactContents; +}; + +getJasmineRequireObj().Empty = function(j$) { + function Empty() {} + + Empty.prototype.asymmetricMatch = function(other) { + if (j$.isString_(other) || j$.isArray_(other) || j$.isTypedArray_(other)) { + return other.length === 0; + } + + if (j$.isMap(other) || j$.isSet(other)) { + return other.size === 0; + } + + if (j$.isObject_(other)) { + return Object.keys(other).length === 0; + } + return false; + }; + + Empty.prototype.jasmineToString = function() { + return ''; + }; + + return Empty; +}; + +getJasmineRequireObj().Falsy = function(j$) { + function Falsy() {} + + Falsy.prototype.asymmetricMatch = function(other) { + return !other; + }; + + Falsy.prototype.jasmineToString = function() { + return ''; + }; + + return Falsy; +}; + +getJasmineRequireObj().MapContaining = function(j$) { + function MapContaining(sample) { + if (!j$.isMap(sample)) { + throw new Error( + 'You must provide a map to `mapContaining`, not ' + j$.pp(sample) + ); + } + + this.sample = sample; + } + + MapContaining.prototype.asymmetricMatch = function(other, matchersUtil) { + if (!j$.isMap(other)) return false; + + var hasAllMatches = true; + j$.util.forEachBreakable(this.sample, function(breakLoop, value, key) { + // for each key/value pair in `sample` + // there should be at least one pair in `other` whose key and value both match + var hasMatch = false; + j$.util.forEachBreakable(other, function(oBreakLoop, oValue, oKey) { + if ( + matchersUtil.equals(oKey, key) && + matchersUtil.equals(oValue, value) + ) { + hasMatch = true; + oBreakLoop(); + } + }); + if (!hasMatch) { + hasAllMatches = false; + breakLoop(); + } + }); + + return hasAllMatches; + }; + + MapContaining.prototype.jasmineToString = function(pp) { + return ''; + }; + + return MapContaining; +}; + +getJasmineRequireObj().NotEmpty = function(j$) { + function NotEmpty() {} + NotEmpty.prototype.asymmetricMatch = function(other) { + if (j$.isString_(other) || j$.isArray_(other) || j$.isTypedArray_(other)) { + return other.length !== 0; + } + + if (j$.isMap(other) || j$.isSet(other)) { + return other.size !== 0; + } + + if (j$.isObject_(other)) { + return Object.keys(other).length !== 0; + } + + return false; + }; + + NotEmpty.prototype.jasmineToString = function() { + return ''; + }; + + return NotEmpty; +}; + +getJasmineRequireObj().ObjectContaining = function(j$) { function ObjectContaining(sample) { this.sample = sample; } @@ -1419,7 +2980,7 @@ getJasmineRequireObj().ObjectContaining = function(j$) { } function hasProperty(obj, property) { - if (!obj) { + if (!obj || typeof obj !== 'object') { return false; } @@ -1430,12 +2991,23 @@ getJasmineRequireObj().ObjectContaining = function(j$) { return hasProperty(getPrototype(obj), property); } - ObjectContaining.prototype.asymmetricMatch = function(other, customTesters) { - if (typeof(this.sample) !== 'object') { throw new Error('You must provide an object to objectContaining, not \''+this.sample+'\'.'); } + ObjectContaining.prototype.asymmetricMatch = function(other, matchersUtil) { + if (typeof this.sample !== 'object') { + throw new Error( + "You must provide an object to objectContaining, not '" + + this.sample + + "'." + ); + } + if (typeof other !== 'object') { + return false; + } for (var property in this.sample) { - if (!hasProperty(other, property) || - !j$.matchersUtil.equals(this.sample[property], other[property], customTesters)) { + if ( + !hasProperty(other, property) || + !matchersUtil.equals(this.sample[property], other[property]) + ) { return false; } } @@ -1443,15 +3015,102 @@ getJasmineRequireObj().ObjectContaining = function(j$) { return true; }; - ObjectContaining.prototype.jasmineToString = function() { - return ''; + ObjectContaining.prototype.valuesForDiff_ = function(other, pp) { + if (!j$.isObject_(other)) { + return { + self: this.jasmineToString(pp), + other: other + }; + } + + var filteredOther = {}; + Object.keys(this.sample).forEach(function(k) { + // eq short-circuits comparison of objects that have different key sets, + // so include all keys even if undefined. + filteredOther[k] = other[k]; + }); + + return { + self: this.sample, + other: filteredOther + }; + }; + + ObjectContaining.prototype.jasmineToString = function(pp) { + return ''; }; return ObjectContaining; }; -getJasmineRequireObj().StringMatching = function(j$) { +getJasmineRequireObj().SetContaining = function(j$) { + function SetContaining(sample) { + if (!j$.isSet(sample)) { + throw new Error( + 'You must provide a set to `setContaining`, not ' + j$.pp(sample) + ); + } + + this.sample = sample; + } + + SetContaining.prototype.asymmetricMatch = function(other, matchersUtil) { + if (!j$.isSet(other)) return false; + + var hasAllMatches = true; + j$.util.forEachBreakable(this.sample, function(breakLoop, item) { + // for each item in `sample` there should be at least one matching item in `other` + // (not using `matchersUtil.contains` because it compares set members by reference, + // not by deep value equality) + var hasMatch = false; + j$.util.forEachBreakable(other, function(oBreakLoop, oItem) { + if (matchersUtil.equals(oItem, item)) { + hasMatch = true; + oBreakLoop(); + } + }); + if (!hasMatch) { + hasAllMatches = false; + breakLoop(); + } + }); + + return hasAllMatches; + }; + + SetContaining.prototype.jasmineToString = function(pp) { + return ''; + }; + + return SetContaining; +}; + +getJasmineRequireObj().StringContaining = function(j$) { + function StringContaining(expected) { + if (!j$.isString_(expected)) { + throw new Error('Expected is not a String'); + } + + this.expected = expected; + } + + StringContaining.prototype.asymmetricMatch = function(other) { + if (!j$.isString_(other)) { + // Arrays, etc. don't match no matter what their indexOf returns. + return false; + } + + return other.indexOf(this.expected) !== -1; + }; + + StringContaining.prototype.jasmineToString = function() { + return ''; + }; + return StringContaining; +}; + +getJasmineRequireObj().StringMatching = function(j$) { function StringMatching(expected) { if (!j$.isString_(expected) && !j$.isA_('RegExp', expected)) { throw new Error('Expected is not a String or a RegExp'); @@ -1471,31 +3130,140 @@ getJasmineRequireObj().StringMatching = function(j$) { return StringMatching; }; -getJasmineRequireObj().CallTracker = function(j$) { +getJasmineRequireObj().Truthy = function(j$) { + function Truthy() {} + + Truthy.prototype.asymmetricMatch = function(other) { + return !!other; + }; + + Truthy.prototype.jasmineToString = function() { + return ''; + }; + + return Truthy; +}; + +getJasmineRequireObj().asymmetricEqualityTesterArgCompatShim = function(j$) { + /* + Older versions of Jasmine passed an array of custom equality testers as the + second argument to each asymmetric equality tester's `asymmetricMatch` + method. Newer versions will pass a `MatchersUtil` instance. The + asymmetricEqualityTesterArgCompatShim allows for a graceful migration from + the old interface to the new by "being" both an array of custom equality + testers and a `MatchersUtil` at the same time. + + This code should be removed in the next major release. + */ + + var likelyArrayProps = [ + 'concat', + 'constructor', + 'copyWithin', + 'entries', + 'every', + 'fill', + 'filter', + 'find', + 'findIndex', + 'flat', + 'flatMap', + 'forEach', + 'includes', + 'indexOf', + 'join', + 'keys', + 'lastIndexOf', + 'length', + 'map', + 'pop', + 'push', + 'reduce', + 'reduceRight', + 'reverse', + 'shift', + 'slice', + 'some', + 'sort', + 'splice', + 'toLocaleString', + 'toSource', + 'toString', + 'unshift', + 'values' + ]; + + function asymmetricEqualityTesterArgCompatShim( + matchersUtil, + customEqualityTesters + ) { + var self = Object.create(matchersUtil), + props, + i, + k; + + copy(self, customEqualityTesters, 'length'); + + for (i = 0; i < customEqualityTesters.length; i++) { + copy(self, customEqualityTesters, i); + } + + var props = arrayProps(); + + for (i = 0; i < props.length; i++) { + k = props[i]; + // Skip length (dealt with above), and anything that collides with + // MatchesUtil e.g. an Array.prototype.contains method added by user code + if (k !== 'length' && !self[k]) { + copy(self, Array.prototype, k); + } + } + + return self; + } + + function copy(dest, src, propName) { + Object.defineProperty(dest, propName, { + get: function() { + return src[propName]; + } + }); + } + + function arrayProps() { + var props, a, k; + if (!Object.getOwnPropertyDescriptors) { + return likelyArrayProps.filter(function(k) { + return Array.prototype.hasOwnProperty(k); + }); + } + + props = Object.getOwnPropertyDescriptors(Array.prototype); // eslint-disable-line compat/compat + a = []; + + for (k in props) { + a.push(k); + } + + return a; + } + + return asymmetricEqualityTesterArgCompatShim; +}; + +getJasmineRequireObj().CallTracker = function(j$) { /** * @namespace Spy#calls + * @since 2.0.0 */ function CallTracker() { var calls = []; var opts = {}; - function argCloner(context) { - var clonedArgs = []; - var argsAsArray = j$.util.argsToArray(context.args); - for(var i = 0; i < argsAsArray.length; i++) { - if(Object.prototype.toString.apply(argsAsArray[i]).match(/^\[object/)) { - clonedArgs.push(j$.util.clone(argsAsArray[i])); - } else { - clonedArgs.push(argsAsArray[i]); - } - } - context.args = clonedArgs; - } - this.track = function(context) { - if(opts.cloneArgs) { - argCloner(context); + if (opts.cloneArgs) { + context.args = j$.util.cloneArgs(context.args); } calls.push(context); }; @@ -1503,6 +3271,7 @@ getJasmineRequireObj().CallTracker = function(j$) { /** * Check whether this spy has been invoked. * @name Spy#calls#any + * @since 2.0.0 * @function * @return {Boolean} */ @@ -1513,6 +3282,7 @@ getJasmineRequireObj().CallTracker = function(j$) { /** * Get the number of invocations of this spy. * @name Spy#calls#count + * @since 2.0.0 * @function * @return {Integer} */ @@ -1523,6 +3293,7 @@ getJasmineRequireObj().CallTracker = function(j$) { /** * Get the arguments that were passed to a specific invocation of this spy. * @name Spy#calls#argsFor + * @since 2.0.0 * @function * @param {Integer} index The 0-based invocation index. * @return {Array} @@ -1532,9 +3303,23 @@ getJasmineRequireObj().CallTracker = function(j$) { return call ? call.args : []; }; + /** + * Get the "this" object that was passed to a specific invocation of this spy. + * @name Spy#calls#thisFor + * @since 3.8.0 + * @function + * @param {Integer} index The 0-based invocation index. + * @return {Object?} + */ + this.thisFor = function(index) { + var call = calls[index]; + return call ? call.object : undefined; + }; + /** * Get the raw calls array for this spy. * @name Spy#calls#all + * @since 2.0.0 * @function * @return {Spy.callData[]} */ @@ -1545,12 +3330,13 @@ getJasmineRequireObj().CallTracker = function(j$) { /** * Get all of the arguments for each invocation of this spy in the order they were received. * @name Spy#calls#allArgs + * @since 2.0.0 * @function * @return {Array} */ this.allArgs = function() { var callArgs = []; - for(var i = 0; i < calls.length; i++){ + for (var i = 0; i < calls.length; i++) { callArgs.push(calls[i].args); } @@ -1560,6 +3346,7 @@ getJasmineRequireObj().CallTracker = function(j$) { /** * Get the first invocation of this spy. * @name Spy#calls#first + * @since 2.0.0 * @function * @return {ObjecSpy.callData} */ @@ -1570,6 +3357,7 @@ getJasmineRequireObj().CallTracker = function(j$) { /** * Get the most recent invocation of this spy. * @name Spy#calls#mostRecent + * @since 2.0.0 * @function * @return {ObjecSpy.callData} */ @@ -1580,6 +3368,7 @@ getJasmineRequireObj().CallTracker = function(j$) { /** * Reset this spy as if it has never been called. * @name Spy#calls#reset + * @since 2.0.0 * @function */ this.reset = function() { @@ -1589,12 +3378,12 @@ getJasmineRequireObj().CallTracker = function(j$) { /** * Set this spy to do a shallow clone of arguments passed to each invocation. * @name Spy#calls#saveArgumentsByValue + * @since 2.5.0 * @function */ this.saveArgumentsByValue = function() { opts.cloneArgs = true; }; - } return CallTracker; @@ -1605,8 +3394,8 @@ getJasmineRequireObj().clearStack = function(j$) { function messageChannelImpl(global, setTimeout) { var channel = new global.MessageChannel(), - head = {}, - tail = head; + head = {}, + tail = head; var taskRunning = false; channel.port1.onmessage = function() { @@ -1644,7 +3433,7 @@ getJasmineRequireObj().clearStack = function(j$) { var currentCallCount = 0; var realSetTimeout = global.setTimeout; var setTimeoutImpl = function clearStack(fn) { - Function.prototype.apply.apply(realSetTimeout, [global, [fn, 0]]); + Function.prototype.apply.apply(realSetTimeout, [global, [fn, 0]]); }; if (j$.isFunction_(global.setImmediate)) { @@ -1671,10 +3460,19 @@ getJasmineRequireObj().clearStack = function(j$) { }; getJasmineRequireObj().Clock = function() { + /* global process */ + var NODE_JS = + typeof process !== 'undefined' && + process.versions && + typeof process.versions.node === 'string'; + /** - * _Note:_ Do not construct this directly, Jasmine will make one during booting. You can get the current clock with {@link jasmine.clock}. * @class Clock - * @classdesc Jasmine's mock clock is used when testing time dependent code. + * @since 1.3.0 + * @classdesc Jasmine's mock clock is used when testing time dependent code.
+ * _Note:_ Do not construct this directly. You can get the current clock with + * {@link jasmine.clock}. + * @hideconstructor */ function Clock(global, delayedFunctionSchedulerFactory, mockDate) { var self = this, @@ -1694,16 +3492,20 @@ getJasmineRequireObj().Clock = function() { delayedFunctionScheduler, timer; + self.FakeTimeout = FakeTimeout; /** * Install the mock clock over the built-in methods. * @name Clock#install + * @since 2.0.0 * @function * @return {Clock} */ self.install = function() { - if(!originalTimingFunctionsIntact()) { - throw new Error('Jasmine Clock was unable to install over custom global timer functions. Is the clock already installed?'); + if (!originalTimingFunctionsIntact()) { + throw new Error( + 'Jasmine Clock was unable to install over custom global timer functions. Is the clock already installed?' + ); } replace(global, fakeTimingFunctions); timer = fakeTimingFunctions; @@ -1716,6 +3518,7 @@ getJasmineRequireObj().Clock = function() { /** * Uninstall the mock clock, returning the built-in methods to their places. * @name Clock#uninstall + * @since 2.0.0 * @function */ self.uninstall = function() { @@ -1732,8 +3535,9 @@ getJasmineRequireObj().Clock = function() { * * The clock will be {@link Clock#install|install}ed before the function is called and {@link Clock#uninstall|uninstall}ed in a `finally` after the function completes. * @name Clock#withMock + * @since 2.3.0 * @function - * @param {closure} Function The function to be called. + * @param {Function} closure The function to be called. */ self.withMock = function(closure) { this.install(); @@ -1747,6 +3551,7 @@ getJasmineRequireObj().Clock = function() { /** * Instruct the installed Clock to also mock the date returned by `new Date()` * @name Clock#mockDate + * @since 2.1.0 * @function * @param {Date} [initialDate=now] The `Date` to provide. */ @@ -1755,23 +3560,17 @@ getJasmineRequireObj().Clock = function() { }; self.setTimeout = function(fn, delay, params) { - if (legacyIE()) { - if (arguments.length > 2) { - throw new Error('IE < 9 cannot support extra params to setTimeout without a polyfill'); - } - return timer.setTimeout(fn, delay); - } - return Function.prototype.apply.apply(timer.setTimeout, [global, arguments]); + return Function.prototype.apply.apply(timer.setTimeout, [ + global, + arguments + ]); }; self.setInterval = function(fn, delay, params) { - if (legacyIE()) { - if (arguments.length > 2) { - throw new Error('IE < 9 cannot support extra params to setInterval without a polyfill'); - } - return timer.setInterval(fn, delay); - } - return Function.prototype.apply.apply(timer.setInterval, [global, arguments]); + return Function.prototype.apply.apply(timer.setInterval, [ + global, + arguments + ]); }; self.clearTimeout = function(id) { @@ -1785,29 +3584,31 @@ getJasmineRequireObj().Clock = function() { /** * Tick the Clock forward, running any enqueued timeouts along the way * @name Clock#tick + * @since 1.3.0 * @function * @param {int} millis The number of milliseconds to tick. */ self.tick = function(millis) { if (installed) { - delayedFunctionScheduler.tick(millis, function(millis) { mockDate.tick(millis); }); + delayedFunctionScheduler.tick(millis, function(millis) { + mockDate.tick(millis); + }); } else { - throw new Error('Mock clock is not installed, use jasmine.clock().install()'); + throw new Error( + 'Mock clock is not installed, use jasmine.clock().install()' + ); } }; return self; function originalTimingFunctionsIntact() { - return global.setTimeout === realTimingFunctions.setTimeout && + return ( + global.setTimeout === realTimingFunctions.setTimeout && global.clearTimeout === realTimingFunctions.clearTimeout && global.setInterval === realTimingFunctions.setInterval && - global.clearInterval === realTimingFunctions.clearInterval; - } - - function legacyIE() { - //if these methods are polyfilled, apply will be present - return !(realTimingFunctions.setTimeout || realTimingFunctions.setInterval).apply; + global.clearInterval === realTimingFunctions.clearInterval + ); } function replace(dest, source) { @@ -1817,7 +3618,25 @@ getJasmineRequireObj().Clock = function() { } function setTimeout(fn, delay) { - return delayedFunctionScheduler.scheduleFunction(fn, delay, argSlice(arguments, 2)); + if (!NODE_JS) { + return delayedFunctionScheduler.scheduleFunction( + fn, + delay, + argSlice(arguments, 2) + ); + } + + var timeout = new FakeTimeout(); + + delayedFunctionScheduler.scheduleFunction( + fn, + delay, + argSlice(arguments, 2), + false, + timeout + ); + + return timeout; } function clearTimeout(id) { @@ -1825,7 +3644,26 @@ getJasmineRequireObj().Clock = function() { } function setInterval(fn, interval) { - return delayedFunctionScheduler.scheduleFunction(fn, interval, argSlice(arguments, 2), true); + if (!NODE_JS) { + return delayedFunctionScheduler.scheduleFunction( + fn, + interval, + argSlice(arguments, 2), + true + ); + } + + var timeout = new FakeTimeout(); + + delayedFunctionScheduler.scheduleFunction( + fn, + interval, + argSlice(arguments, 2), + true, + timeout + ); + + return timeout; } function clearInterval(id) { @@ -1837,16 +3675,30 @@ getJasmineRequireObj().Clock = function() { } } + /** + * Mocks Node.js Timeout class + */ + function FakeTimeout() {} + + FakeTimeout.prototype.ref = function() { + return this; + }; + + FakeTimeout.prototype.unref = function() { + return this; + }; + return Clock; }; -getJasmineRequireObj().DelayedFunctionScheduler = function() { +getJasmineRequireObj().DelayedFunctionScheduler = function(j$) { function DelayedFunctionScheduler() { var self = this; var scheduledLookup = []; var scheduledFunctions = {}; var currentTime = 0; var delayedFnCount = 0; + var deletedKeys = []; self.tick = function(millis, tickDate) { millis = millis || 0; @@ -1856,11 +3708,20 @@ getJasmineRequireObj().DelayedFunctionScheduler = function() { currentTime = endTime; }; - self.scheduleFunction = function(funcToCall, millis, params, recurring, timeoutKey, runAtMillis) { + self.scheduleFunction = function( + funcToCall, + millis, + params, + recurring, + timeoutKey, + runAtMillis + ) { var f; - if (typeof(funcToCall) === 'string') { + if (typeof funcToCall === 'string') { /* jshint evil: true */ - f = function() { return eval(funcToCall); }; + f = function() { + return eval(funcToCall); + }; /* jshint evil: false */ } else { f = funcToCall; @@ -1868,7 +3729,7 @@ getJasmineRequireObj().DelayedFunctionScheduler = function() { millis = millis || 0; timeoutKey = timeoutKey || ++delayedFnCount; - runAtMillis = runAtMillis || (currentTime + millis); + runAtMillis = runAtMillis || currentTime + millis; var funcToSchedule = { runAtMillis: runAtMillis, @@ -1884,7 +3745,7 @@ getJasmineRequireObj().DelayedFunctionScheduler = function() { } else { scheduledFunctions[runAtMillis] = [funcToSchedule]; scheduledLookup.push(runAtMillis); - scheduledLookup.sort(function (a, b) { + scheduledLookup.sort(function(a, b) { return a - b; }); } @@ -1893,9 +3754,11 @@ getJasmineRequireObj().DelayedFunctionScheduler = function() { }; self.removeFunctionWithId = function(timeoutKey) { + deletedKeys.push(timeoutKey); + for (var runAtMillis in scheduledFunctions) { var funcs = scheduledFunctions[runAtMillis]; - var i = indexOfFirstToPass(funcs, function (func) { + var i = indexOfFirstToPass(funcs, function(func) { return func.timeoutKey === timeoutKey; }); @@ -1931,7 +3794,7 @@ getJasmineRequireObj().DelayedFunctionScheduler = function() { function deleteFromLookup(key) { var value = Number(key); - var i = indexOfFirstToPass(scheduledLookup, function (millis) { + var i = indexOfFirstToPass(scheduledLookup, function(millis) { return millis === value; }); @@ -1941,12 +3804,14 @@ getJasmineRequireObj().DelayedFunctionScheduler = function() { } function reschedule(scheduledFn) { - self.scheduleFunction(scheduledFn.funcToCall, + self.scheduleFunction( + scheduledFn.funcToCall, scheduledFn.millis, scheduledFn.params, true, scheduledFn.timeoutKey, - scheduledFn.runAtMillis + scheduledFn.millis); + scheduledFn.runAtMillis + scheduledFn.millis + ); } function forEachFunction(funcsToRun, callback) { @@ -1963,12 +3828,14 @@ getJasmineRequireObj().DelayedFunctionScheduler = function() { } do { + deletedKeys = []; var newCurrentTime = scheduledLookup.shift(); tickDate(newCurrentTime - currentTime); currentTime = newCurrentTime; var funcsToRun = scheduledFunctions[currentTime]; + delete scheduledFunctions[currentTime]; forEachFunction(funcsToRun, function(funcToRun) { @@ -1978,13 +3845,20 @@ getJasmineRequireObj().DelayedFunctionScheduler = function() { }); forEachFunction(funcsToRun, function(funcToRun) { + if (j$.util.arrayContains(deletedKeys, funcToRun.timeoutKey)) { + // skip a timeoutKey deleted whilst we were running + return; + } funcToRun.funcToCall.apply(null, funcToRun.params || []); }); - } while (scheduledLookup.length > 0 && - // checking first if we're out of time prevents setTimeout(0) - // scheduled in a funcToRun from forcing an extra iteration - currentTime !== endTime && - scheduledLookup[0] <= endTime); + deletedKeys = []; + } while ( + scheduledLookup.length > 0 && + // checking first if we're out of time prevents setTimeout(0) + // scheduled in a funcToRun from forcing an extra iteration + currentTime !== endTime && + scheduledLookup[0] <= endTime + ); // ran out of functions to call, but still time left on the clock if (currentTime !== endTime) { @@ -2006,13 +3880,32 @@ getJasmineRequireObj().errors = function() { ExpectationFailed: ExpectationFailed }; }; -getJasmineRequireObj().ExceptionFormatter = function() { - function ExceptionFormatter() { + +getJasmineRequireObj().ExceptionFormatter = function(j$) { + var ignoredProperties = [ + 'name', + 'message', + 'stack', + 'fileName', + 'sourceURL', + 'line', + 'lineNumber', + 'column', + 'description', + 'jasmineMessage' + ]; + + function ExceptionFormatter(options) { + var jasmineFile = (options && options.jasmineFile) || j$.util.jasmineFile(); this.message = function(error) { var message = ''; - if (error.name && error.message) { + if (error.jasmineMessage) { + message += error.jasmineMessage; + } else if (error.name && error.message) { message += error.name + ': ' + error.message; + } else if (error.message) { + message += error.message; } else { message += error.toString() + ' thrown'; } @@ -2029,118 +3922,408 @@ getJasmineRequireObj().ExceptionFormatter = function() { }; this.stack = function(error) { - return error ? error.stack : null; - }; - } + if (!error || !error.stack) { + return null; + } - return ExceptionFormatter; -}; + var stackTrace = new j$.StackTrace(error); + var lines = filterJasmine(stackTrace); + var result = ''; -getJasmineRequireObj().Expectation = function() { + if (stackTrace.message) { + lines.unshift(stackTrace.message); + } + result += formatProperties(error); + result += lines.join('\n'); + + return result; + }; + + function filterJasmine(stackTrace) { + var result = [], + jasmineMarker = + stackTrace.style === 'webkit' ? '' : ' at '; + + stackTrace.frames.forEach(function(frame) { + if (frame.file !== jasmineFile) { + result.push(frame.raw); + } else if (result[result.length - 1] !== jasmineMarker) { + result.push(jasmineMarker); + } + }); + + return result; + } + + function formatProperties(error) { + if (!(error instanceof Object)) { + return; + } + + var result = {}; + var empty = true; + + for (var prop in error) { + if (j$.util.arrayContains(ignoredProperties, prop)) { + continue; + } + result[prop] = error[prop]; + empty = false; + } + + if (!empty) { + return 'error properties: ' + j$.pp(result) + '\n'; + } + + return ''; + } + } + + return ExceptionFormatter; +}; + +getJasmineRequireObj().Expectation = function(j$) { /** * Matchers that come with Jasmine out of the box. * @namespace matchers */ function Expectation(options) { - this.util = options.util || { buildFailureMessage: function() {} }; - this.customEqualityTesters = options.customEqualityTesters || []; - this.actual = options.actual; - this.addExpectationResult = options.addExpectationResult || function(){}; - this.isNot = options.isNot; + this.expector = new j$.Expector(options); var customMatchers = options.customMatchers || {}; for (var matcherName in customMatchers) { - this[matcherName] = Expectation.prototype.wrapCompare(matcherName, customMatchers[matcherName]); + this[matcherName] = wrapSyncCompare( + matcherName, + customMatchers[matcherName] + ); } } - Expectation.prototype.wrapCompare = function(name, matcherFactory) { + /** + * Add some context for an {@link expect} + * @function + * @name matchers#withContext + * @since 3.3.0 + * @param {String} message - Additional context to show when the matcher fails + * @return {matchers} + */ + Expectation.prototype.withContext = function withContext(message) { + return addFilter(this, new ContextAddingFilter(message)); + }; + + /** + * Invert the matcher following this {@link expect} + * @member + * @name matchers#not + * @since 1.3.0 + * @type {matchers} + * @example + * expect(something).not.toBe(true); + */ + Object.defineProperty(Expectation.prototype, 'not', { + get: function() { + return addFilter(this, syncNegatingFilter); + } + }); + + /** + * Asynchronous matchers that operate on an actual value which is a promise, + * and return a promise. + * + * Most async matchers will wait indefinitely for the promise to be resolved + * or rejected, resulting in a spec timeout if that never happens. If you + * expect that the promise will already be resolved or rejected at the time + * the matcher is called, you can use the {@link async-matchers#already} + * modifier to get a faster failure with a more helpful message. + * + * Note: Specs must await the result of each async matcher, return the + * promise returned by the matcher, or return a promise that's derived from + * the one returned by the matcher. Otherwise the matcher will not be + * evaluated before the spec completes. + * + * @example + * // Good + * await expectAsync(aPromise).toBeResolved(); + * @example + * // Good + * return expectAsync(aPromise).toBeResolved(); + * @example + * // Good + * return expectAsync(aPromise).toBeResolved() + * .then(function() { + * // more spec code + * }); + * @example + * // Bad + * expectAsync(aPromise).toBeResolved(); + * @namespace async-matchers + */ + function AsyncExpectation(options) { + var global = options.global || j$.getGlobal(); + this.expector = new j$.Expector(options); + + if (!global.Promise) { + throw new Error( + 'expectAsync is unavailable because the environment does not support promises.' + ); + } + + var customAsyncMatchers = options.customAsyncMatchers || {}; + for (var matcherName in customAsyncMatchers) { + this[matcherName] = wrapAsyncCompare( + matcherName, + customAsyncMatchers[matcherName] + ); + } + } + + /** + * Add some context for an {@link expectAsync} + * @function + * @name async-matchers#withContext + * @since 3.3.0 + * @param {String} message - Additional context to show when the async matcher fails + * @return {async-matchers} + */ + AsyncExpectation.prototype.withContext = function withContext(message) { + return addFilter(this, new ContextAddingFilter(message)); + }; + + /** + * Invert the matcher following this {@link expectAsync} + * @member + * @name async-matchers#not + * @type {async-matchers} + * @example + * await expectAsync(myPromise).not.toBeResolved(); + * @example + * return expectAsync(myPromise).not.toBeResolved(); + */ + Object.defineProperty(AsyncExpectation.prototype, 'not', { + get: function() { + return addFilter(this, asyncNegatingFilter); + } + }); + + /** + * Fail as soon as possible if the actual is pending. + * Otherwise evaluate the matcher. + * @member + * @name async-matchers#already + * @since 3.8.0 + * @type {async-matchers} + * @example + * await expectAsync(myPromise).already.toBeResolved(); + * @example + * return expectAsync(myPromise).already.toBeResolved(); + */ + Object.defineProperty(AsyncExpectation.prototype, 'already', { + get: function() { + return addFilter(this, expectSettledPromiseFilter); + } + }); + + function wrapSyncCompare(name, matcherFactory) { + return function() { + var result = this.expector.compare(name, matcherFactory, arguments); + this.expector.processResult(result); + }; + } + + function wrapAsyncCompare(name, matcherFactory) { return function() { - var args = Array.prototype.slice.call(arguments, 0), - expected = args.slice(0), - message = ''; + var self = this; - args.unshift(this.actual); + // Capture the call stack here, before we go async, so that it will contain + // frames that are relevant to the user instead of just parts of Jasmine. + var errorForStack = j$.util.errorWithStack(); - var matcher = matcherFactory(this.util, this.customEqualityTesters), - matcherCompare = matcher.compare; + return this.expector + .compare(name, matcherFactory, arguments) + .then(function(result) { + self.expector.processResult(result, errorForStack); + }); + }; + } + function addCoreMatchers(prototype, matchers, wrapper) { + for (var matcherName in matchers) { + var matcher = matchers[matcherName]; + prototype[matcherName] = wrapper(matcherName, matcher); + } + } + + function addFilter(source, filter) { + var result = Object.create(source); + result.expector = source.expector.addFilter(filter); + return result; + } + + function negatedFailureMessage(result, matcherName, args, matchersUtil) { + if (result.message) { + if (j$.isFunction_(result.message)) { + return result.message(); + } else { + return result.message; + } + } + + args = args.slice(); + args.unshift(true); + args.unshift(matcherName); + return matchersUtil.buildFailureMessage.apply(matchersUtil, args); + } + + function negate(result) { + result.pass = !result.pass; + return result; + } + + var syncNegatingFilter = { + selectComparisonFunc: function(matcher) { function defaultNegativeCompare() { - var result = matcher.compare.apply(null, args); - result.pass = !result.pass; - return result; + return negate(matcher.compare.apply(null, arguments)); } - if (this.isNot) { - matcherCompare = matcher.negativeCompare || defaultNegativeCompare; + return matcher.negativeCompare || defaultNegativeCompare; + }, + buildFailureMessage: negatedFailureMessage + }; + + var asyncNegatingFilter = { + selectComparisonFunc: function(matcher) { + function defaultNegativeCompare() { + return matcher.compare.apply(this, arguments).then(negate); } - var result = matcherCompare.apply(null, args); + return matcher.negativeCompare || defaultNegativeCompare; + }, + buildFailureMessage: negatedFailureMessage + }; - if (!result.pass) { - if (!result.message) { - args.unshift(this.isNot); - args.unshift(name); - message = this.util.buildFailureMessage.apply(null, args); - } else { - if (Object.prototype.toString.apply(result.message) === '[object Function]') { - message = result.message(); + var expectSettledPromiseFilter = { + selectComparisonFunc: function(matcher) { + return function(actual) { + var matcherArgs = arguments; + + return j$.isPending_(actual).then(function(isPending) { + if (isPending) { + return { + pass: false, + message: + 'Expected a promise to be settled (via ' + + 'expectAsync(...).already) but it was pending.' + }; } else { - message = result.message; + return matcher.compare.apply(null, matcherArgs); } - } - } + }); + }; + } + }; - if (expected.length == 1) { - expected = expected[0]; - } + function ContextAddingFilter(message) { + this.message = message; + } - // TODO: how many of these params are needed? - this.addExpectationResult( - result.pass, - { - matcherName: name, - passed: result.pass, - message: message, - error: result.error, - actual: this.actual, - expected: expected // TODO: this may need to be arrayified/sliced - } - ); - }; + ContextAddingFilter.prototype.modifyFailureMessage = function(msg) { + var nl = msg.indexOf('\n'); + + if (nl === -1) { + return this.message + ': ' + msg; + } else { + return this.message + ':\n' + indent(msg); + } }; - Expectation.addCoreMatchers = function(matchers) { - var prototype = Expectation.prototype; - for (var matcherName in matchers) { - var matcher = matchers[matcherName]; - prototype[matcherName] = prototype.wrapCompare(matcherName, matcher); + function indent(s) { + return s.replace(/^/gm, ' '); + } + + return { + factory: function(options) { + return new Expectation(options || {}); + }, + addCoreMatchers: function(matchers) { + addCoreMatchers(Expectation.prototype, matchers, wrapSyncCompare); + }, + asyncFactory: function(options) { + return new AsyncExpectation(options || {}); + }, + addAsyncCoreMatchers: function(matchers) { + addCoreMatchers(AsyncExpectation.prototype, matchers, wrapAsyncCompare); } }; +}; - Expectation.Factory = function(options) { - options = options || {}; +getJasmineRequireObj().ExpectationFilterChain = function() { + function ExpectationFilterChain(maybeFilter, prev) { + this.filter_ = maybeFilter; + this.prev_ = prev; + } - var expect = new Expectation(options); + ExpectationFilterChain.prototype.addFilter = function(filter) { + return new ExpectationFilterChain(filter, this); + }; - // TODO: this would be nice as its own Object - NegativeExpectation - // TODO: copy instead of mutate options - options.isNot = true; - expect.not = new Expectation(options); + ExpectationFilterChain.prototype.selectComparisonFunc = function(matcher) { + return this.callFirst_('selectComparisonFunc', arguments).result; + }; - return expect; + ExpectationFilterChain.prototype.buildFailureMessage = function( + result, + matcherName, + args, + matchersUtil + ) { + return this.callFirst_('buildFailureMessage', arguments).result; }; - return Expectation; + ExpectationFilterChain.prototype.modifyFailureMessage = function(msg) { + var result = this.callFirst_('modifyFailureMessage', arguments).result; + return result || msg; + }; + + ExpectationFilterChain.prototype.callFirst_ = function(fname, args) { + var prevResult; + + if (this.prev_) { + prevResult = this.prev_.callFirst_(fname, args); + + if (prevResult.found) { + return prevResult; + } + } + + if (this.filter_ && this.filter_[fname]) { + return { + found: true, + result: this.filter_[fname].apply(this.filter_, args) + }; + } + + return { found: false }; + }; + + return ExpectationFilterChain; }; //TODO: expectation result may make more sense as a presentation of an expectation. -getJasmineRequireObj().buildExpectationResult = function() { +getJasmineRequireObj().buildExpectationResult = function(j$) { function buildExpectationResult(options) { var messageFormatter = options.messageFormatter || function() {}, stackFormatter = options.stackFormatter || function() {}; + /** + * @typedef Expectation + * @property {String} matcherName - The name of the matcher that was executed for this expectation. + * @property {String} message - The failure message for the expectation. + * @property {String} stack - The stack trace for the failure if available. + * @property {Boolean} passed - Whether the expectation passed or failed. + * @property {Object} expected - If the expectation failed, what was the expected value. + * @property {Object} actual - If the expectation failed, what actual value was produced. + */ var result = { matcherName: options.matcherName, message: message(), @@ -2148,9 +4331,25 @@ getJasmineRequireObj().buildExpectationResult = function() { passed: options.passed }; - if(!result.passed) { + if (!result.passed) { result.expected = options.expected; result.actual = options.actual; + + if (options.error && !j$.isString_(options.error)) { + if ('code' in options.error) { + result.code = options.error.code; + } + + if ( + options.error.code === 'ERR_ASSERTION' && + options.expected === '' && + options.actual === '' + ) { + result.expected = options.error.expected; + result.actual = options.error.actual; + result.matcherName = 'assert ' + options.error.operator; + } + } } return result; @@ -2173,10 +4372,16 @@ getJasmineRequireObj().buildExpectationResult = function() { var error = options.error; if (!error) { - try { - throw new Error(message()); - } catch (e) { - error = e; + if (options.errorForStack) { + error = options.errorForStack; + } else if (options.stack) { + error = options; + } else { + try { + throw new Error(message()); + } catch (e) { + error = e; + } } } return stackFormatter(error); @@ -2186,6 +4391,102 @@ getJasmineRequireObj().buildExpectationResult = function() { return buildExpectationResult; }; +getJasmineRequireObj().Expector = function(j$) { + function Expector(options) { + this.matchersUtil = options.matchersUtil || { + buildFailureMessage: function() {} + }; + this.customEqualityTesters = options.customEqualityTesters || []; + this.actual = options.actual; + this.addExpectationResult = options.addExpectationResult || function() {}; + this.filters = new j$.ExpectationFilterChain(); + } + + Expector.prototype.instantiateMatcher = function( + matcherName, + matcherFactory, + args + ) { + this.matcherName = matcherName; + this.args = Array.prototype.slice.call(args, 0); + this.expected = this.args.slice(0); + + this.args.unshift(this.actual); + + var matcher = matcherFactory(this.matchersUtil, this.customEqualityTesters); + var comparisonFunc = this.filters.selectComparisonFunc(matcher); + return comparisonFunc || matcher.compare; + }; + + Expector.prototype.buildMessage = function(result) { + var self = this; + + if (result.pass) { + return ''; + } + + var msg = this.filters.buildFailureMessage( + result, + this.matcherName, + this.args, + this.matchersUtil, + defaultMessage + ); + return this.filters.modifyFailureMessage(msg || defaultMessage()); + + function defaultMessage() { + if (!result.message) { + var args = self.args.slice(); + args.unshift(false); + args.unshift(self.matcherName); + return self.matchersUtil.buildFailureMessage.apply( + self.matchersUtil, + args + ); + } else if (j$.isFunction_(result.message)) { + return result.message(); + } else { + return result.message; + } + } + }; + + Expector.prototype.compare = function(matcherName, matcherFactory, args) { + var matcherCompare = this.instantiateMatcher( + matcherName, + matcherFactory, + args + ); + return matcherCompare.apply(null, this.args); + }; + + Expector.prototype.addFilter = function(filter) { + var result = Object.create(this); + result.filters = this.filters.addFilter(filter); + return result; + }; + + Expector.prototype.processResult = function(result, errorForStack) { + var message = this.buildMessage(result); + + if (this.expected.length === 1) { + this.expected = this.expected[0]; + } + + this.addExpectationResult(result.pass, { + matcherName: this.matcherName, + passed: result.pass, + message: message, + error: errorForStack ? undefined : result.error, + errorForStack: errorForStack || undefined, + actual: this.actual, + expected: this.expected // TODO: this may need to be arrayified/sliced + }); + }; + + return Expector; +}; + getJasmineRequireObj().formatErrorMsg = function() { function generateErrorMsg(domain, usage) { var usageDefinition = usage ? '\nUsage: ' + usage : ''; @@ -2213,26 +4514,102 @@ getJasmineRequireObj().GlobalErrors = function(j$) { } }; - this.uninstall = function noop() {}; + this.originalHandlers = {}; + this.jasmineHandlers = {}; + this.installOne_ = function installOne_(errorType, jasmineMessage) { + function taggedOnError(error) { + var substituteMsg; - this.install = function install() { - if (global.process && global.process.listeners && j$.isFunction_(global.process.on)) { - var originalHandlers = global.process.listeners('uncaughtException'); - global.process.removeAllListeners('uncaughtException'); - global.process.on('uncaughtException', onerror); + if (j$.isError_(error)) { + error.jasmineMessage = jasmineMessage + ': ' + error; + } else { + if (error) { + substituteMsg = jasmineMessage + ': ' + error; + } else { + substituteMsg = jasmineMessage + ' with no error or message'; + } - this.uninstall = function uninstall() { - global.process.removeListener('uncaughtException', onerror); - for (var i = 0; i < originalHandlers.length; i++) { - global.process.on('uncaughtException', originalHandlers[i]); + if (errorType === 'unhandledRejection') { + substituteMsg += + '\n' + + '(Tip: to get a useful stack trace, use ' + + 'Promise.reject(new Error(...)) instead of Promise.reject(' + + (error ? '...' : '') + + ').)'; } - }; + + error = new Error(substituteMsg); + } + + var handler = handlers[handlers.length - 1]; + + if (handler) { + handler(error); + } else { + throw error; + } + } + + this.originalHandlers[errorType] = global.process.listeners(errorType); + this.jasmineHandlers[errorType] = taggedOnError; + + global.process.removeAllListeners(errorType); + global.process.on(errorType, taggedOnError); + + this.uninstall = function uninstall() { + var errorTypes = Object.keys(this.originalHandlers); + for (var iType = 0; iType < errorTypes.length; iType++) { + var errorType = errorTypes[iType]; + global.process.removeListener( + errorType, + this.jasmineHandlers[errorType] + ); + for (var i = 0; i < this.originalHandlers[errorType].length; i++) { + global.process.on(errorType, this.originalHandlers[errorType][i]); + } + delete this.originalHandlers[errorType]; + delete this.jasmineHandlers[errorType]; + } + }; + }; + + this.install = function install() { + if ( + global.process && + global.process.listeners && + j$.isFunction_(global.process.on) + ) { + this.installOne_('uncaughtException', 'Uncaught exception'); + this.installOne_('unhandledRejection', 'Unhandled promise rejection'); } else { var originalHandler = global.onerror; global.onerror = onerror; + var browserRejectionHandler = function browserRejectionHandler(event) { + if (j$.isError_(event.reason)) { + event.reason.jasmineMessage = + 'Unhandled promise rejection: ' + event.reason; + global.onerror(event.reason); + } else { + global.onerror('Unhandled promise rejection: ' + event.reason); + } + }; + + if (global.addEventListener) { + global.addEventListener( + 'unhandledrejection', + browserRejectionHandler + ); + } + this.uninstall = function uninstall() { global.onerror = originalHandler; + if (global.removeEventListener) { + global.removeEventListener( + 'unhandledrejection', + browserRejectionHandler + ); + } }; } }; @@ -2241,7 +4618,11 @@ getJasmineRequireObj().GlobalErrors = function(j$) { handlers.push(listener); }; - this.popListener = function popListener() { + this.popListener = function popListener(listener) { + if (!listener) { + throw new Error('popListener expects a listener'); + } + handlers.pop(); }; } @@ -2249,22 +4630,420 @@ getJasmineRequireObj().GlobalErrors = function(j$) { return GlobalErrors; }; +/* eslint-disable compat/compat */ +getJasmineRequireObj().toBePending = function(j$) { + /** + * Expect a promise to be pending, i.e. the promise is neither resolved nor rejected. + * @function + * @async + * @name async-matchers#toBePending + * @since 3.6 + * @example + * await expectAsync(aPromise).toBePending(); + */ + return function toBePending() { + return { + compare: function(actual) { + if (!j$.isPromiseLike(actual)) { + throw new Error('Expected toBePending to be called on a promise.'); + } + var want = {}; + return Promise.race([actual, Promise.resolve(want)]).then( + function(got) { + return { pass: want === got }; + }, + function() { + return { pass: false }; + } + ); + } + }; + }; +}; + +getJasmineRequireObj().toBeRejected = function(j$) { + /** + * Expect a promise to be rejected. + * @function + * @async + * @name async-matchers#toBeRejected + * @since 3.1.0 + * @example + * await expectAsync(aPromise).toBeRejected(); + * @example + * return expectAsync(aPromise).toBeRejected(); + */ + return function toBeRejected() { + return { + compare: function(actual) { + if (!j$.isPromiseLike(actual)) { + throw new Error('Expected toBeRejected to be called on a promise.'); + } + return actual.then( + function() { + return { pass: false }; + }, + function() { + return { pass: true }; + } + ); + } + }; + }; +}; + +getJasmineRequireObj().toBeRejectedWith = function(j$) { + /** + * Expect a promise to be rejected with a value equal to the expected, using deep equality comparison. + * @function + * @async + * @name async-matchers#toBeRejectedWith + * @since 3.3.0 + * @param {Object} expected - Value that the promise is expected to be rejected with + * @example + * await expectAsync(aPromise).toBeRejectedWith({prop: 'value'}); + * @example + * return expectAsync(aPromise).toBeRejectedWith({prop: 'value'}); + */ + return function toBeRejectedWith(matchersUtil) { + return { + compare: function(actualPromise, expectedValue) { + if (!j$.isPromiseLike(actualPromise)) { + throw new Error( + 'Expected toBeRejectedWith to be called on a promise.' + ); + } + + function prefix(passed) { + return ( + 'Expected a promise ' + + (passed ? 'not ' : '') + + 'to be rejected with ' + + matchersUtil.pp(expectedValue) + ); + } + + return actualPromise.then( + function() { + return { + pass: false, + message: prefix(false) + ' but it was resolved.' + }; + }, + function(actualValue) { + if (matchersUtil.equals(actualValue, expectedValue)) { + return { + pass: true, + message: prefix(true) + '.' + }; + } else { + return { + pass: false, + message: + prefix(false) + + ' but it was rejected with ' + + matchersUtil.pp(actualValue) + + '.' + }; + } + } + ); + } + }; + }; +}; + +getJasmineRequireObj().toBeRejectedWithError = function(j$) { + /** + * Expect a promise to be rejected with a value matched to the expected + * @function + * @async + * @name async-matchers#toBeRejectedWithError + * @since 3.5.0 + * @param {Error} [expected] - `Error` constructor the object that was thrown needs to be an instance of. If not provided, `Error` will be used. + * @param {RegExp|String} [message] - The message that should be set on the thrown `Error` + * @example + * await expectAsync(aPromise).toBeRejectedWithError(MyCustomError, 'Error message'); + * await expectAsync(aPromise).toBeRejectedWithError(MyCustomError, /Error message/); + * await expectAsync(aPromise).toBeRejectedWithError(MyCustomError); + * await expectAsync(aPromise).toBeRejectedWithError('Error message'); + * return expectAsync(aPromise).toBeRejectedWithError(/Error message/); + */ + return function toBeRejectedWithError(matchersUtil) { + return { + compare: function(actualPromise, arg1, arg2) { + if (!j$.isPromiseLike(actualPromise)) { + throw new Error( + 'Expected toBeRejectedWithError to be called on a promise.' + ); + } + + var expected = getExpectedFromArgs(arg1, arg2, matchersUtil); + + return actualPromise.then( + function() { + return { + pass: false, + message: 'Expected a promise to be rejected but it was resolved.' + }; + }, + function(actualValue) { + return matchError(actualValue, expected, matchersUtil); + } + ); + } + }; + }; + + function matchError(actual, expected, matchersUtil) { + if (!j$.isError_(actual)) { + return fail(expected, 'rejected with ' + matchersUtil.pp(actual)); + } + + if (!(actual instanceof expected.error)) { + return fail( + expected, + 'rejected with type ' + j$.fnNameFor(actual.constructor) + ); + } + + var actualMessage = actual.message; + + if ( + actualMessage === expected.message || + typeof expected.message === 'undefined' + ) { + return pass(expected); + } + + if ( + expected.message instanceof RegExp && + expected.message.test(actualMessage) + ) { + return pass(expected); + } + + return fail(expected, 'rejected with ' + matchersUtil.pp(actual)); + } + + function pass(expected) { + return { + pass: true, + message: + 'Expected a promise not to be rejected with ' + + expected.printValue + + ', but it was.' + }; + } + + function fail(expected, message) { + return { + pass: false, + message: + 'Expected a promise to be rejected with ' + + expected.printValue + + ' but it was ' + + message + + '.' + }; + } + + function getExpectedFromArgs(arg1, arg2, matchersUtil) { + var error, message; + + if (isErrorConstructor(arg1)) { + error = arg1; + message = arg2; + } else { + error = Error; + message = arg1; + } + + return { + error: error, + message: message, + printValue: + j$.fnNameFor(error) + + (typeof message === 'undefined' ? '' : ': ' + matchersUtil.pp(message)) + }; + } + + function isErrorConstructor(value) { + return ( + typeof value === 'function' && + (value === Error || j$.isError_(value.prototype)) + ); + } +}; + +getJasmineRequireObj().toBeResolved = function(j$) { + /** + * Expect a promise to be resolved. + * @function + * @async + * @name async-matchers#toBeResolved + * @since 3.1.0 + * @example + * await expectAsync(aPromise).toBeResolved(); + * @example + * return expectAsync(aPromise).toBeResolved(); + */ + return function toBeResolved(matchersUtil) { + return { + compare: function(actual) { + if (!j$.isPromiseLike(actual)) { + throw new Error('Expected toBeResolved to be called on a promise.'); + } + + return actual.then( + function() { + return { pass: true }; + }, + function(e) { + return { + pass: false, + message: + 'Expected a promise to be resolved but it was ' + + 'rejected with ' + + matchersUtil.pp(e) + + '.' + }; + } + ); + } + }; + }; +}; + +getJasmineRequireObj().toBeResolvedTo = function(j$) { + /** + * Expect a promise to be resolved to a value equal to the expected, using deep equality comparison. + * @function + * @async + * @name async-matchers#toBeResolvedTo + * @since 3.1.0 + * @param {Object} expected - Value that the promise is expected to resolve to + * @example + * await expectAsync(aPromise).toBeResolvedTo({prop: 'value'}); + * @example + * return expectAsync(aPromise).toBeResolvedTo({prop: 'value'}); + */ + return function toBeResolvedTo(matchersUtil) { + return { + compare: function(actualPromise, expectedValue) { + if (!j$.isPromiseLike(actualPromise)) { + throw new Error('Expected toBeResolvedTo to be called on a promise.'); + } + + function prefix(passed) { + return ( + 'Expected a promise ' + + (passed ? 'not ' : '') + + 'to be resolved to ' + + matchersUtil.pp(expectedValue) + ); + } + + return actualPromise.then( + function(actualValue) { + if (matchersUtil.equals(actualValue, expectedValue)) { + return { + pass: true, + message: prefix(true) + '.' + }; + } else { + return { + pass: false, + message: + prefix(false) + + ' but it was resolved to ' + + matchersUtil.pp(actualValue) + + '.' + }; + } + }, + function(e) { + return { + pass: false, + message: + prefix(false) + + ' but it was rejected with ' + + matchersUtil.pp(e) + + '.' + }; + } + ); + } + }; + }; +}; + getJasmineRequireObj().DiffBuilder = function(j$) { - return function DiffBuilder() { - var path = new j$.ObjectPath(), - mismatches = []; + return function DiffBuilder(config) { + var prettyPrinter = (config || {}).prettyPrinter || j$.makePrettyPrinter(), + mismatches = new j$.MismatchTree(), + path = new j$.ObjectPath(), + actualRoot = undefined, + expectedRoot = undefined; return { - record: function (actual, expected, formatter) { - formatter = formatter || defaultFormatter; - mismatches.push(formatter(actual, expected, path)); + setRoots: function(actual, expected) { + actualRoot = actual; + expectedRoot = expected; + }, + + recordMismatch: function(formatter) { + mismatches.add(path, formatter); }, - getMessage: function () { - return mismatches.join('\n'); + getMessage: function() { + var messages = []; + + mismatches.traverse(function(path, isLeaf, formatter) { + var actualCustom, + expectedCustom, + useCustom, + derefResult = dereferencePath( + path, + actualRoot, + expectedRoot, + prettyPrinter + ), + actual = derefResult.actual, + expected = derefResult.expected; + + if (formatter) { + messages.push(formatter(actual, expected, path, prettyPrinter)); + return true; + } + + actualCustom = prettyPrinter.customFormat_(actual); + expectedCustom = prettyPrinter.customFormat_(expected); + useCustom = !( + j$.util.isUndefined(actualCustom) && + j$.util.isUndefined(expectedCustom) + ); + + if (useCustom) { + messages.push( + wrapPrettyPrinted(actualCustom, expectedCustom, path) + ); + return false; // don't recurse further + } + + if (isLeaf) { + messages.push( + defaultFormatter(actual, expected, path, prettyPrinter) + ); + } + + return true; + }); + + return messages.join('\n'); }, - withPath: function (pathComponent, block) { + withPath: function(pathComponent, block) { var oldPath = path; path = path.add(pathComponent); block(); @@ -2272,109 +5051,250 @@ getJasmineRequireObj().DiffBuilder = function(j$) { } }; - function defaultFormatter (actual, expected, path) { - return 'Expected ' + - path + (path.depth() ? ' = ' : '') + - j$.pp(actual) + + function defaultFormatter(actual, expected, path, prettyPrinter) { + return wrapPrettyPrinted( + prettyPrinter(actual), + prettyPrinter(expected), + path + ); + } + + function wrapPrettyPrinted(actual, expected, path) { + return ( + 'Expected ' + + path + + (path.depth() ? ' = ' : '') + + actual + ' to equal ' + - j$.pp(expected) + - '.'; + expected + + '.' + ); } }; -}; -getJasmineRequireObj().matchersUtil = function(j$) { - // TODO: what to do about jasmine.pp not being inject? move to JSON.stringify? gut PrettyPrinter? + function dereferencePath(objectPath, actual, expected, pp) { + function handleAsymmetricExpected() { + if ( + j$.isAsymmetricEqualityTester_(expected) && + j$.isFunction_(expected.valuesForDiff_) + ) { + var asymmetricResult = expected.valuesForDiff_(actual, pp); + expected = asymmetricResult.self; + actual = asymmetricResult.other; + } + } - return { - equals: equals, + var i; + handleAsymmetricExpected(); - contains: function(haystack, needle, customTesters) { - customTesters = customTesters || []; + for (i = 0; i < objectPath.components.length; i++) { + actual = actual[objectPath.components[i]]; + expected = expected[objectPath.components[i]]; + handleAsymmetricExpected(); + } - if ((Object.prototype.toString.apply(haystack) === '[object Set]')) { - return haystack.has(needle); - } + return { actual: actual, expected: expected }; + } +}; - if ((Object.prototype.toString.apply(haystack) === '[object Array]') || - (!!haystack && !haystack.indexOf)) - { - for (var i = 0; i < haystack.length; i++) { - if (equals(haystack[i], needle, customTesters)) { - return true; - } +getJasmineRequireObj().MatchersUtil = function(j$) { + // TODO: convert all uses of j$.pp to use the injected pp + + /** + * @class MatchersUtil + * @classdesc Utilities for use in implementing matchers.
+ * _Note:_ Do not construct this directly. Jasmine will construct one and + * pass it to matchers and asymmetric equality testers. + * @hideconstructor + */ + function MatchersUtil(options) { + options = options || {}; + this.customTesters_ = options.customTesters || []; + /** + * Formats a value for use in matcher failure messages and similar contexts, + * taking into account the current set of custom value formatters. + * @function + * @name MatchersUtil#pp + * @since 3.6.0 + * @param {*} value The value to pretty-print + * @return {string} The pretty-printed value + */ + this.pp = options.pp || function() {}; + } + + /** + * Determines whether `haystack` contains `needle`, using the same comparison + * logic as {@link MatchersUtil#equals}. + * @function + * @name MatchersUtil#contains + * @since 2.0.0 + * @param {*} haystack The collection to search + * @param {*} needle The value to search for + * @param [customTesters] An array of custom equality testers + * @returns {boolean} True if `needle` was found in `haystack` + */ + MatchersUtil.prototype.contains = function(haystack, needle, customTesters) { + if (j$.isSet(haystack)) { + return haystack.has(needle); + } + + if ( + Object.prototype.toString.apply(haystack) === '[object Array]' || + (!!haystack && !haystack.indexOf) + ) { + for (var i = 0; i < haystack.length; i++) { + if (this.equals(haystack[i], needle, customTesters)) { + return true; } - return false; } + return false; + } - return !!haystack && haystack.indexOf(needle) >= 0; - }, + return !!haystack && haystack.indexOf(needle) >= 0; + }; - buildFailureMessage: function() { - var args = Array.prototype.slice.call(arguments, 0), - matcherName = args[0], - isNot = args[1], - actual = args[2], - expected = args.slice(3), - englishyPredicate = matcherName.replace(/[A-Z]/g, function(s) { return ' ' + s.toLowerCase(); }); - - var message = 'Expected ' + - j$.pp(actual) + - (isNot ? ' not ' : ' ') + - englishyPredicate; - - if (expected.length > 0) { - for (var i = 0; i < expected.length; i++) { - if (i > 0) { - message += ','; - } - message += ' ' + j$.pp(expected[i]); + MatchersUtil.prototype.buildFailureMessage = function() { + var self = this; + var args = Array.prototype.slice.call(arguments, 0), + matcherName = args[0], + isNot = args[1], + actual = args[2], + expected = args.slice(3), + englishyPredicate = matcherName.replace(/[A-Z]/g, function(s) { + return ' ' + s.toLowerCase(); + }); + + var message = + 'Expected ' + + self.pp(actual) + + (isNot ? ' not ' : ' ') + + englishyPredicate; + + if (expected.length > 0) { + for (var i = 0; i < expected.length; i++) { + if (i > 0) { + message += ','; } + message += ' ' + self.pp(expected[i]); } - - return message + '.'; } - }; - function isAsymmetric(obj) { - return obj && obj.asymmetricMatch && j$.isA_('Function', obj.asymmetricMatch); - } + return message + '.'; + }; - function asymmetricMatch(a, b, customTesters, diffBuilder) { - var asymmetricA = isAsymmetric(a), - asymmetricB = isAsymmetric(b), - result; + MatchersUtil.prototype.asymmetricDiff_ = function( + a, + b, + aStack, + bStack, + customTesters, + diffBuilder + ) { + if (j$.isFunction_(b.valuesForDiff_)) { + var values = b.valuesForDiff_(a, this.pp); + this.eq_( + values.other, + values.self, + aStack, + bStack, + customTesters, + diffBuilder + ); + } else { + diffBuilder.recordMismatch(); + } + }; - if (asymmetricA && asymmetricB) { + MatchersUtil.prototype.asymmetricMatch_ = function( + a, + b, + aStack, + bStack, + customTesters, + diffBuilder + ) { + var asymmetricA = j$.isAsymmetricEqualityTester_(a), + asymmetricB = j$.isAsymmetricEqualityTester_(b), + shim, + result; + + if (asymmetricA === asymmetricB) { return undefined; } + shim = j$.asymmetricEqualityTesterArgCompatShim(this, customTesters); + if (asymmetricA) { - result = a.asymmetricMatch(b, customTesters); - diffBuilder.record(a, b); + result = a.asymmetricMatch(b, shim); + if (!result) { + diffBuilder.recordMismatch(); + } return result; } if (asymmetricB) { - result = b.asymmetricMatch(a, customTesters); - diffBuilder.record(a, b); + result = b.asymmetricMatch(a, shim); + if (!result) { + this.asymmetricDiff_(a, b, aStack, bStack, customTesters, diffBuilder); + } return result; } - } + }; - function equals(a, b, customTesters, diffBuilder) { - customTesters = customTesters || []; + /** + * Determines whether two values are deeply equal to each other. + * @function + * @name MatchersUtil#equals + * @since 2.0.0 + * @param {*} a The first value to compare + * @param {*} b The second value to compare + * @param [customTesters] An array of custom equality testers + * @returns {boolean} True if the values are equal + */ + MatchersUtil.prototype.equals = function( + a, + b, + customTestersOrDiffBuilder, + diffBuilderOrNothing + ) { + var customTesters, diffBuilder; + + if (isDiffBuilder(customTestersOrDiffBuilder)) { + diffBuilder = customTestersOrDiffBuilder; + } else { + customTesters = customTestersOrDiffBuilder; + diffBuilder = diffBuilderOrNothing; + } + + customTesters = customTesters || this.customTesters_; diffBuilder = diffBuilder || j$.NullDiffBuilder(); + diffBuilder.setRoots(a, b); - return eq(a, b, [], [], customTesters, diffBuilder); - } + return this.eq_(a, b, [], [], customTesters, diffBuilder); + }; // Equality function lovingly adapted from isEqual in // [Underscore](http://underscorejs.org) - function eq(a, b, aStack, bStack, customTesters, diffBuilder) { - var result = true, i; - - var asymmetricResult = asymmetricMatch(a, b, customTesters, diffBuilder); + MatchersUtil.prototype.eq_ = function( + a, + b, + aStack, + bStack, + customTesters, + diffBuilder + ) { + var result = true, + self = this, + i; + + var asymmetricResult = this.asymmetricMatch_( + a, + b, + aStack, + bStack, + customTesters, + diffBuilder + ); if (!j$.util.isUndefined(asymmetricResult)) { return asymmetricResult; } @@ -2383,7 +5303,7 @@ getJasmineRequireObj().matchersUtil = function(j$) { var customTesterResult = customTesters[i](a, b); if (!j$.util.isUndefined(customTesterResult)) { if (!customTesterResult) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); } return customTesterResult; } @@ -2392,7 +5312,7 @@ getJasmineRequireObj().matchersUtil = function(j$) { if (a instanceof Error && b instanceof Error) { result = a.message == b.message; if (!result) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); } return result; } @@ -2402,7 +5322,7 @@ getJasmineRequireObj().matchersUtil = function(j$) { if (a === b) { result = a !== 0 || 1 / a == 1 / b; if (!result) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); } return result; } @@ -2410,13 +5330,13 @@ getJasmineRequireObj().matchersUtil = function(j$) { if (a === null || b === null) { result = a === b; if (!result) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); } return result; } var className = Object.prototype.toString.call(a); if (className != Object.prototype.toString.call(b)) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); return false; } switch (className) { @@ -2426,15 +5346,16 @@ getJasmineRequireObj().matchersUtil = function(j$) { // equivalent to `new String("5")`. result = a == String(b); if (!result) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); } return result; case '[object Number]': // `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for // other numeric values. - result = a != +a ? b != +b : (a === 0 ? 1 / a == 1 / b : a == +b); + result = + a != +a ? b != +b : a === 0 && b === 0 ? 1 / a == 1 / b : a == +b; if (!result) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); } return result; case '[object Date]': @@ -2444,18 +5365,31 @@ getJasmineRequireObj().matchersUtil = function(j$) { // of `NaN` are not equivalent. result = +a == +b; if (!result) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); } return result; + case '[object ArrayBuffer]': + // If we have an instance of ArrayBuffer the Uint8Array ctor + // will be defined as well + return self.eq_( + new Uint8Array(a), // eslint-disable-line compat/compat + new Uint8Array(b), // eslint-disable-line compat/compat + aStack, + bStack, + customTesters, + diffBuilder + ); // RegExps are compared by their source patterns and flags. case '[object RegExp]': - return a.source == b.source && + return ( + a.source == b.source && a.global == b.global && a.multiline == b.multiline && - a.ignoreCase == b.ignoreCase; + a.ignoreCase == b.ignoreCase + ); } if (typeof a != 'object' || typeof b != 'object') { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); return false; } @@ -2463,45 +5397,32 @@ getJasmineRequireObj().matchersUtil = function(j$) { var bIsDomNode = j$.isDomNode(b); if (aIsDomNode && bIsDomNode) { // At first try to use DOM3 method isEqualNode - if (a.isEqualNode) { - result = a.isEqualNode(b); - if (!result) { - diffBuilder.record(a, b); - } - return result; - } - // IE8 doesn't support isEqualNode, try to use outerHTML && innerText - var aIsElement = a instanceof Element; - var bIsElement = b instanceof Element; - if (aIsElement && bIsElement) { - result = a.outerHTML == b.outerHTML; - if (!result) { - diffBuilder.record(a, b); - } - return result; - } - if (aIsElement || bIsElement) { - diffBuilder.record(a, b); - return false; - } - result = a.innerText == b.innerText && a.textContent == b.textContent; + result = a.isEqualNode(b); if (!result) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); } return result; } if (aIsDomNode || bIsDomNode) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); return false; } + var aIsPromise = j$.isPromise(a); + var bIsPromise = j$.isPromise(b); + if (aIsPromise && bIsPromise) { + return a === b; + } + // Assume equality for cyclic structures. The algorithm for detecting cyclic // structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`. var length = aStack.length; while (length--) { // Linear search. Performance is inversely proportional to the number of // unique nested structures. - if (aStack[length] == a) { return bStack[length] == b; } + if (aStack[length] == a) { + return bStack[length] == b; + } } // Add the first object to the stack of traversed objects. aStack.push(a); @@ -2510,57 +5431,194 @@ getJasmineRequireObj().matchersUtil = function(j$) { // Recursively compare objects and arrays. // Compare array lengths to determine if a deep comparison is necessary. if (className == '[object Array]') { - size = a.length; - if (size !== b.length) { - diffBuilder.record(a, b); + var aLength = a.length; + var bLength = b.length; + + diffBuilder.withPath('length', function() { + if (aLength !== bLength) { + diffBuilder.recordMismatch(); + result = false; + } + }); + + for (i = 0; i < aLength || i < bLength; i++) { + diffBuilder.withPath(i, function() { + if (i >= bLength) { + diffBuilder.recordMismatch( + actualArrayIsLongerFormatter.bind(null, self.pp) + ); + result = false; + } else { + result = + self.eq_( + i < aLength ? a[i] : void 0, + i < bLength ? b[i] : void 0, + aStack, + bStack, + customTesters, + diffBuilder + ) && result; + } + }); + } + if (!result) { + return false; + } + } else if (j$.isMap(a) && j$.isMap(b)) { + if (a.size != b.size) { + diffBuilder.recordMismatch(); return false; } - for (i = 0; i < size; i++) { - diffBuilder.withPath(i, function() { - result = eq(a[i], b[i], aStack, bStack, customTesters, diffBuilder) && result; - }); + var keysA = []; + var keysB = []; + a.forEach(function(valueA, keyA) { + keysA.push(keyA); + }); + b.forEach(function(valueB, keyB) { + keysB.push(keyB); + }); + + // For both sets of keys, check they map to equal values in both maps. + // Keep track of corresponding keys (in insertion order) in order to handle asymmetric obj keys. + var mapKeys = [keysA, keysB]; + var cmpKeys = [keysB, keysA]; + var mapIter, mapKey, mapValueA, mapValueB; + var cmpIter, cmpKey; + for (i = 0; result && i < mapKeys.length; i++) { + mapIter = mapKeys[i]; + cmpIter = cmpKeys[i]; + + for (var j = 0; result && j < mapIter.length; j++) { + mapKey = mapIter[j]; + cmpKey = cmpIter[j]; + mapValueA = a.get(mapKey); + + // Only use the cmpKey when one of the keys is asymmetric and the corresponding key matches, + // otherwise explicitly look up the mapKey in the other Map since we want keys with unique + // obj identity (that are otherwise equal) to not match. + if ( + j$.isAsymmetricEqualityTester_(mapKey) || + (j$.isAsymmetricEqualityTester_(cmpKey) && + this.eq_( + mapKey, + cmpKey, + aStack, + bStack, + customTesters, + j$.NullDiffBuilder() + )) + ) { + mapValueB = b.get(cmpKey); + } else { + mapValueB = b.get(mapKey); + } + result = this.eq_( + mapValueA, + mapValueB, + aStack, + bStack, + customTesters, + j$.NullDiffBuilder() + ); + } } + if (!result) { + diffBuilder.recordMismatch(); return false; } - } else if (className == '[object Set]') { + } else if (j$.isSet(a) && j$.isSet(b)) { if (a.size != b.size) { - diffBuilder.record(a, b); + diffBuilder.recordMismatch(); return false; } - var iterA = a.values(), iterB = b.values(); - var valA, valB; - do { - valA = iterA.next(); - valB = iterB.next(); - if (!eq(valA.value, valB.value, aStack, bStack, customTesters, j$.NullDiffBuilder())) { - diffBuilder.record(a, b); - return false; + + var valuesA = []; + a.forEach(function(valueA) { + valuesA.push(valueA); + }); + var valuesB = []; + b.forEach(function(valueB) { + valuesB.push(valueB); + }); + + // For both sets, check they are all contained in the other set + var setPairs = [[valuesA, valuesB], [valuesB, valuesA]]; + var stackPairs = [[aStack, bStack], [bStack, aStack]]; + var baseValues, baseValue, baseStack; + var otherValues, otherValue, otherStack; + var found; + var prevStackSize; + for (i = 0; result && i < setPairs.length; i++) { + baseValues = setPairs[i][0]; + otherValues = setPairs[i][1]; + baseStack = stackPairs[i][0]; + otherStack = stackPairs[i][1]; + // For each value in the base set... + for (var k = 0; result && k < baseValues.length; k++) { + baseValue = baseValues[k]; + found = false; + // ... test that it is present in the other set + for (var l = 0; !found && l < otherValues.length; l++) { + otherValue = otherValues[l]; + prevStackSize = baseStack.length; + // compare by value equality + found = this.eq_( + baseValue, + otherValue, + baseStack, + otherStack, + customTesters, + j$.NullDiffBuilder() + ); + if (!found && prevStackSize !== baseStack.length) { + baseStack.splice(prevStackSize); + otherStack.splice(prevStackSize); + } + } + result = result && found; } - } while (!valA.done && !valB.done); - } else { + } + if (!result) { + diffBuilder.recordMismatch(); + return false; + } + } else if (j$.isURL(a) && j$.isURL(b)) { + // URLs have no enumrable properties, so the default object comparison + // would consider any two URLs to be equal. + return a.toString() === b.toString(); + } else { // Objects with different constructors are not equivalent, but `Object`s // or `Array`s from different frames are. - var aCtor = a.constructor, bCtor = b.constructor; - if (aCtor !== bCtor && - isFunction(aCtor) && isFunction(bCtor) && - a instanceof aCtor && b instanceof bCtor && - !(aCtor instanceof aCtor && bCtor instanceof bCtor)) { - - diffBuilder.record(a, b, constructorsAreDifferentFormatter); + var aCtor = a.constructor, + bCtor = b.constructor; + if ( + aCtor !== bCtor && + isFunction(aCtor) && + isFunction(bCtor) && + a instanceof aCtor && + b instanceof bCtor && + !(aCtor instanceof aCtor && bCtor instanceof bCtor) + ) { + diffBuilder.recordMismatch( + constructorsAreDifferentFormatter.bind(null, this.pp) + ); return false; } } // Deep compare objects. - var aKeys = keys(a, className == '[object Array]'), key; + var aKeys = keys(a, className == '[object Array]'), + key; size = aKeys.length; // Ensure that both objects contain the same number of properties before comparing deep equality. if (keys(b, className == '[object Array]').length !== size) { - diffBuilder.record(a, b, objectKeysAreDifferentFormatter); + diffBuilder.recordMismatch( + objectKeysAreDifferentFormatter.bind(null, this.pp) + ); return false; } @@ -2568,13 +5626,17 @@ getJasmineRequireObj().matchersUtil = function(j$) { key = aKeys[i]; // Deep compare each member if (!j$.util.has(b, key)) { - diffBuilder.record(a, b, objectKeysAreDifferentFormatter); + diffBuilder.recordMismatch( + objectKeysAreDifferentFormatter.bind(null, this.pp) + ); result = false; continue; } diffBuilder.withPath(key, function() { - if(!eq(a[key], b[key], aStack, bStack, customTesters, diffBuilder)) { + if ( + !self.eq_(a[key], b[key], aStack, bStack, customTesters, diffBuilder) + ) { result = false; } }); @@ -2589,26 +5651,27 @@ getJasmineRequireObj().matchersUtil = function(j$) { bStack.pop(); return result; - } + }; function keys(obj, isArray) { - var allKeys = Object.keys ? Object.keys(obj) : - (function(o) { + var allKeys = Object.keys + ? Object.keys(obj) + : (function(o) { var keys = []; for (var key in o) { - if (j$.util.has(o, key)) { - keys.push(key); - } + if (j$.util.has(o, key)) { + keys.push(key); + } } return keys; - })(obj); + })(obj); if (!isArray) { return allKeys; } if (allKeys.length === 0) { - return allKeys; + return allKeys; } var extraKeys = []; @@ -2621,54 +5684,208 @@ getJasmineRequireObj().matchersUtil = function(j$) { return extraKeys; } - function has(obj, key) { - return Object.prototype.hasOwnProperty.call(obj, key); - } - function isFunction(obj) { return typeof obj === 'function'; } - function objectKeysAreDifferentFormatter(actual, expected, path) { + function objectKeysAreDifferentFormatter(pp, actual, expected, path) { var missingProperties = j$.util.objectDifference(expected, actual), - extraProperties = j$.util.objectDifference(actual, expected), - missingPropertiesMessage = formatKeyValuePairs(missingProperties), - extraPropertiesMessage = formatKeyValuePairs(extraProperties), - messages = []; + extraProperties = j$.util.objectDifference(actual, expected), + missingPropertiesMessage = formatKeyValuePairs(pp, missingProperties), + extraPropertiesMessage = formatKeyValuePairs(pp, extraProperties), + messages = []; if (!path.depth()) { path = 'object'; } if (missingPropertiesMessage.length) { - messages.push('Expected ' + path + ' to have properties' + missingPropertiesMessage); + messages.push( + 'Expected ' + path + ' to have properties' + missingPropertiesMessage + ); } if (extraPropertiesMessage.length) { - messages.push('Expected ' + path + ' not to have properties' + extraPropertiesMessage); + messages.push( + 'Expected ' + path + ' not to have properties' + extraPropertiesMessage + ); } return messages.join('\n'); } - function constructorsAreDifferentFormatter(actual, expected, path) { + function constructorsAreDifferentFormatter(pp, actual, expected, path) { if (!path.depth()) { path = 'object'; } - return 'Expected ' + - path + ' to be a kind of ' + + return ( + 'Expected ' + + path + + ' to be a kind of ' + j$.fnNameFor(expected.constructor) + - ', but was ' + j$.pp(actual) + '.'; + ', but was ' + + pp(actual) + + '.' + ); + } + + function actualArrayIsLongerFormatter(pp, actual, expected, path) { + return ( + 'Unexpected ' + + path + + (path.depth() ? ' = ' : '') + + pp(actual) + + ' in array.' + ); } - function formatKeyValuePairs(obj) { + function formatKeyValuePairs(pp, obj) { var formatted = ''; for (var key in obj) { - formatted += '\n ' + key + ': ' + j$.pp(obj[key]); + formatted += '\n ' + key + ': ' + pp(obj[key]); } return formatted; } + + function isDiffBuilder(obj) { + return obj && typeof obj.recordMismatch === 'function'; + } + + return MatchersUtil; +}; + +/** + * @interface AsymmetricEqualityTester + * @classdesc An asymmetric equality tester is an object that can match multiple + * objects. Examples include jasmine.any() and jasmine.stringMatching(). Jasmine + * includes a number of built-in asymmetric equality testers, such as + * {@link jasmine.objectContaining}. User-defined asymmetric equality testers are + * also supported. + * + * Asymmetric equality testers work with any matcher, including user-defined + * custom matchers, that uses {@link MatchersUtil#equals} or + * {@link MatchersUtil#contains}. + * + * @example + * function numberDivisibleBy(divisor) { + * return { + * asymmetricMatch: function(n) { + * return typeof n === 'number' && n % divisor === 0; + * }, + * jasmineToString: function() { + * return ``; + * } + * }; + * } + * + * var actual = { + * n: 2, + * otherFields: "don't care" + * }; + * + * expect(actual).toEqual(jasmine.objectContaining({n: numberDivisibleBy(2)})); + * @see custom_asymmetric_equality_testers + * @since 2.0.0 + */ +/** + * Determines whether a value matches this tester + * @function + * @name AsymmetricEqualityTester#asymmetricMatch + * @param value {any} The value to test + * @param matchersUtil {MatchersUtil} utilities for testing equality, etc + * @return {Boolean} + */ +/** + * Returns a string representation of this tester to use in matcher failure messages + * @function + * @name AsymmetricEqualityTester#jasmineToString + * @param pp {function} Function that takes a value and returns a pretty-printed representation + * @return {String} + */ + +getJasmineRequireObj().MismatchTree = function(j$) { + /* + To be able to apply custom object formatters at all possible levels of an + object graph, DiffBuilder needs to be able to know not just where the + mismatch occurred but also all ancestors of the mismatched value in both + the expected and actual object graphs. MismatchTree maintains that context + and provides it via the traverse method. + */ + function MismatchTree(path) { + this.path = path || new j$.ObjectPath([]); + this.formatter = undefined; + this.children = []; + this.isMismatch = false; + } + + MismatchTree.prototype.add = function(path, formatter) { + var key, child; + + if (path.depth() === 0) { + this.formatter = formatter; + this.isMismatch = true; + } else { + key = path.components[0]; + path = path.shift(); + child = this.child(key); + + if (!child) { + child = new MismatchTree(this.path.add(key)); + this.children.push(child); + } + + child.add(path, formatter); + } + }; + + MismatchTree.prototype.traverse = function(visit) { + var i, + hasChildren = this.children.length > 0; + + if (this.isMismatch || hasChildren) { + if (visit(this.path, !hasChildren, this.formatter)) { + for (i = 0; i < this.children.length; i++) { + this.children[i].traverse(visit); + } + } + } + }; + + MismatchTree.prototype.child = function(key) { + var i, pathEls; + + for (i = 0; i < this.children.length; i++) { + pathEls = this.children[i].path.components; + if (pathEls[pathEls.length - 1] === key) { + return this.children[i]; + } + } + }; + + return MismatchTree; +}; + +getJasmineRequireObj().nothing = function() { + /** + * {@link expect} nothing explicitly. + * @function + * @name matchers#nothing + * @since 2.8.0 + * @example + * expect().nothing(); + */ + function nothing() { + return { + compare: function() { + return { + pass: true + }; + } + }; + } + + return nothing; }; getJasmineRequireObj().NullDiffBuilder = function(j$) { @@ -2677,7 +5894,8 @@ getJasmineRequireObj().NullDiffBuilder = function(j$) { withPath: function(_, block) { block(); }, - record: function() {} + setRoots: function() {}, + recordMismatch: function() {} }; }; }; @@ -2699,6 +5917,10 @@ getJasmineRequireObj().ObjectPath = function(j$) { return new ObjectPath(this.components.concat([component])); }; + ObjectPath.prototype.shift = function() { + return new ObjectPath(this.components.slice(1)); + }; + ObjectPath.prototype.depth = function() { return this.components.length; }; @@ -2712,7 +5934,7 @@ getJasmineRequireObj().ObjectPath = function(j$) { return '.' + prop; } - return '[\'' + prop + '\']'; + return "['" + prop + "']"; } function map(array, fn) { @@ -2730,21 +5952,56 @@ getJasmineRequireObj().ObjectPath = function(j$) { return ObjectPath; }; -getJasmineRequireObj().toBe = function() { +getJasmineRequireObj().requireAsyncMatchers = function(jRequire, j$) { + var availableMatchers = [ + 'toBePending', + 'toBeResolved', + 'toBeRejected', + 'toBeResolvedTo', + 'toBeRejectedWith', + 'toBeRejectedWithError' + ], + matchers = {}; + + for (var i = 0; i < availableMatchers.length; i++) { + var name = availableMatchers[i]; + matchers[name] = jRequire[name](j$); + } + + return matchers; +}; + +getJasmineRequireObj().toBe = function(j$) { /** * {@link expect} the actual value to be `===` to the expected value. * @function * @name matchers#toBe + * @since 1.3.0 * @param {Object} expected - The expected value to compare against. * @example * expect(thing).toBe(realThing); */ - function toBe() { + function toBe(matchersUtil) { + var tip = + ' Tip: To check for deep equality, use .toEqual() instead of .toBe().'; + return { compare: function(actual, expected) { - return { + var result = { pass: actual === expected }; + + if (typeof expected === 'object') { + result.message = + matchersUtil.buildFailureMessage( + 'toBe', + result.pass, + actual, + expected + ) + tip; + } + + return result; } }; } @@ -2757,6 +6014,7 @@ getJasmineRequireObj().toBeCloseTo = function() { * {@link expect} the actual value to be within a specified precision of the expected value. * @function * @name matchers#toBeCloseTo + * @since 1.3.0 * @param {Object} expected - The expected value to compare against. * @param {Number} [precision=2] - The number of decimal points to check. * @example @@ -2769,8 +6027,23 @@ getJasmineRequireObj().toBeCloseTo = function() { precision = precision || 2; } + if (expected === null || actual === null) { + throw new Error( + 'Cannot use toBeCloseTo with null. Arguments evaluated to: ' + + 'expect(' + + actual + + ').toBeCloseTo(' + + expected + + ').' + ); + } + + var pow = Math.pow(10, precision + 1); + var delta = Math.abs(expected - actual); + var maxDelta = Math.pow(10, -precision) / 2; + return { - pass: Math.abs(expected - actual) < (Math.pow(10, -precision) / 2) + pass: Math.round(delta * pow) <= maxDelta * pow }; } }; @@ -2784,6 +6057,7 @@ getJasmineRequireObj().toBeDefined = function() { * {@link expect} the actual value to be defined. (Not `undefined`) * @function * @name matchers#toBeDefined + * @since 1.3.0 * @example * expect(result).toBeDefined(); */ @@ -2791,7 +6065,7 @@ getJasmineRequireObj().toBeDefined = function() { return { compare: function(actual) { return { - pass: (void 0 !== actual) + pass: void 0 !== actual }; } }; @@ -2800,11 +6074,34 @@ getJasmineRequireObj().toBeDefined = function() { return toBeDefined; }; +getJasmineRequireObj().toBeFalse = function() { + /** + * {@link expect} the actual value to be `false`. + * @function + * @name matchers#toBeFalse + * @since 3.5.0 + * @example + * expect(result).toBeFalse(); + */ + function toBeFalse() { + return { + compare: function(actual) { + return { + pass: actual === false + }; + } + }; + } + + return toBeFalse; +}; + getJasmineRequireObj().toBeFalsy = function() { /** * {@link expect} the actual value to be falsy * @function * @name matchers#toBeFalsy + * @since 2.0.0 * @example * expect(result).toBeFalsy(); */ @@ -2812,7 +6109,7 @@ getJasmineRequireObj().toBeFalsy = function() { return { compare: function(actual) { return { - pass: !!!actual + pass: !actual }; } }; @@ -2826,6 +6123,7 @@ getJasmineRequireObj().toBeGreaterThan = function() { * {@link expect} the actual value to be greater than the expected value. * @function * @name matchers#toBeGreaterThan + * @since 2.0.0 * @param {Number} expected - The value to compare against. * @example * expect(result).toBeGreaterThan(3); @@ -2843,12 +6141,12 @@ getJasmineRequireObj().toBeGreaterThan = function() { return toBeGreaterThan; }; - getJasmineRequireObj().toBeGreaterThanOrEqual = function() { /** * {@link expect} the actual value to be greater than or equal to the expected value. * @function * @name matchers#toBeGreaterThanOrEqual + * @since 2.0.0 * @param {Number} expected - The expected value to compare against. * @example * expect(result).toBeGreaterThanOrEqual(25); @@ -2866,18 +6164,83 @@ getJasmineRequireObj().toBeGreaterThanOrEqual = function() { return toBeGreaterThanOrEqual; }; +getJasmineRequireObj().toBeInstanceOf = function(j$) { + var usageError = j$.formatErrorMsg( + '', + 'expect(value).toBeInstanceOf()' + ); + + /** + * {@link expect} the actual to be an instance of the expected class + * @function + * @name matchers#toBeInstanceOf + * @since 3.5.0 + * @param {Object} expected - The class or constructor function to check for + * @example + * expect('foo').toBeInstanceOf(String); + * expect(3).toBeInstanceOf(Number); + * expect(new Error()).toBeInstanceOf(Error); + */ + function toBeInstanceOf(matchersUtil) { + return { + compare: function(actual, expected) { + var actualType = + actual && actual.constructor + ? j$.fnNameFor(actual.constructor) + : matchersUtil.pp(actual), + expectedType = expected + ? j$.fnNameFor(expected) + : matchersUtil.pp(expected), + expectedMatcher, + pass; + + try { + expectedMatcher = new j$.Any(expected); + pass = expectedMatcher.asymmetricMatch(actual); + } catch (error) { + throw new Error( + usageError('Expected value is not a constructor function') + ); + } + + if (pass) { + return { + pass: true, + message: + 'Expected instance of ' + + actualType + + ' not to be an instance of ' + + expectedType + }; + } else { + return { + pass: false, + message: + 'Expected instance of ' + + actualType + + ' to be an instance of ' + + expectedType + }; + } + } + }; + } + + return toBeInstanceOf; +}; + getJasmineRequireObj().toBeLessThan = function() { /** * {@link expect} the actual value to be less than the expected value. * @function * @name matchers#toBeLessThan + * @since 2.0.0 * @param {Number} expected - The expected value to compare against. * @example * expect(result).toBeLessThan(0); */ function toBeLessThan() { return { - compare: function(actual, expected) { return { pass: actual < expected @@ -2894,13 +6257,13 @@ getJasmineRequireObj().toBeLessThanOrEqual = function() { * {@link expect} the actual value to be less than or equal to the expected value. * @function * @name matchers#toBeLessThanOrEqual + * @since 2.0.0 * @param {Number} expected - The expected value to compare against. * @example * expect(result).toBeLessThanOrEqual(123); */ function toBeLessThanOrEqual() { return { - compare: function(actual, expected) { return { pass: actual <= expected @@ -2917,20 +6280,23 @@ getJasmineRequireObj().toBeNaN = function(j$) { * {@link expect} the actual value to be `NaN` (Not a Number). * @function * @name matchers#toBeNaN + * @since 1.3.0 * @example * expect(thing).toBeNaN(); */ - function toBeNaN() { + function toBeNaN(matchersUtil) { return { compare: function(actual) { var result = { - pass: (actual !== actual) + pass: actual !== actual }; if (result.pass) { result.message = 'Expected actual not to be NaN.'; } else { - result.message = function() { return 'Expected ' + j$.pp(actual) + ' to be NaN.'; }; + result.message = function() { + return 'Expected ' + matchersUtil.pp(actual) + ' to be NaN.'; + }; } return result; @@ -2946,20 +6312,23 @@ getJasmineRequireObj().toBeNegativeInfinity = function(j$) { * {@link expect} the actual value to be `-Infinity` (-infinity). * @function * @name matchers#toBeNegativeInfinity + * @since 2.6.0 * @example * expect(thing).toBeNegativeInfinity(); */ - function toBeNegativeInfinity() { + function toBeNegativeInfinity(matchersUtil) { return { compare: function(actual) { var result = { - pass: (actual === Number.NEGATIVE_INFINITY) + pass: actual === Number.NEGATIVE_INFINITY }; if (result.pass) { - result.message = 'Expected actual to be -Infinity.'; + result.message = 'Expected actual not to be -Infinity.'; } else { - result.message = function() { return 'Expected ' + j$.pp(actual) + ' not to be -Infinity.'; }; + result.message = function() { + return 'Expected ' + matchersUtil.pp(actual) + ' to be -Infinity.'; + }; } return result; @@ -2975,6 +6344,7 @@ getJasmineRequireObj().toBeNull = function() { * {@link expect} the actual value to be `null`. * @function * @name matchers#toBeNull + * @since 1.3.0 * @example * expect(result).toBeNull(); */ @@ -2996,20 +6366,23 @@ getJasmineRequireObj().toBePositiveInfinity = function(j$) { * {@link expect} the actual value to be `Infinity` (infinity). * @function * @name matchers#toBePositiveInfinity + * @since 2.6.0 * @example * expect(thing).toBePositiveInfinity(); */ - function toBePositiveInfinity() { + function toBePositiveInfinity(matchersUtil) { return { compare: function(actual) { var result = { - pass: (actual === Number.POSITIVE_INFINITY) + pass: actual === Number.POSITIVE_INFINITY }; if (result.pass) { - result.message = 'Expected actual to be Infinity.'; + result.message = 'Expected actual not to be Infinity.'; } else { - result.message = function() { return 'Expected ' + j$.pp(actual) + ' not to be Infinity.'; }; + result.message = function() { + return 'Expected ' + matchersUtil.pp(actual) + ' to be Infinity.'; + }; } return result; @@ -3020,11 +6393,34 @@ getJasmineRequireObj().toBePositiveInfinity = function(j$) { return toBePositiveInfinity; }; +getJasmineRequireObj().toBeTrue = function() { + /** + * {@link expect} the actual value to be `true`. + * @function + * @name matchers#toBeTrue + * @since 3.5.0 + * @example + * expect(result).toBeTrue(); + */ + function toBeTrue() { + return { + compare: function(actual) { + return { + pass: actual === true + }; + } + }; + } + + return toBeTrue; +}; + getJasmineRequireObj().toBeTruthy = function() { /** * {@link expect} the actual value to be truthy. * @function * @name matchers#toBeTruthy + * @since 2.0.0 * @example * expect(thing).toBeTruthy(); */ @@ -3046,6 +6442,7 @@ getJasmineRequireObj().toBeUndefined = function() { * {@link expect} the actual value to be `undefined`. * @function * @name matchers#toBeUndefined + * @since 1.3.0 * @example * expect(result).toBeUndefined(): */ @@ -3067,19 +6464,17 @@ getJasmineRequireObj().toContain = function() { * {@link expect} the actual value to contain a specific value. * @function * @name matchers#toContain + * @since 2.0.0 * @param {Object} expected - The value to look for. * @example * expect(array).toContain(anElement); * expect(string).toContain(substring); */ - function toContain(util, customEqualityTesters) { - customEqualityTesters = customEqualityTesters || []; - + function toContain(matchersUtil) { return { compare: function(actual, expected) { - return { - pass: util.contains(actual, expected, customEqualityTesters) + pass: matchersUtil.contains(actual, expected) }; } }; @@ -3093,21 +6488,20 @@ getJasmineRequireObj().toEqual = function(j$) { * {@link expect} the actual value to be equal to the expected, using deep equality comparison. * @function * @name matchers#toEqual + * @since 1.3.0 * @param {Object} expected - Expected value * @example * expect(bigObject).toEqual({"foo": ['bar', 'baz']}); */ - function toEqual(util, customEqualityTesters) { - customEqualityTesters = customEqualityTesters || []; - + function toEqual(matchersUtil) { return { compare: function(actual, expected) { var result = { pass: false }, - diffBuilder = j$.DiffBuilder(); + diffBuilder = j$.DiffBuilder({ prettyPrinter: matchersUtil.pp }); - result.pass = util.equals(actual, expected, customEqualityTesters, diffBuilder); + result.pass = matchersUtil.equals(actual, expected, diffBuilder); // TODO: only set error message if test fails result.message = diffBuilder.getMessage(); @@ -3121,35 +6515,44 @@ getJasmineRequireObj().toEqual = function(j$) { }; getJasmineRequireObj().toHaveBeenCalled = function(j$) { - - var getErrorMsg = j$.formatErrorMsg('', 'expect().toHaveBeenCalled()'); + var getErrorMsg = j$.formatErrorMsg( + '', + 'expect().toHaveBeenCalled()' + ); /** * {@link expect} the actual (a {@link Spy}) to have been called. * @function * @name matchers#toHaveBeenCalled + * @since 1.3.0 * @example * expect(mySpy).toHaveBeenCalled(); * expect(mySpy).not.toHaveBeenCalled(); */ - function toHaveBeenCalled() { + function toHaveBeenCalled(matchersUtil) { return { compare: function(actual) { var result = {}; if (!j$.isSpy(actual)) { - throw new Error(getErrorMsg('Expected a spy, but got ' + j$.pp(actual) + '.')); + throw new Error( + getErrorMsg( + 'Expected a spy, but got ' + matchersUtil.pp(actual) + '.' + ) + ); } if (arguments.length > 1) { - throw new Error(getErrorMsg('Does not take arguments, use toHaveBeenCalledWith')); + throw new Error( + getErrorMsg('Does not take arguments, use toHaveBeenCalledWith') + ); } result.pass = actual.calls.any(); - result.message = result.pass ? - 'Expected spy ' + actual.and.identity() + ' not to have been called.' : - 'Expected spy ' + actual.and.identity() + ' to have been called.'; + result.message = result.pass + ? 'Expected spy ' + actual.and.identity + ' not to have been called.' + : 'Expected spy ' + actual.and.identity + ' to have been called.'; return result; } @@ -3160,35 +6563,48 @@ getJasmineRequireObj().toHaveBeenCalled = function(j$) { }; getJasmineRequireObj().toHaveBeenCalledBefore = function(j$) { - - var getErrorMsg = j$.formatErrorMsg('', 'expect().toHaveBeenCalledBefore()'); + var getErrorMsg = j$.formatErrorMsg( + '', + 'expect().toHaveBeenCalledBefore()' + ); /** * {@link expect} the actual value (a {@link Spy}) to have been called before another {@link Spy}. * @function * @name matchers#toHaveBeenCalledBefore + * @since 2.6.0 * @param {Spy} expected - {@link Spy} that should have been called after the `actual` {@link Spy}. * @example * expect(mySpy).toHaveBeenCalledBefore(otherSpy); */ - function toHaveBeenCalledBefore() { + function toHaveBeenCalledBefore(matchersUtil) { return { compare: function(firstSpy, latterSpy) { if (!j$.isSpy(firstSpy)) { - throw new Error(getErrorMsg('Expected a spy, but got ' + j$.pp(firstSpy) + '.')); + throw new Error( + getErrorMsg( + 'Expected a spy, but got ' + matchersUtil.pp(firstSpy) + '.' + ) + ); } if (!j$.isSpy(latterSpy)) { - throw new Error(getErrorMsg('Expected a spy, but got ' + j$.pp(latterSpy) + '.')); + throw new Error( + getErrorMsg( + 'Expected a spy, but got ' + matchersUtil.pp(latterSpy) + '.' + ) + ); } var result = { pass: false }; if (!firstSpy.calls.count()) { - result.message = 'Expected spy ' + firstSpy.and.identity() + ' to have been called.'; + result.message = + 'Expected spy ' + firstSpy.and.identity + ' to have been called.'; return result; } if (!latterSpy.calls.count()) { - result.message = 'Expected spy ' + latterSpy.and.identity() + ' to have been called.'; + result.message = + 'Expected spy ' + latterSpy.and.identity + ' to have been called.'; return result; } @@ -3198,17 +6614,36 @@ getJasmineRequireObj().toHaveBeenCalledBefore = function(j$) { result.pass = latest1stSpyCall < first2ndSpyCall; if (result.pass) { - result.message = 'Expected spy ' + firstSpy.and.identity() + ' to not have been called before spy ' + latterSpy.and.identity() + ', but it was'; + result.message = + 'Expected spy ' + + firstSpy.and.identity + + ' to not have been called before spy ' + + latterSpy.and.identity + + ', but it was'; } else { var first1stSpyCall = firstSpy.calls.first().invocationOrder; var latest2ndSpyCall = latterSpy.calls.mostRecent().invocationOrder; - if(first1stSpyCall < first2ndSpyCall) { - result.message = 'Expected latest call to spy ' + firstSpy.and.identity() + ' to have been called before first call to spy ' + latterSpy.and.identity() + ' (no interleaved calls)'; + if (first1stSpyCall < first2ndSpyCall) { + result.message = + 'Expected latest call to spy ' + + firstSpy.and.identity + + ' to have been called before first call to spy ' + + latterSpy.and.identity + + ' (no interleaved calls)'; } else if (latest2ndSpyCall > latest1stSpyCall) { - result.message = 'Expected first call to spy ' + latterSpy.and.identity() + ' to have been called after latest call to spy ' + firstSpy.and.identity() + ' (no interleaved calls)'; + result.message = + 'Expected first call to spy ' + + latterSpy.and.identity + + ' to have been called after latest call to spy ' + + firstSpy.and.identity + + ' (no interleaved calls)'; } else { - result.message = 'Expected spy ' + firstSpy.and.identity() + ' to have been called before spy ' + latterSpy.and.identity(); + result.message = + 'Expected spy ' + + firstSpy.and.identity + + ' to have been called before spy ' + + latterSpy.and.identity; } } @@ -3220,81 +6655,339 @@ getJasmineRequireObj().toHaveBeenCalledBefore = function(j$) { return toHaveBeenCalledBefore; }; -getJasmineRequireObj().toHaveBeenCalledTimes = function(j$) { +getJasmineRequireObj().toHaveBeenCalledOnceWith = function(j$) { + var getErrorMsg = j$.formatErrorMsg( + '', + 'expect().toHaveBeenCalledOnceWith(...arguments)' + ); + + /** + * {@link expect} the actual (a {@link Spy}) to have been called exactly once, and exactly with the particular arguments. + * @function + * @name matchers#toHaveBeenCalledOnceWith + * @since 3.6.0 + * @param {...Object} - The arguments to look for + * @example + * expect(mySpy).toHaveBeenCalledOnceWith('foo', 'bar', 2); + */ + function toHaveBeenCalledOnceWith(util) { + return { + compare: function() { + var args = Array.prototype.slice.call(arguments, 0), + actual = args[0], + expectedArgs = args.slice(1); + + if (!j$.isSpy(actual)) { + throw new Error( + getErrorMsg('Expected a spy, but got ' + util.pp(actual) + '.') + ); + } + + var prettyPrintedCalls = actual.calls + .allArgs() + .map(function(argsForCall) { + return ' ' + util.pp(argsForCall); + }); + + if ( + actual.calls.count() === 1 && + util.contains(actual.calls.allArgs(), expectedArgs) + ) { + return { + pass: true, + message: + 'Expected spy ' + + actual.and.identity + + ' to have been called 0 times, multiple times, or once, but with arguments different from:\n' + + ' ' + + util.pp(expectedArgs) + + '\n' + + 'But the actual call was:\n' + + prettyPrintedCalls.join(',\n') + + '.\n\n' + }; + } + + function getDiffs() { + return actual.calls.allArgs().map(function(argsForCall, callIx) { + var diffBuilder = new j$.DiffBuilder(); + util.equals(argsForCall, expectedArgs, diffBuilder); + return diffBuilder.getMessage(); + }); + } + + function butString() { + switch (actual.calls.count()) { + case 0: + return 'But it was never called.\n\n'; + case 1: + return ( + 'But the actual call was:\n' + + prettyPrintedCalls.join(',\n') + + '.\n' + + getDiffs().join('\n') + + '\n\n' + ); + default: + return ( + 'But the actual calls were:\n' + + prettyPrintedCalls.join(',\n') + + '.\n\n' + ); + } + } + + return { + pass: false, + message: + 'Expected spy ' + + actual.and.identity + + ' to have been called only once, and with given args:\n' + + ' ' + + util.pp(expectedArgs) + + '\n' + + butString() + }; + } + }; + } + + return toHaveBeenCalledOnceWith; +}; - var getErrorMsg = j$.formatErrorMsg('', 'expect().toHaveBeenCalledTimes()'); +getJasmineRequireObj().toHaveBeenCalledTimes = function(j$) { + var getErrorMsg = j$.formatErrorMsg( + '', + 'expect().toHaveBeenCalledTimes()' + ); /** * {@link expect} the actual (a {@link Spy}) to have been called the specified number of times. * @function * @name matchers#toHaveBeenCalledTimes + * @since 2.4.0 * @param {Number} expected - The number of invocations to look for. * @example * expect(mySpy).toHaveBeenCalledTimes(3); */ - function toHaveBeenCalledTimes() { + function toHaveBeenCalledTimes(matchersUtil) { return { compare: function(actual, expected) { if (!j$.isSpy(actual)) { - throw new Error(getErrorMsg('Expected a spy, but got ' + j$.pp(actual) + '.')); + throw new Error( + getErrorMsg( + 'Expected a spy, but got ' + matchersUtil.pp(actual) + '.' + ) + ); + } + + var args = Array.prototype.slice.call(arguments, 0), + result = { pass: false }; + + if (!j$.isNumber_(expected)) { + throw new Error( + getErrorMsg( + 'The expected times failed is a required argument and must be a number.' + ) + ); } + actual = args[0]; + var calls = actual.calls.count(); + var timesMessage = expected === 1 ? 'once' : expected + ' times'; + result.pass = calls === expected; + result.message = result.pass + ? 'Expected spy ' + + actual.and.identity + + ' not to have been called ' + + timesMessage + + '. It was called ' + + calls + + ' times.' + : 'Expected spy ' + + actual.and.identity + + ' to have been called ' + + timesMessage + + '. It was called ' + + calls + + ' times.'; + return result; + } + }; + } + + return toHaveBeenCalledTimes; +}; + +getJasmineRequireObj().toHaveBeenCalledWith = function(j$) { + var getErrorMsg = j$.formatErrorMsg( + '', + 'expect().toHaveBeenCalledWith(...arguments)' + ); + + /** + * {@link expect} the actual (a {@link Spy}) to have been called with particular arguments at least once. + * @function + * @name matchers#toHaveBeenCalledWith + * @since 1.3.0 + * @param {...Object} - The arguments to look for + * @example + * expect(mySpy).toHaveBeenCalledWith('foo', 'bar', 2); + */ + function toHaveBeenCalledWith(matchersUtil) { + return { + compare: function() { var args = Array.prototype.slice.call(arguments, 0), + actual = args[0], + expectedArgs = args.slice(1), result = { pass: false }; - if (!j$.isNumber_(expected)){ - throw new Error(getErrorMsg('The expected times failed is a required argument and must be a number.')); + if (!j$.isSpy(actual)) { + throw new Error( + getErrorMsg( + 'Expected a spy, but got ' + matchersUtil.pp(actual) + '.' + ) + ); + } + + if (!actual.calls.any()) { + result.message = function() { + return ( + 'Expected spy ' + + actual.and.identity + + ' to have been called with:\n' + + ' ' + + matchersUtil.pp(expectedArgs) + + '\nbut it was never called.' + ); + }; + return result; + } + + if (matchersUtil.contains(actual.calls.allArgs(), expectedArgs)) { + result.pass = true; + result.message = function() { + return ( + 'Expected spy ' + + actual.and.identity + + ' not to have been called with:\n' + + ' ' + + matchersUtil.pp(expectedArgs) + + '\nbut it was.' + ); + }; + } else { + result.message = function() { + var prettyPrintedCalls = actual.calls + .allArgs() + .map(function(argsForCall) { + return ' ' + matchersUtil.pp(argsForCall); + }); + + var diffs = actual.calls + .allArgs() + .map(function(argsForCall, callIx) { + var diffBuilder = new j$.DiffBuilder(); + matchersUtil.equals(argsForCall, expectedArgs, diffBuilder); + return ( + 'Call ' + + callIx + + ':\n' + + diffBuilder.getMessage().replace(/^/gm, ' ') + ); + }); + + return ( + 'Expected spy ' + + actual.and.identity + + ' to have been called with:\n' + + ' ' + + matchersUtil.pp(expectedArgs) + + '\n' + + '' + + 'but actual calls were:\n' + + prettyPrintedCalls.join(',\n') + + '.\n\n' + + diffs.join('\n') + ); + }; + } + + return result; + } + }; + } + + return toHaveBeenCalledWith; +}; + +getJasmineRequireObj().toHaveClass = function(j$) { + /** + * {@link expect} the actual value to be a DOM element that has the expected class + * @function + * @name matchers#toHaveClass + * @since 3.0.0 + * @param {Object} expected - The class name to test for + * @example + * var el = document.createElement('div'); + * el.className = 'foo bar baz'; + * expect(el).toHaveClass('bar'); + */ + function toHaveClass(matchersUtil) { + return { + compare: function(actual, expected) { + if (!isElement(actual)) { + throw new Error(matchersUtil.pp(actual) + ' is not a DOM element'); } - actual = args[0]; - var calls = actual.calls.count(); - var timesMessage = expected === 1 ? 'once' : expected + ' times'; - result.pass = calls === expected; - result.message = result.pass ? - 'Expected spy ' + actual.and.identity() + ' not to have been called ' + timesMessage + '. It was called ' + calls + ' times.' : - 'Expected spy ' + actual.and.identity() + ' to have been called ' + timesMessage + '. It was called ' + calls + ' times.'; - return result; + return { + pass: actual.classList.contains(expected) + }; } }; } - return toHaveBeenCalledTimes; -}; - -getJasmineRequireObj().toHaveBeenCalledWith = function(j$) { + function isElement(maybeEl) { + return ( + maybeEl && maybeEl.classList && j$.isFunction_(maybeEl.classList.contains) + ); + } - var getErrorMsg = j$.formatErrorMsg('', 'expect().toHaveBeenCalledWith(...arguments)'); + return toHaveClass; +}; +getJasmineRequireObj().toHaveSize = function(j$) { /** - * {@link expect} the actual (a {@link Spy}) to have been called with particular arguments at least once. + * {@link expect} the actual size to be equal to the expected, using array-like length or object keys size. * @function - * @name matchers#toHaveBeenCalledWith - * @param {...Object} - The arguments to look for + * @name matchers#toHaveSize + * @since 3.6.0 + * @param {Object} expected - Expected size * @example - * expect(mySpy).toHaveBeenCalledWith('foo', 'bar', 2); + * array = [1,2]; + * expect(array).toHaveSize(2); */ - function toHaveBeenCalledWith(util, customEqualityTesters) { + function toHaveSize() { return { - compare: function() { - var args = Array.prototype.slice.call(arguments, 0), - actual = args[0], - expectedArgs = args.slice(1), - result = { pass: false }; - - if (!j$.isSpy(actual)) { - throw new Error(getErrorMsg('Expected a spy, but got ' + j$.pp(actual) + '.')); - } + compare: function(actual, expected) { + var result = { + pass: false + }; - if (!actual.calls.any()) { - result.message = function() { return 'Expected spy ' + actual.and.identity() + ' to have been called with ' + j$.pp(expectedArgs) + ' but it was never called.'; }; - return result; + if ( + j$.isA_('WeakSet', actual) || + j$.isWeakMap(actual) || + j$.isDataView(actual) + ) { + throw new Error('Cannot get size of ' + actual + '.'); } - if (util.contains(actual.calls.allArgs(), expectedArgs, customEqualityTesters)) { - result.pass = true; - result.message = function() { return 'Expected spy ' + actual.and.identity() + ' not to have been called with ' + j$.pp(expectedArgs) + ' but it was.'; }; + if (j$.isSet(actual) || j$.isMap(actual)) { + result.pass = actual.size === expected; + } else if (isLength(actual.length)) { + result.pass = actual.length === expected; } else { - result.message = function() { return 'Expected spy ' + actual.and.identity() + ' to have been called with ' + j$.pp(expectedArgs) + ' but actual calls were ' + j$.pp(actual.calls.allArgs()).replace(/^\[ | \]$/g, '') + '.'; }; + result.pass = Object.keys(actual).length === expected; } return result; @@ -3302,17 +6995,30 @@ getJasmineRequireObj().toHaveBeenCalledWith = function(j$) { }; } - return toHaveBeenCalledWith; + var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || 9007199254740991; // eslint-disable-line compat/compat + function isLength(value) { + return ( + typeof value == 'number' && + value > -1 && + value % 1 === 0 && + value <= MAX_SAFE_INTEGER + ); + } + + return toHaveSize; }; getJasmineRequireObj().toMatch = function(j$) { - - var getErrorMsg = j$.formatErrorMsg('', 'expect().toMatch( || )'); + var getErrorMsg = j$.formatErrorMsg( + '', + 'expect().toMatch( || )' + ); /** * {@link expect} the actual value to match a regular expression * @function * @name matchers#toMatch + * @since 1.3.0 * @param {RegExp|String} expected - Value to look for in the string. * @example * expect("my string").toMatch(/string$/); @@ -3338,19 +7044,22 @@ getJasmineRequireObj().toMatch = function(j$) { }; getJasmineRequireObj().toThrow = function(j$) { - - var getErrorMsg = j$.formatErrorMsg('', 'expect(function() {}).toThrow()'); + var getErrorMsg = j$.formatErrorMsg( + '', + 'expect(function() {}).toThrow()' + ); /** * {@link expect} a function to `throw` something. * @function * @name matchers#toThrow + * @since 2.0.0 * @param {Object} [expected] - Value that should be thrown. If not provided, simply the fact that something was thrown will be checked. * @example * expect(function() { return 'things'; }).toThrow('foo'); * expect(function() { return 'stuff'; }).toThrow(); */ - function toThrow(util) { + function toThrow(matchersUtil) { return { compare: function(actual, expected) { var result = { pass: false }, @@ -3375,16 +7084,36 @@ getJasmineRequireObj().toThrow = function(j$) { if (arguments.length == 1) { result.pass = true; - result.message = function() { return 'Expected function not to throw, but it threw ' + j$.pp(thrown) + '.'; }; + result.message = function() { + return ( + 'Expected function not to throw, but it threw ' + + matchersUtil.pp(thrown) + + '.' + ); + }; return result; } - if (util.equals(thrown, expected)) { + if (matchersUtil.equals(thrown, expected)) { result.pass = true; - result.message = function() { return 'Expected function not to throw ' + j$.pp(expected) + '.'; }; + result.message = function() { + return ( + 'Expected function not to throw ' + + matchersUtil.pp(expected) + + '.' + ); + }; } else { - result.message = function() { return 'Expected function to throw ' + j$.pp(expected) + ', but it threw ' + j$.pp(thrown) + '.'; }; + result.message = function() { + return ( + 'Expected function to throw ' + + matchersUtil.pp(expected) + + ', but it threw ' + + matchersUtil.pp(thrown) + + '.' + ); + }; } return result; @@ -3396,13 +7125,16 @@ getJasmineRequireObj().toThrow = function(j$) { }; getJasmineRequireObj().toThrowError = function(j$) { - - var getErrorMsg = j$.formatErrorMsg('', 'expect(function() {}).toThrowError(, )'); + var getErrorMsg = j$.formatErrorMsg( + '', + 'expect(function() {}).toThrowError(, )' + ); /** * {@link expect} a function to `throw` an `Error`. * @function * @name matchers#toThrowError + * @since 2.0.0 * @param {Error} [expected] - `Error` constructor the object that was thrown needs to be an instance of. If not provided, `Error` will be used. * @param {RegExp|String} [message] - The message that should be set on the thrown `Error` * @example @@ -3412,81 +7144,83 @@ getJasmineRequireObj().toThrowError = function(j$) { * expect(function() { return 'other'; }).toThrowError(/foo/); * expect(function() { return 'other'; }).toThrowError(); */ - function toThrowError () { + function toThrowError(matchersUtil) { return { compare: function(actual) { - var threw = false, - pass = {pass: true}, - fail = {pass: false}, + var errorMatcher = getMatcher.apply(null, arguments), thrown; if (typeof actual != 'function') { throw new Error(getErrorMsg('Actual is not a Function')); } - var errorMatcher = getMatcher.apply(null, arguments); - try { actual(); + return fail('Expected function to throw an Error.'); } catch (e) { - threw = true; thrown = e; } - if (!threw) { - fail.message = 'Expected function to throw an Error.'; - return fail; - } - - // Get Error constructor of thrown - if (!isErrorObject(thrown)) { - fail.message = function() { return 'Expected function to throw an Error, but it threw ' + j$.pp(thrown) + '.'; }; - return fail; - } - - if (errorMatcher.hasNoSpecifics()) { - pass.message = 'Expected function not to throw an Error, but it threw ' + j$.fnNameFor(thrown) + '.'; - return pass; + if (!j$.isError_(thrown)) { + return fail(function() { + return ( + 'Expected function to throw an Error, but it threw ' + + matchersUtil.pp(thrown) + + '.' + ); + }); } - if (errorMatcher.matches(thrown)) { - pass.message = function() { - return 'Expected function not to throw ' + errorMatcher.errorTypeDescription + errorMatcher.messageDescription() + '.'; - }; - return pass; - } else { - fail.message = function() { - return 'Expected function to throw ' + errorMatcher.errorTypeDescription + errorMatcher.messageDescription() + - ', but it threw ' + errorMatcher.thrownDescription(thrown) + '.'; - }; - return fail; - } + return errorMatcher.match(thrown); } }; function getMatcher() { - var expected = null, - errorType = null; + var expected, errorType; - if (arguments.length == 2) { - expected = arguments[1]; - if (isAnErrorType(expected)) { - errorType = expected; - expected = null; - } - } else if (arguments.length > 2) { + if (arguments[2]) { errorType = arguments[1]; expected = arguments[2]; if (!isAnErrorType(errorType)) { throw new Error(getErrorMsg('Expected error type is not an Error.')); } + + return exactMatcher(expected, errorType); + } else if (arguments[1]) { + expected = arguments[1]; + + if (isAnErrorType(arguments[1])) { + return exactMatcher(null, arguments[1]); + } else { + return exactMatcher(arguments[1], null); + } + } else { + return anyMatcher(); } + } + + function anyMatcher() { + return { + match: function(error) { + return pass( + 'Expected function not to throw an Error, but it threw ' + + j$.fnNameFor(error) + + '.' + ); + } + }; + } + function exactMatcher(expected, errorType) { if (expected && !isStringOrRegExp(expected)) { if (errorType) { - throw new Error(getErrorMsg('Expected error message is not a string or RegExp.')); + throw new Error( + getErrorMsg('Expected error message is not a string or RegExp.') + ); } else { - throw new Error(getErrorMsg('Expected is not an Error, string, or RegExp.')); + throw new Error( + getErrorMsg('Expected is not an Error, string, or RegExp.') + ); } } @@ -3498,39 +7232,69 @@ getJasmineRequireObj().toThrowError = function(j$) { } } - return { - errorTypeDescription: errorType ? j$.fnNameFor(errorType) : 'an exception', - thrownDescription: function(thrown) { - var thrownName = errorType ? j$.fnNameFor(thrown.constructor) : 'an exception', - thrownMessage = ''; + var errorTypeDescription = errorType + ? j$.fnNameFor(errorType) + : 'an exception'; - if (expected) { - thrownMessage = ' with message ' + j$.pp(thrown.message); - } + function thrownDescription(thrown) { + var thrownName = errorType + ? j$.fnNameFor(thrown.constructor) + : 'an exception', + thrownMessage = ''; - return thrownName + thrownMessage; - }, - messageDescription: function() { - if (expected === null) { - return ''; - } else if (expected instanceof RegExp) { - return ' with a message matching ' + j$.pp(expected); + if (expected) { + thrownMessage = ' with message ' + matchersUtil.pp(thrown.message); + } + + return thrownName + thrownMessage; + } + + function messageDescription() { + if (expected === null) { + return ''; + } else if (expected instanceof RegExp) { + return ' with a message matching ' + matchersUtil.pp(expected); + } else { + return ' with message ' + matchersUtil.pp(expected); + } + } + + function matches(error) { + return ( + (errorType === null || error instanceof errorType) && + (expected === null || messageMatch(error.message)) + ); + } + + return { + match: function(thrown) { + if (matches(thrown)) { + return pass(function() { + return ( + 'Expected function not to throw ' + + errorTypeDescription + + messageDescription() + + '.' + ); + }); } else { - return ' with message ' + j$.pp(expected); + return fail(function() { + return ( + 'Expected function to throw ' + + errorTypeDescription + + messageDescription() + + ', but it threw ' + + thrownDescription(thrown) + + '.' + ); + }); } - }, - hasNoSpecifics: function() { - return expected === null && errorType === null; - }, - matches: function(error) { - return (errorType === null || error instanceof errorType) && - (expected === null || messageMatch(error.message)); } }; } function isStringOrRegExp(potential) { - return potential instanceof RegExp || (typeof potential == 'string'); + return potential instanceof RegExp || typeof potential == 'string'; } function isAnErrorType(type) { @@ -3540,22 +7304,107 @@ getJasmineRequireObj().toThrowError = function(j$) { var Surrogate = function() {}; Surrogate.prototype = type.prototype; - return isErrorObject(new Surrogate()); + return j$.isError_(new Surrogate()); } + } - function isErrorObject(thrown) { - if (thrown instanceof Error) { - return true; + function pass(message) { + return { + pass: true, + message: message + }; + } + + function fail(message) { + return { + pass: false, + message: message + }; + } + + return toThrowError; +}; + +getJasmineRequireObj().toThrowMatching = function(j$) { + var usageError = j$.formatErrorMsg( + '', + 'expect(function() {}).toThrowMatching()' + ); + + /** + * {@link expect} a function to `throw` something matching a predicate. + * @function + * @name matchers#toThrowMatching + * @since 3.0.0 + * @param {Function} predicate - A function that takes the thrown exception as its parameter and returns true if it matches. + * @example + * expect(function() { throw new Error('nope'); }).toThrowMatching(function(thrown) { return thrown.message === 'nope'; }); + */ + function toThrowMatching(matchersUtil) { + return { + compare: function(actual, predicate) { + var thrown; + + if (typeof actual !== 'function') { + throw new Error(usageError('Actual is not a Function')); + } + + if (typeof predicate !== 'function') { + throw new Error(usageError('Predicate is not a Function')); + } + + try { + actual(); + return fail('Expected function to throw an exception.'); + } catch (e) { + thrown = e; + } + + if (predicate(thrown)) { + return pass( + 'Expected function not to throw an exception matching a predicate.' + ); + } else { + return fail(function() { + return ( + 'Expected function to throw an exception matching a predicate, ' + + 'but it threw ' + + thrownDescription(thrown) + + '.' + ); + }); + } } - if (thrown && thrown.constructor && thrown.constructor.constructor && - (thrown instanceof (thrown.constructor.constructor('return this')()).Error)) { - return true; + }; + + function thrownDescription(thrown) { + if (thrown && thrown.constructor) { + return ( + j$.fnNameFor(thrown.constructor) + + ' with message ' + + matchersUtil.pp(thrown.message) + ); + } else { + return matchersUtil.pp(thrown); } - return false; } } - return toThrowError; + function pass(message) { + return { + pass: true, + message: message + }; + } + + function fail(message) { + return { + pass: false, + message: message + }; + } + + return toThrowMatching; }; getJasmineRequireObj().MockDate = function() { @@ -3597,7 +7446,7 @@ getJasmineRequireObj().MockDate = function() { return self; function FakeDate() { - switch(arguments.length) { + switch (arguments.length) { case 0: return new GlobalDate(currentTime); case 1: @@ -3607,16 +7456,39 @@ getJasmineRequireObj().MockDate = function() { case 3: return new GlobalDate(arguments[0], arguments[1], arguments[2]); case 4: - return new GlobalDate(arguments[0], arguments[1], arguments[2], arguments[3]); + return new GlobalDate( + arguments[0], + arguments[1], + arguments[2], + arguments[3] + ); case 5: - return new GlobalDate(arguments[0], arguments[1], arguments[2], arguments[3], - arguments[4]); + return new GlobalDate( + arguments[0], + arguments[1], + arguments[2], + arguments[3], + arguments[4] + ); case 6: - return new GlobalDate(arguments[0], arguments[1], arguments[2], arguments[3], - arguments[4], arguments[5]); + return new GlobalDate( + arguments[0], + arguments[1], + arguments[2], + arguments[3], + arguments[4], + arguments[5] + ); default: - return new GlobalDate(arguments[0], arguments[1], arguments[2], arguments[3], - arguments[4], arguments[5], arguments[6]); + return new GlobalDate( + arguments[0], + arguments[1], + arguments[2], + arguments[3], + arguments[4], + arguments[5], + arguments[6] + ); } } @@ -3636,55 +7508,94 @@ getJasmineRequireObj().MockDate = function() { FakeDate.parse = GlobalDate.parse; FakeDate.UTC = GlobalDate.UTC; } - } + } return MockDate; }; -getJasmineRequireObj().pp = function(j$) { - - function PrettyPrinter() { +getJasmineRequireObj().makePrettyPrinter = function(j$) { + function SinglePrettyPrintRun(customObjectFormatters, pp) { + this.customObjectFormatters_ = customObjectFormatters; this.ppNestLevel_ = 0; this.seen = []; + this.length = 0; + this.stringParts = []; + this.pp_ = pp; } function hasCustomToString(value) { // value.toString !== Object.prototype.toString if value has no custom toString but is from another context (e.g. // iframe, web worker) - return value.toString !== Object.prototype.toString && (value.toString() !== Object.prototype.toString.call(value)); + try { + return ( + j$.isFunction_(value.toString) && + value.toString !== Object.prototype.toString && + value.toString() !== Object.prototype.toString.call(value) + ); + } catch (e) { + // The custom toString() threw. + return true; + } } - PrettyPrinter.prototype.format = function(value) { + SinglePrettyPrintRun.prototype.format = function(value) { this.ppNestLevel_++; try { - if (j$.util.isUndefined(value)) { + var customFormatResult = this.applyCustomFormatters_(value); + + if (customFormatResult) { + this.emitScalar(customFormatResult); + } else if (j$.util.isUndefined(value)) { this.emitScalar('undefined'); } else if (value === null) { this.emitScalar('null'); - } else if (value === 0 && 1/value === -Infinity) { + } else if (value === 0 && 1 / value === -Infinity) { this.emitScalar('-0'); } else if (value === j$.getGlobal()) { this.emitScalar(''); } else if (value.jasmineToString) { - this.emitScalar(value.jasmineToString()); + this.emitScalar(value.jasmineToString(this.pp_)); } else if (typeof value === 'string') { this.emitString(value); } else if (j$.isSpy(value)) { - this.emitScalar('spy on ' + value.and.identity()); + this.emitScalar('spy on ' + value.and.identity); + } else if (j$.isSpy(value.toString)) { + this.emitScalar('spy on ' + value.toString.and.identity); } else if (value instanceof RegExp) { this.emitScalar(value.toString()); } else if (typeof value === 'function') { this.emitScalar('Function'); - } else if (typeof value.nodeType === 'number') { - this.emitScalar('HTMLNode'); + } else if (j$.isDomNode(value)) { + if (value.tagName) { + this.emitDomElement(value); + } else { + this.emitScalar('HTMLNode'); + } } else if (value instanceof Date) { this.emitScalar('Date(' + value + ')'); - } else if (value.toString && value.toString() == '[object Set]') { + } else if (j$.isSet(value)) { this.emitSet(value); - } else if (value.toString && typeof value === 'object' && !j$.isArray_(value) && hasCustomToString(value)) { - this.emitScalar(value.toString()); + } else if (j$.isMap(value)) { + this.emitMap(value); + } else if (j$.isTypedArray_(value)) { + this.emitTypedArray(value); + } else if ( + value.toString && + typeof value === 'object' && + !j$.isArray_(value) && + hasCustomToString(value) + ) { + try { + this.emitScalar(value.toString()); + } catch (e) { + this.emitScalar('has-invalid-toString-method'); + } } else if (j$.util.arrayContains(this.seen, value)) { - this.emitScalar(''); + this.emitScalar( + '' + ); } else if (j$.isArray_(value) || j$.isA_('Object', value)) { this.seen.push(value); if (j$.isArray_(value)) { @@ -3696,42 +7607,47 @@ getJasmineRequireObj().pp = function(j$) { } else { this.emitScalar(value.toString()); } + } catch (e) { + if (this.ppNestLevel_ > 1 || !(e instanceof MaxCharsReachedError)) { + throw e; + } } finally { this.ppNestLevel_--; } }; - PrettyPrinter.prototype.iterateObject = function(obj, fn) { - for (var property in obj) { - if (!Object.prototype.hasOwnProperty.call(obj, property)) { continue; } - fn(property, obj.__lookupGetter__ ? (!j$.util.isUndefined(obj.__lookupGetter__(property)) && - obj.__lookupGetter__(property) !== null) : false); - } + SinglePrettyPrintRun.prototype.applyCustomFormatters_ = function(value) { + return customFormat(value, this.customObjectFormatters_); }; - PrettyPrinter.prototype.emitArray = j$.unimplementedMethod_; - PrettyPrinter.prototype.emitSet = j$.unimplementedMethod_; - PrettyPrinter.prototype.emitObject = j$.unimplementedMethod_; - PrettyPrinter.prototype.emitScalar = j$.unimplementedMethod_; - PrettyPrinter.prototype.emitString = j$.unimplementedMethod_; + SinglePrettyPrintRun.prototype.iterateObject = function(obj, fn) { + var objKeys = keys(obj, j$.isArray_(obj)); + var isGetter = function isGetter(prop) {}; - function StringPrettyPrinter() { - PrettyPrinter.call(this); - - this.string = ''; - } + if (obj.__lookupGetter__) { + isGetter = function isGetter(prop) { + var getter = obj.__lookupGetter__(prop); + return !j$.util.isUndefined(getter) && getter !== null; + }; + } + var length = Math.min(objKeys.length, j$.MAX_PRETTY_PRINT_ARRAY_LENGTH); + for (var i = 0; i < length; i++) { + var property = objKeys[i]; + fn(property, isGetter(property)); + } - j$.util.inherit(StringPrettyPrinter, PrettyPrinter); + return objKeys.length > length; + }; - StringPrettyPrinter.prototype.emitScalar = function(value) { + SinglePrettyPrintRun.prototype.emitScalar = function(value) { this.append(value); }; - StringPrettyPrinter.prototype.emitString = function(value) { - this.append('\'' + value + '\''); + SinglePrettyPrintRun.prototype.emitString = function(value) { + this.append("'" + value + "'"); }; - StringPrettyPrinter.prototype.emitArray = function(array) { + SinglePrettyPrintRun.prototype.emitArray = function(array) { if (this.ppNestLevel_ > j$.MAX_PRETTY_PRINT_DEPTH) { this.append('Array'); return; @@ -3744,17 +7660,13 @@ getJasmineRequireObj().pp = function(j$) { } this.format(array[i]); } - if(array.length > length){ + if (array.length > length) { this.append(', ...'); } var self = this; var first = array.length === 0; - this.iterateObject(array, function(property, isGetter) { - if (property.match(/^\d+$/)) { - return; - } - + var truncated = this.iterateObject(array, function(property, isGetter) { if (first) { first = false; } else { @@ -3764,36 +7676,71 @@ getJasmineRequireObj().pp = function(j$) { self.formatProperty(array, property, isGetter); }); + if (truncated) { + this.append(', ...'); + } + this.append(' ]'); }; - StringPrettyPrinter.prototype.emitSet = function(set) { + SinglePrettyPrintRun.prototype.emitSet = function(set) { if (this.ppNestLevel_ > j$.MAX_PRETTY_PRINT_DEPTH) { this.append('Set'); return; } this.append('Set( '); var size = Math.min(set.size, j$.MAX_PRETTY_PRINT_ARRAY_LENGTH); - var iter = set.values(); - for (var i = 0; i < size; i++) { + var i = 0; + set.forEach(function(value, key) { + if (i >= size) { + return; + } if (i > 0) { this.append(', '); } - this.format(iter.next().value); + this.format(value); + + i++; + }, this); + if (set.size > size) { + this.append(', ...'); + } + this.append(' )'); + }; + + SinglePrettyPrintRun.prototype.emitMap = function(map) { + if (this.ppNestLevel_ > j$.MAX_PRETTY_PRINT_DEPTH) { + this.append('Map'); + return; } - if (set.size > size){ + this.append('Map( '); + var size = Math.min(map.size, j$.MAX_PRETTY_PRINT_ARRAY_LENGTH); + var i = 0; + map.forEach(function(value, key) { + if (i >= size) { + return; + } + if (i > 0) { + this.append(', '); + } + this.format([key, value]); + + i++; + }, this); + if (map.size > size) { this.append(', ...'); } this.append(' )'); }; - StringPrettyPrinter.prototype.emitObject = function(obj) { + SinglePrettyPrintRun.prototype.emitObject = function(obj) { var ctor = obj.constructor, - constructorName; + constructorName; - constructorName = typeof ctor === 'function' && obj instanceof ctor ? - j$.fnNameFor(obj.constructor) : - 'null'; + constructorName = + typeof ctor === 'function' && obj instanceof ctor + ? j$.fnNameFor(obj.constructor) + : 'null'; this.append(constructorName); @@ -3805,7 +7752,7 @@ getJasmineRequireObj().pp = function(j$) { this.append('({ '); var first = true; - this.iterateObject(obj, function(property, isGetter) { + var truncated = this.iterateObject(obj, function(property, isGetter) { if (first) { first = false; } else { @@ -3815,152 +7762,397 @@ getJasmineRequireObj().pp = function(j$) { self.formatProperty(obj, property, isGetter); }); + if (truncated) { + this.append(', ...'); + } + this.append(' })'); }; - StringPrettyPrinter.prototype.formatProperty = function(obj, property, isGetter) { - this.append(property); - this.append(': '); - if (isGetter) { - this.append(''); - } else { - this.format(obj[property]); + SinglePrettyPrintRun.prototype.emitTypedArray = function(arr) { + var constructorName = j$.fnNameFor(arr.constructor), + limitedArray = Array.prototype.slice.call( + arr, + 0, + j$.MAX_PRETTY_PRINT_ARRAY_LENGTH + ), + itemsString = Array.prototype.join.call(limitedArray, ', '); + + if (limitedArray.length !== arr.length) { + itemsString += ', ...'; + } + + this.append(constructorName + ' [ ' + itemsString + ' ]'); + }; + + SinglePrettyPrintRun.prototype.emitDomElement = function(el) { + var tagName = el.tagName.toLowerCase(), + attrs = el.attributes, + i, + len = attrs.length, + out = '<' + tagName, + attr; + + for (i = 0; i < len; i++) { + attr = attrs[i]; + out += ' ' + attr.name; + + if (attr.value !== '') { + out += '="' + attr.value + '"'; } + } + + out += '>'; + + if (el.childElementCount !== 0 || el.textContent !== '') { + out += '...'; + } + + this.append(out); + }; + + SinglePrettyPrintRun.prototype.formatProperty = function( + obj, + property, + isGetter + ) { + this.append(property); + this.append(': '); + if (isGetter) { + this.append(''); + } else { + this.format(obj[property]); + } }; - StringPrettyPrinter.prototype.append = function(value) { - this.string += value; + SinglePrettyPrintRun.prototype.append = function(value) { + // This check protects us from the rare case where an object has overriden + // `toString()` with an invalid implementation (returning a non-string). + if (typeof value !== 'string') { + value = Object.prototype.toString.call(value); + } + + var result = truncate(value, j$.MAX_PRETTY_PRINT_CHARS - this.length); + this.length += result.value.length; + this.stringParts.push(result.value); + + if (result.truncated) { + throw new MaxCharsReachedError(); + } }; - return function(value) { - var stringPrettyPrinter = new StringPrettyPrinter(); - stringPrettyPrinter.format(value); - return stringPrettyPrinter.string; + function truncate(s, maxlen) { + if (s.length <= maxlen) { + return { value: s, truncated: false }; + } + + s = s.substring(0, maxlen - 4) + ' ...'; + return { value: s, truncated: true }; + } + + function MaxCharsReachedError() { + this.message = + 'Exceeded ' + + j$.MAX_PRETTY_PRINT_CHARS + + ' characters while pretty-printing a value'; + } + + MaxCharsReachedError.prototype = new Error(); + + function keys(obj, isArray) { + var allKeys = Object.keys + ? Object.keys(obj) + : (function(o) { + var keys = []; + for (var key in o) { + if (j$.util.has(o, key)) { + keys.push(key); + } + } + return keys; + })(obj); + + if (!isArray) { + return allKeys; + } + + if (allKeys.length === 0) { + return allKeys; + } + + var extraKeys = []; + for (var i = 0; i < allKeys.length; i++) { + if (!/^[0-9]+$/.test(allKeys[i])) { + extraKeys.push(allKeys[i]); + } + } + + return extraKeys; + } + + function customFormat(value, customObjectFormatters) { + var i, result; + + for (i = 0; i < customObjectFormatters.length; i++) { + result = customObjectFormatters[i](value); + + if (result !== undefined) { + return result; + } + } + } + + return function(customObjectFormatters) { + customObjectFormatters = customObjectFormatters || []; + + var pp = function(value) { + var prettyPrinter = new SinglePrettyPrintRun(customObjectFormatters, pp); + prettyPrinter.format(value); + return prettyPrinter.stringParts.join(''); + }; + + pp.customFormat_ = function(value) { + return customFormat(value, customObjectFormatters); + }; + + return pp; }; }; getJasmineRequireObj().QueueRunner = function(j$) { + var nextid = 1; + + function StopExecutionError() {} + StopExecutionError.prototype = new Error(); + j$.StopExecutionError = StopExecutionError; function once(fn) { var called = false; - return function() { + return function(arg) { if (!called) { called = true; - fn(); + // Direct call using single parameter, because cleanup/next does not need more + fn(arg); } return null; }; } + function emptyFn() {} + function QueueRunner(attrs) { - this.queueableFns = attrs.queueableFns || []; - this.onComplete = attrs.onComplete || function() {}; - this.clearStack = attrs.clearStack || function(fn) {fn();}; - this.onException = attrs.onException || function() {}; - this.catchException = attrs.catchException || function() { return true; }; - this.userContext = attrs.userContext || {}; - this.timeout = attrs.timeout || {setTimeout: setTimeout, clearTimeout: clearTimeout}; - this.fail = attrs.fail || function() {}; - this.globalErrors = attrs.globalErrors || { pushListener: function() {}, popListener: function() {} }; + this.id_ = nextid++; + var queueableFns = attrs.queueableFns || []; + this.queueableFns = queueableFns.concat(attrs.cleanupFns || []); + this.firstCleanupIx = queueableFns.length; + this.onComplete = attrs.onComplete || emptyFn; + this.clearStack = + attrs.clearStack || + function(fn) { + fn(); + }; + this.onException = attrs.onException || emptyFn; + this.userContext = attrs.userContext || new j$.UserContext(); + this.timeout = attrs.timeout || { + setTimeout: setTimeout, + clearTimeout: clearTimeout + }; + this.fail = attrs.fail || emptyFn; + this.globalErrors = attrs.globalErrors || { + pushListener: emptyFn, + popListener: emptyFn + }; + this.completeOnFirstError = !!attrs.completeOnFirstError; + this.errored = false; + + if (typeof this.onComplete !== 'function') { + throw new Error('invalid onComplete ' + JSON.stringify(this.onComplete)); + } + this.deprecated = attrs.deprecated; } QueueRunner.prototype.execute = function() { var self = this; - this.handleFinalError = function(error) { - self.onException(error); + this.handleFinalError = function(message, source, lineno, colno, error) { + // Older browsers would send the error as the first parameter. HTML5 + // specifies the the five parameters above. The error instance should + // be preffered, otherwise the call stack would get lost. + self.onException(error || message); }; this.globalErrors.pushListener(this.handleFinalError); - this.run(this.queueableFns, 0); + this.run(0); + }; + + QueueRunner.prototype.skipToCleanup = function(lastRanIndex) { + if (lastRanIndex < this.firstCleanupIx) { + this.run(this.firstCleanupIx); + } else { + this.run(lastRanIndex + 1); + } }; - QueueRunner.prototype.run = function(queueableFns, recursiveIndex) { - var length = queueableFns.length, - self = this, - iterativeIndex; - + QueueRunner.prototype.clearTimeout = function(timeoutId) { + Function.prototype.apply.apply(this.timeout.clearTimeout, [ + j$.getGlobal(), + [timeoutId] + ]); + }; - for(iterativeIndex = recursiveIndex; iterativeIndex < length; iterativeIndex++) { - var queueableFn = queueableFns[iterativeIndex]; - if (queueableFn.fn.length > 0) { - attemptAsync(queueableFn); - return; - } else { - attemptSync(queueableFn); - } - } + QueueRunner.prototype.setTimeout = function(fn, timeout) { + return Function.prototype.apply.apply(this.timeout.setTimeout, [ + j$.getGlobal(), + [fn, timeout] + ]); + }; - this.clearStack(function() { - self.globalErrors.popListener(self.handleFinalError); - self.onComplete(); - }); + QueueRunner.prototype.attempt = function attempt(iterativeIndex) { + var self = this, + completedSynchronously = true, + handleError = function handleError(error) { + onException(error); + }, + cleanup = once(function cleanup() { + if (timeoutId !== void 0) { + self.clearTimeout(timeoutId); + } + self.globalErrors.popListener(handleError); + }), + next = once(function next(err) { + cleanup(); - function attemptSync(queueableFn) { - try { - queueableFn.fn.call(self.userContext); - } catch (e) { - handleException(e, queueableFn); - } - } + if (j$.isError_(err)) { + if (!(err instanceof StopExecutionError) && !err.jasmineMessage) { + self.fail(err); + } + self.errored = errored = true; + } - function attemptAsync(queueableFn) { - var clearTimeout = function () { - Function.prototype.apply.apply(self.timeout.clearTimeout, [j$.getGlobal(), [timeoutId]]); - }, - completedSynchronously = true, - setTimeout = function(delayedFn, delay) { - return Function.prototype.apply.apply(self.timeout.setTimeout, [j$.getGlobal(), [delayedFn, delay]]); - }, - handleError = function(error) { - onException(error); - next(); - }, - next = once(function () { - clearTimeout(timeoutId); - self.globalErrors.popListener(handleError); - if (completedSynchronously) { - setTimeout(function() { - self.run(queueableFns, iterativeIndex + 1); - }); + function runNext() { + if (self.completeOnFirstError && errored) { + self.skipToCleanup(iterativeIndex); } else { - self.run(queueableFns, iterativeIndex + 1); + self.run(iterativeIndex + 1); } - }), - timeoutId; + } - next.fail = function() { - self.fail.apply(null, arguments); + if (completedSynchronously) { + self.setTimeout(runNext); + } else { + runNext(); + } + }), + errored = false, + queueableFn = self.queueableFns[iterativeIndex], + timeoutId, + maybeThenable; + + next.fail = function nextFail() { + self.fail.apply(null, arguments); + self.errored = errored = true; + next(); + }; + + self.globalErrors.pushListener(handleError); + + if (queueableFn.timeout !== undefined) { + var timeoutInterval = queueableFn.timeout || j$.DEFAULT_TIMEOUT_INTERVAL; + timeoutId = self.setTimeout(function() { + var error = new Error( + 'Timeout - Async function did not complete within ' + + timeoutInterval + + 'ms ' + + (queueableFn.timeout + ? '(custom timeout)' + : '(set by jasmine.DEFAULT_TIMEOUT_INTERVAL)') + ); + onException(error); next(); - }; - - self.globalErrors.pushListener(handleError); + }, timeoutInterval); + } - if (queueableFn.timeout) { - timeoutId = setTimeout(function() { - var error = new Error('Timeout - Async callback was not invoked within timeout specified by jasmine.DEFAULT_TIMEOUT_INTERVAL.'); - onException(error); - next(); - }, queueableFn.timeout()); - } + try { + if (queueableFn.fn.length === 0) { + maybeThenable = queueableFn.fn.call(self.userContext); - try { - queueableFn.fn.call(self.userContext, next); + if (maybeThenable && j$.isFunction_(maybeThenable.then)) { + maybeThenable.then(next, onPromiseRejection); + completedSynchronously = false; + return { completedSynchronously: false }; + } + } else { + maybeThenable = queueableFn.fn.call(self.userContext, next); + this.diagnoseConflictingAsync_(queueableFn.fn, maybeThenable); completedSynchronously = false; - } catch (e) { - handleException(e, queueableFn); - next(); + return { completedSynchronously: false }; } + } catch (e) { + onException(e); + self.errored = errored = true; } + cleanup(); + return { completedSynchronously: true, errored: errored }; + function onException(e) { self.onException(e); + self.errored = errored = true; } - function handleException(e, queueableFn) { + function onPromiseRejection(e) { onException(e); - if (!self.catchException(e)) { - //TODO: set a var when we catch an exception and - //use a finally block to close the loop in a nice way.. - throw e; + next(); + } + }; + + QueueRunner.prototype.run = function(recursiveIndex) { + var length = this.queueableFns.length, + self = this, + iterativeIndex; + + for ( + iterativeIndex = recursiveIndex; + iterativeIndex < length; + iterativeIndex++ + ) { + var result = this.attempt(iterativeIndex); + + if (!result.completedSynchronously) { + return; + } + + self.errored = self.errored || result.errored; + + if (this.completeOnFirstError && result.errored) { + this.skipToCleanup(iterativeIndex); + return; + } + } + + this.clearStack(function() { + self.globalErrors.popListener(self.handleFinalError); + self.onComplete(self.errored && new StopExecutionError()); + }); + }; + + QueueRunner.prototype.diagnoseConflictingAsync_ = function(fn, retval) { + if (retval && j$.isFunction_(retval.then)) { + // Issue a warning that matches the user's code + if (j$.isAsyncFunction_(fn)) { + this.deprecated( + 'An asynchronous before/it/after ' + + 'function was defined with the async keyword but also took a ' + + 'done callback. This is not supported and will stop working in' + + ' the future. Either remove the done callback (recommended) or ' + + 'remove the async keyword.' + ); + } else { + this.deprecated( + 'An asynchronous before/it/after ' + + 'function took a done callback but also returned a promise. ' + + 'This is not supported and will stop working in the future. ' + + 'Either remove the done callback (recommended) or change the ' + + 'function to not return a promise.' + ); } } }; @@ -3968,9 +8160,8 @@ getJasmineRequireObj().QueueRunner = function(j$) { return QueueRunner; }; -getJasmineRequireObj().ReportDispatcher = function() { - function ReportDispatcher(methods) { - +getJasmineRequireObj().ReportDispatcher = function(j$) { + function ReportDispatcher(methods, queueRunnerFactory) { var dispatchedMethods = methods || []; for (var i = 0; i < dispatchedMethods.length; i++) { @@ -3979,7 +8170,7 @@ getJasmineRequireObj().ReportDispatcher = function() { return function() { dispatch(m, arguments); }; - }(method)); + })(method); } var reporters = []; @@ -4001,13 +8192,42 @@ getJasmineRequireObj().ReportDispatcher = function() { function dispatch(method, args) { if (reporters.length === 0 && fallbackReporter !== null) { - reporters.push(fallbackReporter); + reporters.push(fallbackReporter); } + var onComplete = args[args.length - 1]; + args = j$.util.argsToArray(args).splice(0, args.length - 1); + var fns = []; for (var i = 0; i < reporters.length; i++) { var reporter = reporters[i]; - if (reporter[method]) { - reporter[method].apply(reporter, args); - } + addFn(fns, reporter, method, args); + } + + queueRunnerFactory({ + queueableFns: fns, + onComplete: onComplete, + isReporter: true + }); + } + + function addFn(fns, reporter, method, args) { + var fn = reporter[method]; + if (!fn) { + return; + } + + var thisArgs = j$.util.cloneArgs(args); + if (fn.length <= 1) { + fns.push({ + fn: function() { + return fn.apply(reporter, thisArgs); + } + }); + } else { + fns.push({ + fn: function(done) { + return fn.apply(reporter, thisArgs.concat([done])); + } + }); } } } @@ -4015,18 +8235,28 @@ getJasmineRequireObj().ReportDispatcher = function() { return ReportDispatcher; }; - getJasmineRequireObj().interface = function(jasmine, env) { var jasmineInterface = { + /** + * Callback passed to parts of the Jasmine base interface. + * + * By default Jasmine assumes this function completes synchronously. + * If you have code that you need to test asynchronously, you can declare that you receive a `done` callback, return a Promise, or use the `async` keyword if it is supported in your environment. + * @callback implementationCallback + * @param {Function} [done] Used to specify to Jasmine that this callback is asynchronous and Jasmine should wait until it has been called before moving on. + * @returns {} Optionally return a Promise instead of using `done` to cause Jasmine to wait for completion. + */ + /** * Create a group of specs (often called a suite). * * Calls to `describe` can be nested within other calls to compose your suite as a tree. * @name describe + * @since 1.3.0 * @function * @global * @param {String} description Textual description of the group - * @param {Function} specDefinitions Function for Jasmine to invoke that will define inner suites a specs + * @param {Function} specDefinitions Function for Jasmine to invoke that will define inner suites and specs */ describe: function(description, specDefinitions) { return env.describe(description, specDefinitions); @@ -4037,10 +8267,11 @@ getJasmineRequireObj().interface = function(jasmine, env) { * * Specs within an `xdescribe` will be marked pending and not executed * @name xdescribe + * @since 1.3.0 * @function * @global * @param {String} description Textual description of the group - * @param {Function} specDefinitions Function for Jasmine to invoke that will define inner suites a specs + * @param {Function} specDefinitions Function for Jasmine to invoke that will define inner suites and specs */ xdescribe: function(description, specDefinitions) { return env.xdescribe(description, specDefinitions); @@ -4052,10 +8283,11 @@ getJasmineRequireObj().interface = function(jasmine, env) { * If suites or specs are focused, only those that are focused will be executed * @see fit * @name fdescribe + * @since 2.1.0 * @function * @global * @param {String} description Textual description of the group - * @param {Function} specDefinitions Function for Jasmine to invoke that will define inner suites a specs + * @param {Function} specDefinitions Function for Jasmine to invoke that will define inner suites and specs */ fdescribe: function(description, specDefinitions) { return env.fdescribe(description, specDefinitions); @@ -4065,12 +8297,17 @@ getJasmineRequireObj().interface = function(jasmine, env) { * Define a single spec. A spec should contain one or more {@link expect|expectations} that test the state of the code. * * A spec whose expectations all succeed will be passing and a spec with any failures will fail. + * The name `it` is a pronoun for the test target, not an abbreviation of anything. It makes the + * spec more readable by connecting the function name `it` and the argument `description` as a + * complete sentence. * @name it + * @since 1.3.0 * @function * @global * @param {String} description Textual description of what this spec is checking - * @param {Function} [testFunction] Function that contains the code of your test. If not provided the test will be `pending`. + * @param {implementationCallback} [testFunction] Function that contains the code of your test. If not provided the test will be `pending`. * @param {Int} [timeout={@link jasmine.DEFAULT_TIMEOUT_INTERVAL}] Custom timeout for an async spec. + * @see async */ it: function() { return env.it.apply(env, arguments); @@ -4081,10 +8318,11 @@ getJasmineRequireObj().interface = function(jasmine, env) { * * The spec will report as `pending` and will not be executed. * @name xit + * @since 1.3.0 * @function * @global * @param {String} description Textual description of what this spec is checking. - * @param {Function} [testFunction] Function that contains the code of your test. Will not be executed. + * @param {implementationCallback} [testFunction] Function that contains the code of your test. Will not be executed. */ xit: function() { return env.xit.apply(env, arguments); @@ -4095,11 +8333,13 @@ getJasmineRequireObj().interface = function(jasmine, env) { * * If suites or specs are focused, only those that are focused will be executed. * @name fit + * @since 2.1.0 * @function * @global * @param {String} description Textual description of what this spec is checking. - * @param {Function} testFunction Function that contains the code of your test. + * @param {implementationCallback} testFunction Function that contains the code of your test. * @param {Int} [timeout={@link jasmine.DEFAULT_TIMEOUT_INTERVAL}] Custom timeout for an async spec. + * @see async */ fit: function() { return env.fit.apply(env, arguments); @@ -4108,10 +8348,12 @@ getJasmineRequireObj().interface = function(jasmine, env) { /** * Run some shared setup before each of the specs in the {@link describe} in which it is called. * @name beforeEach + * @since 1.3.0 * @function * @global - * @param {Function} [function] Function that contains the code to setup your specs. + * @param {implementationCallback} [function] Function that contains the code to setup your specs. * @param {Int} [timeout={@link jasmine.DEFAULT_TIMEOUT_INTERVAL}] Custom timeout for an async beforeEach. + * @see async */ beforeEach: function() { return env.beforeEach.apply(env, arguments); @@ -4120,10 +8362,12 @@ getJasmineRequireObj().interface = function(jasmine, env) { /** * Run some shared teardown after each of the specs in the {@link describe} in which it is called. * @name afterEach + * @since 1.3.0 * @function * @global - * @param {Function} [function] Function that contains the code to teardown your specs. + * @param {implementationCallback} [function] Function that contains the code to teardown your specs. * @param {Int} [timeout={@link jasmine.DEFAULT_TIMEOUT_INTERVAL}] Custom timeout for an async afterEach. + * @see async */ afterEach: function() { return env.afterEach.apply(env, arguments); @@ -4134,32 +8378,61 @@ getJasmineRequireObj().interface = function(jasmine, env) { * * _Note:_ Be careful, sharing the setup from a beforeAll makes it easy to accidentally leak state between your specs so that they erroneously pass or fail. * @name beforeAll + * @since 2.1.0 * @function * @global - * @param {Function} [function] Function that contains the code to setup your specs. + * @param {implementationCallback} [function] Function that contains the code to setup your specs. * @param {Int} [timeout={@link jasmine.DEFAULT_TIMEOUT_INTERVAL}] Custom timeout for an async beforeAll. + * @see async */ beforeAll: function() { return env.beforeAll.apply(env, arguments); }, /** - * Run some shared teardown once before all of the specs in the {@link describe} are run. + * Run some shared teardown once after all of the specs in the {@link describe} are run. * * _Note:_ Be careful, sharing the teardown from a afterAll makes it easy to accidentally leak state between your specs so that they erroneously pass or fail. * @name afterAll + * @since 2.1.0 * @function * @global - * @param {Function} [function] Function that contains the code to teardown your specs. + * @param {implementationCallback} [function] Function that contains the code to teardown your specs. * @param {Int} [timeout={@link jasmine.DEFAULT_TIMEOUT_INTERVAL}] Custom timeout for an async afterAll. + * @see async */ afterAll: function() { return env.afterAll.apply(env, arguments); }, + /** + * Sets a user-defined property that will be provided to reporters as part of the properties field of {@link SpecResult} + * @name setSpecProperty + * @since 3.6.0 + * @function + * @param {String} key The name of the property + * @param {*} value The value of the property + */ + setSpecProperty: function(key, value) { + return env.setSpecProperty(key, value); + }, + + /** + * Sets a user-defined property that will be provided to reporters as part of the properties field of {@link SuiteResult} + * @name setSuiteProperty + * @since 3.6.0 + * @function + * @param {String} key The name of the property + * @param {*} value The value of the property + */ + setSuiteProperty: function(key, value) { + return env.setSuiteProperty(key, value); + }, + /** * Create an expectation for a spec. * @name expect + * @since 1.3.0 * @function * @global * @param {Object} actual - Actual computed value to test expectations against. @@ -4169,9 +8442,30 @@ getJasmineRequireObj().interface = function(jasmine, env) { return env.expect(actual); }, + /** + * Create an asynchronous expectation for a spec. Note that the matchers + * that are provided by an asynchronous expectation all return promises + * which must be either returned from the spec or waited for using `await` + * in order for Jasmine to associate them with the correct spec. + * @name expectAsync + * @since 3.3.0 + * @function + * @global + * @param {Object} actual - Actual computed value to test expectations against. + * @return {async-matchers} + * @example + * await expectAsync(somePromise).toBeResolved(); + * @example + * return expectAsync(somePromise).toBeResolved(); + */ + expectAsync: function(actual) { + return env.expectAsync(actual); + }, + /** * Mark a spec as pending, expectation results will be ignored. * @name pending + * @since 2.0.0 * @function * @global * @param {String} [message] - Reason the spec is pending. @@ -4183,10 +8477,11 @@ getJasmineRequireObj().interface = function(jasmine, env) { /** * Explicitly mark a spec as failed. * @name fail + * @since 2.1.0 * @function * @global * @param {String|Error} [error] - Reason for the failure. - */ + */ fail: function() { return env.fail.apply(env, arguments); }, @@ -4194,6 +8489,7 @@ getJasmineRequireObj().interface = function(jasmine, env) { /** * Install a spy onto an existing object. * @name spyOn + * @since 1.3.0 * @function * @global * @param {Object} obj - The object upon which to install the {@link Spy}. @@ -4205,8 +8501,9 @@ getJasmineRequireObj().interface = function(jasmine, env) { }, /** - * Install a spy on a property onto an existing object. + * Install a spy on a property installed with `Object.defineProperty` onto an existing object. * @name spyOnProperty + * @since 2.6.0 * @function * @global * @param {Object} obj - The object upon which to install the {@link Spy} @@ -4218,6 +8515,20 @@ getJasmineRequireObj().interface = function(jasmine, env) { return env.spyOnProperty(obj, methodName, accessType); }, + /** + * Installs spies on all writable and configurable properties of an object. + * @name spyOnAllFunctions + * @since 3.2.1 + * @function + * @global + * @param {Object} obj - The object upon which to install the {@link Spy}s + * @param {boolean} includeNonEnumerable - Whether or not to add spies to non-enumerable properties + * @returns {Object} the spied object + */ + spyOnAllFunctions: function(obj, includeNonEnumerable) { + return env.spyOnAllFunctions(obj, includeNonEnumerable); + }, + jsApiReporter: new jasmine.JsApiReporter({ timer: new jasmine.Timer() }), @@ -4233,6 +8544,7 @@ getJasmineRequireObj().interface = function(jasmine, env) { * * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. * @name jasmine.addCustomEqualityTester + * @since 2.0.0 * @function * @param {Function} tester - A function which takes two arguments to compare and returns a `true` or `false` comparison result if it knows how to compare them, and `undefined` otherwise. * @see custom_equality @@ -4246,6 +8558,7 @@ getJasmineRequireObj().interface = function(jasmine, env) { * * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. * @name jasmine.addMatchers + * @since 2.0.0 * @function * @param {Object} matchers - Keys from this object will be the new matcher names. * @see custom_matcher @@ -4254,9 +8567,38 @@ getJasmineRequireObj().interface = function(jasmine, env) { return env.addMatchers(matchers); }; + /** + * Add custom async matchers for the current scope of specs. + * + * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. + * @name jasmine.addAsyncMatchers + * @since 3.5.0 + * @function + * @param {Object} matchers - Keys from this object will be the new async matcher names. + * @see custom_matcher + */ + jasmine.addAsyncMatchers = function(matchers) { + return env.addAsyncMatchers(matchers); + }; + + /** + * Add a custom object formatter for the current scope of specs. + * + * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. + * @name jasmine.addCustomObjectFormatter + * @since 3.6.0 + * @function + * @param {Function} formatter - A function which takes a value to format and returns a string if it knows how to format it, and `undefined` otherwise. + * @see custom_object_formatters + */ + jasmine.addCustomObjectFormatter = function(formatter) { + return env.addCustomObjectFormatter(formatter); + }; + /** * Get the currently booted mock {Clock} for this Jasmine environment. * @name jasmine.clock + * @since 2.0.0 * @function * @returns {Clock} */ @@ -4264,11 +8606,67 @@ getJasmineRequireObj().interface = function(jasmine, env) { return env.clock; }; + /** + * Create a bare {@link Spy} object. This won't be installed anywhere and will not have any implementation behind it. + * @name jasmine.createSpy + * @since 1.3.0 + * @function + * @param {String} [name] - Name to give the spy. This will be displayed in failure messages. + * @param {Function} [originalFn] - Function to act as the real implementation. + * @return {Spy} + */ + jasmine.createSpy = function(name, originalFn) { + return env.createSpy(name, originalFn); + }; + + /** + * Create an object with multiple {@link Spy}s as its members. + * @name jasmine.createSpyObj + * @since 1.3.0 + * @function + * @param {String} [baseName] - Base name for the spies in the object. + * @param {String[]|Object} methodNames - Array of method names to create spies for, or Object whose keys will be method names and values the {@link Spy#and#returnValue|returnValue}. + * @param {String[]|Object} [propertyNames] - Array of property names to create spies for, or Object whose keys will be propertynames and values the {@link Spy#and#returnValue|returnValue}. + * @return {Object} + */ + jasmine.createSpyObj = function(baseName, methodNames, propertyNames) { + return env.createSpyObj(baseName, methodNames, propertyNames); + }; + + /** + * Add a custom spy strategy for the current scope of specs. + * + * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. + * @name jasmine.addSpyStrategy + * @since 3.5.0 + * @function + * @param {String} name - The name of the strategy (i.e. what you call from `and`) + * @param {Function} factory - Factory function that returns the plan to be executed. + */ + jasmine.addSpyStrategy = function(name, factory) { + return env.addSpyStrategy(name, factory); + }; + + /** + * Set the default spy strategy for the current scope of specs. + * + * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. + * @name jasmine.setDefaultSpyStrategy + * @function + * @param {Function} defaultStrategyFn - a function that assigns a strategy + * @example + * beforeEach(function() { + * jasmine.setDefaultSpyStrategy(and => and.returnValue(true)); + * }); + */ + jasmine.setDefaultSpyStrategy = function(defaultStrategyFn) { + return env.setDefaultSpyStrategy(defaultStrategyFn); + }; + return jasmineInterface; }; -getJasmineRequireObj().Spy = function (j$) { - +getJasmineRequireObj().Spy = function(j$) { var nextOrder = (function() { var order = 0; @@ -4277,39 +8675,55 @@ getJasmineRequireObj().Spy = function (j$) { }; })(); + var matchersUtil = new j$.MatchersUtil({ + customTesters: [], + pp: j$.makePrettyPrinter() + }); + /** - * _Note:_ Do not construct this directly, use {@link spyOn}, {@link spyOnProperty}, {@link jasmine.createSpy}, or {@link jasmine.createSpyObj} - * @constructor - * @name Spy + * @classdesc _Note:_ Do not construct this directly. Use {@link spyOn}, + * {@link spyOnProperty}, {@link jasmine.createSpy}, or + * {@link jasmine.createSpyObj} instead. + * @class Spy + * @hideconstructor */ - function Spy(name, originalFn) { - var numArgs = (typeof originalFn === 'function' ? originalFn.length : 0), - wrapper = makeFunc(numArgs, function () { - return spy.apply(this, Array.prototype.slice.call(arguments)); + function Spy( + name, + originalFn, + customStrategies, + defaultStrategyFn, + getPromise + ) { + var numArgs = typeof originalFn === 'function' ? originalFn.length : 0, + wrapper = makeFunc(numArgs, function(context, args, invokeNew) { + return spy(context, args, invokeNew); }), - spyStrategy = new j$.SpyStrategy({ + strategyDispatcher = new SpyStrategyDispatcher({ name: name, fn: originalFn, - getSpy: function () { + getSpy: function() { return wrapper; - } + }, + customStrategies: customStrategies, + getPromise: getPromise }), callTracker = new j$.CallTracker(), - spy = function () { + spy = function(context, args, invokeNew) { /** * @name Spy.callData * @property {object} object - `this` context for the invocation. * @property {number} invocationOrder - Order of the invocation. * @property {Array} args - The arguments passed for this invocation. + * @property returnValue - The value that was returned from this invocation. */ var callData = { - object: this, + object: context, invocationOrder: nextOrder(), - args: Array.prototype.slice.apply(arguments) + args: Array.prototype.slice.apply(args) }; callTracker.track(callData); - var returnValue = spyStrategy.exec.apply(this, arguments); + var returnValue = strategyDispatcher.exec(context, args, invokeNew); callData.returnValue = returnValue; return returnValue; @@ -4317,52 +8731,270 @@ getJasmineRequireObj().Spy = function (j$) { function makeFunc(length, fn) { switch (length) { - case 1 : return function (a) { return fn.apply(this, arguments); }; - case 2 : return function (a,b) { return fn.apply(this, arguments); }; - case 3 : return function (a,b,c) { return fn.apply(this, arguments); }; - case 4 : return function (a,b,c,d) { return fn.apply(this, arguments); }; - case 5 : return function (a,b,c,d,e) { return fn.apply(this, arguments); }; - case 6 : return function (a,b,c,d,e,f) { return fn.apply(this, arguments); }; - case 7 : return function (a,b,c,d,e,f,g) { return fn.apply(this, arguments); }; - case 8 : return function (a,b,c,d,e,f,g,h) { return fn.apply(this, arguments); }; - case 9 : return function (a,b,c,d,e,f,g,h,i) { return fn.apply(this, arguments); }; - default : return function () { return fn.apply(this, arguments); }; + case 1: + return function wrap1(a) { + return fn(this, arguments, this instanceof wrap1); + }; + case 2: + return function wrap2(a, b) { + return fn(this, arguments, this instanceof wrap2); + }; + case 3: + return function wrap3(a, b, c) { + return fn(this, arguments, this instanceof wrap3); + }; + case 4: + return function wrap4(a, b, c, d) { + return fn(this, arguments, this instanceof wrap4); + }; + case 5: + return function wrap5(a, b, c, d, e) { + return fn(this, arguments, this instanceof wrap5); + }; + case 6: + return function wrap6(a, b, c, d, e, f) { + return fn(this, arguments, this instanceof wrap6); + }; + case 7: + return function wrap7(a, b, c, d, e, f, g) { + return fn(this, arguments, this instanceof wrap7); + }; + case 8: + return function wrap8(a, b, c, d, e, f, g, h) { + return fn(this, arguments, this instanceof wrap8); + }; + case 9: + return function wrap9(a, b, c, d, e, f, g, h, i) { + return fn(this, arguments, this instanceof wrap9); + }; + default: + return function wrap() { + return fn(this, arguments, this instanceof wrap); + }; } } for (var prop in originalFn) { if (prop === 'and' || prop === 'calls') { - throw new Error('Jasmine spies would overwrite the \'and\' and \'calls\' properties on the object being spied upon'); + throw new Error( + "Jasmine spies would overwrite the 'and' and 'calls' properties on the object being spied upon" + ); } wrapper[prop] = originalFn[prop]; } - wrapper.and = spyStrategy; + /** + * @member {SpyStrategy} - Accesses the default strategy for the spy. This strategy will be used + * whenever the spy is called with arguments that don't match any strategy + * created with {@link Spy#withArgs}. + * @name Spy#and + * @since 2.0.0 + * @example + * spyOn(someObj, 'func').and.returnValue(42); + */ + wrapper.and = strategyDispatcher.and; + /** + * Specifies a strategy to be used for calls to the spy that have the + * specified arguments. + * @name Spy#withArgs + * @since 3.0.0 + * @function + * @param {...*} args - The arguments to match + * @type {SpyStrategy} + * @example + * spyOn(someObj, 'func').withArgs(1, 2, 3).and.returnValue(42); + * someObj.func(1, 2, 3); // returns 42 + */ + wrapper.withArgs = function() { + return strategyDispatcher.withArgs.apply(strategyDispatcher, arguments); + }; wrapper.calls = callTracker; + if (defaultStrategyFn) { + defaultStrategyFn(wrapper.and); + } + return wrapper; } + function SpyStrategyDispatcher(strategyArgs) { + var baseStrategy = new j$.SpyStrategy(strategyArgs); + var argsStrategies = new StrategyDict(function() { + return new j$.SpyStrategy(strategyArgs); + }); + + this.and = baseStrategy; + + this.exec = function(spy, args, invokeNew) { + var strategy = argsStrategies.get(args); + + if (!strategy) { + if (argsStrategies.any() && !baseStrategy.isConfigured()) { + throw new Error( + "Spy '" + + strategyArgs.name + + "' received a call with arguments " + + j$.pp(Array.prototype.slice.call(args)) + + ' but all configured strategies specify other arguments.' + ); + } else { + strategy = baseStrategy; + } + } + + return strategy.exec(spy, args, invokeNew); + }; + + this.withArgs = function() { + return { and: argsStrategies.getOrCreate(arguments) }; + }; + } + + function StrategyDict(strategyFactory) { + this.strategies = []; + this.strategyFactory = strategyFactory; + } + + StrategyDict.prototype.any = function() { + return this.strategies.length > 0; + }; + + StrategyDict.prototype.getOrCreate = function(args) { + var strategy = this.get(args); + + if (!strategy) { + strategy = this.strategyFactory(); + this.strategies.push({ + args: args, + strategy: strategy + }); + } + + return strategy; + }; + + StrategyDict.prototype.get = function(args) { + var i; + + for (i = 0; i < this.strategies.length; i++) { + if (matchersUtil.equals(args, this.strategies[i].args)) { + return this.strategies[i].strategy; + } + } + }; + return Spy; }; -getJasmineRequireObj().SpyRegistry = function(j$) { +getJasmineRequireObj().SpyFactory = function(j$) { + function SpyFactory(getCustomStrategies, getDefaultStrategyFn, getPromise) { + var self = this; + + this.createSpy = function(name, originalFn) { + return j$.Spy( + name, + originalFn, + getCustomStrategies(), + getDefaultStrategyFn(), + getPromise + ); + }; - var getErrorMsg = j$.formatErrorMsg('', 'spyOn(, )'); + this.createSpyObj = function(baseName, methodNames, propertyNames) { + var baseNameIsCollection = + j$.isObject_(baseName) || j$.isArray_(baseName); + + if (baseNameIsCollection) { + propertyNames = methodNames; + methodNames = baseName; + baseName = 'unknown'; + } + + var obj = {}; + var spy, descriptor; + + var methods = normalizeKeyValues(methodNames); + for (var i = 0; i < methods.length; i++) { + spy = obj[methods[i][0]] = self.createSpy( + baseName + '.' + methods[i][0] + ); + if (methods[i].length > 1) { + spy.and.returnValue(methods[i][1]); + } + } + + var properties = normalizeKeyValues(propertyNames); + for (var i = 0; i < properties.length; i++) { + descriptor = { + enumerable: true, + get: self.createSpy(baseName + '.' + properties[i][0] + '.get'), + set: self.createSpy(baseName + '.' + properties[i][0] + '.set') + }; + if (properties[i].length > 1) { + descriptor.get.and.returnValue(properties[i][1]); + descriptor.set.and.returnValue(properties[i][1]); + } + Object.defineProperty(obj, properties[i][0], descriptor); + } + + if (methods.length === 0 && properties.length === 0) { + throw 'createSpyObj requires a non-empty array or object of method names to create spies for'; + } + + return obj; + }; + } + + function normalizeKeyValues(object) { + var result = []; + if (j$.isArray_(object)) { + for (var i = 0; i < object.length; i++) { + result.push([object[i]]); + } + } else if (j$.isObject_(object)) { + for (var key in object) { + if (object.hasOwnProperty(key)) { + result.push([key, object[key]]); + } + } + } + return result; + } + + return SpyFactory; +}; + +getJasmineRequireObj().SpyRegistry = function(j$) { + var spyOnMsg = j$.formatErrorMsg('', 'spyOn(, )'); + var spyOnPropertyMsg = j$.formatErrorMsg( + '', + 'spyOnProperty(, , [accessType])' + ); function SpyRegistry(options) { options = options || {}; - var currentSpies = options.currentSpies || function() { return []; }; + var global = options.global || j$.getGlobal(); + var createSpy = options.createSpy; + var currentSpies = + options.currentSpies || + function() { + return []; + }; - this.allowRespy = function(allow){ + this.allowRespy = function(allow) { this.respy = allow; }; this.spyOn = function(obj, methodName) { + var getErrorMsg = spyOnMsg; if (j$.util.isUndefined(obj) || obj === null) { - throw new Error(getErrorMsg('could not find an object to spy upon for ' + methodName + '()')); + throw new Error( + getErrorMsg( + 'could not find an object to spy upon for ' + methodName + '()' + ) + ); } if (j$.util.isUndefined(methodName) || methodName === null) { @@ -4373,30 +9005,32 @@ getJasmineRequireObj().SpyRegistry = function(j$) { throw new Error(getErrorMsg(methodName + '() method does not exist')); } - if (obj[methodName] && j$.isSpy(obj[methodName]) ) { - if ( !!this.respy ){ + if (obj[methodName] && j$.isSpy(obj[methodName])) { + if (this.respy) { return obj[methodName]; - }else { - throw new Error(getErrorMsg(methodName + ' has already been spied upon')); + } else { + throw new Error( + getErrorMsg(methodName + ' has already been spied upon') + ); } } - var descriptor; - try { - descriptor = Object.getOwnPropertyDescriptor(obj, methodName); - } catch(e) { - // IE 8 doesn't support `definePropery` on non-DOM nodes - } - + var descriptor = Object.getOwnPropertyDescriptor(obj, methodName); + if (descriptor && !(descriptor.writable || descriptor.set)) { - throw new Error(getErrorMsg(methodName + ' is not declared writable or has no setter')); + throw new Error( + getErrorMsg(methodName + ' is not declared writable or has no setter') + ); } var originalMethod = obj[methodName], - spiedMethod = j$.createSpy(methodName, originalMethod), + spiedMethod = createSpy(methodName, originalMethod), restoreStrategy; - if (Object.prototype.hasOwnProperty.call(obj, methodName)) { + if ( + Object.prototype.hasOwnProperty.call(obj, methodName) || + (obj === global && methodName === 'onerror') + ) { restoreStrategy = function() { obj[methodName] = originalMethod; }; @@ -4417,43 +9051,62 @@ getJasmineRequireObj().SpyRegistry = function(j$) { return spiedMethod; }; - this.spyOnProperty = function (obj, propertyName, accessType) { + this.spyOnProperty = function(obj, propertyName, accessType) { + var getErrorMsg = spyOnPropertyMsg; + accessType = accessType || 'get'; if (j$.util.isUndefined(obj)) { - throw new Error('spyOn could not find an object to spy upon for ' + propertyName + ''); + throw new Error( + getErrorMsg( + 'spyOn could not find an object to spy upon for ' + + propertyName + + '' + ) + ); } if (j$.util.isUndefined(propertyName)) { - throw new Error('No property name supplied'); + throw new Error(getErrorMsg('No property name supplied')); } - var descriptor; - try { - descriptor = j$.util.getPropertyDescriptor(obj, propertyName); - } catch(e) { - // IE 8 doesn't support `definePropery` on non-DOM nodes - } + var descriptor = j$.util.getPropertyDescriptor(obj, propertyName); if (!descriptor) { - throw new Error(propertyName + ' property does not exist'); + throw new Error(getErrorMsg(propertyName + ' property does not exist')); } if (!descriptor.configurable) { - throw new Error(propertyName + ' is not declared configurable'); + throw new Error( + getErrorMsg(propertyName + ' is not declared configurable') + ); } - if(!descriptor[accessType]) { - throw new Error('Property ' + propertyName + ' does not have access type ' + accessType); + if (!descriptor[accessType]) { + throw new Error( + getErrorMsg( + 'Property ' + + propertyName + + ' does not have access type ' + + accessType + ) + ); } if (j$.isSpy(descriptor[accessType])) { - //TODO?: should this return the current spy? Downside: may cause user confusion about spy state - throw new Error(propertyName + ' has already been spied upon'); + if (this.respy) { + return descriptor[accessType]; + } else { + throw new Error( + getErrorMsg( + propertyName + '#' + accessType + ' has already been spied upon' + ) + ); + } } var originalDescriptor = j$.util.clone(descriptor), - spy = j$.createSpy(propertyName, descriptor[accessType]), + spy = createSpy(propertyName, descriptor[accessType]), restoreStrategy; if (Object.prototype.hasOwnProperty.call(obj, propertyName)) { @@ -4477,6 +9130,40 @@ getJasmineRequireObj().SpyRegistry = function(j$) { return spy; }; + this.spyOnAllFunctions = function(obj, includeNonEnumerable) { + if (j$.util.isUndefined(obj)) { + throw new Error( + 'spyOnAllFunctions could not find an object to spy upon' + ); + } + + var pointer = obj, + propsToSpyOn = [], + properties, + propertiesToSkip = []; + + while ( + pointer && + (!includeNonEnumerable || pointer !== Object.prototype) + ) { + properties = getProps(pointer, includeNonEnumerable); + properties = properties.filter(function(prop) { + return propertiesToSkip.indexOf(prop) === -1; + }); + propertiesToSkip = propertiesToSkip.concat(properties); + propsToSpyOn = propsToSpyOn.concat( + getSpyableFunctionProps(pointer, properties) + ); + pointer = Object.getPrototypeOf(pointer); + } + + for (var i = 0; i < propsToSpyOn.length; i++) { + this.spyOn(obj, propsToSpyOn[i]); + } + + return obj; + }; + this.clearSpies = function() { var spies = currentSpies(); for (var i = spies.length - 1; i >= 0; i--) { @@ -4486,152 +9173,464 @@ getJasmineRequireObj().SpyRegistry = function(j$) { }; } + function getProps(obj, includeNonEnumerable) { + var enumerableProperties = Object.keys(obj); + + if (!includeNonEnumerable) { + return enumerableProperties; + } + + return Object.getOwnPropertyNames(obj).filter(function(prop) { + return ( + prop !== 'constructor' || + enumerableProperties.indexOf('constructor') > -1 + ); + }); + } + + function getSpyableFunctionProps(obj, propertiesToCheck) { + var props = [], + prop; + for (var i = 0; i < propertiesToCheck.length; i++) { + prop = propertiesToCheck[i]; + if ( + Object.prototype.hasOwnProperty.call(obj, prop) && + isSpyableProp(obj, prop) + ) { + props.push(prop); + } + } + return props; + } + + function isSpyableProp(obj, prop) { + var value, descriptor; + try { + value = obj[prop]; + } catch (e) { + return false; + } + if (value instanceof Function) { + descriptor = Object.getOwnPropertyDescriptor(obj, prop); + return (descriptor.writable || descriptor.set) && descriptor.configurable; + } + return false; + } + return SpyRegistry; }; getJasmineRequireObj().SpyStrategy = function(j$) { - /** - * @namespace Spy#and + * @interface SpyStrategy */ function SpyStrategy(options) { options = options || {}; - var identity = options.name || 'unknown', - originalFn = options.fn || function() {}, - getSpy = options.getSpy || function() {}, - plan = function() {}; + var self = this; /** - * Return the identifying information for the spy. - * @name Spy#and#identity - * @function - * @returns {String} + * Get the identifying information for the spy. + * @name SpyStrategy#identity + * @since 3.0.0 + * @member + * @type {String} */ - this.identity = function() { - return identity; - }; + this.identity = options.name || 'unknown'; + this.originalFn = options.fn || function() {}; + this.getSpy = options.getSpy || function() {}; + this.plan = this._defaultPlan = function() {}; - /** - * Execute the current spy strategy. - * @name Spy#and#exec - * @function - */ - this.exec = function() { - return plan.apply(this, arguments); - }; + var k, + cs = options.customStrategies || {}; + for (k in cs) { + if (j$.util.has(cs, k) && !this[k]) { + this[k] = createCustomPlan(cs[k]); + } + } - /** - * Tell the spy to call through to the real implementation when invoked. - * @name Spy#and#callThrough - * @function - */ - this.callThrough = function() { - plan = originalFn; - return getSpy(); + var getPromise = + typeof options.getPromise === 'function' + ? options.getPromise + : function() {}; + + var requirePromise = function(name) { + var Promise = getPromise(); + + if (!Promise) { + throw new Error( + name + + ' requires global Promise, or `Promise` configured with `jasmine.getEnv().configure()`' + ); + } + + return Promise; }; /** - * Tell the spy to return the value when invoked. - * @name Spy#and#returnValue + * Tell the spy to return a promise resolving to the specified value when invoked. + * @name SpyStrategy#resolveTo + * @since 3.5.0 * @function * @param {*} value The value to return. */ - this.returnValue = function(value) { - plan = function() { - return value; + this.resolveTo = function(value) { + var Promise = requirePromise('resolveTo'); + self.plan = function() { + return Promise.resolve(value); }; - return getSpy(); + return self.getSpy(); }; /** - * Tell the spy to return one of the specified values (sequentially) each time the spy is invoked. - * @name Spy#and#returnValues + * Tell the spy to return a promise rejecting with the specified value when invoked. + * @name SpyStrategy#rejectWith + * @since 3.5.0 * @function - * @param {...*} values - Values to be returned on subsequent calls to the spy. + * @param {*} value The value to return. */ - this.returnValues = function() { - var values = Array.prototype.slice.call(arguments); - plan = function () { - return values.shift(); - }; - return getSpy(); - }; + this.rejectWith = function(value) { + var Promise = requirePromise('rejectWith'); - /** - * Tell the spy to throw an error when invoked. - * @name Spy#and#throwError - * @function - * @param {Error|String} something Thing to throw - */ - this.throwError = function(something) { - var error = (something instanceof Error) ? something : new Error(something); - plan = function() { - throw error; + self.plan = function() { + return Promise.reject(value); }; - return getSpy(); + return self.getSpy(); }; + } - /** - * Tell the spy to call a fake implementation when invoked. - * @name Spy#and#callFake - * @function - * @param {Function} fn The function to invoke with the passed parameters. - */ - this.callFake = function(fn) { - if(!j$.isFunction_(fn)) { - throw new Error('Argument passed to callFake should be a function, got ' + fn); + function createCustomPlan(factory) { + return function() { + var plan = factory.apply(null, arguments); + + if (!j$.isFunction_(plan)) { + throw new Error('Spy strategy must return a function'); } - plan = fn; - return getSpy(); - }; - /** - * Tell the spy to do nothing when invoked. This is the default. - * @name Spy#and#stub - * @function - */ - this.stub = function(fn) { - plan = function() {}; - return getSpy(); + this.plan = plan; + return this.getSpy(); }; } + /** + * Execute the current spy strategy. + * @name SpyStrategy#exec + * @since 2.0.0 + * @function + */ + SpyStrategy.prototype.exec = function(context, args, invokeNew) { + var contextArgs = [context].concat( + args ? Array.prototype.slice.call(args) : [] + ); + var target = this.plan.bind.apply(this.plan, contextArgs); + + return invokeNew ? new target() : target(); + }; + + /** + * Tell the spy to call through to the real implementation when invoked. + * @name SpyStrategy#callThrough + * @since 2.0.0 + * @function + */ + SpyStrategy.prototype.callThrough = function() { + this.plan = this.originalFn; + return this.getSpy(); + }; + + /** + * Tell the spy to return the value when invoked. + * @name SpyStrategy#returnValue + * @since 2.0.0 + * @function + * @param {*} value The value to return. + */ + SpyStrategy.prototype.returnValue = function(value) { + this.plan = function() { + return value; + }; + return this.getSpy(); + }; + + /** + * Tell the spy to return one of the specified values (sequentially) each time the spy is invoked. + * @name SpyStrategy#returnValues + * @since 2.1.0 + * @function + * @param {...*} values - Values to be returned on subsequent calls to the spy. + */ + SpyStrategy.prototype.returnValues = function() { + var values = Array.prototype.slice.call(arguments); + this.plan = function() { + return values.shift(); + }; + return this.getSpy(); + }; + + /** + * Tell the spy to throw an error when invoked. + * @name SpyStrategy#throwError + * @since 2.0.0 + * @function + * @param {Error|Object|String} something Thing to throw + */ + SpyStrategy.prototype.throwError = function(something) { + var error = j$.isString_(something) ? new Error(something) : something; + this.plan = function() { + throw error; + }; + return this.getSpy(); + }; + + /** + * Tell the spy to call a fake implementation when invoked. + * @name SpyStrategy#callFake + * @since 2.0.0 + * @function + * @param {Function} fn The function to invoke with the passed parameters. + */ + SpyStrategy.prototype.callFake = function(fn) { + if ( + !( + j$.isFunction_(fn) || + j$.isAsyncFunction_(fn) || + j$.isGeneratorFunction_(fn) + ) + ) { + throw new Error( + 'Argument passed to callFake should be a function, got ' + fn + ); + } + this.plan = fn; + return this.getSpy(); + }; + + /** + * Tell the spy to do nothing when invoked. This is the default. + * @name SpyStrategy#stub + * @since 2.0.0 + * @function + */ + SpyStrategy.prototype.stub = function(fn) { + this.plan = function() {}; + return this.getSpy(); + }; + + SpyStrategy.prototype.isConfigured = function() { + return this.plan !== this._defaultPlan; + }; + return SpyStrategy; }; +getJasmineRequireObj().StackTrace = function(j$) { + function StackTrace(error) { + var lines = error.stack.split('\n').filter(function(line) { + return line !== ''; + }); + + var extractResult = extractMessage(error.message, lines); + + if (extractResult) { + this.message = extractResult.message; + lines = extractResult.remainder; + } + + var parseResult = tryParseFrames(lines); + this.frames = parseResult.frames; + this.style = parseResult.style; + } + + var framePatterns = [ + // PhantomJS on Linux, Node, Chrome, IE, Edge + // e.g. " at QueueRunner.run (http://localhost:8888/__jasmine__/jasmine.js:4320:20)" + // Note that the "function name" can include a surprisingly large set of + // characters, including angle brackets and square brackets. + { + re: /^\s*at ([^\)]+) \(([^\)]+)\)$/, + fnIx: 1, + fileLineColIx: 2, + style: 'v8' + }, + + // NodeJS alternate form, often mixed in with the Chrome style + // e.g. " at /some/path:4320:20 + { re: /\s*at (.+)$/, fileLineColIx: 1, style: 'v8' }, + + // PhantomJS on OS X, Safari, Firefox + // e.g. "run@http://localhost:8888/__jasmine__/jasmine.js:4320:27" + // or "http://localhost:8888/__jasmine__/jasmine.js:4320:27" + { + re: /^(([^@\s]+)@)?([^\s]+)$/, + fnIx: 2, + fileLineColIx: 3, + style: 'webkit' + } + ]; + + // regexes should capture the function name (if any) as group 1 + // and the file, line, and column as group 2. + function tryParseFrames(lines) { + var style = null; + var frames = lines.map(function(line) { + var convertedLine = first(framePatterns, function(pattern) { + var overallMatch = line.match(pattern.re), + fileLineColMatch; + if (!overallMatch) { + return null; + } + + fileLineColMatch = overallMatch[pattern.fileLineColIx].match( + /^(.*):(\d+):\d+$/ + ); + if (!fileLineColMatch) { + return null; + } + + style = style || pattern.style; + return { + raw: line, + file: fileLineColMatch[1], + line: parseInt(fileLineColMatch[2], 10), + func: overallMatch[pattern.fnIx] + }; + }); + + return convertedLine || { raw: line }; + }); + + return { + style: style, + frames: frames + }; + } + + function first(items, fn) { + var i, result; + + for (i = 0; i < items.length; i++) { + result = fn(items[i]); + + if (result) { + return result; + } + } + } + + function extractMessage(message, stackLines) { + var len = messagePrefixLength(message, stackLines); + + if (len > 0) { + return { + message: stackLines.slice(0, len).join('\n'), + remainder: stackLines.slice(len) + }; + } + } + + function messagePrefixLength(message, stackLines) { + if (!stackLines[0].match(/^\w*Error/)) { + return 0; + } + + var messageLines = message.split('\n'); + var i; + + for (i = 1; i < messageLines.length; i++) { + if (messageLines[i] !== stackLines[i]) { + return 0; + } + } + + return messageLines.length; + } + + return StackTrace; +}; + getJasmineRequireObj().Suite = function(j$) { + /** + * @interface Suite + * @see Env#topSuite + * @since 2.0.0 + */ function Suite(attrs) { this.env = attrs.env; + /** + * The unique ID of this suite. + * @name Suite#id + * @readonly + * @type {string} + * @since 2.0.0 + */ this.id = attrs.id; + /** + * The parent of this suite, or null if this is the top suite. + * @name Suite#parentSuite + * @readonly + * @type {Suite} + */ this.parentSuite = attrs.parentSuite; + /** + * The description passed to the {@link describe} that created this suite. + * @name Suite#description + * @readonly + * @type {string} + * @since 2.0.0 + */ this.description = attrs.description; this.expectationFactory = attrs.expectationFactory; + this.asyncExpectationFactory = attrs.asyncExpectationFactory; this.expectationResultFactory = attrs.expectationResultFactory; this.throwOnExpectationFailure = !!attrs.throwOnExpectationFailure; + this.autoCleanClosures = + attrs.autoCleanClosures === undefined ? true : !!attrs.autoCleanClosures; this.beforeFns = []; this.afterFns = []; this.beforeAllFns = []; this.afterAllFns = []; + this.timer = attrs.timer || new j$.Timer(); + + /** + * The suite's children. + * @name Suite#children + * @type {Array.<(Spec|Suite)>} + * @since 2.0.0 + */ this.children = []; - this.result = { - id: this.id, - description: this.description, - fullName: this.getFullName(), - failedExpectations: [] - }; + this.reset(); } + Suite.prototype.setSuiteProperty = function(key, value) { + this.result.properties = this.result.properties || {}; + this.result.properties[key] = value; + }; + Suite.prototype.expect = function(actual) { return this.expectationFactory(actual, this); }; + Suite.prototype.expectAsync = function(actual) { + return this.asyncExpectationFactory(actual, this); + }; + + /** + * The full description including all ancestors of this suite. + * @name Suite#getFullName + * @function + * @returns {string} + * @since 2.0.0 + */ Suite.prototype.getFullName = function() { var fullName = []; - for (var parentSuite = this; parentSuite; parentSuite = parentSuite.parentSuite) { + for ( + var parentSuite = this; + parentSuite; + parentSuite = parentSuite.parentSuite + ) { if (parentSuite.parentSuite) { fullName.unshift(parentSuite.description); } @@ -4639,10 +9638,22 @@ getJasmineRequireObj().Suite = function(j$) { return fullName.join(' '); }; + /* + * Mark the suite with "pending" status + */ Suite.prototype.pend = function() { this.markedPending = true; }; + /* + * Like {@link Suite#pend}, but pending state will survive {@link Spec#reset} + * Useful for fdescribe, xdescribe, where pending state should remain. + */ + Suite.prototype.exclude = function() { + this.pend(); + this.markedExcluding = true; + }; + Suite.prototype.beforeEach = function(fn) { this.beforeFns.unshift(fn); }; @@ -4659,6 +9670,57 @@ getJasmineRequireObj().Suite = function(j$) { this.afterAllFns.unshift(fn); }; + Suite.prototype.startTimer = function() { + this.timer.start(); + }; + + Suite.prototype.endTimer = function() { + this.result.duration = this.timer.elapsed(); + }; + + function removeFns(queueableFns) { + for (var i = 0; i < queueableFns.length; i++) { + queueableFns[i].fn = null; + } + } + + Suite.prototype.cleanupBeforeAfter = function() { + if (this.autoCleanClosures) { + removeFns(this.beforeAllFns); + removeFns(this.afterAllFns); + removeFns(this.beforeFns); + removeFns(this.afterFns); + } + }; + + Suite.prototype.reset = function() { + /** + * @typedef SuiteResult + * @property {Int} id - The unique id of this suite. + * @property {String} description - The description text passed to the {@link describe} that made this suite. + * @property {String} fullName - The full description including all ancestors of this suite. + * @property {Expectation[]} failedExpectations - The list of expectations that failed in an {@link afterAll} for this suite. + * @property {Expectation[]} deprecationWarnings - The list of deprecation warnings that occurred on this suite. + * @property {String} status - Once the suite has completed, this string represents the pass/fail status of this suite. + * @property {number} duration - The time in ms for Suite execution, including any before/afterAll, before/afterEach. + * @property {Object} properties - User-supplied properties, if any, that were set using {@link Env#setSuiteProperty} + * @since 2.0.0 + */ + this.result = { + id: this.id, + description: this.description, + fullName: this.getFullName(), + failedExpectations: [], + deprecationWarnings: [], + duration: null, + properties: null + }; + this.markedPending = this.markedExcluding; + this.children.forEach(function(child) { + child.reset(); + }); + }; + Suite.prototype.addChild = function(child) { this.children.push(child); }; @@ -4671,14 +9733,10 @@ getJasmineRequireObj().Suite = function(j$) { if (this.result.failedExpectations.length > 0) { return 'failed'; } else { - return 'finished'; + return 'passed'; } }; - Suite.prototype.isExecutable = function() { - return !this.markedPending; - }; - Suite.prototype.canBeReentered = function() { return this.beforeAllFns.length === 0 && this.afterAllFns.length === 0; }; @@ -4690,14 +9748,16 @@ getJasmineRequireObj().Suite = function(j$) { Suite.prototype.sharedUserContext = function() { if (!this.sharedContext) { - this.sharedContext = this.parentSuite ? clone(this.parentSuite.sharedUserContext()) : {}; + this.sharedContext = this.parentSuite + ? this.parentSuite.clonedSharedUserContext() + : new j$.UserContext(); } return this.sharedContext; }; Suite.prototype.clonedSharedUserContext = function() { - return clone(this.sharedUserContext()); + return j$.UserContext.fromExisting(this.sharedUserContext()); }; Suite.prototype.onException = function() { @@ -4705,71 +9765,58 @@ getJasmineRequireObj().Suite = function(j$) { return; } - if(isAfterAll(this.children)) { - var data = { - matcherName: '', - passed: false, - expected: '', - actual: '', - error: arguments[0] - }; - this.result.failedExpectations.push(this.expectationResultFactory(data)); - } else { - for (var i = 0; i < this.children.length; i++) { - var child = this.children[i]; - child.onException.apply(child, arguments); - } + var data = { + matcherName: '', + passed: false, + expected: '', + actual: '', + error: arguments[0] + }; + var failedExpectation = this.expectationResultFactory(data); + + if (!this.parentSuite) { + failedExpectation.globalErrorType = 'afterAll'; } + + this.result.failedExpectations.push(failedExpectation); }; - Suite.prototype.addExpectationResult = function () { - if(isAfterAll(this.children) && isFailure(arguments)){ + Suite.prototype.addExpectationResult = function() { + if (isFailure(arguments)) { var data = arguments[1]; this.result.failedExpectations.push(this.expectationResultFactory(data)); - if(this.throwOnExpectationFailure) { + if (this.throwOnExpectationFailure) { throw new j$.errors.ExpectationFailed(); } - } else { - for (var i = 0; i < this.children.length; i++) { - var child = this.children[i]; - try { - child.addExpectationResult.apply(child, arguments); - } catch(e) { - // keep going - } - } } }; - function isAfterAll(children) { - return children && children[0].result.status; - } + Suite.prototype.addDeprecationWarning = function(deprecation) { + if (typeof deprecation === 'string') { + deprecation = { message: deprecation }; + } + this.result.deprecationWarnings.push( + this.expectationResultFactory(deprecation) + ); + }; function isFailure(args) { return !args[0]; } - function clone(obj) { - var clonedObj = {}; - for (var prop in obj) { - if (obj.hasOwnProperty(prop)) { - clonedObj[prop] = obj[prop]; - } - } - - return clonedObj; - } - return Suite; }; if (typeof window == void 0 && typeof exports == 'object') { + /* globals exports */ exports.Suite = jasmineRequire.Suite; } getJasmineRequireObj().Timer = function() { var defaultNow = (function(Date) { - return function() { return new Date().getTime(); }; + return function() { + return new Date().getTime(); + }; })(Date); function Timer(options) { @@ -4793,18 +9840,28 @@ getJasmineRequireObj().Timer = function() { getJasmineRequireObj().TreeProcessor = function() { function TreeProcessor(attrs) { var tree = attrs.tree, - runnableIds = attrs.runnableIds, - queueRunnerFactory = attrs.queueRunnerFactory, - nodeStart = attrs.nodeStart || function() {}, - nodeComplete = attrs.nodeComplete || function() {}, - orderChildren = attrs.orderChildren || function(node) { return node.children; }, - stats = { valid: true }, - processed = false, - defaultMin = Infinity, - defaultMax = 1 - Infinity; + runnableIds = attrs.runnableIds, + queueRunnerFactory = attrs.queueRunnerFactory, + nodeStart = attrs.nodeStart || function() {}, + nodeComplete = attrs.nodeComplete || function() {}, + failSpecWithNoExpectations = !!attrs.failSpecWithNoExpectations, + orderChildren = + attrs.orderChildren || + function(node) { + return node.children; + }, + excludeNode = + attrs.excludeNode || + function(node) { + return false; + }, + stats = { valid: true }, + processed = false, + defaultMin = Infinity, + defaultMax = 1 - Infinity; this.processTree = function() { - processNode(tree, false); + processNode(tree, true); processed = true; return stats; }; @@ -4838,25 +9895,27 @@ getJasmineRequireObj().TreeProcessor = function() { } } - function processNode(node, parentEnabled) { + function processNode(node, parentExcluded) { var executableIndex = runnableIndex(node.id); if (executableIndex !== undefined) { - parentEnabled = true; + parentExcluded = false; } - parentEnabled = parentEnabled && node.isExecutable(); - if (!node.children) { + var excluded = parentExcluded || excludeNode(node); stats[node.id] = { - executable: parentEnabled && node.isExecutable(), - segments: [{ - index: 0, - owner: node, - nodes: [node], - min: startingMin(executableIndex), - max: startingMax(executableIndex) - }] + excluded: excluded, + willExecute: !excluded && !node.markedPending, + segments: [ + { + index: 0, + owner: node, + nodes: [node], + min: startingMin(executableIndex), + max: startingMax(executableIndex) + } + ] }; } else { var hasExecutableChild = false; @@ -4866,7 +9925,7 @@ getJasmineRequireObj().TreeProcessor = function() { for (var i = 0; i < orderedChildren.length; i++) { var child = orderedChildren[i]; - processNode(child, parentEnabled); + processNode(child, parentExcluded); if (!stats.valid) { return; @@ -4874,11 +9933,12 @@ getJasmineRequireObj().TreeProcessor = function() { var childStats = stats[child.id]; - hasExecutableChild = hasExecutableChild || childStats.executable; + hasExecutableChild = hasExecutableChild || childStats.willExecute; } stats[node.id] = { - executable: hasExecutableChild + excluded: parentExcluded, + willExecute: hasExecutableChild }; segmentChildren(node, orderedChildren, stats[node.id], executableIndex); @@ -4897,14 +9957,29 @@ getJasmineRequireObj().TreeProcessor = function() { return executableIndex === undefined ? defaultMax : executableIndex; } - function segmentChildren(node, orderedChildren, nodeStats, executableIndex) { - var currentSegment = { index: 0, owner: node, nodes: [], min: startingMin(executableIndex), max: startingMax(executableIndex) }, - result = [currentSegment], - lastMax = defaultMax, - orderedChildSegments = orderChildSegments(orderedChildren); + function segmentChildren( + node, + orderedChildren, + nodeStats, + executableIndex + ) { + var currentSegment = { + index: 0, + owner: node, + nodes: [], + min: startingMin(executableIndex), + max: startingMax(executableIndex) + }, + result = [currentSegment], + lastMax = defaultMax, + orderedChildSegments = orderChildSegments(orderedChildren); function isSegmentBoundary(minIndex) { - return lastMax !== defaultMax && minIndex !== defaultMin && lastMax < minIndex - 1; + return ( + lastMax !== defaultMax && + minIndex !== defaultMin && + lastMax < minIndex - 1 + ); } for (var i = 0; i < orderedChildSegments.length; i++) { @@ -4913,7 +9988,13 @@ getJasmineRequireObj().TreeProcessor = function() { minIndex = childSegment.min; if (isSegmentBoundary(minIndex)) { - currentSegment = {index: result.length, owner: node, nodes: [], min: defaultMin, max: defaultMax}; + currentSegment = { + index: result.length, + owner: node, + nodes: [], + min: defaultMin, + max: defaultMax + }; result.push(currentSegment); } @@ -4928,11 +10009,11 @@ getJasmineRequireObj().TreeProcessor = function() { function orderChildSegments(children) { var specifiedOrder = [], - unspecifiedOrder = []; + unspecifiedOrder = []; for (var i = 0; i < children.length; i++) { var child = children[i], - segments = stats[child.id].segments; + segments = stats[child.id].segments; for (var j = 0; j < segments.length; j++) { var seg = segments[j]; @@ -4956,14 +10037,21 @@ getJasmineRequireObj().TreeProcessor = function() { if (node.children) { return { fn: function(done) { - nodeStart(node); + var onStart = { + fn: function(next) { + nodeStart(node, next); + } + }; queueRunnerFactory({ onComplete: function() { - nodeComplete(node, node.getResult()); - done(); + var args = Array.prototype.slice.call(arguments, [0]); + node.cleanupBeforeAfter(); + nodeComplete(node, node.getResult(), function() { + done.apply(undefined, args); + }); }, - queueableFns: wrapChildren(node, segmentNumber), + queueableFns: [onStart].concat(wrapChildren(node, segmentNumber)), userContext: node.sharedUserContext(), onException: function() { node.onException.apply(node, arguments); @@ -4973,20 +10061,28 @@ getJasmineRequireObj().TreeProcessor = function() { }; } else { return { - fn: function(done) { node.execute(done, stats[node.id].executable); } + fn: function(done) { + node.execute( + done, + stats[node.id].excluded, + failSpecWithNoExpectations + ); + } }; } } function wrapChildren(node, segmentNumber) { var result = [], - segmentChildren = stats[node.id].segments[segmentNumber].nodes; + segmentChildren = stats[node.id].segments[segmentNumber].nodes; for (var i = 0; i < segmentChildren.length; i++) { - result.push(executeNode(segmentChildren[i].owner, segmentChildren[i].index)); + result.push( + executeNode(segmentChildren[i].owner, segmentChildren[i].index) + ); } - if (!stats[node.id].executable) { + if (!stats[node.id].willExecute) { return result; } @@ -4997,6 +10093,24 @@ getJasmineRequireObj().TreeProcessor = function() { return TreeProcessor; }; +getJasmineRequireObj().UserContext = function(j$) { + function UserContext() {} + + UserContext.fromExisting = function(oldContext) { + var context = new UserContext(); + + for (var prop in oldContext) { + if (oldContext.hasOwnProperty(prop)) { + context[prop] = oldContext[prop]; + } + } + + return context; + }; + + return UserContext; +}; + getJasmineRequireObj().version = function() { - return '2.6.4'; + return '3.10.1'; }; diff --git a/lib/local-modifications.patch b/lib/local-modifications.patch index 9341169..c902dc8 100644 --- a/lib/local-modifications.patch +++ b/lib/local-modifications.patch @@ -1,34 +1,34 @@ ---- lib/jasmine.js.orig 2020-08-24 22:31:16.866022768 -0700 -+++ lib/jasmine.js 2020-08-24 22:31:16.878022764 -0700 +--- jasmine.js.orig 2024-01-20 15:06:20.821078800 +0100 ++++ jasmine.js 2024-01-20 15:07:10.360495593 +0100 @@ -1,3 +1,4 @@ +/* jscs:disable */ /* - Copyright (c) 2008-2015 Pivotal Labs + Copyright (c) 2008-2021 Pivotal Labs -@@ -143,7 +144,7 @@ +@@ -319,7 +320,7 @@ }; - j$.isDomNode = function(obj) { -- return obj.nodeType > 0; -+ return obj.nodeType && obj.nodeType > 0; - }; - - j$.fnNameFor = function(func) { -@@ -206,7 +207,7 @@ + j$.isAsymmetricEqualityTester_ = function(obj) { +- return obj ? j$.isA_('Function', obj.asymmetricMatch) : false; ++ return obj?.asymmetricMatch ? j$.isA_('Function', obj.asymmetricMatch) : false; }; + j$.getType_ = function(value) { +@@ -581,7 +582,7 @@ + * @return {Boolean} + */ j$.isSpy = function(putativeSpy) { - if (!putativeSpy) { + if (!putativeSpy || !putativeSpy.and) { return false; } - return putativeSpy.and instanceof j$.SpyStrategy && -@@ -2594,7 +2595,7 @@ - }; - - function isAsymmetric(obj) { -- return obj && j$.isA_('Function', obj.asymmetricMatch); -+ return obj && obj.asymmetricMatch && j$.isA_('Function', obj.asymmetricMatch); - } + return ( +@@ -2249,7 +2250,7 @@ + }; - function asymmetricMatch(a, b) { + this.describe = function(description, specDefinitions) { +- ensureIsNotNested('describe'); ++ //ensureIsNotNested('describe'); + ensureIsFunction(specDefinitions, 'describe'); + var suite = suiteFactory(description); + if (specDefinitions.length > 0) { diff --git a/lib/update-jasmine.sh b/lib/update-jasmine.sh index 39f9dce..7abbbd2 100755 --- a/lib/update-jasmine.sh +++ b/lib/update-jasmine.sh @@ -1,5 +1,5 @@ # This script is used to build our custom version of the Jasmine library by # downloading the upstream file and applying our patches, and is meant for use # only when upgrading to a new upstream version. -curl -o jasmine.js https://raw.githubusercontent.com/jasmine/jasmine/v2.6.4/lib/jasmine-core/jasmine.js +curl -o jasmine.js https://raw.githubusercontent.com/jasmine/jasmine/v3.10.1/lib/jasmine-core/jasmine.js patch = 0.50.0') gjs_dep = dependency('gjs-1.0', required: false) @@ -71,6 +71,6 @@ test_env.set('BUILDDIR', meson.current_build_dir()) test_env.set('JASMINE_UNINSTALLED', 'yes') foreach t : tests test_file = files('test/@0@.js'.format(t)) - test(t, gjs, args: ['jasmine', test_file, '--tap', '--no-config'], + test(t, gjs, args: ['-m', 'jasmine', test_file, '--module', '--tap', '--no-config'], env: test_env, protocol: 'tap') endforeach diff --git a/src/command.js b/src/command.js index a03b38f..9f42a01 100644 --- a/src/command.js +++ b/src/command.js @@ -1,21 +1,25 @@ -/* global jasmineImporter */ -/* exported run */ +import Gio from 'gi://Gio'; +import GLib from 'gi://GLib'; -const {Gio, GLib} = imports.gi; -const Mainloop = imports.mainloop; +import * as Options from './options.js'; +import * as Timer from './timer.js'; +import * as JUnitReporter from './junitReporter.js'; +import * as VerboseReporter from './verboseReporter.js'; +import * as TapReporter from './tapReporter.js'; +import * as ConsoleReporter from './consoleReporter.js'; -const Options = jasmineImporter.options; -const Timer = jasmineImporter.timer; +export const mainloop = GLib.MainLoop.new(null, false); -function run(_jasmine, argv, timeout = -1) { +export async function run(_jasmine, argv, timeout = -1) { const [files, options] = Options.parseOptions(argv); if (options.exclude) _jasmine.exclusions = options.exclude; - if (options.junit) { - const JUnitReporter = jasmineImporter.junitReporter; + if (options.module) + _jasmine.module = true; + if (options.junit) { let junitPath = options.junit; if (!GLib.path_is_absolute(junitPath) && GLib.getenv('JASMINE_JUNIT_REPORTS_DIR') !== null) @@ -56,44 +60,39 @@ function run(_jasmine, argv, timeout = -1) { let exitCode = 0; let reporter; - if (options.verbose) { - const VerboseReporter = jasmineImporter.verboseReporter; + if (options.verbose) reporter = new VerboseReporter.VerboseReporter(reporterOptions); - } else if (options.tap) { - const TapReporter = jasmineImporter.tapReporter; + else if (options.tap) reporter = new TapReporter.TapReporter(reporterOptions); - } else { - const ConsoleReporter = jasmineImporter.consoleReporter; + else reporter = new ConsoleReporter.DefaultReporter(reporterOptions); - } - reporter.connect('started', () => Mainloop.source_remove(timeoutId)); + + reporter.connect('started', () => GLib.source_remove(timeoutId)); reporter.connect('complete', (_, success) => { if (!success) exitCode = 1; - Mainloop.quit('jasmine'); + mainloop.quit(); }); _jasmine.addReporter(reporter); // This works around a limitation in GJS 1.40 where exceptions occurring // during module import are swallowed. if (timeout !== -1) { - timeoutId = Mainloop.timeout_add_seconds(timeout, function () { + timeoutId = GLib.timeout_add_seconds(GLib.PRIORITY_DEFAULT, timeout, function () { if (options.tap) print('Bail out! Test suite failed to start within 10 seconds'); else printerr('Test suite failed to start within 10 seconds'); exitCode = 1; - Mainloop.quit('jasmine'); + mainloop.quit(); }); } // This should start after the main loop starts, otherwise we will hit // Mainloop.run() only after several tests have already run. For consistency // we should guarantee that there is a main loop running during the tests. - Mainloop.idle_add(function () { - try { - _jasmine.execute(files); - } catch (e) { + GLib.idle_add(GLib.PRIORITY_DEFAULT, function () { + _jasmine.execute(files).catch(e => { if (options.tap) { // "Bail out!" has a special meaning to TAP harnesses print('Bail out! Exception occurred inside Jasmine:', e); @@ -103,12 +102,12 @@ function run(_jasmine, argv, timeout = -1) { printerr(e.stack); } exitCode = 1; - Mainloop.quit('jasmine'); - } + mainloop.quit(); + }); return GLib.SOURCE_REMOVE; }); // _jasmine.execute() queues up all the tests and runs them asynchronously. - Mainloop.run('jasmine'); + await mainloop.runAsync(); return exitCode; } diff --git a/src/config.js b/src/config.js index df2a1de..f2eae16 100644 --- a/src/config.js +++ b/src/config.js @@ -1,6 +1,5 @@ -/* exported configToArgs, loadConfig, prepareLauncher, wrapArgs */ - -const {Gio, GLib} = imports.gi; +import Gio from 'gi://Gio'; +import GLib from 'gi://GLib'; function _makePathsAbsolute(configFile, paths) { return paths.map(path => { @@ -12,13 +11,13 @@ function _makePathsAbsolute(configFile, paths) { // Make it legal to specify "some_option": "single_value" in the config file as // well as "some_option": ["multiple", "values"] -function ensureArray(option) { +export function ensureArray(option) { if (!Array.isArray(option)) return [option]; return option; } -function loadConfig(options, defaultFile = 'jasmine.json') { +export function loadConfig(options, defaultFile = 'jasmine.json') { if (options['no-config']) return {}; @@ -66,6 +65,8 @@ function optionsToArgs(options) { const args = [options.color ? '--color' : '--no-color']; if (options.verbose) args.push('--verbose'); + if (options.module) + args.push('--module'); if (options.tap) args.push('--tap'); if (options.junit) { @@ -81,7 +82,7 @@ function optionsToArgs(options) { return args; } -function configToArgs(config, specFiles = [], options = {}) { +export function configToArgs(config, specFiles = [], options = {}) { let retval = []; if (config.exclude) { ensureArray(config.exclude).forEach(exclude => { @@ -102,7 +103,7 @@ function configToArgs(config, specFiles = [], options = {}) { return retval; } -function prepareLauncher(config, options = {}) { +export function prepareLauncher(config, options = {}) { let flags = Gio.SubprocessFlags.NONE; if (options.debug) flags |= Gio.SubprocessFlags.STDIN_INHERIT; @@ -125,14 +126,16 @@ function prepareLauncher(config, options = {}) { return launcher; } -function wrapArgs(args, config, options = {}) { +export function wrapArgs(args, config, options = {}) { if (options.interpreter) args.unshift(...options.interpreter.split(' ')); else if (config.interpreter) args.unshift(...config.interpreter.split(' ')); + else if (options.module) + args.push('--module'); if (options.debug) { if (!options.interpreter && !config.interpreter) - args.unshift('gjs'); + args.unshift('gjs', '-m'); args.unshift(...options.debug.split(' ')); } return args; diff --git a/src/consoleReporter.js b/src/consoleReporter.js index 4db1f4b..ac3db00 100644 --- a/src/consoleReporter.js +++ b/src/consoleReporter.js @@ -1,9 +1,7 @@ -/* global jasmineImporter */ -/* exported DefaultReporter */ +import Gio from 'gi://Gio'; +import GObject from 'gi://GObject'; -const {Gio, GObject} = imports.gi; - -const Utils = jasmineImporter.utils; +import {indenter} from './utils.js'; const YELLOW = '\x1b[33m'; const GREEN = '\x1b[32m'; @@ -19,7 +17,7 @@ function createNoopTimer() { }; } -var ConsoleReporter = GObject.registerClass({ +export const ConsoleReporter = GObject.registerClass({ Properties: { 'show-colors': GObject.ParamSpec.boolean('show-colors', 'Show colors', 'Whether to print color output', @@ -186,7 +184,7 @@ var ConsoleReporter = GObject.registerClass({ // This reporter has very nearly the same behaviour to Jasmine's default console // reporter. -var DefaultReporter = GObject.registerClass(class DefaultReporter extends ConsoleReporter { +export const DefaultReporter = GObject.registerClass(class DefaultReporter extends ConsoleReporter { jasmineStarted(info) { super.jasmineStarted(info); this._print('Started\n'); @@ -243,7 +241,7 @@ ${this._color(failedExpectation.message, RED)} Stack: ${this.filterStack(failedExpectation.stack)} `; - this._print(Utils.indent(report, 2)); + this._print(indenter.indent(report, 2)); }); } diff --git a/src/jasmineBoot.js b/src/jasmineBoot.js index 3cc2118..53e0a3d 100644 --- a/src/jasmineBoot.js +++ b/src/jasmineBoot.js @@ -1,9 +1,9 @@ /* global jasmineImporter */ -/* exported Jasmine */ -const {Gio, GLib} = imports.gi; +import Gio from 'gi://Gio'; +import GLib from 'gi://GLib'; -var Jasmine = class Jasmine { +export const Jasmine = class Jasmine { constructor({jasmineCore} = {jasmineCore: jasmineImporter.jasmine}) { const jasmineCorePath = jasmineCore.__file__; this._jasmineCoreFile = Gio.File.new_for_path(jasmineCorePath); @@ -11,10 +11,14 @@ var Jasmine = class Jasmine { const jasmineRequire = jasmineCore.getJasmineRequireObj(); this._jasmine = jasmineRequire.core(jasmineRequire); this.env = this._jasmine.getEnv(); + this.env.configure({ + random: false, + }); this._jasmineInterface = jasmineRequire.interface(this._jasmine, this.env); this.exclusions = []; this.specFiles = []; + this.module = false; this._reportersCount = 0; } @@ -66,10 +70,11 @@ var Jasmine = class Jasmine { }); } - loadSpecs() { - const oldSearchPath = imports.searchPath.slice(); // make a copy - let specImporter = imports['.']; - this.specFiles.forEach(function (file) { + async loadSpecs() { + await Promise.all(this.specFiles.map(async file => { + const oldSearchPath = imports.searchPath.slice(); // make a copy + let specImporter = imports['.']; + const modulePath = GLib.path_get_dirname(file); const moduleName = GLib.path_get_basename(file).slice(0, -3); // .js @@ -77,15 +82,19 @@ var Jasmine = class Jasmine { // directories imports.searchPath.unshift(modulePath); specImporter.searchPath.unshift(modulePath); + try { - void specImporter[moduleName]; + if (this.module) + await import(`file://${file}`); + else + await specImporter[moduleName]; } catch (err) { if (!(err instanceof SyntaxError || err.name === 'ImportError')) throw err; // Fake failing suite, to log a failure but continue on with // other specs - window.describe(file, function () { - window.it('did not import correctly', function () { + globalThis.describe(file, function () { + globalThis.it('did not import correctly', function () { let failureMessage; if (err instanceof SyntaxError) { const {fileName, lineNumber, columnNumber, message} = err; @@ -93,7 +102,7 @@ var Jasmine = class Jasmine { } else { failureMessage = err.message; } - window.fail(failureMessage); + globalThis.fail(failureMessage); }); }); } @@ -102,14 +111,14 @@ var Jasmine = class Jasmine { // Make a new copy of the importer in case we need to import another // spec with the same filename, so it is not cached specImporter = specImporter['.']; - }); + })); } - execute(files) { + async execute(files) { if (files && files.length > 0) this.addSpecFiles(files); - this.loadSpecs(); + await this.loadSpecs(); this.env.execute(); } diff --git a/src/junitReporter.js b/src/junitReporter.js index fa54595..3d4a9a6 100644 --- a/src/junitReporter.js +++ b/src/junitReporter.js @@ -2,15 +2,13 @@ // See http://llg.cubic.org/docs/junit/ // Unfortunately, the JUnit format is woefully underspecified. -/* global jasmineImporter */ -/* exported JUnitReporter */ +import GLib from 'gi://GLib'; +import GObject from 'gi://GObject'; -const {GLib, GObject} = imports.gi; +import {ConsoleReporter} from './consoleReporter.js'; +import * as XMLWriter from './xmlWriter.js'; -const {ConsoleReporter} = jasmineImporter.consoleReporter; -const XMLWriter = jasmineImporter.xmlWriter; - -var JUnitReporter = GObject.registerClass(class JUnitReporter extends ConsoleReporter { +export const JUnitReporter = GObject.registerClass(class JUnitReporter extends ConsoleReporter { jasmineStarted(info) { this._currentSuite = null; super.jasmineStarted(info); diff --git a/src/options.js b/src/options.js index cdc4514..25d3b25 100644 --- a/src/options.js +++ b/src/options.js @@ -1,6 +1,4 @@ -/* exported parseOptions */ - -const System = imports.system; +import * as System from 'system'; const ARGS = { 'help': { @@ -47,6 +45,10 @@ const ARGS = { help: 'do not execute the given spec (may include wildcards)', action: 'append', }, + 'module': { + help: 'execute specs as module', + action: 'store_true', + }, 'interpreter': { help: 'run with the given program instead of /usr/bin/env gjs', action: 'store', @@ -59,7 +61,7 @@ const ARGS = { }, }; -function parseOptions(argv) { +export function parseOptions(argv) { argv = argv.slice(); // Make a copy const namespace = {}; const files = []; diff --git a/src/tapReporter.js b/src/tapReporter.js index fc2f13e..08746cd 100644 --- a/src/tapReporter.js +++ b/src/tapReporter.js @@ -1,14 +1,11 @@ // Reporter that outputs according to the Test Anything Protocol // See http://testanything.org/tap-specification.html -/* global jasmineImporter */ -/* exported TapReporter */ +import GObject from 'gi://GObject'; -const {GObject} = imports.gi; +import {ConsoleReporter} from './consoleReporter.js'; -const {ConsoleReporter} = jasmineImporter.consoleReporter; - -var TapReporter = GObject.registerClass(class TapReporter extends ConsoleReporter { +export const TapReporter = GObject.registerClass(class TapReporter extends ConsoleReporter { jasmineStarted(info) { super.jasmineStarted(info); this._print(`1..${info.totalSpecsDefined}\n`); diff --git a/src/timer.js b/src/timer.js index a5abe87..6a5b788 100644 --- a/src/timer.js +++ b/src/timer.js @@ -1,30 +1,7 @@ -/* exported installAPI, createDefaultTimer */ - -const {GLib} = imports.gi; -const Mainloop = imports.mainloop; - -function _setTimeoutInternal(continueTimeout, func, time) { - return Mainloop.timeout_add(time, function () { - func(); - return continueTimeout; - }); -} - -function _clearTimeoutInternal(id) { - if (id > 0) - Mainloop.source_remove(id); -} - -// Installs the browser setTimeout/setInterval API on the given object. (Pass -// window to get these available globally.) -function installAPI(global) { - global.setTimeout = _setTimeoutInternal.bind(undefined, GLib.SOURCE_REMOVE); - global.setInterval = _setTimeoutInternal.bind(undefined, GLib.SOURCE_CONTINUE); - global.clearTimeout = global.clearInterval = _clearTimeoutInternal; -} +import GLib from 'gi://GLib'; // Measures elapsed time in milliseconds. -function createDefaultTimer() { +export function createDefaultTimer() { let startTime, elapsedTime; return { start() { diff --git a/src/utils.js b/src/utils.js index 28ca8f3..aee6905 100644 --- a/src/utils.js +++ b/src/utils.js @@ -1,9 +1,9 @@ -/* exported indent */ - -function indent(str, spaces) { - return str.split('\n').map(line => { - if (line === '') - return line; - return ' '.repeat(spaces) + line; - }).join('\n'); -} +export const indenter = { + indent(str, spaces) { + return str.split('\n').map(line => { + if (line === '') + return line; + return ' '.repeat(spaces) + line; + }).join('\n'); + }, +}; diff --git a/src/verboseReporter.js b/src/verboseReporter.js index 8df4a29..c5a7ead 100644 --- a/src/verboseReporter.js +++ b/src/verboseReporter.js @@ -1,10 +1,7 @@ -/* global jasmineImporter */ -/* exported VerboseReporter */ +import GObject from 'gi://GObject'; -const {GObject} = imports.gi; - -const {ConsoleReporter} = jasmineImporter.consoleReporter; -const Utils = jasmineImporter.utils; +import {ConsoleReporter} from './consoleReporter.js'; +import {indenter} from './utils.js'; const GRAY = '\x1b[38;5;246m'; const YELLOW = '\x1b[33m'; @@ -13,7 +10,7 @@ const RED = '\x1b[31m'; // This reporter, activated with --verbose on the command line, behaves very // similarly to Mocha's nicely formatted reporter. -var VerboseReporter = GObject.registerClass(class VerboseReporter extends ConsoleReporter { +export const VerboseReporter = GObject.registerClass(class VerboseReporter extends ConsoleReporter { jasmineStarted(info) { super.jasmineStarted(info); this._print('Started\n\n'); @@ -39,14 +36,14 @@ var VerboseReporter = GObject.registerClass(class VerboseReporter extends Consol suiteStarted(result) { super.suiteStarted(result); - this._print(Utils.indent(this._color(result.description, GRAY), + this._print(indenter.indent(this._color(result.description, GRAY), this._suiteLevel * 2)); this._print('\n'); } suiteDone(result) { if (result.status === 'disabled') { - this._print(Utils.indent(`${this._color('(disabled)', YELLOW)}\n`, + this._print(indenter.indent(`${this._color('(disabled)', YELLOW)}\n`, this._suiteLevel * 2 + 2)); } @@ -71,7 +68,7 @@ var VerboseReporter = GObject.registerClass(class VerboseReporter extends Consol failed: `${this._failureCount})`, disabled: 'x', }; - this._print(Utils.indent(this._color(symbols[result.status], + this._print(indenter.indent(this._color(symbols[result.status], colors[result.status]), this._suiteLevel * 2 + 2)); this._print(` ${result.description}`); if (result.time > 75) @@ -87,9 +84,9 @@ var VerboseReporter = GObject.registerClass(class VerboseReporter extends Consol this._print(this._color(`${index + 1}) ${result.fullName}\n\n`, RED)); result.failedExpectations.forEach(failedExpectation => { - this._print(Utils.indent(this._color(failedExpectation.message, GRAY), 2)); + this._print(indenter.indent(this._color(failedExpectation.message, GRAY), 2)); this._print('\n'); - this._print(Utils.indent(this.filterStack(failedExpectation.stack), 4)); + this._print(indenter.indent(this.filterStack(failedExpectation.stack), 4)); this._print('\n\n'); }); } diff --git a/src/xmlWriter.js b/src/xmlWriter.js index e4f412f..cce33a7 100644 --- a/src/xmlWriter.js +++ b/src/xmlWriter.js @@ -1,11 +1,8 @@ -/* global jasmineImporter */ -/* exported Node */ +import GLib from 'gi://GLib'; -const {GLib} = imports.gi; +import {indenter} from './utils.js'; -const Utils = jasmineImporter.utils; - -var Node = class Node { +export const Node = class Node { constructor(name) { this.name = name; this.attrs = {}; @@ -36,6 +33,6 @@ function _prettyprint(node) { if (text.length !== 0) text += '\n'; - return elementTop + Utils.indent(children, 2) + Utils.indent(text, 2) + + return elementTop + indenter.indent(children, 2) + indenter.indent(text, 2) + elementBottom; } diff --git a/test/commandSpec.js b/test/commandSpec.js index a5403b1..3456d7d 100644 --- a/test/commandSpec.js +++ b/test/commandSpec.js @@ -1,12 +1,12 @@ -/* global jasmineImporter */ +import Gio from 'gi://Gio'; +import GLib from 'gi://GLib'; -const {Gio, GLib} = imports.gi; -const Mainloop = imports.mainloop; +import * as Command from '../src/command.js'; +import * as JUnitReporter from '../src/junitReporter.js'; +import * as TapReporter from '../src/tapReporter.js'; +import * as VerboseReporter from '../src/verboseReporter.js'; -const Command = jasmineImporter.command; -const JUnitReporter = jasmineImporter.junitReporter; -const TapReporter = jasmineImporter.tapReporter; -const VerboseReporter = jasmineImporter.verboseReporter; +const {mainloop} = Command; describe('Jasmine command', function () { let fakeJasmine; @@ -17,7 +17,7 @@ describe('Jasmine command', function () { beforeEach(function () { fakeJasmine = jasmine.createSpyObj('jasmine', ['addReporter', 'configureDefaultReporter', 'execute']); - spyOn(Mainloop, 'run'); // stub out system behaviour + spyOn(mainloop, 'runAsync'); // stub out system behaviour }); describe('running specs', function () { @@ -105,9 +105,9 @@ describe('Jasmine command', function () { }); it('executes the Jasmine suite', function (done) { - expect(Command.run(fakeJasmine, [])).toEqual(0); + expectAsync(Command.run(fakeJasmine, [])).toBeResolvedTo(0); // fakeJasmine.execute() is started in idle - Mainloop.idle_add(function () { + GLib.idle_add(GLib.PRIORITY_DEFAULT, function () { expect(fakeJasmine.execute).toHaveBeenCalled(); done(); }); @@ -115,7 +115,7 @@ describe('Jasmine command', function () { it('runs the specified specs', function (done) { Command.run(fakeJasmine, ['spec/some/fileSpec.js', '--no-color']); - Mainloop.idle_add(function () { + GLib.idle_add(GLib.PRIORITY_DEFAULT, function () { expect(fakeJasmine.execute).toHaveBeenCalledWith(['spec/some/fileSpec.js']); done(); }); diff --git a/test/configSpec.js b/test/configSpec.js index b89261f..c818120 100644 --- a/test/configSpec.js +++ b/test/configSpec.js @@ -1,9 +1,8 @@ -/* global jasmineImporter */ +import Gio from 'gi://Gio'; +import GLib from 'gi://GLib'; -const {Gio, GLib} = imports.gi; - -const Config = jasmineImporter.config; -const Options = jasmineImporter.options; +import * as Config from '../src/config.js'; +import * as Options from '../src/options.js'; // This is in case we are running the tests from a build tree that is different // from the source tree, for example during 'meson test'. @@ -23,8 +22,8 @@ describe('Ensure array', function () { describe('Loading configuration', function () { beforeEach(function () { // suppress messages - spyOn(window, 'print'); - spyOn(window, 'printerr'); + spyOn(globalThis, 'print'); + spyOn(globalThis, 'printerr'); }); it('loads from a file', function () { @@ -73,7 +72,7 @@ describe('Loading configuration', function () { it('warns about unrecognized config options', function () { Config.loadConfig({config: `${SRCDIR}test/fixtures/jasmine.json`}); - expect(window.printerr).toHaveBeenCalledWith(jasmine.stringMatching(/^warning: /)); + expect(globalThis.printerr).toHaveBeenCalledWith(jasmine.stringMatching(/^warning: /)); }); }); @@ -251,7 +250,7 @@ describe('Manipulating the launcher command line', function () { args = Config.wrapArgs(args, {}, { debug: 'gdb --args', }); - expect(args).toEqual(['gdb', '--args', 'gjs', 'jasmine-runner', '--verbose', 'foo.js']); + expect(args).toEqual(['gdb', '--args', 'gjs', '-m', 'jasmine-runner', '--verbose', 'foo.js']); }); it('does not pass the gjs interpreter to the debugger if a custom one is configured', function () { diff --git a/test/consoleReporterSpec.js b/test/consoleReporterSpec.js index 60bbaec..56a824f 100644 --- a/test/consoleReporterSpec.js +++ b/test/consoleReporterSpec.js @@ -1,6 +1,4 @@ -/* global jasmineImporter */ - -const ConsoleReporter = jasmineImporter.consoleReporter; +import * as ConsoleReporter from '../src/consoleReporter.js'; describe('Console reporter base class', function () { let reporter, timerSpies; diff --git a/test/defaultReporterSpec.js b/test/defaultReporterSpec.js index bcd6b53..ca14fab 100644 --- a/test/defaultReporterSpec.js +++ b/test/defaultReporterSpec.js @@ -1,6 +1,4 @@ -/* global jasmineImporter */ - -const ConsoleReporter = jasmineImporter.consoleReporter; +import * as ConsoleReporter from '../src/consoleReporter.js'; describe('Default console reporter', function () { let out, reporter, timerSpies; diff --git a/test/importerSpec.js b/test/importerSpec.js index 5154094..f75fa65 100644 --- a/test/importerSpec.js +++ b/test/importerSpec.js @@ -2,7 +2,7 @@ const Utils = imports.utils; describe('Jasmine importer', function () { it('hides Jasmine modules from the test code', function () { - expect(Object.keys(Utils)).not.toContain('indent'); + expect(Object.keys(Utils)).not.toContain('indenter'); }); it("lets test code import modules named the same as Jasmine's", function () { diff --git a/test/jasmineBootSpec.js b/test/jasmineBootSpec.js index 5a1e4b9..fd5e0d6 100644 --- a/test/jasmineBootSpec.js +++ b/test/jasmineBootSpec.js @@ -1,8 +1,7 @@ -/* global jasmineImporter */ +import Gio from 'gi://Gio'; +import GLib from 'gi://GLib'; -const {Gio, GLib} = imports.gi; - -const JasmineBoot = jasmineImporter.jasmineBoot; +import * as JasmineBoot from '../src/jasmineBoot.js'; // This is in case we are running the tests from a build tree that is different // from the source tree, for example during 'make distcheck'. @@ -59,6 +58,7 @@ describe('Jasmine boot', function () { getEnv: jasmine.createSpy('getEnv').and.returnValue({ addReporter: jasmine.createSpy('addReporter'), execute: jasmine.createSpy('execute'), + configure: jasmine.createSpy('configure'), }), Timer: jasmine.createSpy('Timer'), Expectation: { @@ -177,7 +177,7 @@ describe('Jasmine boot', function () { `${SRCDIR}test/fixtures/path1`, `${SRCDIR}test/fixtures/path2`, ]); - expect(() => testJasmine.loadSpecs()).toThrowError(Error, + expectAsync(testJasmine.loadSpecs()).toBeRejectedWithError(Error, 'Catch this error to ensure this file is loaded'); }); diff --git a/test/jasmineIntegrationTest.js b/test/jasmineIntegrationTest.js index cbb3acc..835ab40 100644 --- a/test/jasmineIntegrationTest.js +++ b/test/jasmineIntegrationTest.js @@ -11,7 +11,7 @@ /* global setInterval, setTimeout */ -const GLib = imports.gi.GLib; +import GLib from 'gi://GLib'; describe('Jasmine integration test', function () { describe("A suite", function () { @@ -647,7 +647,7 @@ describe('Jasmine integration test', function () { }); it("is named, which helps in error reporting", function () { - expect(whatAmI.and.identity()).toEqual('whatAmI'); + expect(whatAmI.and.identity).toEqual('whatAmI'); }); it("tracks that the spy was called", function () { diff --git a/test/junitReporterSpec.js b/test/junitReporterSpec.js index 9d81aa8..6c4061e 100644 --- a/test/junitReporterSpec.js +++ b/test/junitReporterSpec.js @@ -1,9 +1,7 @@ -/* global jasmineImporter */ +import GLib from 'gi://GLib'; -const {GLib} = imports.gi; - -const JUnitReporter = jasmineImporter.junitReporter; -const XMLWriter = jasmineImporter.xmlWriter; +import * as JUnitReporter from '../src/junitReporter.js'; +import * as XMLWriter from '../src/xmlWriter.js'; const SUITE_INFO = { id: 'foo', diff --git a/test/optionsSpec.js b/test/optionsSpec.js index 30a7625..25fbf32 100644 --- a/test/optionsSpec.js +++ b/test/optionsSpec.js @@ -1,9 +1,7 @@ -/* global jasmineImporter */ - // FIXME: the argument parser should be refactored into something more general // so that the ARGS object in options.js isn't hardcoded. -const Options = jasmineImporter.options; +import * as Options from '../src/options.js'; describe('Argument parser', function () { it('stores the given value for a "store" argument', function () { diff --git a/test/tapReporterSpec.js b/test/tapReporterSpec.js index c17a5b8..ea90afc 100644 --- a/test/tapReporterSpec.js +++ b/test/tapReporterSpec.js @@ -1,6 +1,4 @@ -/* global jasmineImporter */ - -const TapReporter = jasmineImporter.tapReporter; +import * as TapReporter from '../src/tapReporter.js'; describe('The TAP reporter', function () { let out, reporter; diff --git a/test/timerSpec.js b/test/timerSpec.js index 4447c3b..28756e8 100644 --- a/test/timerSpec.js +++ b/test/timerSpec.js @@ -1,6 +1,4 @@ -/* global jasmineImporter */ - -const Timer = jasmineImporter.timer; +import * as Timer from '../src/timer.js'; describe('The default timer', function () { it('stops timing when elapsed() is called', function () { diff --git a/test/utils.js b/test/utils.js index 5e1ecc0..39b4d1e 100644 --- a/test/utils.js +++ b/test/utils.js @@ -1,4 +1,3 @@ -/* exported add */ function add(a, b) { return a + b; } diff --git a/test/utilsSpec.js b/test/utilsSpec.js index d3226a4..3d84b51 100644 --- a/test/utilsSpec.js +++ b/test/utilsSpec.js @@ -1,22 +1,20 @@ -/* global jasmineImporter */ - -const Utils = jasmineImporter.utils; +import {indenter} from '../src/utils.js'; describe('Indent', function () { it('prepends spaces to a string', function () { - expect(Utils.indent('foo', 4)).toEqual(' foo'); + expect(indenter.indent('foo', 4)).toEqual(' foo'); }); it('prepends spaces to each line in a string', function () { - expect(Utils.indent('a\nb\nc', 4)).toEqual(' a\n b\n c'); + expect(indenter.indent('a\nb\nc', 4)).toEqual(' a\n b\n c'); }); it('does not indent an extra blank line at the end of the string', function () { - expect(Utils.indent('a\nb\n', 4)).toEqual(' a\n b\n'); + expect(indenter.indent('a\nb\n', 4)).toEqual(' a\n b\n'); }); it('handles zero spaces', function () { - expect(Utils.indent('foo', 0)).toEqual('foo'); - expect(Utils.indent('a\nb\nc', 0)).toEqual('a\nb\nc'); + expect(indenter.indent('foo', 0)).toEqual('foo'); + expect(indenter.indent('a\nb\nc', 0)).toEqual('a\nb\nc'); }); }); diff --git a/test/verboseReporterSpec.js b/test/verboseReporterSpec.js index dc9f345..91415d4 100644 --- a/test/verboseReporterSpec.js +++ b/test/verboseReporterSpec.js @@ -1,7 +1,5 @@ -/* global jasmineImporter */ - -const VerboseReporter = jasmineImporter.verboseReporter; -const Utils = jasmineImporter.utils; +import * as VerboseReporter from '../src/verboseReporter.js'; +import {indenter} from '../src/utils.js'; describe('Verbose console reporter', function () { let out, reporter, timerSpy, timerSpies; @@ -35,7 +33,7 @@ describe('Verbose console reporter', function () { }); // disable indentation for test purposes - spyOn(Utils, 'indent').and.callFake(str => str); + spyOn(indenter, 'indent').and.callFake(str => str); }); it('reports that the suite has started to the console', function () { diff --git a/test/xmlWriterSpec.js b/test/xmlWriterSpec.js index 9a85bbc..de8bd25 100644 --- a/test/xmlWriterSpec.js +++ b/test/xmlWriterSpec.js @@ -1,6 +1,4 @@ -/* global jasmineImporter */ - -const XMLWriter = jasmineImporter.xmlWriter; +import * as XMLWriter from '../src/xmlWriter.js'; describe('XML writer', function () { let node;