Coding Guidelines

Good question, maybe it is a matter of phpUnit finding the classes? We should ask Oli Klee - our tests expert - for his opinion on that.

Shall unit test files following the CGL?

Stefano Kowalke wrote:

Shall unit test files following the CGL?

Yes, they should. There might be some exceptions due to special features of unit test files, but I don't think this needs to be documented.

Oliver's answer:

in order for the tests to work both in the CLI runner as well as the BE test runner, the file names need to end with "Test.php" and the contained test classes need to end with "Test".

I strongly recommend to name the test class for a class like the tested class plus just the suffix "Test" and name the file like the tested file name plus the same suffix. (However, this is only a convention, not a technical necessity. For some very large classes, it might make sense to have more than one test class - before refactoring the big class to smaller classes, of course. :-)

So, to sum up, for the CGL I propose to use the same class and file names as the original class and just add the suffix "Test".

Ernesto's reflections based on Oliver's information:

I think something should be cleaned up, especially if we also consider that we have sysext that also ship with tests. Some examples of what we have currently:

typo3/sysext/saltedpasswords/tests/tx_saltedpasswords_divTest.php => class = tx_saltedpasswords_divTest

tests/typo3/sysext/cms/tslib/tslib_contentTest.php => class = tslib_contentTest

tests/t3lib/t3lib_spritemanagerTest.php => class = t3lib_spritemanagerTest

tests/t3lib/tree/t3lib_tree_nodeTest.php => class = t3lib_tree_nodeTest

tests/contrib/removexssTest.php => class removexssTest

My suggestion for the rules and what then have to be done in our current code base in order to adhere to it:

1) sysext should ship with their tests in their own directly. => Meaning move the tests from tests/typo3/sysext/cms/ to typo3/sysext/cms/tests/.

2) Tests for typo3/ and t3lib/ classes are the only ones kept under our root "tests/". => Meaning move tests/contrib/removexssTest.php to tests/typo3/contrib/RemoveXSS/

3) Use the same filename as the original ones only with the "Test.php" suffix appended. => Meaning adding the "class." in front of all test classes, i.e. tests/t3lib/t3lib_divTest.php => tests/t3lib/class.t3lib_divTest.php

Only exception to these rules are Extbase / Fluid and all Extbase-based extensions, which have their own CGL for file naming anyway.

Ok, I am fine with this. I will provide patches for the renaming and moving

I guess after namespacing, all files have been renamed.