java.lang.NoClassDefFoundError: org/sonarsource/analyzer/commons/RuleMetadataLoader

mattadamson · April 17, 2023, 9:23pm

Hi

We see this exception

from a new java custom plug in similar to the community edition. This class is referenced here

    NewRepository repository = context.createRepository(REPOSITORY_KEY, "java").setName(REPOSITORY_NAME);

    RuleMetadataLoader ruleMetadataLoader = new RuleMetadataLoader(RESOURCE_BASE_PATH, runtime);

We can see this class defined in sonar-java-plugin and org.sonarsource.analyzer-commons

Sonar 10.0 is used 9.15.0.435 of org.sonarsource.api.plugin is a provided dependency
Thanks

felipebz · April 17, 2023, 10:13pm

Hi,

Using the class directly from the sonar-java plugin is not possible due to the isolated classloaders utilized by the plugins, as explained in the SonarQube docs.

Plugins are loaded in isolated classloaders. It means a plugin can’t access another plugin’s classes. There is an exception for package names following pattern org.sonar.plugins.<pluginKey>.api . For example, all classes in a plugin with the key myplugin that are located in org.sonar.plugins.myplugin.api are visible to other plugins.

In general, a plugin cannot access classes from another plugin, except for those that follow that specific package naming convention. Therefore, only the SonarQube API and classes from org.sonar.plugins.java.api.* are available to your plugin.

This example seems to be relevant to what you’re implementing: https://github.com/SonarSource/sonar-java/blob/master/its/plugin/plugins/java-extension-plugin/src/main/java/org/sonar/samples/java/JavaExtensionRulesDefinition.java

mattadamson · April 18, 2023, 9:30am

thanks @felipebz I used the original sample from

github.com

SonarSource/sonar-java/blob/master/docs/java-custom-rules-example/src/main/java/org/sonar/samples/java/MyJavaRulesDefinition.java

/*
 * Copyright (C) 2012-2023 SonarSource SA - mailto:info AT sonarsource DOT com
 * This code is released under [MIT No Attribution](https://opensource.org/licenses/MIT-0) license.
 */
package org.sonar.samples.java;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Objects;
import java.util.Set;
import org.sonar.api.SonarRuntime;
import org.sonar.api.server.rule.RulesDefinition;
import org.sonarsource.analyzer.commons.RuleMetadataLoader;

/**
 * Declare rule metadata in server repository of rules.
 * That allows to list the rules in the page "Rules".
 */
public class MyJavaRulesDefinition implements RulesDefinition {

This file has been truncated. show original

I made the updates from the other link which works better now thanks.

Ram_Gurung · May 9, 2023, 8:55am

I am having the same issue. Can you share how you fix this issue?