PHPUnit - Not seeing code coverage on simple function

Question

I'm trying to troubleshoot an issue where in my test, my assert passes.. but neither my expects() passes, nor am I seeing coverage executing in the resulting code coverage generated html.

error: Method was expected to be called 1 times, actually called 0 times.

I'm starting with a very basic example (below). I must be missing something obvious with phpunit that I haven't wrapped my head around with yet, apparently. I double-checked that the function I'm trying to test is in fact a public function.

At this point, I would just like to be able to see some coverage executing in the generated code coverage html.

Any ideas are greatly appreciated.

public function returnVal()
{
  return 5;
}

public function test_returnVal()
{
    $testVal = 5;
    $controllerMock = $this->getMockBuilder('MyClass')
        ->setMethods(null)
        ->disableOriginalConstructor()
        ->getMock();

    $controllerMock->expects($this->any())
        ->method('testReturnVal')
        ->with($testVal);

    $testResult = $controllerMock->testReturnVal($testVal);
    $this->assertEquals($testResult, $testVal);
}

Steven Scott · Accepted Answer · 2014-05-12 16:55:07Z

2

You do not see any code coverage, as you never actually execute the returnVal() function. Your test suite uses a Mock which does not call the original function, but it references a Mock function (testReturnVal) instead.

$controllerMock->expects($this->any())
    ->method('testReturnVal')
    ->with($testVal);

When testing, Mocks are handy for hiding external dependencies and keeping a known state. However, for simply functions (add 2 numbers for instance) you can simply create the object and call the code.

For your situation, simply add an additional test into the test code:

public function test_RealReturnVal()
{
     $TestObject = new MyClass();
     $this->assertEquals(5, $TestObject->returnVal());
}

This new test will actually call your real code and execute the returnVal() call. This will cause the code coverage to show these lines as executed.

answered May 12, 2014 at 16:55

Steven Scott

11.4k10 gold badges82 silver badges138 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

brainmonger Over a year ago

I accepted your answer because executing the real code would fix the issue.. however, due to various dependencies I wasn't able to do that.

brainmonger Over a year ago

The problem ended up actually being, and I'm shaking my head as I type.. due to TYPO in the getMockBuilder call. ie MyClass vs Myclass (more obscure, actually). There was no error produced so it took a while to track down..

JSmitty Over a year ago

If you're using PHP 5.5+ you could use MyClass::class instead of 'MyClass' in the call to $this->getMockBuilder(). I've started doing that everywhere to eliminate typos on my part but also to facilitate using my IDE's refactoring tools to rename classes and (sometimes) move them into new namespaces.

Collectives™ on Stack Overflow

PHPUnit - Not seeing code coverage on simple function

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related