Mocks & Spies - shouldBeCalledTimes()
Keep on Learning!
If you liked what you've learned so far, dive in! Subscribe to get access to this tutorial plus video, code and script downloads.
With a Subscription, click any sentence in the script to jump to that part of the video!
Login SubscribeHey! We are experts when it comes to controlling the return value of any method on a test double. Here, we told it that when growVelociraptor() is called with any integer argument, return $dino1 the first time and $dino2 the second time.
By doing this, we also added some expectations. Because, as soon as you control the return value of one method call, then you must control the behavior of all method calls. And so if a different method is called or different arguments are passed to this method, the tests will fail.
But what this does not guarantee is that growVelociraptor() was actually called... or how many times it was called. Nope, we're saying, if it's called, it must be called with this argument... and here's what to return. But technically, if it were called zero times, this part would not fail!
And that's what I want to talk about now: sometimes it is super important to make sure a method was called... or was called exactly three times... or was not called! For example, what if we wanted to be absolutely sure that growVelociraptor() was called exactly two times? We can do that, and it starts the same way: $dinosaurFactory->growVelociraptor(Argument::type('integer')). But then, instead of willReturn(), use shouldBeCalledTimes(2).
| // ... lines 1 - 18 | |
| function it_builds_enclosure_with_dinosaurs(DinosaurFactory $dinosaurFactory) | |
| { | |
| // ... lines 21 - 29 | |
| $dinosaurFactory->growVelociraptor(Argument::type('integer')) | |
| ->shouldBeCalledTimes(2); | |
| // ... lines 32 - 38 | |
| } | |
| // ... lines 40 - 41 |
This feels familiar... because it's exactly like what we've been doing! It looks like a matcher! It's identical to $this->shoudHaveType(), for example.
Now that we're asserting that this method should be called twice, run phpspec:
./vendor/bin/phpspec run spec/Service/EnclosureBuilderServiceSpec.php:19
Nice! It passes! What does it look like to fail? Change this to 3... and try it again:
./vendor/bin/phpspec run spec/Service/EnclosureBuilderServiceSpec.php:19
Perfect: Expected exactly 3 calls that match growVelociraptor() with type integer, but 2 were made.
Re-Using the "Promise" for Stubbing & Mocking
Change this back to 2. But notice: there's some duplication here: we're repeating the $dinosaurFactory->growVelociraptor(Argument::type('integer')) part when we need to control the return value and when we want to assert how many times it was called. We can totally remove that. Chain the ->shouldBeCalledTimes() onto the end of the first call.
| // ... lines 1 - 18 | |
| function it_builds_enclosure_with_dinosaurs(DinosaurFactory $dinosaurFactory) | |
| { | |
| // ... lines 21 - 25 | |
| $dinosaurFactory->growVelociraptor(Argument::type('integer'))->willReturn( | |
| $dino1, | |
| $dino2 | |
| )->shouldBeCalledTimes(2); | |
| // ... lines 30 - 36 | |
| } | |
| // ... lines 38 - 39 |
Try it!
./vendor/bin/phpspec run spec/Service/EnclosureBuilderServiceSpec.php:19
Nice! It's sort of a low-level detail, but when we call $dinosaurFactory->growVelociraptor(), that returns what's called a "method prophecy" object... and we can then add "promises" to it - that's the willReturn() stuff - or predictions - that's the shouldBeCalledTimes() stuff. What's interesting is that, if you call a method on a stub two times and pass it the same exact Argument stuff, prophecy will return the same MethodProphecy object. In other words, if you called willReturn() multiple times, the second would override the first.
If that doesn't totally make sense - forget about it - it's just some low-level coolness I wanted to mention while we were here.
Predicting After (Spies)
Anyways, when you want to add a "prediction"... basically, an expectation that a method should be called an exact number of times, you can do it in two different ways... and it's just a matter of style. First, you can do it like we just did: call ->shouldBeCalledTimes() and then execute the code.
Or, you can put the assertion stuff after you run your code. Check this out: remove the ->shouldBeCalledTimes() line. Then, anywhere after we call buildEnclosure(), start with $dinosaurFactory->growVelociraptor(Argument::any()) and then ->shouldHaveBeenCalledTimes(2).
| // ... lines 1 - 18 | |
| function it_builds_enclosure_with_dinosaurs(DinosaurFactory $dinosaurFactory) | |
| { | |
| // ... lines 21 - 25 | |
| $dinosaurFactory->growVelociraptor(Argument::type('integer'))->willReturn( | |
| $dino1, | |
| $dino2 | |
| ); | |
| // ... lines 30 - 37 | |
| $dinosaurFactory->growVelociraptor(Argument::any()) | |
| ->shouldHaveBeenCalledTimes(2); | |
| } | |
| // ... lines 41 - 42 |
This does the exact same thing... it's just a different style. Oh, and I used Argument::any() down here instead of type(), but not for any special reason: I'm just showing how we can make sure that this method is called exactly 2 times, regardless of the arguments.
Let's try this!
./vendor/bin/phpspec run spec/Service/EnclosureBuilderServiceSpec.php:19
We're green! Next: let's take a super-quick tour into the phpspec documentation where we'll see test doubles, dummies, mocks and spies... hiding within its text.
