warren/jasmine
1
0
Fork 0
Code Issues Pull Requests Actions 9 Packages Projects Releases Wiki Activity

Resolve the promise returned by Env#execute to the overall status

Browse Source
This commit is contained in:
Steve Gravrock
2021-11-30 20:05:23 -08:00
parent 42e6c45efa
commit d739c23401
5 changed files with 45 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
lib/jasmine-core/jasmine.js
View File

@@ -1832,19 +1832,21 @@ getJasmineRequireObj().Env = function(j$) {
* 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.
* execute should not be called more than once unless the env has been
* configured with `{autoCleanClosures: false}`.
*
* 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.
* resolved (not rejected) to the suite's overall status as long as the
* suite runs to completion. To determine whether the suite passed, check
* the value that the promise resolves to or use a {@link Reporter}.
*
* @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<undefined>}
* @return {Promise<string>}
*/
this.execute = function(runnablesToRun, onComplete) {
if (this._executedBefore) {
@@ -1910,12 +1912,12 @@ getJasmineRequireObj().Env = function(j$) {
jasmineTimer.start();
return new Promise(function(resolve) {
runAll(function() {
runAll(function(overallStatus) {
if (onComplete) {
onComplete();
}
resolve();
resolve(overallStatus);
});
});
@@ -1975,7 +1977,9 @@ getJasmineRequireObj().Env = function(j$) {
failedExpectations: topSuite.result.failedExpectations,
deprecationWarnings: topSuite.result.deprecationWarnings
},
done
function() {
done(overallStatus);
}
);
});
}

57
spec/core/integration/CustomSpyStrategiesSpec.js
View File

@@ -10,10 +10,9 @@ describe('Custom Spy Strategies (Integration)', function() {
env.cleanup_();
});
it('allows adding more strategies local to a suite', function(done) {
it('allows adding more strategies local to a suite', async function() {
var plan = jasmine.createSpy('custom strategy plan').and.returnValue(42);
var strategy = jasmine.createSpy('custom strategy').and.returnValue(plan);
var jasmineDone = jasmine.createSpy('jasmineDone');
env.describe('suite defining a custom spy strategy', function() {
env.beforeAll(function() {
@@ -32,20 +31,13 @@ describe('Custom Spy Strategies (Integration)', function() {
expect(env.createSpy('something').and.frobnicate).toBeUndefined();
});
function expectations() {
var result = jasmineDone.calls.argsFor(0)[0];
expect(result.overallStatus).toEqual('passed');
done();
}
env.addReporter({ jasmineDone: jasmineDone });
env.execute(null, expectations);
const overallStatus = await env.execute();
expect(overallStatus).toEqual('passed');
});
it('allows adding more strategies local to a spec', function(done) {
it('allows adding more strategies local to a spec', async function() {
var plan = jasmine.createSpy('custom strategy plan').and.returnValue(42);
var strategy = jasmine.createSpy('custom strategy').and.returnValue(plan);
var jasmineDone = jasmine.createSpy('jasmineDone');
env.it('spec defining a custom spy strategy', function() {
env.addSpyStrategy('frobnicate', strategy);
@@ -59,20 +51,13 @@ describe('Custom Spy Strategies (Integration)', function() {
expect(env.createSpy('something').and.frobnicate).toBeUndefined();
});
function expectations() {
var result = jasmineDone.calls.argsFor(0)[0];
expect(result.overallStatus).toEqual('passed');
done();
}
env.addReporter({ jasmineDone: jasmineDone });
env.execute(null, expectations);
const overallStatus = await env.execute();
expect(overallStatus).toEqual('passed');
});
it('allows using custom strategies on a per-argument basis', function(done) {
it('allows using custom strategies on a per-argument basis', async function() {
var plan = jasmine.createSpy('custom strategy plan').and.returnValue(42);
var strategy = jasmine.createSpy('custom strategy').and.returnValue(plan);
var jasmineDone = jasmine.createSpy('jasmineDone');
env.it('spec defining a custom spy strategy', function() {
env.addSpyStrategy('frobnicate', strategy);
@@ -92,23 +77,16 @@ describe('Custom Spy Strategies (Integration)', function() {
expect(env.createSpy('something').and.frobnicate).toBeUndefined();
});
function expectations() {
var result = jasmineDone.calls.argsFor(0)[0];
expect(result.overallStatus).toEqual('passed');
done();
}
env.addReporter({ jasmineDone: jasmineDone });
env.execute(null, expectations);
const overallStatus = await env.execute();
expect(overallStatus).toEqual('passed');
});
it('allows multiple custom strategies to be used', function(done) {
it('allows multiple custom strategies to be used', async function() {
var plan1 = jasmine.createSpy('plan 1').and.returnValue(42),
strategy1 = jasmine.createSpy('strat 1').and.returnValue(plan1),
plan2 = jasmine.createSpy('plan 2').and.returnValue(24),
strategy2 = jasmine.createSpy('strat 2').and.returnValue(plan2),
specDone = jasmine.createSpy('specDone'),
jasmineDone = jasmine.createSpy('jasmineDone');
specDone = jasmine.createSpy('specDone');
env.beforeEach(function() {
env.addSpyStrategy('frobnicate', strategy1);
@@ -133,14 +111,9 @@ describe('Custom Spy Strategies (Integration)', function() {
expect(plan2).toHaveBeenCalled();
});
function expectations() {
var result = jasmineDone.calls.argsFor(0)[0];
expect(result.overallStatus).toEqual('passed');
expect(specDone.calls.count()).toBe(2);
done();
}
env.addReporter({ jasmineDone: jasmineDone, specDone: specDone });
env.execute(null, expectations);
env.addReporter({ specDone: specDone });
const overallStatus = await env.execute();
expect(overallStatus).toEqual('passed');
expect(specDone.calls.count()).toBe(2);
});
});

26
spec/core/integration/DefaultSpyStrategySpec.js
View File

@@ -10,7 +10,7 @@ describe('Default Spy Strategy (Integration)', function() {
env.cleanup_();
});
it('allows defining a default spy strategy', function(done) {
it('allows defining a default spy strategy', async function() {
env.describe('suite with default strategy', function() {
env.beforeEach(function() {
env.setDefaultSpyStrategy(function(and) {
@@ -29,18 +29,11 @@ describe('Default Spy Strategy (Integration)', function() {
expect(spy()).toBeUndefined();
});
function expectations() {
var result = jasmineDone.calls.argsFor(0)[0];
expect(result.overallStatus).toEqual('passed');
done();
}
var jasmineDone = jasmine.createSpy('jasmineDone');
env.addReporter({ jasmineDone: jasmineDone });
env.execute(null, expectations);
const overallStatus = await env.execute();
expect(overallStatus).toEqual('passed');
});
it('uses the default spy strategy defined when the spy is created', function(done) {
it('uses the default spy strategy defined when the spy is created', async function() {
env.it('spec', function() {
var a = env.createSpy('a');
env.setDefaultSpyStrategy(function(and) {
@@ -67,14 +60,7 @@ describe('Default Spy Strategy (Integration)', function() {
expect(d.and.isConfigured()).toBe(false);
});
function expectations() {
var result = jasmineDone.calls.argsFor(0)[0];
expect(result.overallStatus).toEqual('passed');
done();
}
var jasmineDone = jasmine.createSpy('jasmineDone');
env.addReporter({ jasmineDone: jasmineDone });
env.execute(null, expectations);
const overallStatus = await env.execute();
expect(overallStatus).toEqual('passed');
});
});

4
spec/core/integration/EnvSpec.js
View File

@@ -3229,14 +3229,14 @@ describe('Env integration', function() {
});
});
it('is resolved even if specs fail', function() {
it('is resolved to the overall status', function() {
env.describe('suite', function() {
env.it('spec', function() {
env.expect(true).toBe(false);
});
});
return expectAsync(env.execute(null)).toBeResolved();
return expectAsync(env.execute(null)).toBeResolvedTo('failed');
});
});

18
src/core/Env.js
View File

@@ -669,19 +669,21 @@ getJasmineRequireObj().Env = function(j$) {
* 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.
* execute should not be called more than once unless the env has been
* configured with `{autoCleanClosures: false}`.
*
* 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.
* resolved (not rejected) to the suite's overall status as long as the
* suite runs to completion. To determine whether the suite passed, check
* the value that the promise resolves to or use a {@link Reporter}.
*
* @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<undefined>}
* @return {Promise<string>}
*/
this.execute = function(runnablesToRun, onComplete) {
if (this._executedBefore) {
@@ -747,12 +749,12 @@ getJasmineRequireObj().Env = function(j$) {
jasmineTimer.start();
return new Promise(function(resolve) {
runAll(function() {
runAll(function(overallStatus) {
if (onComplete) {
onComplete();
}
resolve();
resolve(overallStatus);
});
});
@@ -812,7 +814,9 @@ getJasmineRequireObj().Env = function(j$) {
failedExpectations: topSuite.result.failedExpectations,
deprecationWarnings: topSuite.result.deprecationWarnings
},
done
function() {
done(overallStatus);
}
);
});
}