Behaviour Driven Development (BDD)

How to fix: You have requested a non-existent service “test.client” with Behat 3

So, it’s been a long day of development.

And the last 50 minutes have been particularly painful.

I’ve been bringing FOSUserBundle, Dunglas API Bundle, Lexik JWT Bundle, and Behat (amongst a good few others) together into one project for the first time.

Most of today has been productive. I’ve solved two of my big headaches, but as the hours have gone by, tiredness has set in.

And rather than call it a night, I did my usual “I’ll just see if I can…” once too many times, and buggered everything up.

If I had been behaving, I could have quickly done a little git bisect magic and found the source of my woes. Alas, I had not been behaving.

Anyway, the issue:

Run bin/behat , encounter error:

  [Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException]
  You have requested a non-existent service "test.client".

1 2	[Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException] You have requested a non-existent service "test.client".

Wot do?

Well, there is a major shortage of Google help on this one.

The two most likely answers were not it.

Behat had been working just fine. I knew it was my mistake. But the project is growing and there’s just a ton of possible files that could have changed. When will I learn?

As it turned out, I had changed my behat.yml file in my tired stupor:

# behat.yml 
 extensions:
    Behat\Symfony2Extension:
      kernel:
        env: "test"
        debug: "true"

# behat.yml

extensions:

Behat\Symfony2Extension:

kernel:

env: "test"

debug: "true"

I’d changed env to a new Symfony Environment I had created so as not to keep messing up my local dev database every time I re-ran behat.

In my case changing back to env: "test" solved all my problems.

Ok, well not all of them… plenty of work still to do. But that’s it for this evening.

I hope that saves someone a headache in the future.

Time to commit and go to bed.

Mocking Collections in PHPSpec

I’m a huge fan of PHPSpec, and its close cousin, Behat. I find when writing code in conjunction with PHPSpec, I am able to enter a rhythm that I have never found with any other tool.

I particularly enjoy the code generation functionality – describe some action, do a bin/phpspec run and have your methods created for you as you go. It really is quite a joy to use.

However, as with any tool, there is a learning curve.

I found the basics – the stuff described in the manual – to be straightforward enough that even when stuck, I could relatively quickly find my way through and get back on track.

Then, recently, I decided to build an application involving third party / social media providers for authentication using HWIOAuthBundle.

Along the way, I added the concept of a User object having a Collection ( Doctrine\Common\Collections\Collection) of Account objects. Fairly common stuff, particularly if you have ever used Symfony at all.

The very basic idea would be something like this:

<?php

namespace AppBundle\OAuth\Connect;

use HWI\Bundle\OAuthBundle\OAuth\Response\UserResponseInterface;
use HWI\Bundle\OAuthBundle\Security\Core\User\FOSUBUserProvider as BaseClass;
use FOS\UserBundle\Model\UserManagerInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Security\Core\User\UserInterface;

class ProfileConnector extends BaseClass
{
    /**
     * @var RequestStack
     */
    private $requestStack;

    public function injectRequestStack(RequestStack $requestStack)
    {
        $this->requestStack = $requestStack;
    }

    public function connect(UserInterface $user, UserResponseInterface $response)
    {
        $req = $this->requestStack->getMasterRequest();

        if ( ! $req->request->has('profiles')) {
            return false;
        }

        $selectedProfiles = $req->request->get('profiles');

        /** @var $user \AppBundle\Entity\User */
        /** @var $profile \AppBundle\Model\ProfileInterface */
        foreach ($user->getProfiles() as $profile) {
            if ( ! array_key_exists($profile->getId(), $selectedProfiles)) {
                continue;
            }
        }

        // something else here
        return true;
    }
}

<?php

namespace AppBundle\OAuth\Connect;

use HWI\Bundle\OAuthBundle\OAuth\Response\UserResponseInterface;

use HWI\Bundle\OAuthBundle\Security\Core\User\FOSUBUserProvider as BaseClass;

use FOS\UserBundle\Model\UserManagerInterface;

use Symfony\Component\HttpFoundation\RequestStack;

use Symfony\Component\Security\Core\User\UserInterface;

class ProfileConnector extends BaseClass

