BDD test framework for PHP

I have been trying to implement pho as a way to test php code for software that we develop at work. We have a file that will import all of our base system classes which relies on reading out of a config file.

$cfg = parse_ini_file($cfg_path, true);

require_once("using.php");



using.php contains a function:

public static function init() {
        global $cfg;

        self::$package_path = $cfg['APPLICATION']['path_app'] . 'ModulePackages/';

        ....use self::$package_path here to load files
    }

Inside of the init function the $cfg is null no matter what.

If I run the files from php command line it will load properly. Is there anything I am missing from pho that will stop my ability to call global $cfg?

First of all I just want to thank you all for this framwork! I love it! I'm a big fan of jasmine for javascript and now I can have the same syntax for my unit-test. I like that you have decided to keep it simple and rely on other mocking frameworks. I have tried Mockery and I think the combo is fantastic.

But when I try to follow the this example:

describe("a suite", function () {
    // Any last checks that could fail a test would go here
    $this->teardown = function () {
        Mockery::close();
    };

    it("should check mock object expectations", function () {
        $mock = Mockery::mock('simplemock');
        $mock->shouldReceive('foo')->with(5)->once()->andReturn(10);
        expect($mock->foo(5))->toBe(10);

        $this->teardown();
    });
});

I get:

Fatal error: Call to undefined method pho\Suite\Suite::teardown()

I suggest updating example by exposing teardown with use keyword or not declaring the Spec-"store" as private as I try to access it in another scope. I think that is causing the fatal error. Is it working for you guys? What am I doing wrong? I think the easiest would be to update the example to this:

describe("a suite", function () {
    // Any last checks that could fail a test would go here
    $teardown = function () {
        Mockery::close();
    };

    it("should check mock object expectations", function () use ($teardown) {
        $mock = Mockery::mock('simplemock');
        $mock->shouldReceive('foo')->with(5)->once()->andReturn(10);
        expect($mock->foo(5))->toBe(10);

        $teardown();
    });
});

By the way I also fixed a typo in my example. ;-) The teardown function have a closing parentheses before the semicolon like it would have been if you pass a closure as param to function call.

I found when using Pho and Mockery that test failures could cause the subsequent test to fail as well.

I'm using Pho and Mockery and have found I need to use close() a lot.

Initially I was just doing Mockery::close() at the end of each test, but I found that when a method is called that does not match an expectation, an exception is thrown which means that the close is not called. This causes the next test to fail because the expectation is not met. e.g.

describe('some tests', function () {
    it('Should do stuff', function () {
        $mock = Mockery::mock('alias:Some\Thing');
        $mock->shouldReceive('doSomething')
            ->with('bob')
            ->once();

       // Oops, I'm passing the wrong argument, so this test will fail
       $mock->doSomething('alf');

       Mockery::close();
    });

    it('Should do other stuff', function () {
         expect(1 + 1)->toBe(2);

         Mockery::close();
    });
});

In this case, the first test will fail because the $mock->doSomething('alf') call will throw an exception due to no expectation being configured for that argument. This will mean that the Mockery::close() call in that test will not happen. This is all correct and expected! BUT the second test will then fail because when it calls Mockery::close(), Mockery will report that the expectation has not been met.

The quick answer is to put an afterEach in each top level describe block that calls Mockery::close() as well as the Mockery::close() inside the test - the one inside the test makes sure that test failures are reported when expectations are not met, and the one in the afterEach cleans up any unmet expectations from failed tests.

This is a bit awkward - it would be nice if I could set up global afterEach things in the bootstrap or something, rather than add this extra boilerplate to every spec file, but at least update the documentation about using Mockery::close() to mention this?

#21 has worked great but it obviously didn't change the way bootstrap files are loaded, so I lost globals when trying to use it. This change is essentially the same thing but it pulls the loadBootstrap function out of the Runner and into src/pho.php

Just found a bug in my tests caused by a misunderstanding of how beforeEach and afterEach work in the context of expectations.

I use prophecy for mocks, although this is framework agnostic. To test predictions, I've been using something like this:

<?php

use Prophecy\Exception\Prediction\AggregateException;

describe("blah blah", function () {
    $prophet = new Prophecy\Prophet;

    afterEach(function () use ($prophet) {
        $check = function () use ($prophet) {
            $prophet->checkPredictions();
        };
        expect($check)->not()->toThrow("AggregateException");
    });

    it("should do something", function () use ($prophet) {
        $mock = $prophet->prophesize();
        $mock->myMethod()->shouldBeCalled();

        $caller = new MethodCaller();
        $caller->call($mock->reveal());
    });
});

This silently succeeds though, because expectations in the afterEach (and beforeEach, although I don't think that's particularly useful) are not considered. I'd like, similar to PHPUnit, to be able to fail a test from the teardown method.

Is this a change you'd be interested in merging in? If it's not, would you be interested in merging in a change to the documentation to point this behavior out?

Just noticed this when updating Phony for Pho. If you use beforeEach(), and it doesn't fail, you'll get something like this:

