90

I have a question about using PHPUnit to mock a private method inside a class. Let me introduce with an example:

class A { public function b() { // some code $this->c(); // some more code } private function c(){ // some code } } 

How can I stub the result of the private method to test the some more code part of the public function.

Solved partially reading here

11 Answers 11

105

Usually you just don't test or mock the private & protected methods directy.

What you want to test is the public API of your class. Everything else is an implementation detail for your class and should not "break" your tests if you change it.

That also helps you when you notice that you "can't get 100% code coverage" because you might have code in your class that you can't execute by calling the public API.


You usually don't want to do this

But if your class looks like this:

class a { public function b() { return 5 + $this->c(); } private function c() { return mt_rand(1,3); } } 

i can see the need to want to mock out c() since the "random" function is global state and you can't test that.

The "clean?/verbose?/overcomplicated-maybe?/i-like-it-usually" Solution

class a { public function __construct(RandomGenerator $foo) { $this->foo = $foo; } public function b() { return 5 + $this->c(); } private function c() { return $this->foo->rand(1,3); } } 

now there is no more need to mock "c()" out since it does not contain any globals and you can test nicely.


If you don't want to do or can't remove the global state from your private function (bad thing bad reality or you definition of bad might be different) that you can test against the mock.

// maybe set the function protected for this to work $testMe = $this->getMock("a", array("c")); $testMe->expects($this->once())->method("c")->will($this->returnValue(123123)); 

and run your tests against this mock since the only function you take out/mock is "c()".


To quote the "Pragmatic Unit Testing" book:

"In general, you don't want to break any encapsulation for the sake of testing (or as Mom used to say, "don't expose your privates!"). Most of the time, you should be able to test a class by exercising its public methods. If there is significant functionality that is hidden behind private or protected access, that might be a warning sign that there's another class in there struggling to get out."


Some more: Why you don't want test private methods.

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

12 Comments

this is not true, in my example i need to test the second 'some code...' but that result maybe altered by the previous result of the private function that i can't mock, here's the example : public function b() { // some code if($this->c() == 0) // do something; else // do someanotherthing // some code }
@dyoser: If you really need to mock a private method, you implicitly suggest, that the result may change in a way you cannot control via accessable methods. Or: If the test-case (blackbox- or greybox-tests) needs to know something about the internal structure of the unit to test, something is wrong in the unit.
@dyoser Sure it may be altered by what the private function does, thats why you usually need more than one test case. Every possible effect that function c() has will be triggered by you passing in some parameters to your class so if you pass in the right stuff c() also will do the right stuff. Anyways, I'll build a little example where you might want to mock c()
Yeah thats what i meant with the "// maybe set the function protected for this to work" comment. Ether change the function to protected or use reflection to change it
"What you want to test is the public API of your class. Everything else is an implementation detail for your class and should not "break" your tests if you change it." Should not doesn't mean it won't break, in which case I would like my unit test to indicate which of the private methods could be responsible for the failure. If I test the public interface only which is dependent on many smaller units, isn't it effectively an integration test? I think testing world went into weird corporate rules dictated by test coverage in which case testing public methods helps a lot to build nice stats.
|
32

You can use reflection and setAccessible() in your tests to allow you to set the internal state of your object in such a way that it will return what you want from the private method. You'll need to be on PHP 5.3.2.

$fixture = new MyClass(...); $reflector = new ReflectionProperty('MyClass', 'myPrivateProperty'); $reflector->setAccessible(true); $reflector->setValue($fixture, 'value'); // test $fixture ... 

3 Comments

Nope, you're using reflection on a property but in the example y use a private METHOD. Just to clarify i want to simulate (mock) the running of the private method to obtain the result that i want (or just a simulated one). I don't need to test it.
@dyoser - If you don't want to alter the class under test, you must alter its state such that the private method operates as you need. Since the public method can call the private method, and you cannot override the private method, you cannot mock it.
Solved a different problem for me, but works as a charm.
27

You can test private methods but you can't simulate (mock) the running of this methods.

Furthermore, the reflection does not allow you to convert a private method to a protected or public method. setAccessible only allows you to invoke the original method.

Alternatively, you could use runkit for rename the private methods and include a "new implementation". However, these features are experimental and their use is not recommended.

2 Comments

What about extending the class A and implementing new c method?
@PetrPeller - Since c is private, it cannot be overridden in subclasses.
19

You can get mock of protected method , so if you can convert C to protected then this code will help.

 $mock = $this->getMockBuilder('A') ->disableOriginalConstructor() ->setMethods(array('C')) ->getMock(); $response = $mock->B(); 

This will definitely work , It worked for me . Then For covering protected method C you can use reflection classes.

2 Comments

Its really works. Here is more complete example: phpunit.de/manual/current/en/…
You shouldn't change things to invalid settings like making a private method protected just to support testing. If testing messes up your code then it's wrong.
15

Assuming that you need to test $myClass->privateMethodX($arg1, $arg2), you can do this with reflection:

$class = new ReflectionClass ($myClass); $method = $class->getMethod ('privateMethodX'); $method->setAccessible(true); $output = $method->invoke ($myClass, $arg1, $arg2); 

6 Comments

Hi @Edson, your answer is the same that I said with the link: "test private methods".
The OP doesn't need to test the private method; they need to mock it to provide a canned result while testing a different method.
@DavidHarkness I agree with you that private methods should not be tested, but it's debatable. It's a shady area. If you want to go anal with the coverage there's no pretty away around it.
@EdsonMedina While I did say "doesn't need to test," I didn't mean to imply the OP shouldn't test the private method--only that they didn't want to for the purpose of this question. I just noticed that the title doesn't match the body at all and will fix that now.
@DavidHarkness It's a little too late to change the question 3 years after getting responses and closing the thread, don't you think? That will make it confusing.
|
10

One option would be to make c() protected instead of private and then subclass and override c(). Then test with your subclass. Another option would be to refactor c() out into a different class that you can inject into A (this is called dependency injection). And then inject a testing instance with a mock implementation of c() in your unit test.

2 Comments

sure but this means that i need to rewrite the original class, it's not a good implementation to test functionality.
@dyoser: Yes, this is a necessary thing. Your original implementation is somewhat untestable and needs to be refactored a little to get it under test. Don't be afraid to do it. Michael Feathers talks about this very issue in his excellent book Working Effectively with Legacy Code.
10

Here's a variation of the other answers that can be used to make such calls one line:

public function callPrivateMethod($object, $methodName) { $reflectionClass = new \ReflectionClass($object); $reflectionMethod = $reflectionClass->getMethod($methodName); $reflectionMethod->setAccessible(true); $params = array_slice(func_get_args(), 2); //get all the parameters after $methodName return $reflectionMethod->invokeArgs($object, $params); } 

2 Comments

Thanks for this Snippet. This is saving me a lot of work!
The question is about how to mock a call of a private method, and not about how to call directly a private method within a unit test.
8

I came up with this general purpose class for my case:

/** * @author Torge Kummerow */ class Liberator { private $originalObject; private $class; public function __construct($originalObject) { $this->originalObject = $originalObject; $this->class = new ReflectionClass($originalObject); } public function __get($name) { $property = $this->class->getProperty($name); $property->setAccessible(true); return $property->getValue($this->originalObject); } public function __set($name, $value) { $property = $this->class->getProperty($name); $property->setAccessible(true); $property->setValue($this->originalObject, $value); } public function __call($name, $args) { $method = $this->class->getMethod($name); $method->setAccessible(true); return $method->invokeArgs($this->originalObject, $args); } } 

With this class you can now easily & transparently liberate all private functions/fields on any object.

$myObject = new Liberator(new MyObject()); /* @var $myObject MyObject */ //Usefull for code completion in some IDEs //Writing to a private field $myObject->somePrivateField = "testData"; //Reading a private field echo $myObject->somePrivateField; //calling a private function $result = $myObject->somePrivateFunction($arg1, $arg2); 

If performance is important, it can be improved by caching the properties/methods called in the Liberator class.

2 Comments

This is actually quite useful, thanks! Do you have this on packagist or some repository that could be included with composer? I did find eloquent/liberator by the namesake, but I think it's just a coincidence.
Thanks! No I have not. This is a coincidence. This code is selfcontained so feel free to change the class name if it gives you collisions.
1

An alternative solution is to change your private method to a protected method and then mock.

$myMockObject = $this->getMockBuilder('MyMockClass') ->setMethods(array('__construct')) ->setConstructorArgs(array("someValue", 5)) ->setMethods(array('myProtectedMethod')) ->getMock(); $response = $myMockObject->myPublicMethod(); 

where myPublicMethod calls myProtectedMethod. Unfortunately we can not do this with private methods since setMethods can not find a private method where as it can find a protected method

Comments

0

You can use anonymous classes using PHP 7.

$mock = new class Concrete { private function bob():void { } }; 

In prior versions of PHP you can make a test class extending the base class.

Comments

0

When the target class is neither static nor final, I solve this kind of problem in a way close to @jgmjgm, by anonymously and locally extending the original class and therefore not testing the same method multiple times in different test cases :

$extent = new class ($args) extends A { private function c() { return $hardCodedValue; } }; 

Then I can test the behaviour of $extent->b() without executing again the potentially heavy c() method.

Comments

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.