{

/**

* @var RequestStack

private $requestStack;

public function injectRequestStack(RequestStack $requestStack)

{

$this->requestStack = $requestStack;

}

public function connect(UserInterface $user, UserResponseInterface $response)

{

$req = $this->requestStack->getMasterRequest();

if ( ! $req->request->has('profiles')) {

return false;

}

$selectedProfiles = $req->request->get('profiles');

/** @var $user \AppBundle\Entity\User */

/** @var $profile \AppBundle\Model\ProfileInterface */

foreach ($user->getProfiles() as $profile) {

if ( ! array_key_exists($profile->getId(), $selectedProfiles)) {

continue;

}

// something else here

return true;

}

This is a work in progress, so if it looks a little rough… hey, that’s why I do TDD. The refactoring will come in time.

Seeing the tests would likely also help:

<?php

namespace spec\AppBundle\OAuth\Connect;

use Doctrine\Common\Collections\ArrayCollection;
use PhpSpec\ObjectBehavior;
use Prophecy\Argument;
use HWI\Bundle\OAuthBundle\OAuth\Response\UserResponseInterface;
use FOS\UserBundle\Model\UserManagerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use AppBundle\Model\ProfileInterface;
use AppBundle\Entity\Profile;
use AppBundle\Entity\User;
use AppBundle\Entity\SocialMediaAccount;

class ProfileConnectorSpec extends ObjectBehavior
{
    private $user;
    private $response;

    function let(UserManagerInterface $userManager, User $user, UserResponseInterface $userResponse)
    {
        $this->user = $user;
        $this->response = $userResponse;

        $this->beConstructedWith($userManager, []);
    }

    function it_is_initializable()
    {
        $this->shouldHaveType('AppBundle\OAuth\Connect\ProfileConnector');
        $this->beAnInstanceOf('HWI\Bundle\OAuthBundle\Security\Core\User\FOSUBUserProvider');
    }

    function it_can_inject_the_request_stack()
    {
        $this->injectRequestStack(new RequestStack());
    }

    function it_can_handle_no_profile_accounts_being_selected()
    {
        $requestStack = new RequestStack();
        $requestStack->push(new Request());

        $this->injectRequestStack($requestStack);

        $this->connect($this->user, $this->response)->shouldReturn(false);
    }

    function it_can_connect_one_account_to_a_social_media_service(User $user, Profile $profile)
    {
        $profile->getId()->willReturn(16);
        $profiles = new ArrayCollection([$profile->getWrappedObject()]);

        $user->getProfiles()->willReturn($profiles);

        $requestStack = new RequestStack();
        $requestStack->push(new Request([], ['profiles'=>[16=>'on']]));

        $this->injectRequestStack($requestStack);

        $this->connect($user, $this->response)->shouldReturn(true);
    }

