do PHPUnit tests need to be inside a “/test” directory?

Question

when using PHPUnit, is it required for tests to be inside of a /tests directory? How does PHPUnit know that a test is a "test"? Does it parse the file and look for method names, or use some sort of naming convention of files?

Answer 1

it required for tests to be inside of a /tests directory?

No.

How does PHPUnit know that a test is a "test"?

Via reflection (and by the user specifying a directory to look into).

Answer 2

Does it parse the file and look for method names, or use some sort of naming convention of files?

• If first checks if the passed argument is a file so you could call phpunit myTestStuff.php
• Since it's not in your case It recursively scans the directory by calling File_Iterator and adding all files that end in "Test.php" and ".phpt" to your testsuite.
• It then goes through all those files and adds all the classes that extend from PHPUnit_Framework_Test
• Then the tests are run

So in short:

Filename needs to end in Test.php , class needs to extends from PHPUnit_Framework_TestCase (some point down the inheritance tree).

It is good practice to seperate your test code from your production code though. Usually it mirrors the folder structure. But there is nothing stopping you from doing it differently. Just consider that it's easier to generate statistics (metrics) for your production code.

Maybe you want to have some automatically checked coding rules for your production code and others for your tests.

You want to generate code coverage for your code and have it include all the production code but not all the tests. (PHPUnit will not show your test classes in the coverage anyways but base and helper classes)

Answer 3

Convention is to name the test classes and files by appending Test to those of the classes you're testing. For example My_Cool_User in My/Cool/User.php would be tested with My_Cool_UserTest in My/Cool/UserTest.php .

I prefer to separate the tests in their own directory, but this isn't required. By using a naming convention you can tell PHPUnit how to find all the tests mixed in with your regular code. By default PHPUnit follows the above, so if you point it to a folder called myproject it will look for all files ending in Test.php within it.

Answer 4

进入您的设置和目录，然后选择并验证您的测试和源位置是否已添加。