Search rule by key

[satabin]

For custom rules created from a template rule, the internalKey is set
to the internal key of the template rule by Sonar and not the custom
rule key. When looking up the rule by internal key and providing the
custom rule key, nothing is found as they do not match.

Here is the rule created in sonarqube

and the API returns the following object:

{
      "key": "sonar-scala-scalastyle:test_test",
      "repo": "sonar-scala-scalastyle",
      "name": "test",
      "createdAt": "2019-01-23T16:23:58+0000",
      "severity": "MINOR",
      "internalKey": "org.scalastyle.file.RegexChecker-template",
      "templateKey": "sonar-scala-scalastyle:org.scalastyle.file.RegexChecker-template",
      "lang": "scala",
      "params": [
        {
          "key": "line",
          "htmlDesc": "Line: Boolean whether to process line by line",
          "type": "BOOLEAN"
        },
        {
          "key": "regex",
          "htmlDesc": "Regular expression: Standard Scala regular expression syntax including multiline",
          "defaultValue": "\\*>",
          "type": "STRING"
        },
        {
          "key": "ruleClass",
          "htmlDesc": "Scalastyle's rule (checker) class name.",
          "type": "STRING"
        }
      ],
      "type": "CODE_SMELL"
}

Using the rule key with repository to lookup fo rules ensures that even custom rules are found.

[BalmungSan]

@satabin Good catch and Thanks! for the contribution.
Could you please also add an unit test case that should fail before the fix and pass now?

[satabin]

Yes, I will do that.

[satabin]

I added a test and took the occasion to fix another one that was not checking anything.

[BalmungSan]

Great, Thanks! 👍

[mwz]

Nice one - thanks for contributing and implementing the tests which @BalmungSan asked for. I've made a minor inline comment about your testing style and I'll be happy to merge and release as soon you've addressed it. Thanks again 👍

[mwz]

Thanks for the fix @satabin.

[mwz]

Released as 7.3.1.

[satabin]

Awesome, thanks!