    function it_can_connect_multiple_accounts_to_a_social_media_service()
    {

    }
}

<?php

namespace spec\AppBundle\OAuth\Connect;

use Doctrine\Common\Collections\ArrayCollection;

use PhpSpec\ObjectBehavior;

use Prophecy\Argument;

use HWI\Bundle\OAuthBundle\OAuth\Response\UserResponseInterface;

use FOS\UserBundle\Model\UserManagerInterface;

use Symfony\Component\HttpFoundation\Request;

use Symfony\Component\HttpFoundation\RequestStack;

use AppBundle\Model\ProfileInterface;

use AppBundle\Entity\Profile;

use AppBundle\Entity\User;

use AppBundle\Entity\SocialMediaAccount;

class ProfileConnectorSpec extends ObjectBehavior

{

private $user;

private $response;

function let(UserManagerInterface $userManager, User $user, UserResponseInterface $userResponse)

{

$this->user = $user;

$this->response = $userResponse;

$this->beConstructedWith($userManager, []);

}

function it_is_initializable()

{

$this->shouldHaveType('AppBundle\OAuth\Connect\ProfileConnector');

$this->beAnInstanceOf('HWI\Bundle\OAuthBundle\Security\Core\User\FOSUBUserProvider');

}

function it_can_inject_the_request_stack()

{

$this->injectRequestStack(new RequestStack());

}

function it_can_handle_no_profile_accounts_being_selected()

{

$requestStack = new RequestStack();

$requestStack->push(new Request());

$this->injectRequestStack($requestStack);

$this->connect($this->user, $this->response)->shouldReturn(false);

}

function it_can_connect_one_account_to_a_social_media_service(User $user, Profile $profile)

{

$profile->getId()->willReturn(16);

$profiles = new ArrayCollection([$profile->getWrappedObject()]);

$user->getProfiles()->willReturn($profiles);

$requestStack = new RequestStack();

$requestStack->push(new Request([], ['profiles'=>[16=>'on']]));

$this->injectRequestStack($requestStack);

$this->connect($user, $this->response)->shouldReturn(true);

}

function it_can_connect_multiple_accounts_to_a_social_media_service()

{

}

This is absolutely a work in progress. I even left in the last test, yet to be started.

As a quick side note, for the first time I have decided to declare commonly required objects by way of the let() method. I am not absolutely sure whether or not this is good practice, but it does seem to work as I intended it too. If you know differently, do let me know by way of leaving a comment – thanks !

Currently the tests are passing – with the exception of the pending example still to write.

What may be less obvious is how much effort I went through to get the it_can_connect_one_account_to_a_social_media_service() example to play ball.

I’ve spent a good few hours these past few evenings trying to figure out this error:

AppBundle/OAuth/Connect/ProfileConnector
  51  - it can connect one account to a social media service
      warning: array_key_exists(): The first argument should be either a string or an integer in
      /var/www/myproj/src/AppBundle/OAuth/Connect/ProfileConnector.php line 46

AppBundle/OAuth/Connect/ProfileConnector

51 - it can connect one account to a social media service

warning: array_key_exists(): The first argument should be either a string or an integer in

/var/www/myproj/src/AppBundle/OAuth/Connect/ProfileConnector.php line 46

When I was seeing this error, the problematic test actually looked like this:

function it_can_connect_one_account_to_a_social_media_service(User $user, Profile $profile)
{
    $profile->getId()->willReturn(16);
    $user->addProfile($profile);

    $requestStack = new RequestStack();
    $requestStack->push(new Request([], ['profiles'=>[16=>'on']]));

    $this->injectRequestStack($requestStack);

    $this->connect($user, $this->response)->shouldReturn(true);
}

function it_can_connect_one_account_to_a_social_media_service(User $user, Profile $profile)

{

$profile->getId()->willReturn(16);

$user->addProfile($profile);

$requestStack = new RequestStack();

$requestStack->push(new Request([], ['profiles'=>[16=>'on']]));

$this->injectRequestStack($requestStack);

$this->connect($user, $this->response)->shouldReturn(true);

}

A bit of Google-foo told me I was likely going about this entirely the wrong way:

When the creator of PHPSpec tells you (indirectly) that you are wrong, then… you are wrong.

I could actually see the problem – the implementation seemed correct, but PHPSpec sees my call $profile->getId() as returning an Object, and then throwing an error something along the lines of :

AppBundle/OAuth/Connect/ProfileConnector
  51  - it can connect one account to a social media service
      error: Object of class Prophecy\Prophecy\MethodProphecy could not be converted to string in
      /var/www/myproj/src/AppBundle/OAuth/Connect/ProfileConnector.php line 44

AppBundle/OAuth/Connect/ProfileConnector

51 - it can connect one account to a social media service

error: Object of class Prophecy\Prophecy\MethodProphecy could not be converted to string in

/var/www/myproj/src/AppBundle/OAuth/Connect/ProfileConnector.php line 44

At first I figured… ok, well I won’t mock the User object – I can new that up – but when trying to add a mock Profile to the real collection, it all went a bit wrong:

AppBundle/OAuth/Connect/ProfileConnector
  50  - it can connect one account to a social media service
      error: Argument 1 passed to AppBundle\Entity\User::addProfile() must implement interface
      AppBundle\Model\ProfileInterface, instance of PhpSpec\Wrapper\Collaborator given, called in
      /var/www/myproj/spec/AppBundle/OAuth/Connect/ProfileConnectorSpec.php on line 54 and defined in
      /var/www/myproj/src/AppBundle/Entity/User.php line 44

AppBundle/OAuth/Connect/ProfileConnector

50 - it can connect one account to a social media service

error: Argument 1 passed to AppBundle\Entity\User::addProfile() must implement interface

AppBundle\Model\ProfileInterface, instance of PhpSpec\Wrapper\Collaborator given, called in

/var/www/myproj/spec/AppBundle/OAuth/Connect/ProfileConnectorSpec.php on line 54 and defined in

/var/www/myproj/src/AppBundle/Entity/User.php line 44

That’s fine, I thought, I will use a real Profile object as well, because why not?

Well, I’ll tell you why not.

The test expects my Profile object to have an id of 16. I’m not about to add in a setId() method, that would be bonkers.

At heart, I knew as soon as I started adding in real objects that I was heading down the wrong path.

Generally I find that when PHPSpec is making your life hard it is because you are trying to do the wrong thing. Sooner or later you must stop resisting.

Star Trek: The Next Generation 365 (Star Trek 365) — Picard lost most of his hair due to frustrating late night bug fixing in ten forward. It’s all explained in the Season 3 episode Bynar2Hex.

Anyway, after quite ~~a bit~~ a lot of further hackery, I managed to find a working solution (as per the earlier sample):