Fatal error: Uncaught TypeError: Argument 1 passed to pho\Runnable\Spec::setException() must be an instance of Exception, null given, called in /path/to/vendor/danielstjules/pho/src/Runner/Runner.php on line 318 and defined in /path/to/vendor/danielstjules/pho/src/Runnable/Spec.php:122
Stack trace:
#0 /path/to/vendor/danielstjules/pho/src/Runner/Runner.php(318): pho\Runnable\Spec->setException(NULL)
#1 /path/to/vendor/danielstjules/pho/src/Runner/Runner.php(293): pho\Runner\Runner->runBeforeEachHooks(Object(pho\Suite\Suite), Object(pho\Runnable\Spec))
#2 /path/to/vendor/danielstjules/pho/src/Runner/Runner.php(262): pho\Runner\Runner->runSpecs(Object(pho\Suite\Suite))
#3 /path/to/vendor/danielstjules/pho/src/Runner/Runner.php(193): pho\Runner\Runner->runSuite(Object(pho\Suite\Suite))
#4 /path/to/vendor/danielstjules/ in /path/to/vendor/danielstjules/pho/src/Runnable/Spec.php on line 122

I think this is simply because Pho isn't checking whether beforeEach actually produced an exception:

        if (!$spec->getException() && $hook) {
            $spec->setException($hook->getException());
        }

Looks like the same problem exists in a bunch of places in Runner.php. Perhaps it went unnoticed because of loose error reporting?

I just notice that pho do not catch exceptions, when function that is out of scope fails.

describe("simple suite", function() {
    context("with reference", function () {
        $ref = new stdClass();
        $ref->callback = function () {
            throw new Exception();
        };

        it("should just fail", function () use($ref) {
            $ref->callback();
        });
    });
});

Result looks something like this:

simple suite
    with reference
PHP Fatal error:  Uncaught Error: Call to undefined method stdClass::callback() in ...\test\concurrency\RendezvousChannelSpec.php:14
Stack trace:
#0 ...\vendor\danielstjules\pho\src\Runnable\Runnable.php(31): Closure->{closure}()
#1 ...\vendor\danielstjules\pho\src\Runnable\Runnable.php(31): Closure->__invoke()
#2 ...\vendor\danielstjules\pho\src\Runnable\Spec.php(56): pho\Runnable\Runnable->run()
#3 ...\vendor\danielstjules\pho\src\Runner\Runner.php(351): pho\Runnable\Spec->run()
#4 ...\vendor\danielstjules\pho\src\Runner\Runner.php(294): pho\Runner\Runner->runRunnable(Object(pho\Runnable\Spec))
#5 ...\vendor\danielstjules\pho\src\Runner\Runner.php(262): pho\Runner\Runner->runSpecs(Object(pho\Suite\Suite))
#6 ...\vendor\danielstjules\pho\src\Runner\Runner.php in ...test\concurrency\RendezvousChannelSpec.php on line 14

I did not do any deep analysis, but If it helps I can provide more data.

This was the error thrown: PHP Fatal error: Class 'pho\Console\Console' not found in /Users/admin/.composer/vendor/danielstjules/pho/src/pho.php on line 100

Installed tag 1.0 instead and pho executed perfectly.

Hi,

just wanted to chime in and mention http://codeception.com/ because I'm curious on what you think about it and how you intend to improve pho over that.

This PR adds 5.3 compatibility at the expense of the short array syntax ([]), anything involving Closure::bindTo, and one instance of some late static binding weirdness.

• Most of the changes are switching short array syntax to array() calls. They're ugly, but they're backward compatible
• There are 6 instances of a version_compare call being added. 3 of those are in the specs, 3 of those are in the source. Comparisons in the specs are used to skip tests that only work with Closure::bindTo calls, and the comparisons in the source are used to avoid bindTo calls. This is, imo, the ugliest part of this code. I'm open to suggestions on how to improve it
• Some of the specs (especially the reporter specs) were using bound-to objects to store and pass around variables. I've replaced those calls with references. Again, it's ugly but it's backward compatible

I've also modified the composer file to allow >= 5.3, and added 5.3 as a build target for Travis. All the tests pass on all environments.

I know this seems a little pretentious to assume that you event want to bother with 5.3 support, but it's intended to be less of a suggestion and more of a "hey if you're interested" kind of PR. Either way I need this for work, so I'll be maintaining my fork for the foreseeable future.

Thanks for the awesome library. :+1:

Fixes an issue where, when an optional argument was at the final position in the argument list, a notice was being generated:

$ pho --reporter
PHP Notice:  Undefined offset: 1 in /Users/nstory/.composer/vendor/danielstjules/pho/src/Console/ConsoleOptionParser.php on line 150
PHP Stack trace:
PHP   1. {main}() /Users/nstory/.composer/vendor/danielstjules/pho/bin/pho:0
PHP   2. require_once() /Users/nstory/.composer/vendor/danielstjules/pho/bin/pho:28
PHP   3. pho\Console\Console->parseArguments() /Users/nstory/.composer/vendor/danielstjules/pho/src/pho.php:137
PHP   4. pho\Console\ConsoleOptionParser->parseArguments() /Users/nstory/.composer/vendor/danielstjules/pho/src/Console/Console.php:130

Notice: Undefined offset: 1 in /Users/nstory/.composer/vendor/danielstjules/pho/src/Console/ConsoleOptionParser.php on line 150

Call Stack:
    0.0008     228816   1. {main}() /Users/nstory/.composer/vendor/danielstjules/pho/bin/pho:0
    0.0022     372704   2. require_once('/Users/nstory/.composer/vendor/danielstjules/pho/src/pho.php') /Users/nstory/.composer/vendor/danielstjules/pho/bin/pho:28
    0.0029     473216   3. pho\Console\Console->parseArguments() /Users/nstory/.composer/vendor/danielstjules/pho/src/pho.php:137
    0.0030     490104   4. pho\Console\ConsoleOptionParser->parseArguments() /Users/nstory/.composer/vendor/danielstjules/pho/src/Console/Console.php:130