CODEWITHSUNDEEP
eclipsemavenpluginssonarqube
Krummy
Krummy

Reputation: 668

Trouble with the sonar-packaging-maven-plugin after refactoring

I have some trouble developing a plugin for my company, later called as "myPlugin".

Background: I was reading the book "SonarQube in Action" by the Manning company. There was a little guide for developing a own plugin (they used the redmine plugin as example for developing). It told me to use the sonar-plugin-archetype to create the basic framework.

Situation before refactoring: I wrote the plugin and it works fine. I encountered the problem when I've done some refactoring. Before the refactoring every package in the src folder in my tree (using ecplise) was called "main.java.org.sonar.plugins.myplugin" but the package decleration within each class was "org.sonar.plugins.myplugin". This were default settings created by using the sonar-plugin-archetype.

The settings within the pom.xml of the sonar-packaging-maven-plugin were the following once.

Pom-snippet before any changes were done:
<plugin>
   <groupId>org.codehaus.sonar</groupId>
   <artifactId>sonar-packaging-maven-plugin</artifactId>
   <version>1.9</version>
   <extensions>true</extensions>
   <configuration>
     <pluginClass>org.sonar.plugins.myplugin.myPlugin</pluginClass>
   </configuration>
</plugin>

So far everything worked fine. Now we come to my problem.

Situation after refactoring: As my company has some naming conevtions for classes and packages i changed the package names in the tree to "com.mycompany.sonar.plugins.myplugin" and the package decleration within each class also to "com.mycompany.sonar.plugins.myplugin". Then i changed the classPath option for the sonar-packaging-maven-plugin to "com.mycompany.sonar.plugins.myplugin.myPlugin". All I've done so to say was changing "org." into "com.mycompany.".

Pom-snippet after changes were done:
<plugin>
   <groupId>org.codehaus.sonar</groupId>
   <artifactId>sonar-packaging-maven-plugin</artifactId>
   <version>1.9</version>
   <extensions>true</extensions>
   <configuration>
     <pluginClass>com.mycompany.sonar.plugins.myplugin.myPlugin</pluginClass>
   </configuration>
</plugin>

When i was running the "compile" command everything worked. Using "package" does not work, because the sonar-packaging-maven-plugin was not able to find the given class (see console output below). When i'm refoactoring everything again back to the beginning it works again.

[...] 
[INFO] --- sonar-packaging-maven-plugin:1.9:sonar-plugin (default-sonar-plugin) @ sonar-projectkeychecker-plugin ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 19.649 s
[INFO] Finished at: 2014-04-02T11:42:01+01:00
[INFO] Final Memory: 13M/67M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.codehaus.sonar:sonar-packaging-maven-plugin:1.9:sonar-plugin (default-sonar-plugin) on project sonar-myplugin-plugin: Plugin class not found: 'com.mycompany.sonar.plugins.myplugin.myPlugin-> [Help 1]
[ERROR] 
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] 
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

My Question: Why are my new names not working? Are there any inner convetions for the sonar-packaging-maven-plugin (like the packaging name has to beginn with "org.sonar" ot something like this)?

Thank you for reading this long text and your try to help me :)

Upvotes: 0

Views: 1784

Answers (2)

Vanessa Siemon
Vanessa Siemon

Reputation: 1

Under <plugin> I was missing the <extensions>true</extensions> tag

Upvotes: -1

Simon Brandhof
Simon Brandhof

Reputation: 5136

pluginClass is the entry point of the plugin. Value must be an existing class. In your example I suppose that there's a typo, it should be com.mycompany.sonar.plugins.myplugin.MyPlugin (upper-case M).

Upvotes: 2

Related Questions