2016-10-17 04:11:36 +08:00
|
|
|
/* eslint global-require:0 */
|
2016-10-17 07:36:49 +08:00
|
|
|
import _ from 'underscore';
|
2016-10-18 08:59:33 +08:00
|
|
|
|
2016-10-28 03:44:22 +08:00
|
|
|
import ReactTestUtils from 'react-addons-test-utils';
|
2016-10-17 07:36:49 +08:00
|
|
|
import Config from '../../src/config'
|
2016-10-17 04:29:10 +08:00
|
|
|
import N1SpecLoader from './n1-spec-loader'
|
2016-10-17 04:17:34 +08:00
|
|
|
import TimeReporter from './time-reporter'
|
|
|
|
import N1GuiReporter from './n1-gui-reporter';
|
2016-10-17 04:11:36 +08:00
|
|
|
import jasmineExports from './jasmine';
|
2016-10-17 04:17:34 +08:00
|
|
|
import ConsoleReporter from './console-reporter'
|
2016-10-17 07:36:49 +08:00
|
|
|
import MasterAfterEach from './master-after-each'
|
|
|
|
import MasterBeforeEach from './master-before-each'
|
|
|
|
import nylasTestConstants from './nylas-test-constants'
|
2016-10-17 05:53:17 +08:00
|
|
|
import * as jasmineExtensions from './jasmine-extensions'
|
2016-10-17 07:36:49 +08:00
|
|
|
import * as reactTestUtilsExtensions from './react-test-utils-extensions'
|
2016-10-17 04:11:36 +08:00
|
|
|
|
|
|
|
class N1SpecRunner {
|
2016-10-17 04:29:10 +08:00
|
|
|
runSpecs(loadSettings) {
|
|
|
|
this.loadSettings = loadSettings
|
2016-10-17 04:11:36 +08:00
|
|
|
this._extendGlobalWindow();
|
2016-10-17 04:17:34 +08:00
|
|
|
this._setupJasmine();
|
2016-10-17 07:36:49 +08:00
|
|
|
this._setupNylasEnv();
|
|
|
|
this._setupWindow();
|
|
|
|
Object.assign(ReactTestUtils, reactTestUtilsExtensions)
|
|
|
|
MasterBeforeEach.setup(this.loadSettings, jasmineExports.beforeEach)
|
|
|
|
MasterAfterEach.setup(this.loadSettings, jasmineExports.afterEach)
|
2016-10-17 05:41:15 +08:00
|
|
|
N1SpecLoader.loadSpecs(this.loadSettings, this.jasmineEnv);
|
2016-10-17 04:29:10 +08:00
|
|
|
this.jasmineEnv.execute();
|
2016-10-17 04:11:36 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Put jasmine methods on the global scope so they can be used anywhere
|
|
|
|
* without importing jasmine.
|
|
|
|
*/
|
|
|
|
_extendGlobalWindow() {
|
|
|
|
Object.assign(window, {
|
|
|
|
jasmine: jasmineExports.jasmine,
|
|
|
|
|
fix(spec): add support for async specs and disable misbehaving ones
More spec fixes
replace process.nextTick with setTimeout(fn, 0) for specs
Also added an unspy in the afterEach
Temporarily disable specs
fix(spec): start fixing specs
Summary:
This is the WIP fix to our spec runner.
Several tests have been completely commented out that will require
substantially more work to fix. These have been added to our sprint
backlog.
Other tests have been fixed to update to new APIs or to deal with genuine
bugs that were introduced without our knowing!
The most common non-trivial change relates to observing the `NylasAPI` and
`NylasAPIRequest`. We used to observe the arguments to `makeRequest`.
Unfortunately `NylasAPIRequest.run` is argumentless. Instead you can do:
`NylasAPIRequest.prototype.run.mostRecentCall.object.options` to get the
`options` passed into the object. the `.object` property grabs the context
of the spy when it was last called.
Fixing these tests uncovered several concerning issues with our test
runner. I spent a while tracking down why our participant-text-field-spec
was failling every so often. I chose that spec because it was the first
spec to likely fail, thereby requiring looking at the least number of
preceding files. I tried binary searching, turning on and off, several
files beforehand only to realize that the failure rate was not determined
by a particular preceding test, but rather the existing and quantity of
preceding tests, AND the number of console.log statements I had. There is
some processor-dependent race condition going on that needs further
investigation.
I also discovered an issue with the file-download-spec. We were getting
errors about it accessing a file, which was very suspicious given the code
stubs out all fs access. This was caused due to a spec that called an
async function outside ot a `waitsForPromise` block or a `waitsFor` block.
The test completed, the spies were cleaned up, but the downstream async
chain was still running. By the time the async chain finished the runner
was already working on the next spec and the spies had been restored
(causing the real fs access to run).
Juan had an idea to kill the specs once one fails to prevent cascading
failures. I'll implement this in the next diff update
Test Plan: npm test
Reviewers: juan, halla, jackie
Differential Revision: https://phab.nylas.com/D3501
Disable other specs
Disable more broken specs
All specs turned off till passing state
Use async-safe versions of spec functions
Add async test spec
Remove unused package code
Remove canary spec
2016-12-13 04:12:20 +08:00
|
|
|
it: this._makeItAsync(jasmineExports.it),
|
|
|
|
// it: jasmineExports.it,
|
2016-10-17 04:11:36 +08:00
|
|
|
xit: jasmineExports.xit,
|
|
|
|
runs: jasmineExports.runs,
|
|
|
|
waits: jasmineExports.waits,
|
|
|
|
spyOn: jasmineExports.spyOn,
|
|
|
|
expect: jasmineExports.expect,
|
|
|
|
waitsFor: jasmineExports.waitsFor,
|
|
|
|
describe: jasmineExports.describe,
|
|
|
|
xdescribe: jasmineExports.xdescribe,
|
fix(spec): add support for async specs and disable misbehaving ones
More spec fixes
replace process.nextTick with setTimeout(fn, 0) for specs
Also added an unspy in the afterEach
Temporarily disable specs
fix(spec): start fixing specs
Summary:
This is the WIP fix to our spec runner.
Several tests have been completely commented out that will require
substantially more work to fix. These have been added to our sprint
backlog.
Other tests have been fixed to update to new APIs or to deal with genuine
bugs that were introduced without our knowing!
The most common non-trivial change relates to observing the `NylasAPI` and
`NylasAPIRequest`. We used to observe the arguments to `makeRequest`.
Unfortunately `NylasAPIRequest.run` is argumentless. Instead you can do:
`NylasAPIRequest.prototype.run.mostRecentCall.object.options` to get the
`options` passed into the object. the `.object` property grabs the context
of the spy when it was last called.
Fixing these tests uncovered several concerning issues with our test
runner. I spent a while tracking down why our participant-text-field-spec
was failling every so often. I chose that spec because it was the first
spec to likely fail, thereby requiring looking at the least number of
preceding files. I tried binary searching, turning on and off, several
files beforehand only to realize that the failure rate was not determined
by a particular preceding test, but rather the existing and quantity of
preceding tests, AND the number of console.log statements I had. There is
some processor-dependent race condition going on that needs further
investigation.
I also discovered an issue with the file-download-spec. We were getting
errors about it accessing a file, which was very suspicious given the code
stubs out all fs access. This was caused due to a spec that called an
async function outside ot a `waitsForPromise` block or a `waitsFor` block.
The test completed, the spies were cleaned up, but the downstream async
chain was still running. By the time the async chain finished the runner
was already working on the next spec and the spies had been restored
(causing the real fs access to run).
Juan had an idea to kill the specs once one fails to prevent cascading
failures. I'll implement this in the next diff update
Test Plan: npm test
Reviewers: juan, halla, jackie
Differential Revision: https://phab.nylas.com/D3501
Disable other specs
Disable more broken specs
All specs turned off till passing state
Use async-safe versions of spec functions
Add async test spec
Remove unused package code
Remove canary spec
2016-12-13 04:12:20 +08:00
|
|
|
afterEach: this._makeSurroundAsync(jasmineExports.afterEach),
|
|
|
|
beforeEach: this._makeSurroundAsync(jasmineExports.beforeEach),
|
2016-10-17 07:36:49 +08:00
|
|
|
testNowMoment: jasmineExtensions.testNowMoment,
|
2016-10-17 05:53:17 +08:00
|
|
|
waitsForPromise: jasmineExtensions.waitsForPromise,
|
2016-10-17 07:36:49 +08:00
|
|
|
}, nylasTestConstants)
|
|
|
|
|
|
|
|
this.jasmineEnv = jasmineExports.jasmine.getEnv();
|
|
|
|
}
|
|
|
|
|
fix(spec): add support for async specs and disable misbehaving ones
More spec fixes
replace process.nextTick with setTimeout(fn, 0) for specs
Also added an unspy in the afterEach
Temporarily disable specs
fix(spec): start fixing specs
Summary:
This is the WIP fix to our spec runner.
Several tests have been completely commented out that will require
substantially more work to fix. These have been added to our sprint
backlog.
Other tests have been fixed to update to new APIs or to deal with genuine
bugs that were introduced without our knowing!
The most common non-trivial change relates to observing the `NylasAPI` and
`NylasAPIRequest`. We used to observe the arguments to `makeRequest`.
Unfortunately `NylasAPIRequest.run` is argumentless. Instead you can do:
`NylasAPIRequest.prototype.run.mostRecentCall.object.options` to get the
`options` passed into the object. the `.object` property grabs the context
of the spy when it was last called.
Fixing these tests uncovered several concerning issues with our test
runner. I spent a while tracking down why our participant-text-field-spec
was failling every so often. I chose that spec because it was the first
spec to likely fail, thereby requiring looking at the least number of
preceding files. I tried binary searching, turning on and off, several
files beforehand only to realize that the failure rate was not determined
by a particular preceding test, but rather the existing and quantity of
preceding tests, AND the number of console.log statements I had. There is
some processor-dependent race condition going on that needs further
investigation.
I also discovered an issue with the file-download-spec. We were getting
errors about it accessing a file, which was very suspicious given the code
stubs out all fs access. This was caused due to a spec that called an
async function outside ot a `waitsForPromise` block or a `waitsFor` block.
The test completed, the spies were cleaned up, but the downstream async
chain was still running. By the time the async chain finished the runner
was already working on the next spec and the spies had been restored
(causing the real fs access to run).
Juan had an idea to kill the specs once one fails to prevent cascading
failures. I'll implement this in the next diff update
Test Plan: npm test
Reviewers: juan, halla, jackie
Differential Revision: https://phab.nylas.com/D3501
Disable other specs
Disable more broken specs
All specs turned off till passing state
Use async-safe versions of spec functions
Add async test spec
Remove unused package code
Remove canary spec
2016-12-13 04:12:20 +08:00
|
|
|
|
|
|
|
_runAsync(userFn) {
|
|
|
|
if (!userFn) return true
|
|
|
|
const resp = userFn.apply(this);
|
|
|
|
if (resp && resp.then) {
|
|
|
|
return jasmineExtensions.waitsForPromise(() => {
|
|
|
|
return resp
|
|
|
|
})
|
|
|
|
}
|
|
|
|
return resp
|
|
|
|
}
|
|
|
|
|
|
|
|
_makeItAsync(jasmineIt) {
|
|
|
|
const self = this;
|
|
|
|
return (desc, userFn) => {
|
|
|
|
return jasmineIt(desc, function asyncIt() {
|
|
|
|
self._runAsync.call(this, userFn)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
_makeSurroundAsync(jasmineBeforeAfter) {
|
|
|
|
const self = this;
|
|
|
|
return (userFn) => {
|
|
|
|
return jasmineBeforeAfter(function asyncBeforeAfter() {
|
|
|
|
self._runAsync.call(this, userFn)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-10-17 07:36:49 +08:00
|
|
|
_setupJasmine() {
|
|
|
|
this._addReporters()
|
|
|
|
this._initializeDOM()
|
|
|
|
this._extendJasmineMethods();
|
2016-10-17 04:11:36 +08:00
|
|
|
|
|
|
|
// On load, this will require "jasmine-focused" which looks up the
|
|
|
|
// global `jasmine` object and extends onto it:
|
2016-10-17 04:17:34 +08:00
|
|
|
// fdescribe, ffdescribe, fffdescribe, fit, ffit, fffit
|
|
|
|
require('jasmine-tagged');
|
|
|
|
|
2016-10-17 07:36:49 +08:00
|
|
|
// On load this will extend jasmine's `beforeEach`
|
|
|
|
require('jasmine-json');
|
2016-10-17 04:17:34 +08:00
|
|
|
}
|
|
|
|
|
2016-10-17 07:36:49 +08:00
|
|
|
_setupNylasEnv() {
|
|
|
|
// We need to mock the config even before `beforeEach` runs because it
|
|
|
|
// gets accessed on module definitions
|
|
|
|
const fakePersistedConfig = {env: 'production'};
|
|
|
|
NylasEnv.config = new Config();
|
|
|
|
NylasEnv.config.settings = fakePersistedConfig;
|
|
|
|
|
|
|
|
NylasEnv.restoreWindowDimensions();
|
|
|
|
NylasEnv.themes.loadBaseStylesheets();
|
2016-10-28 03:24:13 +08:00
|
|
|
NylasEnv.themes.requireStylesheet('../../static/jasmine');
|
2016-10-17 07:36:49 +08:00
|
|
|
NylasEnv.themes.initialLoadComplete = true;
|
|
|
|
NylasEnv.keymaps.loadKeymaps();
|
|
|
|
}
|
|
|
|
|
|
|
|
_setupWindow() {
|
|
|
|
window.addEventListener('core:close', () => window.close());
|
|
|
|
window.addEventListener('beforeunload', () => {
|
|
|
|
NylasEnv.storeWindowDimensions();
|
|
|
|
return NylasEnv.saveSync();
|
|
|
|
});
|
|
|
|
|
|
|
|
// On load this will extend the window object
|
|
|
|
require('../../src/window');
|
2016-10-17 04:17:34 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
_addReporters() {
|
|
|
|
const timeReporter = new TimeReporter();
|
|
|
|
const consoleReporter = new ConsoleReporter();
|
|
|
|
|
|
|
|
// This needs to be `required` at runtime because terminal-reporter
|
|
|
|
// depends on jasmine-tagged, which depends on jasmine-focused, which
|
|
|
|
// on require will attempt to extend the `jasmine` object with
|
|
|
|
// methods. The `jasmine` object has to be attached to the global
|
|
|
|
// scope before it gets extended. This is done in
|
|
|
|
// `_extendGlobalWindow`.
|
|
|
|
const N1TerminalReporter = require('./terminal-reporter').default
|
|
|
|
|
|
|
|
const terminalReporter = new N1TerminalReporter();
|
|
|
|
|
|
|
|
if (NylasEnv.getLoadSettings().showSpecsInWindow) {
|
|
|
|
this.jasmineEnv.addReporter(N1GuiReporter);
|
2016-10-28 03:44:22 +08:00
|
|
|
NylasEnv.show();
|
2016-10-17 04:17:34 +08:00
|
|
|
} else {
|
|
|
|
this.jasmineEnv.addReporter(terminalReporter);
|
|
|
|
}
|
|
|
|
this.jasmineEnv.addReporter(timeReporter);
|
|
|
|
this.jasmineEnv.addReporter(consoleReporter);
|
|
|
|
}
|
|
|
|
|
|
|
|
_initializeDOM() {
|
|
|
|
const div = document.createElement('div');
|
|
|
|
div.id = 'jasmine-content';
|
|
|
|
document.body.appendChild(div);
|
2016-10-17 07:36:49 +08:00
|
|
|
document.querySelector('html').style.overflow = 'initial';
|
|
|
|
document.querySelector('body').style.overflow = 'initial';
|
2016-10-28 03:44:22 +08:00
|
|
|
document.getElementById("application-loading-cover").remove();
|
2016-10-17 07:36:49 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
_extendJasmineMethods() {
|
|
|
|
const jasmine = jasmineExports.jasmine;
|
|
|
|
|
|
|
|
// Use underscore's definition of equality for toEqual assertions
|
|
|
|
jasmine.getEnv().addEqualityTester(_.isEqual);
|
|
|
|
|
|
|
|
jasmine.unspy = jasmineExtensions.unspy
|
|
|
|
jasmine.attachToDOM = jasmineExtensions.attachToDOM
|
|
|
|
|
|
|
|
const origEmitObject = jasmine.StringPrettyPrinter.prototype.emitObject;
|
|
|
|
jasmine.StringPrettyPrinter.prototype.emitObject = function emitObject(obj) {
|
|
|
|
if (obj.inspect) {
|
|
|
|
return this.append(obj.inspect());
|
|
|
|
}
|
|
|
|
return origEmitObject.call(this, obj);
|
|
|
|
};
|
2016-10-17 04:17:34 +08:00
|
|
|
}
|
2016-10-17 04:11:36 +08:00
|
|
|
}
|
|
|
|
export default new N1SpecRunner()
|