Is there a way to assert if a method or variable is public private or protected with phpunit?
- 1If you need to make sure parts of your code has a certain visibility, you might be better off using php codesniffer. PHPUnit isnt the right tool for this.Gordon– Gordon2011-05-10 07:32:20 +00:00Commented May 10, 2011 at 7:32
- It's perfectly fine to test visibility. I don't see how a codesniffer is the right tool. As far as I see it a codesniffer is the wrong tool. I don't even see how a codesniffer would do what Michael is asking without god only knows what codesniffer configurations.Gerard Roche– Gerard Roche2016-08-20 17:41:02 +00:00Commented Aug 20, 2016 at 17:41
1 Answer
PHPUnit doesn't provide those assertions, and you typically don't use unit tests to test your typing ability. They should validate that the code works at runtime. Here are more pointless unit tests:
- Assert that the class is named
CorrectClassName. - Assert that
function foo() { return 5; }returns5. - Assert that function comments don't contain the word "winning".
Now, sometimes you just want to do something even when it's not recommended or has little value. I know I do. :) Add this to your base test case class:
/** * Assert that a method has public access. * * @param string $class name of the class * @param string $method name of the method * @throws ReflectionException if $class or $method don't exist * @throws PHPUnit_Framework_ExpectationFailedException if the method isn't public */ function assertPublicMethod($class, $method) { $reflector = new ReflectionMethod($class, $method); self::assertTrue($reflector->isPublic(), 'method is public'); } Completing assertProtectedMethod() and assertPrivateMethod() are left as an exercise. You can do the same thing for properties, and you could even make this method more generic to handle a method or property--whichever is found--and throw some other error if neither exist.