Write a wrapper to eliminate done callbacks from async tests

spec/atom-paths-spec.js

@@ -41,14 +41,16 @@ describe('AtomPaths', () => {
         expect(process.env.ATOM_HOME).toEqual(portableAtomHomePath);
       });
 
-      it('uses ATOM_HOME if no write access to portable .atom folder', () => {
-        jasmine.filterByPlatform({except: ['win32']});
+      it('uses ATOM_HOME if no write access to portable .atom folder', (done) => {
+        jasmine.filterByPlatform({except: ['win32']}, done);
 
         const readOnlyPath = temp.mkdirSync('atom-path-spec-no-write-access');
         process.env.ATOM_HOME = readOnlyPath;
         fs.chmodSync(portableAtomHomePath, 444);
         atomPaths.setAtomHome(app.getPath('home'));
         expect(process.env.ATOM_HOME).toEqual(readOnlyPath);
+
+        done();
       });
     });
 
@@ -119,14 +121,16 @@ describe('AtomPaths', () => {
         expect(app.getPath('userData')).toEqual(electronUserDataPath);
       });
 
-      it('leaves userData unchanged if no write access to electronUserData folder', () => {
-        jasmine.filterByPlatform({except: ['win32']});
+      it('leaves userData unchanged if no write access to electronUserData folder', (done) => {
+        jasmine.filterByPlatform({except: ['win32']}, done);
 
         fs.mkdirSync(electronUserDataPath);
         fs.chmodSync(electronUserDataPath, 444);
         atomPaths.setUserData(app);
         fs.chmodSync(electronUserDataPath, 666);
         expect(app.getPath('userData')).toEqual(defaultElectronUserDataPath);
+
+        done();
       });
     });
 

spec/buffered-node-process-spec.js

@@ -3,7 +3,7 @@ const path = require('path');
 const BufferedNodeProcess = require('../src/buffered-node-process');
 
 describe('BufferedNodeProcess', function() {
-  it('executes the script in a new process', async function(done) {
+  it('executes the script in a new process', async function() {
     let output = '';
     const stdout = lines => (output += lines);
     let error = '';
@@ -18,11 +18,9 @@ describe('BufferedNodeProcess', function() {
     expect(output).toBe('hi');
     expect(error).toBe('');
     expect(args).toEqual(['hi']);
-
-    done();
   });
 
-  it('suppresses deprecations in the new process', async function(done) {
+  it('suppresses deprecations in the new process', async function() {
     const exit = jasmine.createSpy('exitCallback');
     let output = '';
     const stdout = lines => (output += lines);
@@ -40,7 +38,5 @@ describe('BufferedNodeProcess', function() {
 
     expect(output).toBe('hi');
     expect(error).toBe('');
-
-    done();
   });
 });

spec/buffered-process-spec.js

@@ -14,7 +14,7 @@ describe('BufferedProcess', function() {
 
     describe('when there is an error handler specified', function() {
       describe('when an error event is emitted by the process', () =>
-        it('calls the error handler and does not throw an exception', async function(done) {
+        it('calls the error handler and does not throw an exception', async function() {
           const bufferedProcess = new BufferedProcess({
             command: 'bad-command-nope1',
             args: ['nothing'],
@@ -36,12 +36,10 @@ describe('BufferedProcess', function() {
           expect(errorSpy.calls.mostRecent().args[0].error.message).toContain(
             'spawn bad-command-nope1 ENOENT'
           );
-
-          done();
         }));
 
       describe('when an error is thrown spawning the process', () =>
-        it('calls the error handler and does not throw an exception', async function(done) {
+        it('calls the error handler and does not throw an exception', async function() {
           spyOn(ChildProcess, 'spawn').and.callFake(function() {
             const error = new Error('Something is really wrong');
             error.code = 'EAGAIN';
@@ -69,13 +67,11 @@ describe('BufferedProcess', function() {
           expect(errorSpy.calls.mostRecent().args[0].error.message).toContain(
             'Something is really wrong'
           );
-
-          done();
         }));
     });
 
     describe('when there is not an error handler specified', () =>
-      it('does throw an exception', async function(done) {
+      it('does throw an exception', async function() {
         await new Promise((resolve) => {
           window.onerror.and.callFake(resolve);
 
@@ -93,8 +89,6 @@ describe('BufferedProcess', function() {
         expect(window.onerror.calls.mostRecent().args[4].name).toBe(
           'BufferedProcessError'
         );
-
-        done();
       }));
   });
 
@@ -103,7 +97,7 @@ describe('BufferedProcess', function() {
     * TODO: FAILING TEST - This test fails with the following output:
     * timeout: timed out after 120000 msec waiting for condition
     */
-    xit('doesnt start unless start method is called', async function(done) {
+    xit('doesnt start unless start method is called', async function() {
       let stdout = '';
       let stderr = '';
       const exitCallback = jasmine.createSpy('exit callback');
@@ -134,14 +128,12 @@ describe('BufferedProcess', function() {
 
       expect(stderr).toContain('apm - Atom Package Manager');
       expect(stdout).toEqual('');
-
-      done();
     }));
   /**
   * TODO: FAILING TEST - This test fails with the following output:
   * timeout: timed out after 120000 msec waiting for condition
   */
-  xit('calls the specified stdout, stderr, and exit callbacks', async function(done) {
+  xit('calls the specified stdout, stderr, and exit callbacks', async function() {
     let stdout = '';
     let stderr = '';
 
@@ -164,7 +156,7 @@ describe('BufferedProcess', function() {
     expect(stdout).toEqual('');
   });
 
-  it('calls the specified stdout callback with whole lines', async function(done) {
+  it('calls the specified stdout callback with whole lines', async function() {
     const exitCallback = jasmine.createSpy('exit callback');
     const loremPath = require.resolve('./fixtures/lorem.txt');
     const content = fs.readFileSync(loremPath).toString();
@@ -191,8 +183,6 @@ describe('BufferedProcess', function() {
 
     expect(allLinesEndWithNewline).toBe(true);
     expect(stdout).toBe(content);
-
-    done();
   });
 
   describe('on Windows', function() {

spec/command-registry-spec.js

@@ -387,7 +387,7 @@ describe('CommandRegistry', () => {
       expect(registry.dispatch(parent, 'command')).toBe(null);
     });
 
-    it('returns a promise that resolves when the listeners resolve', async (done) => {
+    it('returns a promise that resolves when the listeners resolve', async () => {
       jasmine.useRealClock();
       registry.add('.grandchild', 'command', () => 1);
       registry.add('.grandchild', 'command', () => Promise.resolve(2));
@@ -404,10 +404,9 @@ describe('CommandRegistry', () => {
 
       const values = await registry.dispatch(grandchild, 'command');
       expect(values).toEqual([3, 2, 1]);
-      done();
     });
 
-    it('returns a promise that rejects when a listener is rejected', async (done) => {
+    it('returns a promise that rejects when a listener is rejected', async () => {
       jasmine.useRealClock();
       registry.add('.grandchild', 'command', () => 1);
       registry.add('.grandchild', 'command', () => Promise.resolve(2));
@@ -429,7 +428,6 @@ describe('CommandRegistry', () => {
         value = err;
       }
       expect(value).toBe(3);
-      done();
     });
   });
 

spec/config-file-spec.js

@@ -18,28 +18,24 @@ describe('ConfigFile', () => {
   });
 
   describe('when the file does not exist', () => {
-    it('returns an empty object from .get()', async (done) => {
+    it('returns an empty object from .get()', async () => {
       configFile = new ConfigFile(filePath);
       subscription = await configFile.watch();
       expect(configFile.get()).toEqual({});
-
-      done();
     });
   });
 
   describe('when the file is empty', () => {
-    it('returns an empty object from .get()', async (done) => {
+    it('returns an empty object from .get()', async () => {
       writeFileSync(filePath, '');
       configFile = new ConfigFile(filePath);
       subscription = await configFile.watch();
       expect(configFile.get()).toEqual({});
-
-      done();
     });
   });
 
   describe('when the file is updated with valid CSON', () => {
-    it('notifies onDidChange observers with the data', async (done) => {
+    it('notifies onDidChange observers with the data', async () => {
       configFile = new ConfigFile(filePath);
       subscription = await configFile.watch();
 
@@ -65,13 +61,11 @@ describe('ConfigFile', () => {
         '*': { foo: 'bar' },
         javascript: { foo: 'baz' }
       });
-
-      done();
     });
   });
 
   describe('when the file is updated with invalid CSON', () => {
-    it('notifies onDidError observers', async (done) => {
+    it('notifies onDidError observers', async () => {
       configFile = new ConfigFile(filePath);
       subscription = await configFile.watch();
 
@@ -105,8 +99,6 @@ describe('ConfigFile', () => {
         '*': { foo: 'bar' },
         javascript: { foo: 'baz' }
       });
-
-      done();
     });
   });
 

spec/config-spec.js

@@ -1042,7 +1042,7 @@ describe('Config', () => {
       atom.config.onDidChange('foo.bar.baz', changeSpy);
     });
 
-    it('allows only one change event for the duration of the given promise if it gets resolved', async (done) => {
+    it('allows only one change event for the duration of the given promise if it gets resolved', async () => {
       let promiseResult = null;
       const transactionPromise = atom.config.transactAsync(() => {
         atom.config.set('foo.bar.baz', 1);
@@ -1059,11 +1059,9 @@ describe('Config', () => {
         newValue: 3,
         oldValue: undefined
       });
-
-      done();
     });
 
-    it('allows only one change event for the duration of the given promise if it gets rejected', async (done) => {
+    it('allows only one change event for the duration of the given promise if it gets rejected', async () => {
       let promiseError = null;
       const transactionPromise = atom.config.transactAsync(() => {
         atom.config.set('foo.bar.baz', 1);
@@ -1082,11 +1080,9 @@ describe('Config', () => {
         newValue: 3,
         oldValue: undefined
       });
-
-      done();
     });
 
-    it('allows only one change event even when the given callback throws', async (done) => {
+    it('allows only one change event even when the given callback throws', async () => {
       const error = new Error('Oops!');
       let promiseError = null;
       const transactionPromise = atom.config.transactAsync(() => {
@@ -1106,8 +1102,6 @@ describe('Config', () => {
         newValue: 3,
         oldValue: undefined
       });
-
-      done();
     });
   });
 

spec/decoration-manager-spec.js

@@ -4,16 +4,14 @@ const TextEditor = require('../src/text-editor');
 describe('DecorationManager', function() {
   let decorationManager, buffer, editor, markerLayer1, markerLayer2;
 
-  beforeEach(async function(done) {
+  beforeEach(async function() {
     buffer = atom.project.bufferForPathSync('sample.js');
     editor = new TextEditor({ buffer });
     markerLayer1 = editor.addMarkerLayer();
     markerLayer2 = editor.addMarkerLayer();
     decorationManager = new DecorationManager(editor);
 
     await atom.packages.activatePackage('language-javascript');
-
-    done();
   });
 
   afterEach(() => buffer.destroy());

spec/default-directory-provider-spec.js

@@ -33,8 +33,8 @@ describe('DefaultDirectoryProvider', function() {
       expect(directory.getPath()).toEqual(tmp);
     });
 
-    it('normalizes disk drive letter in path on win32', function() {
-      jasmine.filterByPlatform({only: ['win32']});
+    it('normalizes disk drive letter in path on win32', function(done) {
+      jasmine.filterByPlatform({only: ['win32']}, done);
 
       const provider = new DefaultDirectoryProvider();
       const nonNormalizedPath = tmp[0].toLowerCase() + tmp.slice(1);
@@ -43,6 +43,8 @@ describe('DefaultDirectoryProvider', function() {
 
       const directory = provider.directoryForURISync(nonNormalizedPath);
       expect(directory.getPath()).toEqual(tmp);
+
+      done()
     });
 
     it('creates a Directory for its parent dir when passed a file', function() {
@@ -63,12 +65,10 @@ describe('DefaultDirectoryProvider', function() {
   });
 
   describe('.directoryForURI(uri)', () =>
-    it('returns a Promise that resolves to a Directory with a path that matches the uri', async function(done) {
+    it('returns a Promise that resolves to a Directory with a path that matches the uri', async function() {
       const provider = new DefaultDirectoryProvider();
 
       let directory = await provider.directoryForURI(tmp);
       expect(directory.getPath()).toEqual(tmp);
-
-      done();
     }));
 });

spec/default-directory-searcher-spec.js

@@ -11,7 +11,7 @@ describe('DefaultDirectorySearcher', function() {
     searcher = new DefaultDirectorySearcher();
   });
 
-  it('terminates the task after running a search', async function(done) {
+  it('terminates the task after running a search', async function() {
     const options = {
       ignoreCase: false,
       includeHidden: false,
@@ -38,7 +38,5 @@ describe('DefaultDirectorySearcher', function() {
     );
 
     expect(Task.prototype.terminate).toHaveBeenCalled();
-
-    done();
   });
 });