tests: Clean up stubs automatically.

Signed-off-by: Anders Kaseorg <[email protected]>

Author: andersk

README.md

@@ -168,10 +168,9 @@ describe('Users', () => {
       already_subscribed: {},
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output); // Stub the network modules.
+    common.stubNetwork(validator, output); // Stub the network modules.
     const data = await users(common.config).retrieve(params);
     data.should.have.property('result', 'success'); // Function call.
-    common.restoreStubs(stubs); // Restore the stubs.
   });
 });
 ```

test/common.js

@@ -29,19 +29,17 @@ const getFakes = (validator, output) => {
   };
 };
 
-const getStubs = (validator, output) => {
-  const stubs = [];
+const sandbox = sinon.createSandbox();
+
+const stubNetwork = (validator, output) => {
   const fakes = getFakes(validator, output);
-  stubs.push(sinon.stub(helper, 'fetch').callsFake(fakes.fetch));
-  stubs.push(sinon.stub(helper, 'FormData').callsFake(fakes.FormData));
-  return stubs;
+  sandbox.stub(helper, 'fetch').callsFake(fakes.fetch);
+  sandbox.stub(helper, 'FormData').callsFake(fakes.FormData);
 };
 
-const restoreStubs = (stubs) => {
-  stubs.forEach((stub) => {
-    stub.restore();
-  });
-};
+afterEach(() => {
+  sandbox.restore();
+});
 
 const config = {
   username: '[email protected]',
@@ -52,7 +50,6 @@ const config = {
 
 module.exports = {
   getFakes,
-  getStubs,
-  restoreStubs,
+  stubNetwork,
   config,
 };

test/index.js

@@ -27,7 +27,7 @@ describe('Index', () => {
       ]);
     };
     const z = await lib(common.config);
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     (await z.callEndpoint('/testurl', 'GET', params)).should.have.property(
       'result',
       'success'
@@ -36,7 +36,6 @@ describe('Index', () => {
       'result',
       'success'
     );
-    common.restoreStubs(stubs);
   });
   it('should call post endpoints', async () => {
     const validator = (url, options) => {
@@ -47,7 +46,7 @@ describe('Index', () => {
       options.body.data.two.should.equal(params.two);
     };
     const z = await lib(common.config);
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     (await z.callEndpoint('/testurl', 'POST', params)).should.have.property(
       'result',
       'success'
@@ -56,6 +55,5 @@ describe('Index', () => {
       'result',
       'success'
     );
-    common.restoreStubs(stubs);
   });
 });

test/resources/accounts.js

@@ -27,10 +27,9 @@ describe('Accounts', () => {
       api_key: 'randomcharactersonlyq32YIpC8aMSH',
       email: config.email,
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await accounts(config).retrieve();
     data.result.should.be.equal('success');
-    common.restoreStubs(stubs);
   });
 
   it('should return error on incorrect password', async () => {
@@ -39,9 +38,8 @@ describe('Accounts', () => {
       msg: 'Your username or password is incorrect.',
       reason: 'incorrect_creds',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await accounts(config).retrieve();
     data.result.should.be.equal('error');
-    common.restoreStubs(stubs);
   });
 });

test/resources/emojis.js

@@ -22,9 +22,8 @@ describe('Emojis', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await emojis(common.config).retrieve();
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 });

test/resources/events.js

@@ -32,9 +32,8 @@ describe('Events', () => {
       msg: '',
       queue_id: '1511901550:3',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await events(common.config).retrieve(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 });

test/resources/filters.js

@@ -22,9 +22,8 @@ describe('Filters', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await filters(common.config).retrieve();
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 });

test/resources/messages.js

@@ -26,10 +26,9 @@ describe('Messages', () => {
       msg: '',
       id: 168,
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).send(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should fetch messages from test stream', async () => {
@@ -57,10 +56,9 @@ describe('Messages', () => {
       msg: '',
       messages: [], // TODO expand test with actual API message data.
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).retrieve(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should render messages', async () => {
@@ -78,12 +76,11 @@ describe('Messages', () => {
       msg: '',
       rendered: '<p>Hello <strong>world</strong></p>',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     let data = await messages(common.config).render(params);
     data.should.have.property('result', 'success');
     data = await messages(common.config).render(params.content);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should update message', async () => {
@@ -100,10 +97,9 @@ describe('Messages', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).update(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should get message by id', async () => {
@@ -119,10 +115,9 @@ describe('Messages', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).getById(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should get message history by id', async () => {
@@ -138,10 +133,9 @@ describe('Messages', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).getHistoryById(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should mark message as read', async () => {
@@ -163,10 +157,9 @@ describe('Messages', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).flags.add(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should mark message as unread', async () => {
@@ -187,10 +180,9 @@ describe('Messages', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).flags.remove(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should delete reaction by message id', async () => {
@@ -206,10 +198,9 @@ describe('Messages', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).deleteReactionById(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should delete message by message id', async () => {
@@ -225,9 +216,8 @@ describe('Messages', () => {
       msg: '',
       result: 'success',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await messages(common.config).deleteById(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 });

test/resources/queues.js

@@ -23,10 +23,9 @@ describe('Queues', () => {
       Object.keys(options.body.data).length.should.be.equal(1);
       options.body.data.event_types.should.be.equal('["message"]');
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await queues(common.config).register(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should deregister queue', async () => {
@@ -42,9 +41,8 @@ describe('Queues', () => {
       options.method.should.be.equal('DELETE');
       options.should.not.have.property('body');
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await queues(common.config).deregister(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 });

test/resources/reactions.js

@@ -26,10 +26,9 @@ describe('Reactions', () => {
       result: 'success',
       msg: '',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await reactions(common.config).add(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 
   it('should remove reaction from message', async () => {
@@ -49,9 +48,8 @@ describe('Reactions', () => {
       result: 'success',
       msg: '',
     };
-    const stubs = common.getStubs(validator, output);
+    common.stubNetwork(validator, output);
     const data = await reactions(common.config).remove(params);
     data.should.have.property('result', 'success');
-    common.restoreStubs(stubs);
   });
 });