    function it_can_connect_one_account_to_a_social_media_service(User $user, Profile $profile)
    {
        $profile->getId()->willReturn(16);
        $profiles = new ArrayCollection([$profile->getWrappedObject()]);

        $user->getProfiles()->willReturn($profiles);

        $requestStack = new RequestStack();
        $requestStack->push(new Request([], ['profiles'=>[16=>'on']]));

        $this->injectRequestStack($requestStack);

        $this->connect($user, $this->response)->shouldReturn(true);
    }

function it_can_connect_one_account_to_a_social_media_service(User $user, Profile $profile)

{

$profile->getId()->willReturn(16);

$profiles = new ArrayCollection([$profile->getWrappedObject()]);

$user->getProfiles()->willReturn($profiles);

$requestStack = new RequestStack();

$requestStack->push(new Request([], ['profiles'=>[16=>'on']]));

$this->injectRequestStack($requestStack);

$this->connect($user, $this->response)->shouldReturn(true);

}

When I think about it now, it does make sense. This is similar to what I was trying to do, only this way conforms with the way PHPSpec expects me to behave 🙂

Both the User and Profile objects are properly mocked, but as per Everzet’s comment, we are returning a real ArrayCollection, which by way of $profile->getWrappedObject() will return the underlying Profile objects, rather than the PHPSpec wrapped objects / Object Prophecies.

This is exactly the sort of problem that my brother – an aspiring coder – would think I “just knew” how to fix. And that he should also be expected to know how to solve instinctively also.

Of course, the next time this comes up, I will know exactly how to solve it. It’s just if you were sat watching over my shoulder, you wouldn’t imagine the hours of my life that lesson took to learn 😉

Behat 3 Tables and TableNode Examples

Behaviour Driven Development (BDD) with Behat 3 is a thing of beauty. When combined with PHPSpec you get something I am hugely excited about.

However, there are many ways in which BDD can be daunting not just for the new-comer, but for a new project in general.

Once you have a feature or two written up, copy / pasting and doing a little editing can yield quick results but writing the code that lives in the underlying Feature Context can be a little harder. For me, this was most evident when dealing with Scenarios that contained tabular data.

I made myself a little Behat TableNode cheat sheet to help – at a glance, and whilst in my IDE (PHPStorm btw) – figure out just what might be in my TableNode objects for the specific methods available on that class.

This is an example of the scenario I was working with:

Behat 3 TableNode var_dump

  Background:
    Given the product with id: 3 has the following values:
      | asin       | title         | money | currency | description               |
      | CCCCC33333 | third product | 33.33 | GBP      | third product description |

Background:

Given the product with id: 3 has the following values:

And a dump of the resulting TableNode:

var_dump($table);

