Timeout while executing an external tool leads to a crash
While executing an external tool, if its timeout is exceeded, the analysis crashes:
Caused by: Timeout exceeded: 1800000 ms [command: php D:\JI1\workspace\Nemo-php\.sonar\phpunit-3.7.20.phar --log-junit=D:\JI1\workspace\Nemo-php\.sonar\phpunit.xml --coverage-clover=D:\JI1\workspace\Nemo-php\.sonar\phpunit.coverage.xml --configuration=phpunit.xml.dist]
For all the external tools, the default value for the timeout is 30 minutes. It can be tuned:
# Value to set in minutes sonar.phpCodesniffer.timeout=30 sonar.phpDepend.timeout=40 sonar.phpPmd.timeout=50 sonar.phpUnit.timeout=60
I have projects that do not use the required versions of PHPUnit, PHP Depend, etc. What can I do?
If you are able to have several versions of code analysis tool these tools on the same machine, just make sure that the correct one will be used.
You also have to make sure that the output file log is compatible with the one specified by the version of the tool you want to use.
I have created my own PHP_CodeSniffer Standard or PHPMD ruleset. Can I use it with the Sonar PHP plugin?
Yes, but with some extra work. Two possible cases :
1) Your work consisted in pure configuration: modify a ruleset for PHPMD or create a PHPCS Standard including Sniffs from existing standards.
In this case you'll be able to recreate your work directly from the Sonar UI for Quality Profiles
You must check for the presence of your rules in Sonar profiles, as some PHPCS rule descriptions are still missing.
If you don't find all of your rules, you simply fall in case 2.
2) You added code to the solutions: you developed Sniffs or PHP PMD Rules
In this case you will have to Extend the PHP Coding Rules
How do I prevent external tools from analyzing some source files?
Most of the time, using the sonar.exclusions property will be enough to exclude files from being reported by Sonar. However, there might be some cases where one really wants to exclude files from being analyzed by an external tool (may it be PHP_CodeSniffer, PHPMD or PHP Depend):
- a file is badly written and the tool is crashing when analyzing this file, thus preventing Sonar from completing the analysis
- a big number of files must be excluded and there's no need for the external tools to spend time analyzing files that won't be reported by Sonar
In these specific cases, you should use the 'sonar.xxxx.argumentLine' property of the external tools to manually add the exclusions you want. For instance, for PHP_CodeSniffer, you would add the following property:
This would tell PHP_CodeSniffer to ignore every PHP file located in the "Database" folder.
When specifying exclusions directly for each tool, you should also consider to set the 'sonar.exclusions' property accordingly. Otherwise, you may have files with incomplete analysis.
How do I disable unit test & coverage reporting?
The easiest way to disable unit test reporting is to use the following standard Sonar property:
If you want to disable only unit test reporting or coverage reporting, you can use the following properties instead:
When analyzing a large PHP project, PHP hangs or ends with a unusual return code
PHP executable may have reached its maximum allocated memory. Increase the memory_limit value in your php.ini file. For example the file is located in /etc/php5/cli/php.ini on Ubuntu.
; Maximum amount of memory a script may consume (128MB) ; http://php.net/memory-limit memory_limit = 512M
When analyzing large PHP project, Maven hangs with a Java heap space message
Increase the maximum heap memory allocated for Maven by setting the environment variable MAVEN_OPTS.
When analyzing a large PHP project, PHP Depend hangs with an error code 255 and message saying "Maximum function nesting level of ‘100′ reached"
Increase the maximum number of nested levels by editing your php.ini files and setting a value greater than 100 (which is default). You may also need to increase the maximum amount of memory that a script can consume.
; Maximum input variable nesting level ; http://php.net/max-input-nesting-level max_input_nesting_level = 200 xdebug.max_nesting_level = 200 ; Maximum amount of memory a script may consume (128MB) ; http://php.net/memory-limit memory_limit = 1024M