Warning message to GUI from custom plugin

gdaniel · November 30, 2020, 1:28pm

Hi, I would like to add some analysis error notification / warning to the gui if something happened during the analysis.

On GUI I know there is a “Last analysis had x warning” section, but is it available for the public to add custom warning from plugin side?

I know I could create a custom error rule, but would like to use the GUI properly if I can.

Thanks in advance.

Julien_HENRY · December 1, 2020, 12:30pm

Hi,

You can use AnalysisWarnings. See how to use it on scanner side:

github.com

SonarSource/sonarqube/blob/f2bf93dff30ed93fbce24dcf2078801e2544d008/sonar-plugin-api-impl/src/main/java/org/sonar/api/batch/fs/internal/charhandler/LineCounter.java#L49


public LineCounter(AnalysisWarnings analysisWarnings, String filePath, Charset encoding) {
  this.analysisWarnings = analysisWarnings;
  this.filePath = filePath;
  this.encoding = encoding;
}
@Override
public void handleAll(char c) {
  if (!alreadyLoggedInvalidCharacter && c == '\ufffd') {
    analysisWarnings.addUnique("There are problems with file encoding in the source code. Please check the scanner logs for more details.");
    LOG.warn("Invalid character encountered in file {} at line {} for encoding {}. Please fix file content or configure the encoding to be used using property '{}'.", filePath,
      lines, encoding, CoreProperties.ENCODING_PROPERTY);
    alreadyLoggedInvalidCharacter = true;
  }
}
@Override
public void newLine() {
  lines++;
  if (!blankLine) {

++

gdaniel · December 1, 2020, 9:07am

Thanks, I think this would be it. But how could I use it? I mean I have access to the context, sensorcontext but Iam not sure where should I get the AnalysisWarning from.

Julien_HENRY · December 1, 2020, 12:30pm

SonarQube plugins are loaded into PicoContainer, that is an IoC framework. Just add it as parameter to your Sensor constructor.

gdaniel · December 1, 2020, 12:30pm

Yeah, just managed to do this as You wrote it

Thanks for the help.

system · December 8, 2020, 12:30pm

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