4.5.2 API

.travis.yml

@@ -10,8 +10,8 @@ before_install:
 
 install:
         - cd /tmp
-        - wget http://dist.sonar.codehaus.org/sonarqube-4.5.1.zip
-        - unzip sonarqube-4.5.1.zip
+        - wget http://dist.sonar.codehaus.org/sonarqube-4.5.4.zip
+        - unzip sonarqube-4.5.4.zip
         - wget http://repo1.maven.org/maven2/org/codehaus/sonar/runner/sonar-runner-dist/2.4/sonar-runner-dist-2.4.zip
         - unzip sonar-runner-dist-2.4.zip
         - cd -
@@ -24,5 +24,5 @@ before_script:
 script:
         - mvn install -DskipTests=true
         - mvn test
-        - RAILS_ENV=production PATH=$PATH:/tmp/sonar-runner-2.4/bin SONARHOME=/tmp/sonarqube-4.5.1 behave
+        - RAILS_ENV=production PATH=$PATH:/tmp/sonar-runner-2.4/bin SONARHOME=/tmp/sonarqube-4.5.4 behave
 

cxx-checks/src/main/java/org/sonar/cxx/checks/BooleanEqualityComparisonCheck.java

@@ -24,16 +24,20 @@
 import org.sonar.cxx.api.CxxKeyword;
 import org.sonar.cxx.parser.CxxGrammarImpl;
 import org.sonar.squidbridge.checks.SquidCheck;
-
 import com.sonar.sslr.api.Grammar;
 import com.sonar.sslr.api.AstNode;
-
+import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.squidbridge.annotations.ActivatedByDefault;
+import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
+import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;
 
 @Rule(
   key = "BooleanEqualityComparison",
-  description = "Remove literal boolean values from conditional expressions to improve readability.",
+  name = "Literal boolean values should not be used in condition expressions",
   priority = Priority.MINOR)
-
+@ActivatedByDefault
+@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.UNDERSTANDABILITY)
+@SqaleConstantRemediation("5min")
 public class BooleanEqualityComparisonCheck extends SquidCheck<Grammar> {
 
   @Override

cxx-checks/src/main/java/org/sonar/cxx/checks/CheckList.java

@@ -33,46 +33,46 @@ private CheckList() {
   }
 
   public static List<Class> getChecks() {
-    return ImmutableList.<Class> of(
-        CollapsibleIfCandidateCheck.class,
-        CommentedCodeCheck.class,
-        CommentRegularExpressionCheck.class,
-        CycleBetweenPackagesCheck.class,
-        DuplicatedIncludeCheck.class,
-        FileComplexityCheck.class,
-        FileHeaderCheck.class,
-        FileEncodingCheck.class,
-        FileRegularExpressionCheck.class,
-        LineRegularExpressionCheck.class,
-        FixmeTagPresenceCheck.class,
-        FunctionComplexityCheck.class,
-        HardcodedAccountCheck.class,
-        HardcodedIpCheck.class,
-        IndentationCheck.class,
-        MagicNumberCheck.class,
-        MissingCurlyBracesCheck.class,
-        MissingIncludeFileCheck.class,
-        MissingNewLineAtEndOfFileCheck.class,
-        NoSonarCheck.class,
-        ParsingErrorCheck.class,
-        ParsingErrorRecoveryCheck.class,
-        ReservedNamesCheck.class,
-        StringLiteralDuplicatedCheck.class,
-        SwitchLastCaseIsDefaultCheck.class,
-        TabCharacterCheck.class,
-        TodoTagPresenceCheck.class,
-        TooLongLineCheck.class,
-        TooManyLinesOfCodeInFileCheck.class,
-        TooManyStatementsPerLineCheck.class,
-        UndocumentedApiCheck.class,
-        UnnamedNamespaceInHeaderCheck.class,
-        UselessParenthesesCheck.class,
-        UseCorrectTypeCheck.class,
-        UsingNamespaceInHeaderCheck.class,
-        SafetyTagCheck.class,
-        UseCorrectIncludeCheck.class,
-        XPathCheck.class,
-        BooleanEqualityComparisonCheck.class
+    return ImmutableList.<Class>of(
+      CollapsibleIfCandidateCheck.class,
+      CommentedCodeCheck.class,
+      CommentRegularExpressionCheck.class,
+      CycleBetweenPackagesCheck.class,
+      DuplicatedIncludeCheck.class,
+      FileComplexityCheck.class,
+      FileHeaderCheck.class,
+      FileEncodingCheck.class,
+      FileRegularExpressionCheck.class,
+      LineRegularExpressionCheck.class,
+      FixmeTagPresenceCheck.class,
+      FunctionComplexityCheck.class,
+      HardcodedAccountCheck.class,
+      HardcodedIpCheck.class,
+      IndentationCheck.class,
+      MagicNumberCheck.class,
+      MissingCurlyBracesCheck.class,
+      MissingIncludeFileCheck.class,
+      MissingNewLineAtEndOfFileCheck.class,
+      NoSonarCheck.class,
+      ParsingErrorCheck.class,
+      ParsingErrorRecoveryCheck.class,
+      ReservedNamesCheck.class,
+      StringLiteralDuplicatedCheck.class,
+      SwitchLastCaseIsDefaultCheck.class,
+      TabCharacterCheck.class,
+      TodoTagPresenceCheck.class,
+      TooLongLineCheck.class,
+      TooManyLinesOfCodeInFileCheck.class,
+      TooManyStatementsPerLineCheck.class,
+      UndocumentedApiCheck.class,
+      UnnamedNamespaceInHeaderCheck.class,
+      UselessParenthesesCheck.class,
+      UseCorrectTypeCheck.class,
+      UsingNamespaceInHeaderCheck.class,
+      SafetyTagCheck.class,
+      UseCorrectIncludeCheck.class,
+      XPathCheck.class,
+      BooleanEqualityComparisonCheck.class
     );
   }
 

cxx-checks/src/main/java/org/sonar/cxx/checks/CollapsibleIfCandidateCheck.java

@@ -29,12 +29,18 @@
 
 import com.sonar.sslr.api.AstNode;
 import com.sonar.sslr.api.Grammar;
+import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.squidbridge.annotations.ActivatedByDefault;
+import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
+import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;
 
 @Rule(
   key = "CollapsibleIfCandidate",
-  description = "Merge this if statement with the enclosing one.",
+  name = "Collapsible 'if' statements should be merged",
   priority = Priority.MAJOR)
-
+@ActivatedByDefault
+@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.DATA_RELIABILITY)
+@SqaleConstantRemediation("5min")
 public class CollapsibleIfCandidateCheck extends SquidCheck<Grammar> {
 
   @Override

cxx-checks/src/main/java/org/sonar/cxx/checks/CommentContainsPatternChecker.java

@@ -24,11 +24,33 @@
 
 import com.sonar.sslr.api.Token;
 import com.sonar.sslr.api.Trivia;
+import org.sonar.check.Priority;
+import org.sonar.check.Rule;
+import org.sonar.check.RuleProperty;
+import org.sonar.squidbridge.annotations.NoSqale;
+import org.sonar.squidbridge.annotations.RuleTemplate;
 
+@Rule(
+  key = "CommentContainsPatternChecker",
+  name = "Regular expression on comment",
+  priority = Priority.MAJOR)
+@RuleTemplate
+@NoSqale
 public class CommentContainsPatternChecker {
 
+  @RuleProperty(
+    key = "check",
+    description = "The Squid check")
   private final SquidCheck<?> check;
+
+  @RuleProperty(
+    key = "pattern",
+    description = "The regular expression")
   private final String pattern;
+
+  @RuleProperty(
+    key = "message",
+    description = "The violation message")
   private final String message;
 
   public CommentContainsPatternChecker(SquidCheck<?> check, String pattern, String message) {

cxx-checks/src/main/java/org/sonar/cxx/checks/CommentRegularExpressionCheck.java

@@ -19,31 +19,34 @@
  */
 package org.sonar.cxx.checks;
 
-import org.sonar.check.Cardinality;
 import org.sonar.check.Priority;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.squidbridge.checks.AbstractCommentRegularExpressionCheck;
-
 import com.sonar.sslr.api.Grammar;
+import org.sonar.squidbridge.annotations.NoSqale;
+import org.sonar.squidbridge.annotations.RuleTemplate;
 
 @Rule(
   key = "CommentRegularExpression",
-  cardinality = Cardinality.MULTIPLE,
+  name = "Regular expression on comment",
   priority = Priority.MAJOR)
-
+@RuleTemplate
+@NoSqale
 public class CommentRegularExpressionCheck extends AbstractCommentRegularExpressionCheck<Grammar> {
 
   private static final String DEFAULT_REGULAR_EXPRESSION = "";
   private static final String DEFAULT_MESSAGE = "The regular expression matches this comment";
 
   @RuleProperty(
     key = "regularExpression",
+    description = "The regular expression",
     defaultValue = DEFAULT_REGULAR_EXPRESSION)
   public String regularExpression = DEFAULT_REGULAR_EXPRESSION;
 
   @RuleProperty(
     key = "message",
+    description = "The violation message",
     defaultValue = DEFAULT_MESSAGE)
   public String message = DEFAULT_MESSAGE;
 

cxx-checks/src/main/java/org/sonar/cxx/checks/CommentedCodeCheck.java

@@ -32,18 +32,25 @@
 import org.sonar.squidbridge.recognizer.EndWithDetector;
 import org.sonar.squidbridge.recognizer.KeywordsDetector;
 import org.sonar.squidbridge.recognizer.LanguageFootprint;
-
 import com.google.common.collect.Sets;
 import com.sonar.sslr.api.AstAndTokenVisitor;
 import com.sonar.sslr.api.Grammar;
 import com.sonar.sslr.api.Token;
 import com.sonar.sslr.api.Trivia;
+import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.squidbridge.annotations.ActivatedByDefault;
+import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
+import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;
+import org.sonar.squidbridge.annotations.Tags;
 
 @Rule(
   key = "CommentedCode",
-  description = "Commented code shall be avoided and therefore removed.",
+  name = "Sections of code should not be 'commented out'",
+  tags = {Tags.UNUSED},
   priority = Priority.BLOCKER)
-
+@ActivatedByDefault
+@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.UNDERSTANDABILITY)
+@SqaleConstantRemediation("5min")
 public class CommentedCodeCheck extends SquidCheck<Grammar> implements AstAndTokenVisitor {
 
   private static final double THRESHOLD = 0.94;

cxx-checks/src/main/java/org/sonar/cxx/checks/CycleBetweenPackagesCheck.java

@@ -27,16 +27,25 @@
 import org.sonar.check.Priority;
 import org.sonar.check.Rule;
 import org.sonar.squidbridge.checks.SquidCheck;
-
 import com.sonar.sslr.api.Grammar;
+import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.squidbridge.annotations.ActivatedByDefault;
+import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
+import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;
+import org.sonar.squidbridge.annotations.Tags;
 
 /**
  * Companion of {@link org.sonar.plugins.cxx.squid.DependencyAnalyzer} which actually does the job of finding cycles and
  * creating the violations.
  */
-@Rule(key = CycleBetweenPackagesCheck.RULE_KEY,
-      priority = Priority.MAJOR)
-
+@Rule(
+  key = "CycleBetweenPackages",
+  name = "Avoid cyclic dependency between packages",
+  tags = {Tags.CONVENTION},
+  priority = Priority.MAJOR)
+@ActivatedByDefault
+@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.ARCHITECTURE_RELIABILITY)
+@SqaleConstantRemediation("5min")
 public class CycleBetweenPackagesCheck extends SquidCheck<Grammar> {
 
   public static final String RULE_KEY = "CycleBetweenPackages";

cxx-checks/src/main/java/org/sonar/cxx/checks/DuplicatedIncludeCheck.java

@@ -27,16 +27,25 @@
 import org.sonar.check.Priority;
 import org.sonar.check.Rule;
 import org.sonar.squidbridge.checks.SquidCheck;
-
 import com.sonar.sslr.api.Grammar;
+import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.squidbridge.annotations.ActivatedByDefault;
+import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
+import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;
+import org.sonar.squidbridge.annotations.Tags;
 
 /**
  * Companion of {@link org.sonar.plugins.cxx.squid.DependencyAnalyzer} which actually does the job of finding duplicated
  * includes
  */
-@Rule(key = DuplicatedIncludeCheck.RULE_KEY,
-    priority = Priority.MAJOR)
-
+@Rule(
+  key = "DuplicatedInclude",
+  name = "Avoid including the same file multiple times",
+  tags = {Tags.PREPROCESSOR},
+  priority = Priority.MAJOR)
+@ActivatedByDefault
+@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.ARCHITECTURE_RELIABILITY)
+@SqaleConstantRemediation("5min")
 public class DuplicatedIncludeCheck extends SquidCheck<Grammar> {
 
   public static final String RULE_KEY = "DuplicatedInclude";

cxx-checks/src/main/java/org/sonar/cxx/checks/FileComplexityCheck.java

@@ -25,16 +25,31 @@
 import org.sonar.cxx.api.CxxMetric;
 import org.sonar.squidbridge.checks.AbstractFileComplexityCheck;
 import org.sonar.squidbridge.measures.MetricDef;
-
 import com.sonar.sslr.api.Grammar;
+import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.squidbridge.annotations.ActivatedByDefault;
+import org.sonar.squidbridge.annotations.SqaleLinearWithOffsetRemediation;
+import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;
+import org.sonar.squidbridge.annotations.Tags;
 
 @Rule(
-    key = "FileCyclomaticComplexity",
-    priority = Priority.MAJOR)
+  key = "FileComplexity",
+  name = "Files should not be too complex",
+  tags = {Tags.BRAIN_OVERLOAD},
+  priority = Priority.MAJOR)
+//@ActivatedByDefault
+@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.UNIT_TESTABILITY)
+@SqaleLinearWithOffsetRemediation(
+  coeff = "1min",
+  offset = "30min",
+  effortToFixDescription = "per complexity point above the threshold")
 public class FileComplexityCheck extends AbstractFileComplexityCheck<Grammar> {
   private static final int DEFAULT_MAX = 200;
 
-  @RuleProperty(defaultValue = "" + DEFAULT_MAX)
+  @RuleProperty(
+    key = "max",
+    description = "Maximum complexity allowed",
+    defaultValue = "" + DEFAULT_MAX)
   private int max = DEFAULT_MAX;
 
 

cxx-checks/src/main/java/org/sonar/cxx/checks/FileEncodingCheck.java

@@ -22,23 +22,24 @@
 import java.io.IOException;
 import java.nio.charset.Charset;
 import java.util.List;
-
-import org.sonar.api.utils.SonarException;
+import org.sonar.api.utils.SonarException; //@todo: deprecated, see http://javadocs.sonarsource.org/4.5.2/apidocs/deprecated-list.html
 import org.sonar.check.Priority;
 import org.sonar.check.Rule;
 import org.sonar.cxx.visitors.CxxCharsetAwareVisitor;
 import org.sonar.squidbridge.checks.SquidCheck;
-
 import com.google.common.io.Files;
 import com.sonar.sslr.api.AstNode;
 import com.sonar.sslr.api.Grammar;
 import java.nio.charset.CharsetEncoder;
+import org.sonar.squidbridge.annotations.ActivatedByDefault;
+import org.sonar.squidbridge.annotations.NoSqale;
 
 @Rule(
-  key = "InvalidFileEncoding",
-  description = "Verify that all characters of the file can be encoded with the predefined charset.",
+  key = "FileEncoding",
+  name = "Verify that all characters of the file can be encoded with the predefined charset.",
   priority = Priority.MINOR)
-
+@ActivatedByDefault
+@NoSqale
 public class FileEncodingCheck extends SquidCheck<Grammar> implements CxxCharsetAwareVisitor {
 
   private Charset charset;
@@ -53,7 +54,7 @@ public void visitFile(AstNode astNode) {
     try {
       lines = Files.readLines(getContext().getFile(), charset);
     } catch (IOException e) {
-      throw new SonarException(e);
+      throw new SonarException(e); //@todo SonarException has been deprecated, see http://javadocs.sonarsource.org/4.5.2/apidocs/deprecated-list.html
     }
     CharsetEncoder encoder = Charset.forName(charset.name()).newEncoder();
     for (String line : lines) {