Name: sonar-php
Owner: Code Climate
Description: PHP Analyzer for SonarQube
Forked from: SonarSource/sonar-php
Created: 2017-11-07 14:45:35.0
Updated: 2017-11-07 14:45:39.0
Pushed: 2017-11-07 14:36:39.0
Homepage: http://docs.sonarqube.org/display/PLUG/PHP+Plugin
Size: 12379
Language: Java
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
SonarPHP is a static code analyser for PHP language used as an extension for the SonarQube platform. It will allow you to produce stable and easily supported code by helping you find and correct bugs, vulnerabilities and smells in your code.
To provide feedback (request a feature, report a bug etc.) send an email to sonarqube@googlegroups.com, the SonarQube Google Group. Please do not forget to specify the language (PHP!), plugin version and SonarQube version.
If you have a question on how to use the plugin (and the docs don't help you), direct it to StackOverflow tagged both sonarqube
and php
.
To request a new feature, please send an email to sonarqube@googlegroups.com, the SonarQube Google Group. Even if you plan to implement it yourself and submit it back to the community, please start a new Google Group thread first to be sure that we can follow up on it.
To submit a contribution, create a pull request for this repository. Please make sure that you follow our code style and all tests are passing (Travis build is created for each PR).
If you have an idea for a rule but you are not sure that everyone needs it you can implement a custom rule available only for you.
To run tests locally follow these instructions.
To build the plugin and run its unit tests, execute this command from the project's root directory (you will need Maven):
clean install
To run integration tests, you will need to create a properties file like the one shown below, and set its location in an environment variable named ORCHESTRATOR_CONFIG_URL
.
rsion of SonarQube server
r.runtimeVersion=6.2
estrator.updateCenterUrl=http://update.sonarsource.org/update-center-dev.properties
Before running any of integration tests make sure the submodules are checked out:
t submodule init
t submodule update
The “Plugin Test” is an additional integration test which verifies plugin features such as metric calculation, coverage etc. To launch it, execute this command from directory its/plugin
:
clean install
The “Ruling Test” is a special integration test which launches the analysis of a large code base, saves the issues created by the plugin in report files, and then compares those results to the set of expected issues (stored as JSON files). To launch ruling test:
ts/ruling
clean install
This test gives you the opportunity to examine the issues created by each rule and make sure they're what you expect. You can inspect new/lost issues checking web-pages mentioned in the logs at the end of analysis:
- HTML Issues Report generated: /path/to/project/sonar-php/its/sources/src/.sonar/issues-report/issues-report.html
- Light HTML Issues Report generated: /path/to/project/sonar-php/its/sources/src/.sonar/issues-report/issues-report-light.html
If everything looks good to you, you can copy the file with the actual issues located at
r-php/its/ruling/target/actual/
into the directory with the expected issues
r-php/its/ruling/src/test/resources/expected/
Copyright 2010-2017 SonarSource.
Licensed under the GNU Lesser General Public License, Version 3.0