Sqale support for 'other' rules #467

guwirth · 2015-04-16T07:15:07Z

With new API it is no problem to set default values for Sqale/Technical Debt:
http://grepcode.com/file/repo1.maven.org/maven2/org.codehaus.sonar/sonar-plugin-api/4.5.2/org/sonar/api/server/rule/RulesDefinition.java#RulesDefinition.NewRule

[Public Method] setDebtRemediationFunction(DebtRemediationFunction) : RulesDefinition.NewRule
[Public Method] setDebtSubCharacteristic(String) : RulesDefinition.NewRule
[Public Method] setEffortToFixDescription(String) : RulesDefinition.NewRule

Question is only what is 'default'?

The current used RulesDefinitionXmlLoader does not support Technical Debt values:
http://javadocs.sonarsource.org/4.4/apidocs/org/sonar/api/server/rule/RulesDefinitionXmlLoader.html

<rules>
   <rule>
     <!-- required fields -->
     <key>the-rule-key</key>
     <name>The purpose of the rule</name>

     <!-- optional fields -->
     <description>
       <![CDATA[The description]]>
     </description>
     <internalKey>Checker/TreeWalker/LocalVariableName</internalKey>
     <severity>BLOCKER</severity>
     <cardinality>MULTIPLE</cardinality>
     <status>BETA</status>
     <param>
       <key>the-param-key</key>
       <tag>style</tag>
       <tag>security</tag>
       <description>
         <![CDATA[the param-description]]>
       </description>
       <defaultValue>42</defaultValue>
     </param>
     <param>
       <key>another-param</key>
     </param>

     <!-- deprecated fields -->
     <configKey>Checker/TreeWalker/LocalVariableName</configKey>
     <priority>BLOCKER</priority>
   </rule>
 </rules>

Idea could be to extend this file with Sqale values for the rules, so everything is together in one file?

<rule>
  ...
  <sqale>
    <chc>
      <key>PORTABILITY</key>
      <name>Portability</name>
        <chc>
          <key>COMPILER_RELATED_PORTABILITY</key>
          <name>Compiler related portability</name>
            <chc>
              <rule-repo>cppcheck</rule-repo>
              <rule-key>AssignmentAddressToInteger</rule-key>
              <prop>
                <key>remediationFunction</key>
                <txt>linear</txt>
              </prop>
              <prop>
                <key>remediationFactor</key>
                <val>5</val>
                <txt>mn</txt>
              </prop>
              <prop>
                <key>offset</key>
                <val>0.0</val>
                <txt>d</txt>
              </prop>
            ...

The text was updated successfully, but these errors were encountered:

jmecosta · 2015-04-16T08:06:24Z

The default is used to revert the rule to the original value, since those
can be modified when you create a new profile. If you query the rest api
you will get both default and current.

On Thu, Apr 16, 2015, 10:15 Günter Wirth [email protected] wrote:

With new API it is no problem to set default values for Sqale/Technical
Debt:

http://grepcode.com/file/repo1.maven.org/maven2/org.codehaus.sonar/sonar-plugin-api/4.5.2/org/sonar/api/server/rule/RulesDefinition.java#RulesDefinition.NewRule

[Public Method] setDebtRemediationFunction(DebtRemediationFunction) : RulesDefinition.NewRule
[Public Method] setDebtSubCharacteristic(String) : RulesDefinition.NewRule
[Public Method] setEffortToFixDescription(String) : RulesDefinition.NewRule

Question is only what is 'default'?

The current used RulesDefinitionXmlLoader does not support Technical Debt
values:

http://javadocs.sonarsource.org/4.4/apidocs/org/sonar/api/server/rule/RulesDefinitionXmlLoader.html
the-rule-key The purpose of the rule
 
 <description>
   <![CDATA[The description]]>
 </description>
 <internalKey>Checker/TreeWalker/LocalVariableName</internalKey>
 <severity>BLOCKER</severity>
 <cardinality>MULTIPLE</cardinality>
 <status>BETA</status>
 <param>
   <key>the-param-key</key>
   <tag>style</tag>
   <tag>security</tag>
   <description>
     <![CDATA[the param-description]]>
   </description>
   <defaultValue>42</defaultValue>
 </param>
 <param>
   <key>another-param</key>
 </param>

 
 <configKey>Checker/TreeWalker/LocalVariableName</configKey>
 <priority>BLOCKER</priority>
Idea could be to extend this file with Sqale values for the rules, so
everything is together in one file?
... PORTABILITY Portability COMPILER_RELATED_PORTABILITY Compiler related portability cppcheck AssignmentAddressToInteger remediationFunction linear remediationFactor 5 mn offset 0.0 d ...
—
Reply to this email directly or view it on GitHub
#467.

guwirth · 2015-04-16T09:38:32Z

Don't understand this, calling e.g. http://localhost:9000/api/rules/show?key=other:PORTING.BSWAP.MACRO

I get:

{ 
   "rule":{  
      "key":"other:PORTING.BSWAP.MACRO",
      "repo":"other",
      "name":"PORTING.BSWAP.MACRO:Use of a custom byte-swap macro without endianness check",
      "createdAt":"2015-04-09T12:08:21+0200",
      "severity":"MAJOR",
      "status":"READY",
      "internalKey":"PORTING.BSWAP.MACRO",
      "isTemplate":false,
      "tags":[ 
      ],
      "sysTags":[ 
      ],
      "lang":"c++",
      "langName":"c++",
      "htmlDesc":"Use of a custom byte-swap macro without endianness check",
      "debtOverloaded":false,
      "params":[ 
      ]
   }
}

Calling http://localhost:9000/api/rules/show?key=cxx:HardcodedAccount

I get

{  
   "rule":{  
      "key":"cxx:HardcodedAccount",
      "repo":"cxx",
      "name":"Do not hard code sensitive data in programs",
      "createdAt":"2015-04-09T11:59:39+0200",
      "severity":"BLOCKER",
      "status":"READY",
      "internalKey":"HardcodedAccount",
      "isTemplate":false,
      "tags":[  
      ],
      "sysTags":[  
         "cert",
         "security"
      ],
      "lang":"c++",
      "langName":"c++",
      "htmlDesc":"<p>...</p>",
      "defaultDebtChar":"CHANGEABILITY",
      "defaultDebtSubChar":"ARCHITECTURE_CHANGEABILITY",
      "debtChar":"CHANGEABILITY",
      "debtSubChar":"ARCHITECTURE_CHANGEABILITY",
      "debtCharName":"Changeability",
      "debtSubCharName":"Architecture",
      "defaultDebtRemFnType":"CONSTANT_ISSUE",
      "defaultDebtRemFnOffset":"30min",
      "debtOverloaded":false,
      "debtRemFnType":"CONSTANT_ISSUE",
      "debtRemFnOffset":"30min",
      "params":[  
         {  
            "key":"regularExpression",
            "htmlDesc":"literal regular expression rule",
            "type":"STRING",
            "defaultValue":"\\bDSN\\b.*=.*;\\b(UID|PWD)\\b=.*;"
         }
      ]
   }
}

In second case there are

      "defaultDebtChar":"CHANGEABILITY",
      "defaultDebtSubChar":"ARCHITECTURE_CHANGEABILITY",
      "debtChar":"CHANGEABILITY",
      "debtSubChar":"ARCHITECTURE_CHANGEABILITY",
      "debtCharName":"Changeability",
      "debtSubCharName":"Architecture",
      "defaultDebtRemFnType":"CONSTANT_ISSUE",
      "defaultDebtRemFnOffset":"30min",
      "debtOverloaded":false,
      "debtRemFnType":"CONSTANT_ISSUE",
      "debtRemFnOffset":"30min",

So my idea was to add this also for 'other'.

Step 1: a default value
Step 2: add a possibility to define them also in the XML file

jmecosta · 2015-04-16T09:43:47Z

Sure if platform supports its fine, I usually use this
https://github.com/jmecsoftware/QualityProfileEditorPlugin since i can
adjust those ones on the fly.

On Thu, Apr 16, 2015, 12:38 Günter Wirth [email protected] wrote:

Don't understand this, calling e.g.
http://localhost:9000/api/rules/show?key=other:PORTING.BSWAP.MACRO

I get:

{
"rule":{
"key":"other:PORTING.BSWAP.MACRO",
"repo":"other",
"name":"PORTING.BSWAP.MACRO:Use of a custom byte-swap macro without endianness check",
"createdAt":"2015-04-09T12:08:21+0200",
"severity":"MAJOR",
"status":"READY",
"internalKey":"PORTING.BSWAP.MACRO",
"isTemplate":false,
"tags":[
],
"sysTags":[
],
"lang":"c++",
"langName":"c++",
"htmlDesc":"Use of a custom byte-swap macro without endianness check",
"debtOverloaded":false,
"params":[
]
}
}

Calling http://localhost:9000/api/rules/show?key=cxx:HardcodedAccount

I get

{
"rule":{
"key":"cxx:HardcodedAccount",
"repo":"cxx",
"name":"Do not hard code sensitive data in programs",
"createdAt":"2015-04-09T11:59:39+0200",
"severity":"BLOCKER",
"status":"READY",
"internalKey":"HardcodedAccount",
"isTemplate":false,
"tags":[
],
"sysTags":[
"cert",
"security"
],
"lang":"c++",
"langName":"c++",
"htmlDesc":"
...
",
"defaultDebtChar":"CHANGEABILITY",
"defaultDebtSubChar":"ARCHITECTURE_CHANGEABILITY",
"debtChar":"CHANGEABILITY",
"debtSubChar":"ARCHITECTURE_CHANGEABILITY",
"debtCharName":"Changeability",
"debtSubCharName":"Architecture",
"defaultDebtRemFnType":"CONSTANT_ISSUE",
"defaultDebtRemFnOffset":"30min",
"debtOverloaded":false,
"debtRemFnType":"CONSTANT_ISSUE",
"debtRemFnOffset":"30min",
"params":[
{
"key":"regularExpression",
"htmlDesc":"literal regular expression rule",
"type":"STRING",
"defaultValue":"\bDSN\b.=.;\b(UID|PWD)\b=.*;"
}
]
}
}

In second case there are
  "defaultDebtChar":"CHANGEABILITY",
  "defaultDebtSubChar":"ARCHITECTURE_CHANGEABILITY",
  "debtChar":"CHANGEABILITY",
  "debtSubChar":"ARCHITECTURE_CHANGEABILITY",
  "debtCharName":"Changeability",
  "debtSubCharName":"Architecture",
  "defaultDebtRemFnType":"CONSTANT_ISSUE",
  "defaultDebtRemFnOffset":"30min",
  "debtOverloaded":false,
  "debtRemFnType":"CONSTANT_ISSUE",
  "debtRemFnOffset":"30min",
So my idea was to add this also for 'other'.

Step 1: a default value

Step 2: add a possibility to define them also in the XML file

—
Reply to this email directly or view it on GitHub
#467 (comment).

guwirth · 2015-04-16T13:40:41Z

I think your tool is very good to modify the settings but for an initial setup I would prefer to have all in one file and inside of the SQ configuration.

jmecosta · 2015-04-16T15:21:53Z

Sure I can see the point. Perhaps augment the current format with the sqale
definitions

On Thu, Apr 16, 2015, 16:40 Günter Wirth [email protected] wrote:

I think your tool is very good to modify the settings but for an initial
setup I would prefer to have all in one file and inside of the SQ
configuration.

—
Reply to this email directly or view it on GitHub
#467 (comment).

guwirth · 2015-04-16T15:49:28Z

Do you know if there is a helper class to read the sqale xml (<sqale><chc>...)?

jmecosta · 2015-04-16T18:27:42Z

not aware of anything... perhaps the sonar core contains something

On Thu, 16 Apr 2015 at 18:49 Günter Wirth [email protected] wrote:

Do you know if there is a helper class to read the sqale xml (
...)?

—
Reply to this email directly or view it on GitHub
#467 (comment).

guwirth · 2015-04-17T15:33:32Z

See #469 for first demo to set a 'default' sqale value.

guwirth · 2015-05-29T19:25:07Z

This could be a solution: http://grepcode.com/file/repo1.maven.org/maven2/org.codehaus.sonar.sslr-squid-bridge/sslr-squid-bridge/2.5/org/sonar/squidbridge/rules/SqaleXmlLoader.java. Load in the same way as rule file.

jmecosta · 2015-05-29T19:39:15Z

Yep that will work. Good that they introduce this method. I suggest the
sqale XML also to be added via the web ui and this method will load the
definitions

On Fri, May 29, 2015, 22:25 Günter Wirth [email protected] wrote:

This could be a solution:
http://grepcode.com/file/repo1.maven.org/maven2/org.codehaus.sonar.sslr-squid-bridge/sslr-squid-bridge/2.5/org/sonar/squidbridge/rules/SqaleXmlLoader.java.
Load in the same way as rule file.

—
Reply to this email directly or view it on GitHub
#467 (comment).

guwirth · 2015-05-30T10:04:46Z

Still not sure what is the better choice here:

have own xml file for rules and sqale values
or have two separated files?

jmecosta · 2015-05-30T10:11:52Z

Perhaps the existing XML could be augmented to include the chars. Still
keeping the current format intact. We might need to create a script to
validate the characteristics since the model is very specific and it's easy
to make mistakes

On Sat, May 30, 2015, 13:04 Günter Wirth [email protected] wrote:

Still not sure what is the better choice here:

have own xml file for rules and sqale values

or have two separated files?

—
Reply to this email directly or view it on GitHub
#467 (comment).

guwirth added enhancement discussion labels Apr 16, 2015

guwirth modified the milestone: M 0.9.4 Apr 29, 2015

This was referenced Jun 2, 2015

Custom SquidCheck #527

Closed

SQALE characteristics for other rules #529

Merged

guwirth added solution available and removed discussion labels Jun 7, 2015

guwirth self-assigned this Jun 7, 2015

guwirth closed this as completed in #529 Jun 29, 2015

guwirth removed the solution available label Jun 29, 2015

guwirth added the docu request label Jul 25, 2015

guwirth mentioned this issue Oct 25, 2015

V0.9.4 #505

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sqale support for 'other' rules #467

Sqale support for 'other' rules #467

guwirth commented Apr 16, 2015

jmecosta commented Apr 16, 2015

guwirth commented Apr 16, 2015

jmecosta commented Apr 16, 2015

guwirth commented Apr 16, 2015

jmecosta commented Apr 16, 2015

guwirth commented Apr 16, 2015

jmecosta commented Apr 16, 2015

guwirth commented Apr 17, 2015

guwirth commented May 29, 2015

jmecosta commented May 29, 2015

guwirth commented May 30, 2015

jmecosta commented May 30, 2015

Sqale support for 'other' rules #467

Sqale support for 'other' rules #467

Comments

guwirth commented Apr 16, 2015

jmecosta commented Apr 16, 2015

guwirth commented Apr 16, 2015

jmecosta commented Apr 16, 2015

guwirth commented Apr 16, 2015

jmecosta commented Apr 16, 2015

guwirth commented Apr 16, 2015

jmecosta commented Apr 16, 2015

guwirth commented Apr 17, 2015

guwirth commented May 29, 2015

jmecosta commented May 29, 2015

guwirth commented May 30, 2015

jmecosta commented May 30, 2015