Added sonarqube parsers #143

CarlesCapdevila · 2018-06-27T16:22:50Z

Added two parsers for SonarQube:

SonarQube Issues -> Used to parse issues retrieved from the SonarQube api (api/issues/search)
SonarQube Diff -> Used to parse new issues retrieved from a SonarQube differential analysis

uhafner · 2018-07-03T09:24:59Z

Thanks!

Since I already refactored all parsers to use the new API of analysis-model it is important, that no Jenkins libraries are used by a parser. Can you please refactor the code so that the following library is not used?

   <groupId>org.kohsuke.stapler</groupId>
   <artifactId>json-lib</artifactId>
   <packaging>jar</packaging>
   <version>2.4-jenkins-2</version>

You can add new dependencies like

    <dependency>
      <groupId>org.json</groupId>
      <artifactId>json</artifactId>
      <version>${json.version}</version>
    </dependency>
    <dependency>
      <groupId>org.codehaus.groovy</groupId>
      <artifactId>groovy-json</artifactId>
      <version>${groovy-json.version}</version>
    </dependency>

uhafner · 2018-07-03T09:26:40Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeDiffParser.java

+                        String modulePath = "";
+                        String moduleKey = component.optString(COMPONENT_MODULE_KEY, "");
+                        JSONObject moduleComponent = findComponentByKey(components, moduleKey);
+                        if (moduleComponent.containsKey(COMPONENT_PATH)) {


Will throw NPE if findComponentByKey returns NULL

uhafner · 2018-07-03T09:29:11Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeDiffParser.java

+        if (content instanceof JSONObject) {
+            JSONObject jsonReport = (JSONObject) content;
+            //Get the components part to get the file paths on each issue (the component objects contain the most concise path)
+            JSONArray components = null;


Don't use null, Optional can handle this much better (extract into new method)

uhafner · 2018-07-03T09:30:38Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeDiffParser.java

+                        if (moduleComponent.containsKey(COMPONENT_PATH)) {
+                            modulePath = moduleComponent.getString(COMPONENT_PATH) + "/";
+                        }
+


extract code to get modulePath into method

uhafner · 2018-07-03T09:30:58Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeDiffParser.java

+                            } else if (severity.equals(SEVERITY_MINOR) || severity.equals(SEVERITY_INFO)) {
+                                priority = Priority.LOW;
+                            }
+                        }


extract code to get priority into method

uhafner · 2018-07-03T09:31:36Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeDiffParser.java

+            for (Object component : components) {
+                if (component instanceof JSONObject) {
+                    JSONObject jsonComponent = (JSONObject)component;
+                    if (jsonComponent.getString(COMPONENT_KEY).equals(key)) {


flip equals to avoid NPE

uhafner · 2018-07-03T09:32:19Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeIssuesParser.java

+                                modulePath = moduleComponent.getString(COMPONENT_PATH) + "/";
+                            }
+                        }
+


Similar to other class, does it make sense to use a common base?

uhafner · 2018-07-03T09:32:48Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeIssuesParser.java

+
+        return null;
+    }
+}


Extract common features into base class

uhafner · 2018-07-03T09:34:42Z

src/main/resources/hudson/plugins/warnings/parser/Messages.properties

+
+Warnings.SonarQubeDiff.ParserName=SonarQube Diff
+Warnings.SonarQubeDiff.LinkName=SonarQube Diff
+Warnings.SonarQubeDiff.Trend=SonarQube Diff Warnings Trend


You can have icons and a default file name pattern in the next major release, does it make sense to define one for SonarQube?

See example.

That'd be nice, maybe put these icons from the SQ scanner plugin?
And a default pattern of "**/target/sonar/sonar-report.json".

Should I change branch and extend StaticAnalysisTool for that though? :'D

That depends on how much spare time you have ;-) I need to convert the parser to the new API anyway (see https://github.com/jenkinsci/analysis-model). Adding new parsers is now a little bit more complex since the source code is split into two different projects, one for the parsers (no Jenkins dependency) and one for the UI (Jenkins only).

Frankly, I don't have much time on my hands, but maybe I can do it. What's there to be done? :0

Basically, the same PR for the https://github.com/jenkinsci/analysis-model project. You need to extend from AbstractParser and need to create a Report. The test needs to extend from AbstractParserTest. The rest should be the same...

Ok, I'll make the changes to the analysis-model project and PR. Is there anything else to do in this PR? :0 Thank you for your attention!

uhafner · 2018-07-03T09:35:54Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeDiffParser.java

+ * @author Carles Capdevila <Carles.Capdevila@t-systems.com>
+ */
+@Extension
+public class SonarqubeDiffParser extends AbstractWarningsParser {


CamelCase SonarQube

uhafner · 2018-07-03T09:36:06Z

src/main/java/hudson/plugins/warnings/parser/SonarqubeIssuesParser.java

+ * @author Carles Capdevila <Carles.Capdevila@t-systems.com>
+ */
+@Extension
+public class SonarqubeIssuesParser extends AbstractWarningsParser {


CamelCase SonarQube

CarlesCapdevila · 2018-07-03T09:54:06Z

Thank you! I'll get to work on the requested changes and get back to you.

uhafner · 2018-08-23T20:24:41Z

See https://github.com/jenkinsci/analysis-model.

uhafner · 2018-09-10T09:51:37Z

A first beta release of the warnings plug-in is now available. Currently I only integrated the SonarQubeIssuesParser. It would be nice if we can fix that before the 5.0 release.

CarlesCapdevila · 2018-09-10T13:07:49Z

I'm on vacation for a couple weeks, so I don't think I can work on this until at least next month. Is there any estimation for releasing 5.0 yet? Sorry about that :'D

CarlesCapdevila added 2 commits June 27, 2018 17:58

Added sonarqube parsers

695732b

Adapt test (added 2 parsers)

9c410ae

uhafner suggested changes Jul 3, 2018

View reviewed changes

CarlesCapdevila added 3 commits July 3, 2018 18:41

Refactor and fixes as requested

3678291

Don't print on tests

77c07ad

Improve testing a bit

1b2b1ab

CarlesCapdevila mentioned this pull request Jul 9, 2018

Added SonarQube parsers jenkinsci/analysis-model#67

Merged

uhafner closed this Aug 23, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added sonarqube parsers #143

Added sonarqube parsers #143

CarlesCapdevila commented Jun 27, 2018

uhafner commented Jul 3, 2018

uhafner Jul 3, 2018

uhafner Jul 3, 2018

uhafner Jul 3, 2018

uhafner Jul 3, 2018

uhafner Jul 3, 2018

uhafner Jul 3, 2018

uhafner Jul 3, 2018

uhafner Jul 3, 2018

CarlesCapdevila Jul 4, 2018

uhafner Jul 4, 2018

CarlesCapdevila Jul 4, 2018

uhafner Jul 4, 2018 •

edited

Loading

CarlesCapdevila Jul 6, 2018

uhafner Jul 3, 2018

uhafner Jul 3, 2018

CarlesCapdevila commented Jul 3, 2018

uhafner commented Aug 23, 2018

uhafner commented Sep 10, 2018

CarlesCapdevila commented Sep 10, 2018

Added sonarqube parsers #143

Added sonarqube parsers #143

Conversation

CarlesCapdevila commented Jun 27, 2018

uhafner commented Jul 3, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

uhafner Jul 4, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CarlesCapdevila commented Jul 3, 2018

uhafner commented Aug 23, 2018

uhafner commented Sep 10, 2018

CarlesCapdevila commented Sep 10, 2018

uhafner Jul 4, 2018 •

edited

Loading