Custom java plugin : duplicate language

qualitesys · June 24, 2019, 9:11pm

Hello
I write several custon plugins on the same java code template for multiple languages.
The plugins related to new languages (Powerbuilder, Aspx, etc) are working fine.
As soon as I load the java or the php custom plugin, I get the following error “java.lang.IllegalArgumentException: Multiple entries with same key: php=PHP and php=Php”

Is it possible to add custom plugins to already existing languages in the SonarQube server, and how ?

Thanks for your help

PS: tested for SQV7.6, it worked well to SonarV4.2

felipebz · June 24, 2019, 11:03pm

Hi.

Please check what is the pluginKey of your custom plugin (in the pom.xml) and the name of your custom reposity. It should be different than “php”. See the example:

pluginKey is “php-custom”:

github.com

SonarSource/sonar-custom-rules-examples/blob/72af24771d391b04520304feeb7d9c4b37a47dba/php-custom-rules/pom.xml#L46-L57


				<groupId>org.sonarsource.sonar-packaging-maven-plugin</groupId>
				<artifactId>sonar-packaging-maven-plugin</artifactId>
				<version>1.17</version>
				<extensions>true</extensions>
				<configuration>
					<pluginKey>php-custom</pluginKey>
					<pluginName>PHP Custom Rules</pluginName>
					<pluginClass>org.sonar.samples.php.PHPCustomRulesPlugin</pluginClass>
					<sonarLintSupported>true</sonarLintSupported>
					<sonarQubeMinVersion>6.7</sonarQubeMinVersion>
					<basePlugin>php</basePlugin>
				</configuration>

the repositoryKey is “custom”:

github.com

SonarSource/sonar-custom-rules-examples/blob/master/php-custom-rules/src/main/java/org/sonar/samples/php/MyPhpRules.java#L40-L48


public class MyPhpRules implements RulesDefinition, PHPCustomRuleRepository {


  /**
   * Provide the repository key
   */
  @Override
  public String repositoryKey() {
    return "custom";
  }

qualitesys · June 25, 2019, 8:37pm

Thanks Felipe

It appears that my pluginKey is qcr4php for example, so no problem with this.
Unfortunately, the problem seams related to the fact that two plugins must not define the same language (php or java, etc) see [1]
I don’t really understand this. Since in the QualityProfile view one can choose the default profile, it should be possible to create 2 plugins for those languages, then select the default one.

Can SonarSource confirm that a custom plugin cannot provide analysers for languages SonarSource delivers, and since which SQ versions ?
By the way, it was not the case in old versions (4.2 for example)

Thanks for your help

[1] : https://stackoverflow.com/questions/35310698/sonarqube-background-tasks-failing-with-multiple-entries-with-same-key

Colin · June 25, 2019, 8:48pm

Greetings,

Only one plugin can declare a language. The implicit convention is to declare a language only if the plugin handle all “language related” features, like highlighting, core measures, cpd, …

Multiple plugins can contribute rules for a language. A plugin does not have to declare a language to contribute rules for a language.

Does that help?

Best regards,

Colin

qualitesys · June 25, 2019, 9:15pm

Thanks Colin for your quick answer !

Well my purpose is to handle the full set of feature for those languages according to a custom syntax analyser and custom metrics and fonctional rules too. Well, I’ll create special language names, a bit sad though.
Didier