method to reset spy object about chai-spies HOT 11 CLOSED

Jasmine automatically cleans up all spies in afterEach callback

What you need to do is to add

afterEach()=>{
  chai.spy.restore(class, ‘anotherFunction')
})

from chai-spies.

Spies do not currently have a reset. I think it'd be a good idea to add one, and fairly simple to add.

Personally, I'd take the existing metadata assignment (L74-L78) and put it into the reset method, then call reset in the factory, so L74-L80 look more like:

    proxy.reset = function () {
        this.__spy = {
            calls: []
          , called: false
          , name: name
        };
        return this;
    }
    return proxy.reset();

Of course, if you were to make a PR, I'd expect some good test coverage to be present for this feature 😄.

from chai-spies.

fantastic! Let me see if I can get to this today

from chai-spies.

PR #28 created, thanks

from chai-spies.

Thanks @keithamus

from chai-spies.

@d48 could you please describe a use case where you had a need in .reset() method?

from chai-spies.

Like if you have a mocked object and you're using the same instance of it for multiple test cases.

from chai-spies.

The property of good tests is that it should start from clean state otherwise you can’t rely on results.

from chai-spies.

Definitely. I'm just describing a possible scenario where it might be useful. For example you have 3 tests which you embed in a describe block and create a mocked object only once in beforeEach.
Then it might be useful

from chai-spies.

I am coming from jasmine and really confused here, how would you test like this:

describe('myFunction', () => {
  describe('when another function returns true', () => {
    beforeEach(() => {
      chai.spy.on(class, 'anotherFunction', () => true);
    });

    it('should pass', () => {
      expect(myFunction()).to.equal(1);
    });
  });

  describe('when another function returns false', () => {
    beforeEach(() => {
      chai.spy.on(class, 'anotherFunction', () => false);
    });

    it('should not pass', () => {
      expect(myFunction()).to.equal(0);
    });
  });
});

but it tells me that the function is already a spy, even though the spies are not under the same describe (which totally works in jasmine thankfully)

from chai-spies.

hi @stalniy, sure, I can answer a possible use case. It's a convenience method on your spy when making multiple calls to it that you can inspect, and maybe you want to reset after interacting with the spy.

And same as you just mentioned above, it can be used in an afterEach block to reuse if the spy is cached to a var

from chai-spies.