Sonar Plugins

PhpCodeSniffer violations are not taken into account in Sonar

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: PHP-0.3
  • Component/s: PHP
  • Labels:
    None
  • Number of attachments :
    4

Description

Here is a simple example to reproduce. Unzip the attached and analyze. You will only see violations on 6 files. If you open the phpcodesniffer.xml, you will see that many more files have some.

  1. Text File
    FixPhpCodesnifferViolations.patch
    13/Nov/10 4:32 PM
    2 kB
    Mathias kluba
  2. Text File
    FixPhpCodesnifferViolationsBetter.patch
    13/Nov/10 4:59 PM
    16 kB
    Mathias kluba
  3. GZip Archive
    phpMyAdmin.tar.gz
    11/Aug/10 11:04 AM
    4.94 MB
    Gabriele Santini

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Gabriele Santini added a comment -

This is a proper example. The issue is still present in HEAD and for 2.1.2 version

Show
Gabriele Santini added a comment - This is a proper example. The issue is still present in HEAD and for 2.1.2 version
Hide
Permalink
Akram Ben Aissi added a comment -

PhpCodeSniffer violations will be taken into account only if the rule profile used to analyze the project contains these violations.
If the rule profile contains only a sub part of the violations types, only theses violations are taken into account.

In Sonar PHP 0.3, user have now the ability to extends rules profile by defining new profiles, and additionnel rulesets can be added through the extensions directory.

Show
Akram Ben Aissi added a comment - PhpCodeSniffer violations will be taken into account only if the rule profile used to analyze the project contains these violations. If the rule profile contains only a sub part of the violations types, only theses violations are taken into account. In Sonar PHP 0.3, user have now the ability to extends rules profile by defining new profiles, and additionnel rulesets can be added through the extensions directory.
Hide
Permalink
Mathias kluba added a comment -

Hi,
The "plugin_name" columns of the "rules" table == "PHP Language".
But the "keyForPlugin" returns "PHP_CodeSniffer"
Changing the value of the "keyForPlugin" fix the bug.
See the patch in attachment.

I also saw that the Unit test is not working for PhpCodeSniffer: I fixed it in the patch also.
But the test is not good: it uses the same constant as the class for assertion: so the test will pass for any value of the key.
Instead, the test should verify with the key of the constant PhpPlugin.KEY

The code need a serious cleanup about the constants:
Which one should we use: PhpPlugin.KEY? PhpPlugin.PHPMD_PLUGIN_KEY ? PhpPlugin.CODESNIFFER_PLUGIN_KEY ?
Why there is a duplicated key in PhpCheckStyleViolationXmlParser.KEY ? Why not using PhpPlugin.CODESNIFFER_PLUGIN_KEY ?

Show
Mathias kluba added a comment - Hi, The "plugin_name" columns of the "rules" table == "PHP Language". But the "keyForPlugin" returns "PHP_CodeSniffer" Changing the value of the "keyForPlugin" fix the bug. See the patch in attachment. I also saw that the Unit test is not working for PhpCodeSniffer: I fixed it in the patch also. But the test is not good: it uses the same constant as the class for assertion: so the test will pass for any value of the key. Instead, the test should verify with the key of the constant PhpPlugin.KEY The code need a serious cleanup about the constants: Which one should we use: PhpPlugin.KEY? PhpPlugin.PHPMD_PLUGIN_KEY ? PhpPlugin.CODESNIFFER_PLUGIN_KEY ? Why there is a duplicated key in PhpCheckStyleViolationXmlParser.KEY ? Why not using PhpPlugin.CODESNIFFER_PLUGIN_KEY ?
Hide
Permalink
Mathias kluba added a comment -

I understood that this plugin was splitted before: so it was normal to have several KEYs.
But now, it's only one plugin.
I don't understand that choice: the settings panel is very big now, and we can't organize rules by tools (PMD/PhpCodesniffer)
But I don't care: it the choice was to merge in only one plugin, so it should use only one KEY: PhpPlugin.KEY.

That's what I did, and it fix also the bug.

Show
Mathias kluba added a comment - I understood that this plugin was splitted before: so it was normal to have several KEYs. But now, it's only one plugin. I don't understand that choice: the settings panel is very big now, and we can't organize rules by tools (PMD/PhpCodesniffer) But I don't care: it the choice was to merge in only one plugin, so it should use only one KEY: PhpPlugin.KEY. That's what I did, and it fix also the bug.
Hide
Permalink
Mathias kluba added a comment -

Also take a look at SONARPLUGINS-805

Show
Mathias kluba added a comment - Also take a look at SONARPLUGINS-805
Hide
Permalink
Akram Ben Aissi added a comment -

Configuration panel was cleaned

Show
Akram Ben Aissi added a comment - Configuration panel was cleaned

People

  • Assignee:
    Akram Ben Aissi
    Reporter:
    Olivier Gaudin
Vote (2)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: