\nI’m in the process of setting up a continuous integration environment for a new PHP project I’m starting. On our previous project, which was Java based, we used the following tools to support similar requirements on that project in order to allow us to implement the project using a test driven approach and automate build generation:<\/p>\n
\nI’ve managed to set up an analogous process for our PHP project using the following tools:<\/p>\n
\nIt seems to work quite well, here’s the relatively simple ant build script that controls it all.<\/p>\n
I’m currently running this on a windows machine although it’s trivial to change it work in an *ix based environment which I’ll probably configure in the next day or so. I had a couple of problems installing PHP_CodeSniffer although it was because I hadn’t installed PEAR properly. If you have any problems installing PHP_CodeSniffer under Windows then follow these instructions:<\/p>\n
\nTo install PEAR under windows do the following, which assumes you have PHP5.2x installed in c:\\php :<\/p>\n
\r\n cd c:\\\\php\r\n go-pear.bat\r\n<\/pre>\nThe interactive installer presents you with some options, if you follow the defaults you should be fine.
\nOnce PEAR has installed you can install PHP_CodeSniffer like this:<\/p>\n\r\n cd c:\\\\php\r\n pear install PHP_CodeSniffer-beta\r\n<\/pre>\nThis will download the PHP_CodeSniffer package and install into into your php\/PEAR folder.<\/p>\n
Once this is done you can check to see if it has installed by calling phpcs with -h flag which will produce the following:<\/p>\n
\r\nC:\\\\php>phpcs -h\r\nUsage: phpcs [-nlvi] [--report=] [--standard= ]\r\n [--generator= ] [--extensions= ] ...\r\n -n Do not print warnings\r\n -l Local directory only, no recursion\r\n -v[v][v] Print verbose output\r\n -i Show a list of installed coding standards\r\n --help Print this help message\r\n --version Print version information\r\n One or more files and\/or directories to check\r\n A comma separated list of file extensions to check\r\n (only valid if checking a directory)\r\n The name of the coding standard to use\r\n The name of a doc genertor to use\r\n (forces doc generation instead of checking)\r\n Print either the \"full\" or \"summary\" report\r\n<\/pre>\n Now try it out …<\/p>\n
\r\nC:\\\\php>phpcs C:\\\\Projects\\\\dummyproject\\\\test\\\\\r\n\r\nFILE: C:\\\\Projects\\\\dummyproject\\\\test\\\\AllTests.php\r\n--------------------------------------------------------------------------------\r\nFOUND 7 ERROR(S) AND 0 WARNING(S) AFFECTING 7 LINE(S)\r\n--------------------------------------------------------------------------------\r\n 1 | ERROR | End of line character is invalid; expected \"\\n\" but found \"\\r\\n\"\r\n 2 | ERROR | Missing file doc comment\r\n 3 | ERROR | Constants must be uppercase; expected 'PHPUNIT_MAIN_METHOD' but\r\n | | found 'PHPUnit_MAIN_METHOD'\r\n 12 | ERROR | Missing class doc comment\r\n 14 | ERROR | Missing function doc comment\r\n 19 | ERROR | Missing function doc comment\r\n 30 | ERROR | Constants must be uppercase; expected PHPUNIT_MAIN_METHOD but\r\n | | found PHPUnit_MAIN_METHOD\r\n--------------------------------------------------------------------------------\r\n<\/pre>\nCheck the documentation for what the various command line switches do, but you can generate summary reports as well on an entire directory tree:<\/p>\n
\r\nC:\\\\php>phpcs --report=summary --standard=Squiz C:\\\\Projects\\\\dummyproject\\\\test\\\\\r\n\r\nPHP CODE SNIFFER REPORT SUMMARY\r\n--------------------------------------------------------------------------------\r\nFILE ERRORS WARNINGS\r\n--------------------------------------------------------------------------------\r\nC:\\\\Projects\\\\dummyproject\\\\test\\\\AllTests.php 24 0\r\nC:\\\\Projects\\\\dummyproject\\\\test\\\\NodeTest.php 10 0\r\nC:\\\\Projects\\\\dummyproject\\\\test\\\\NodeTypeTest.php 11 0\r\n--------------------------------------------------------------------------------\r\nA TOTAL OF 45 ERROR(S) AND 0 WARNING(S) WERE FOUND IN 3 FILE(S)\r\n--------------------------------------------------------------------------------\r\n<\/pre>\n<\/p>\n… <\/p>\n
Overall I’m quite happy with this set up which for the most part was pretty straight forward. I have no doubt it will evolve over time but I think it’s a good foundation on which to build upon.<\/p>\n","protected":false},"excerpt":{"rendered":"
I’m in the process of setting up a continuous integration environment for a new PHP project I’m starting. On our previous project, which was Java based, we used the following tools to support similar requirements on that project in order … Continue reading