Store Custom Plugin Configurations

unb · June 26, 2020, 8:15am

Hi,

What is the best practice to store custom plugin configurations on sonarqube?
Could you please let me know is there any way to do this?

I am using sonarqube 7.9.3 LTS

Thank You

Julien_HENRY · June 29, 2020, 6:59am

Hi,

You can declare properties your plugin rely on using the PropertyDefinition API: https://github.com/SonarSource/sonar-custom-plugin-example/blob/ee4236541cf276ebaad11dea43c88e7fd18cca9d/src/main/java/org/sonarsource/plugins/example/settings/HelloWorldProperties.java#L38
This will optionally make the setting editable in SonarQube UI.

Then your plugin can query the value using the Configuration API:

github.com

SonarSource/sonar-custom-plugin-example/blob/ee4236541cf276ebaad11dea43c88e7fd18cca9d/src/main/java/org/sonarsource/plugins/example/settings/SayHelloFromScanner.java#L36



public class SayHelloFromScanner implements Sensor {

  @Override
  public void describe(SensorDescriptor descriptor) {
    descriptor.name(getClass().getName());
  }

  @Override
  public void execute(SensorContext context) {
    if (context.config().getBoolean(HelloWorldProperties.HELLO_KEY).orElse(false)) {
      // print log only if property is set to true
      Loggers.get(getClass()).info("Hello World!");
    }
  }

}

unb · June 29, 2020, 1:05pm

Hi @Julien_HENRY

This is the answer what i looking for. Thank you very much for your consideration.

Thank you

system · July 6, 2020, 1:05pm

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.