      │ class Behat\Gherkin\Node\TableNode#3316 (2) {
      │   private $table =>
      │   array(2) {
      │     [10] =>
      │     array(5) {
      │       [0] =>
      │       string(4) "asin"
      │       [1] =>
      │       string(5) "title"
      │       [2] =>
      │       string(5) "money"
      │       [3] =>
      │       string(8) "currency"
      │       [4] =>
      │       string(11) "description"
      │     }
      │     [11] =>
      │     array(5) {
      │       [0] =>
      │       string(10) "CCCCC33333"
      │       [1] =>
      │       string(13) "third product"
      │       [2] =>
      │       string(5) "33.33"
      │       [3] =>
      │       string(3) "GBP"
      │       [4] =>
      │       string(25) "third product description"
      │     }
      │   }
      │   private $maxLineLength =>
      │   array(5) {
      │     [0] =>
      │     int(10)
      │     [1] =>
      │     int(13)
      │     [2] =>
      │     int(5)
      │     [3] =>
      │     int(8)
      │     [4] =>
      │     int(25)
      │   }
      │ }

│ class Behat\Gherkin\Node\TableNode#3316 (2) {

│ private $table =>

│ array(2) {

│ [10] =>

│ array(5) {

│ [0] =>

│ string(4) "asin"

│ [1] =>

│ string(5) "title"

│ [2] =>

│ string(5) "money"

│ [3] =>

│ string(8) "currency"

│ [4] =>

│ string(11) "description"

│ }

│ [11] =>

│ array(5) {

│ [0] =>

│ string(10) "CCCCC33333"

│ [1] =>

│ string(13) "third product"

│ [2] =>

│ string(5) "33.33"

│ [3] =>

│ string(3) "GBP"

│ [4] =>

│ string(25) "third product description"

│ }

│ private $maxLineLength =>

│ array(5) {

│ [0] =>

│ int(10)

│ [1] =>

│ int(13)

│ [2] =>

│ int(5)

│ [3] =>

│ int(8)

│ [4] =>

│ int(25)

│ }

var_dump($table->getRowsHash());

      │ array(2) {
      │   'asin' =>
      │   array(4) {
      │     [0] =>
      │     string(5) "title"
      │     [1] =>
      │     string(5) "money"
      │     [2] =>
      │     string(8) "currency"
      │     [3] =>
      │     string(11) "description"
      │   }
      │   'CCCCC33333' =>
      │   array(4) {
      │     [0] =>
      │     string(13) "third product"
      │     [1] =>
      │     string(5) "33.33"
      │     [2] =>
      │     string(3) "GBP"
      │     [3] =>
      │     string(25) "third product description"
      │   }
      │ }

│ array(2) {

│ 'asin' =>

│ array(4) {

│ [0] =>

│ string(5) "title"

│ [1] =>

│ string(5) "money"

│ [2] =>

│ string(8) "currency"

│ [3] =>

│ string(11) "description"

│ }

│ 'CCCCC33333' =>

│ array(4) {

│ [0] =>

│ string(13) "third product"

│ [1] =>

│ string(5) "33.33"

│ [2] =>

│ string(3) "GBP"

│ [3] =>

│ string(25) "third product description"

│ }

var_dump($table->getColumnsHash());

      │ array(1) {
      │   [0] =>
      │   array(5) {
      │     'asin' =>
      │     string(10) "CCCCC33333"
      │     'title' =>
      │     string(13) "third product"
      │     'money' =>
      │     string(5) "33.33"
      │     'currency' =>
      │     string(3) "GBP"
      │     'description' =>
      │     string(25) "third product description"
      │   }
      │ }

│ array(1) {

│ [0] =>

│ array(5) {

│ 'asin' =>

│ string(10) "CCCCC33333"

│ 'title' =>

│ string(13) "third product"

│ 'money' =>

│ string(5) "33.33"

│ 'currency' =>

│ string(3) "GBP"

│ 'description' =>

│ string(25) "third product description"

│ }

Hopefully this is as useful a reference to you as it has become for me. Being able to quickly ‘guess’ what is going to be in my TableNode objects and where has helped save me a good deal of time already.

Want Code Review Videos In Your Inbox Every Friday?

Category: BDD

How to fix: You have requested a non-existent service “test.client” with Behat 3

Mocking Collections in PHPSpec

Behat 3 Tables and TableNode Examples

Behat 3 TableNode var_dump