SonarQube Plugins

Link a review with a JIRA issue

Details

  • Type: New Feature New Feature
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: JIRA-1.0
  • Component/s: Jira
  • Labels:
    None
  • Number of attachments :
    2

Description

As a user, I want to link a violation to a JIRA issue.

Given I'm in the "Violations drilldown" menu of a project and I'm looking into the violations in the "violations" tab of a source file,
I want to be able to click on a button that creates a JIRA issue from a violation.
The JIRA server and project may be configured in the "configuration section" of my sonar project.

The JIRA issue may be created with :

  • A summary built from the name of the violation and the name of the source file (eg : "Empty If Stmt in Valid.Applications.SimpleJavaApplication")
  • A description that
  • Give details on the violation location : the line number
  • Explains the reason of the violation (eg : Empty If Stmt » Avoid empty if statements)
  • An url to the Sonar violation

Issue Links

depends upon

New Feature - A new feature of the product, which has yet to be developed. SONAR-2706 Add extension point to the Review functionality in order to link review to external tracking system like JIRA or Crucible

  • Major - Major loss of function.
  • Closed - The issue is considered finished, the resolution is correct. Issues which are not closed can be reopened.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Freddy Mallet added a comment -

Hi Benoit, in fact we've introduced Reviews in Sonar 2.8 and it's already possible to add a comment on a review containing a link to a JIRA issue. So perhaps you're just talking about a kind of shortcut button to automatically create the JIRA ticket from the Sonar GUI and insert the JIRA ticket URL in a comment of the review ?

Show
Freddy Mallet added a comment - Hi Benoit, in fact we've introduced Reviews in Sonar 2.8 and it's already possible to add a comment on a review containing a link to a JIRA issue. So perhaps you're just talking about a kind of shortcut button to automatically create the JIRA ticket from the Sonar GUI and insert the JIRA ticket URL in a comment of the review ?
Hide
Permalink
Benoit VIAUD added a comment - - edited

Mockup proposal for the feature.
Is it what you had in mind?

It would be perfect to specify somewhere in Sonar the JIRA project and ticket type associated to the Sonar project.
In a first version, it is also possible to specify those information for each violation (see attachment#1)...

Whether or not to create the JIRA issue after the review (attachment#2) or separately (attachment#1) is up to you...

Show
Benoit VIAUD added a comment - - edited Mockup proposal for the feature. Is it what you had in mind? It would be perfect to specify somewhere in Sonar the JIRA project and ticket type associated to the Sonar project. In a first version, it is also possible to specify those information for each violation (see attachment#1)... Whether or not to create the JIRA issue after the review (attachment#2) or separately (attachment#1) is up to you...
Hide
Permalink
Andreas Pieber added a comment -

+1 to the mockups. I would definitely like to see the issue as you proposed it.

Show
Andreas Pieber added a comment - +1 to the mockups. I would definitely like to see the issue as you proposed it.
Hide
Permalink
Freddy Mallet added a comment -

Works well, could you just :

  • Doesn't provide any default login/password
  • Log an error in the Sonar server log file when a request can't be done and whatever is the reason
  • Merge this JIRA Reviews plugin to the legacy JIRA plugin
  • Add the rule title to the JIRA title : "Sonar Review #12345 - Parameter assignement" (I guess one day we'll allow user to define a JIRA title template)
Show
Freddy Mallet added a comment - Works well, could you just : Doesn't provide any default login/password Log an error in the Sonar server log file when a request can't be done and whatever is the reason Merge this JIRA Reviews plugin to the legacy JIRA plugin Add the rule title to the JIRA title : "Sonar Review #12345 - Parameter assignement" (I guess one day we'll allow user to define a JIRA title template)
Hide
Permalink
David Samuelsson added a comment -

Hope the jira project setting is / project and not global. We have many Jira projects and we need to map one sonar project to one jira project.

Show
David Samuelsson added a comment - Hope the jira project setting is / project and not global. We have many Jira projects and we need to map one sonar project to one jira project.
Hide
Permalink
Fabrice Bellingard added a comment -

Hi David,

the settings are the same as for every plugin in Sonar: you can set them globally, and override them on each project if necessary. This should meet most needs.

Show
Fabrice Bellingard added a comment - Hi David, the settings are the same as for every plugin in Sonar: you can set them globally, and override them on each project if necessary. This should meet most needs.
Hide
Permalink
David Samuelsson added a comment -

ok, good, we ran into the code reviewing rules are set on a global level, which makes us have global rules for all manual code reviews.

Show
David Samuelsson added a comment - ok, good, we ran into the code reviewing rules are set on a global level, which makes us have global rules for all manual code reviews.
Hide
Permalink
Fabrice Bellingard added a comment -

Code merged into the existing JIRA plugin.

Show
Fabrice Bellingard added a comment - Code merged into the existing JIRA plugin.
Hide
Permalink
Fabrice Bellingard added a comment -

Freddy:

  • Sonar 3.1 updated to log errors when a review command fails
  • Rule title added to the ticket summary

And documentation updated on the Wiki.

Show
Fabrice Bellingard added a comment - Freddy: Sonar 3.1 updated to log errors when a review command fails Rule title added to the ticket summary And documentation updated on the Wiki.
Hide
Permalink
Freddy Mallet added a comment -

Manually tested !

Show
Freddy Mallet added a comment - Manually tested !
Hide
Permalink
David Samuelsson added a comment -

hmm tested this on our test server and cant get this to work.

any way i can narrow down my search for this error?

"Impossible to connect to the JIRA server (https://jiratest.home.com). Hide this message"

One way to avoid this would to add an "test connection" button to the Jira settings page so you know if the integration works. All add that as an enhancement.

setup:
Jira 4.4.3 (over https://)
Sonar 3.1

Show
David Samuelsson added a comment - hmm tested this on our test server and cant get this to work. any way i can narrow down my search for this error? "Impossible to connect to the JIRA server ( https://jiratest.home.com ). Hide this message" One way to avoid this would to add an "test connection" button to the Jira settings page so you know if the integration works. All add that as an enhancement. setup: Jira 4.4.3 (over https:// ) Sonar 3.1
Hide
Permalink
David Samuelsson added a comment -

there added: http://jira.codehaus.org/browse/SONARPLUGINS-1982

Show
David Samuelsson added a comment - there added: http://jira.codehaus.org/browse/SONARPLUGINS-1982
Hide
Permalink
Fabrice Bellingard added a comment -

Can you switch to the user ML to discuss you issue please?

Show
Fabrice Bellingard added a comment - Can you switch to the user ML to discuss you issue please?
Hide
Permalink
David Samuelsson added a comment -

huh? What do you mean? What do you want me to do?

Show
David Samuelsson added a comment - huh? What do you mean? What do you want me to do?
Hide
Permalink
Fabrice Bellingard added a comment -

What I mean is that before creating or updating tickets directly in JIRA, we ask users to first initiate a discussion on Sonar user mailing list. The reason is simple: few people follow JIRA tickets, whereas many users can contribute to the discussion and share ideas on the user mailing list.

Show
Fabrice Bellingard added a comment - What I mean is that before creating or updating tickets directly in JIRA, we ask users to first initiate a discussion on Sonar user mailing list. The reason is simple: few people follow JIRA tickets, whereas many users can contribute to the discussion and share ideas on the user mailing list.
Hide
Permalink
David Samuelsson added a comment -

thanks, done!

Show
David Samuelsson added a comment - thanks, done!

People

  • Assignee:
    Fabrice Bellingard
    Reporter:
    Benoit VIAUD
Vote (8)
Watch (8)

Dates

  • Created:
    Updated:
    Resolved: