How to create a Profile with a Parent in extension plugin

jam01 · April 1, 2019, 11:41pm

Hey guys,

I’m currently working on creating a custom plugin with custom rules, I’ve managed that. I’m having some issues figuring out how to create a new Profile to be available in SonarQube while inheriting from the SonarWay Java Profile. I’m using the BuiltInQualityProfilesDefinition to create the profile definition and it works, but can’t seem to figure out how to also inherit from the JavaSonarWayProfile to be able to include all those rules.

Any insight is appreciated, thanks!

Julien_HENRY · April 2, 2019, 7:07am

Hi,

I don’t think there is a way to have built-in profiles inheriting from each other. You will have to repeat all the rules you want in your custom profile.

jam01 · April 3, 2019, 6:50am

Thanks for the response Julien. Is there then a way for me to query all the rules on the SonarWay profile and add them to the new one? Thanks again.

Julien_HENRY · April 3, 2019, 7:27am

You mean at runtime right?

No, BuiltInQualityProfile extension point is evaluated during server startup to initialize the quality profiles. That’s too early to get access to other quality profiles (would create a loop).

jam01 · April 3, 2019, 1:35pm

Not at runtime. The extension plugin I’m writing has dependencies on the Java plugin so the SonarWay profile class is available, it’s just not “built” I think.

Julien_HENRY · April 4, 2019, 7:39am

You are depending on a specific version of SonarJava at compile time, but it doesn’t mean it will be the same version installed on the server. And consequently some rules may not exists.

Still if you want to automate extracting rules of SonarWay at build time, you should maybe look at the unit test:

github.com

SonarSource/sonar-java/blob/12af37db9e296248e19600e48dfc8e85af5b064e/sonar-java-plugin/src/test/java/org/sonar/plugins/java/JavaSonarWayProfileTest.java#L40


import org.sonar.api.utils.ValidationMessages;


import static org.assertj.core.api.Assertions.assertThat;


public class JavaSonarWayProfileTest {


  @Test
  public void should_create_sonar_way_profile() {
    ValidationMessages validation = ValidationMessages.create();


    JavaSonarWayProfile profileDef = new JavaSonarWayProfile(SonarVersion.SQ_73_RUNTIME);
    BuiltInQualityProfilesDefinition.Context context = new BuiltInQualityProfilesDefinition.Context();
    profileDef.define(context);
    BuiltInQualityProfilesDefinition.BuiltInQualityProfile profile = context.profile("java", "Sonar way");
    assertThat(profile.language()).isEqualTo(Java.KEY);
    List<BuiltInQualityProfilesDefinition.BuiltInActiveRule> activeRules = profile.rules();
    assertThat(activeRules.stream().filter(r -> r.repoKey().equals("common-java"))).hasSize(1);
    assertThat(activeRules.size()).as("Expected number of rules in profile").isGreaterThanOrEqualTo(268);
    assertThat(profile.name()).isEqualTo("Sonar way");
    Set<String> keys = new HashSet<>();
    for (BuiltInQualityProfilesDefinition.BuiltInActiveRule activeRule : activeRules) {

jam01 · April 6, 2019, 6:50pm

I’m still trying to understand the best practices or what functionality I could/should provide and what should be left to the user. For example I saw that findbugs does depend on the java plugin as well, here:

github.com

spotbugs/sonar-findbugs/blob/master/pom.xml#L172


    <!-- allows to package xstream into plugin -->
    <exclusion>
      <groupId>com.thoughtworks.xstream</groupId>
      <artifactId>xstream</artifactId>
    </exclusion>
  </exclusions>
</dependency>


<dependency>
  <groupId>org.sonarsource.java</groupId>
  <artifactId>sonar-java-plugin</artifactId>
  <version>${sonar-java.version}</version>
  <scope>provided</scope>
</dependency>


<!-- unit tests -->
<dependency>
  <groupId>junit</groupId>
  <artifactId>junit</artifactId>
  <version>4.12</version>
  <scope>test</scope>

So I thought that’d be an acceptable way to provide a quick way for the user to switch from the built in plugin to one that just adds a few new ones that we provide. Just trying to figure out the best way to do that.

Julien_HENRY · April 8, 2019, 12:08pm

I opened a ticket with this idea of improvement:
https://jira.sonarsource.com/browse/SONAR-11939

I think it will be considered as low priority, so don’t really expect it to be implemented before a few months.

In the meantime, you’ll have to document how users should create manually a new profile, extending the build-in SonarWay and adding your rules.

jam01 · April 8, 2019, 7:43pm

Can’t ask for more than that. Thanks Julien.