Initial set of Clang rules. Add Clang profile.

Author: mjdetullio

src/main/java/org/sonar/plugins/objectivec/ObjectiveCPlugin.java

@@ -23,6 +23,8 @@
 import org.sonar.api.SonarPlugin;
 import org.sonar.api.config.PropertyDefinition;
 import org.sonar.api.resources.Qualifiers;
+import org.sonar.plugins.objectivec.clang.ClangProfile;
+import org.sonar.plugins.objectivec.clang.ClangProfileImporter;
 import org.sonar.plugins.objectivec.clang.ClangRulesDefinition;
 import org.sonar.plugins.objectivec.clang.ClangSensor;
 import org.sonar.plugins.objectivec.cobertura.CoberturaSensor;
@@ -56,6 +58,8 @@ public List getExtensions() {
 
         extensions.add(ClangRulesDefinition.class);
         extensions.add(ClangSensor.class);
+        extensions.add(ClangProfile.class);
+        extensions.add(ClangProfileImporter.class);
         extensions.add(PropertyDefinition.builder(ClangSensor.REPORTS_PATH_KEY)
                 .name("Clang Static Analyzer Reports")
                 .description("Path to the directory containing all the *.plist Clang report files. The path may be absolute or relative to the project base directory.")

src/main/java/org/sonar/plugins/objectivec/clang/ClangPlistParser.java

@@ -39,7 +39,7 @@
 /**
  * @author Matthew DeTullio
  */
-public class ClangPlistParser {
+public final class ClangPlistParser {
     private static final Logger LOGGER = LoggerFactory.getLogger(ClangPlistParser.class);
 
     public static List<ClangWarning> parse(final File reportsDir) {

src/main/java/org/sonar/plugins/objectivec/clang/ClangProfile.java

@@ -0,0 +1,61 @@
+/*
+ * Sonar Objective-C Plugin
+ * Copyright (C) 2012 OCTO Technology, Backelite,
+ *             Denis Bregeon, Mete Balci, Andrés Gil Herrera, Matthew DeTullio
+ * dev@sonar.codehaus.org
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.plugins.objectivec.clang;
+
+import com.google.common.io.Closeables;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.sonar.api.profiles.ProfileDefinition;
+import org.sonar.api.profiles.RulesProfile;
+import org.sonar.api.utils.ValidationMessages;
+import org.sonar.plugins.objectivec.ObjectiveC;
+
+import java.io.InputStreamReader;
+import java.io.Reader;
+
+public final class ClangProfile extends ProfileDefinition {
+    private static final Logger LOGGER = LoggerFactory.getLogger(ClangProfile.class);
+
+    private final ClangProfileImporter importer;
+
+    public ClangProfile(final ClangProfileImporter importer) {
+        this.importer = importer;
+    }
+
+    @Override
+    public RulesProfile createProfile(final ValidationMessages messages) {
+        LOGGER.info("Creating Clang Profile");
+        Reader profileXmlReader = null;
+
+        try {
+            profileXmlReader = new InputStreamReader(ClangProfile.class.getResourceAsStream(
+                    "/org/sonar/plugins/objectivec/profile-clang.xml"));
+
+            RulesProfile profile = importer.importProfile(profileXmlReader, messages);
+            profile.setLanguage(ObjectiveC.KEY);
+            profile.setName(ClangRulesDefinition.REPOSITORY_NAME);
+
+            return profile;
+        } finally {
+            Closeables.closeQuietly(profileXmlReader);
+        }
+    }
+}

src/main/java/org/sonar/plugins/objectivec/clang/ClangProfileImporter.java

@@ -0,0 +1,57 @@
+/*
+ * Sonar Objective-C Plugin
+ * Copyright (C) 2012 OCTO Technology, Backelite,
+ *             Denis Bregeon, Mete Balci, Andrés Gil Herrera, Matthew DeTullio
+ * dev@sonar.codehaus.org
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+package org.sonar.plugins.objectivec.clang;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.sonar.api.profiles.ProfileImporter;
+import org.sonar.api.profiles.RulesProfile;
+import org.sonar.api.profiles.XMLProfileParser;
+import org.sonar.api.utils.ValidationMessages;
+import org.sonar.plugins.objectivec.ObjectiveC;
+
+import java.io.Reader;
+
+public final class ClangProfileImporter extends ProfileImporter {
+    private static final Logger LOGGER = LoggerFactory.getLogger(ClangProfileImporter.class);
+    private static final String UNABLE_TO_LOAD_DEFAULT_PROFILE = "Unable to load default Clang profile";
+
+    private final XMLProfileParser profileParser;
+
+    public ClangProfileImporter(final XMLProfileParser xmlProfileParser) {
+        super(ClangRulesDefinition.REPOSITORY_KEY, ClangRulesDefinition.REPOSITORY_NAME);
+        setSupportedLanguages(ObjectiveC.KEY);
+        profileParser = xmlProfileParser;
+    }
+
+    @Override
+    public RulesProfile importProfile(final Reader reader,
+            final ValidationMessages messages) {
+        final RulesProfile profile = profileParser.parse(reader, messages);
+
+        if (null == profile) {
+            messages.addErrorText(UNABLE_TO_LOAD_DEFAULT_PROFILE);
+            LOGGER.error(UNABLE_TO_LOAD_DEFAULT_PROFILE);
+        }
+
+        return profile;
+    }
+}

src/main/java/org/sonar/plugins/objectivec/clang/ClangRulesDefinition.java

@@ -20,18 +20,39 @@
  */
 package org.sonar.plugins.objectivec.clang;
 
+import com.google.common.collect.ImmutableMap;
 import org.sonar.api.server.rule.RulesDefinition;
 import org.sonar.api.server.rule.RulesDefinitionXmlLoader;
 import org.sonar.plugins.objectivec.ObjectiveC;
 import org.sonar.squidbridge.rules.SqaleXmlLoader;
 
+import java.util.Map;
+
 /**
  * @author Matthew DeTullio
  */
-public class ClangRulesDefinition implements RulesDefinition {
+public final class ClangRulesDefinition implements RulesDefinition {
     public static final String REPOSITORY_KEY = "clang";
     public static final String REPOSITORY_NAME = "Clang";
 
+    /**
+     * Map of Clang plist report <code>type</code>s to their corresponding rules.  Multiple types can map to a single
+     * rule.
+     */
+    public static final Map<String, String> REPORT_TYPE_TO_RULE_MAP = ImmutableMap.<String, String>builder()
+            .put("Assigned value is garbage or undefined", "core.uninitialized.Assign") // Logic error
+            .put("Bad return type when passing NSError**", "osx.cocoa.NSError") // Coding conventions (Apple)
+            .put("Branch condition evaluates to a garbage value", "core.uninitialized.Branch") // Logic error
+            .put("Dead assignment", "deadcode.DeadStores") // Dead store
+            .put("Dead increment", "deadcode.DeadStores") // Dead store
+            .put("Dead initialization", "deadcode.DeadStores") // Dead store
+            .put("Garbage return value", "core.uninitialized.UndefReturn") // Logic error
+            .put("Leak", "osx.cocoa.RetainCount") // Memory (Core Foundation/Objective-C)
+            .put("Missing call to superclass", "osx.cocoa.MissingSuperCall") // Core Foundation/Objective-C
+            .put("Nil value used as mutex for @synchronized() (no synchronization will occur)", "osx.cocoa.AtSync") // Logic error
+            .put("Result of operation is garbage or undefined", "core.UndefinedBinaryOperatorResult") // Logic error
+            .build();
+
     @Override
     public void define(Context context) {
         NewRepository repository = context

src/main/java/org/sonar/plugins/objectivec/clang/ClangSensor.java

@@ -42,7 +42,7 @@
 /**
  * @author Matthew DeTullio
  */
-public class ClangSensor implements Sensor {
+public final class ClangSensor implements Sensor {
     private static final Logger LOGGER = LoggerFactory.getLogger(ClangSensor.class.getName());
 
     public static final String REPORTS_PATH_KEY = "sonar.objectivec.clang.reportsPath";
@@ -84,7 +84,15 @@ protected void collect(Project project, SensorContext context, File reportsDir)
         List<ClangWarning> clangWarnings = ClangPlistParser.parse(reportsDir);
 
         for (ClangWarning clangWarning : clangWarnings) {
-            // TODO: Add check for enabled rule if/when rules get split up
+            String type = clangWarning.getType();
+            String ruleKeyName;
+
+            if (ClangRulesDefinition.REPORT_TYPE_TO_RULE_MAP.containsKey(type)) {
+                ruleKeyName = ClangRulesDefinition.REPORT_TYPE_TO_RULE_MAP.get(type);
+            } else {
+                ruleKeyName = "other";
+                LOGGER.debug("Type '{}' is not mapped to a rule -- using default rule '{}'", type, ruleKeyName);
+            }
 
             Resource resource = context.getResource(
                     org.sonar.api.resources.File.fromIOFile(clangWarning.getFile(), project));
@@ -98,8 +106,8 @@ protected void collect(Project project, SensorContext context, File reportsDir)
 
             if (issuable != null) {
                 Issue issue = issuable.newIssueBuilder()
-                        .ruleKey(RuleKey.of(ClangRulesDefinition.REPOSITORY_KEY, "other"))
-                        .message(String.format("%s - %s", clangWarning.getCategory(), clangWarning.getType()))
+                        .ruleKey(RuleKey.of(ClangRulesDefinition.REPOSITORY_KEY, ruleKeyName))
+                        .message(String.format("%s - %s", clangWarning.getCategory(), type))
                         .line(clangWarning.getLine())
                         .build();
 

src/main/java/org/sonar/plugins/objectivec/oclint/OCLintProfile.java

@@ -51,7 +51,7 @@ public RulesProfile createProfile(final ValidationMessages messages) {
 
             RulesProfile profile = importer.importProfile(profileXmlReader, messages);
             profile.setLanguage(ObjectiveC.KEY);
-            profile.setName(OCLintRulesDefinition.REPOSITORY_KEY);
+            profile.setName(OCLintRulesDefinition.REPOSITORY_NAME);
             profile.setDefaultProfile(true);
 
             return profile;

src/main/java/org/sonar/plugins/objectivec/oclint/OCLintProfileImporter.java

@@ -37,7 +37,7 @@ public final class OCLintProfileImporter extends ProfileImporter {
     private final XMLProfileParser profileParser;
 
     public OCLintProfileImporter(final XMLProfileParser xmlProfileParser) {
-        super(OCLintRulesDefinition.REPOSITORY_KEY, OCLintRulesDefinition.REPOSITORY_KEY);
+        super(OCLintRulesDefinition.REPOSITORY_KEY, OCLintRulesDefinition.REPOSITORY_NAME);
         setSupportedLanguages(ObjectiveC.KEY);
         profileParser = xmlProfileParser;
     }

src/main/java/org/sonar/plugins/objectivec/surefire/SurefireParser.java

@@ -48,7 +48,7 @@
 import java.util.List;
 import java.util.Set;
 
-public class SurefireParser {
+public final class SurefireParser {
     private static final Logger LOGGER = LoggerFactory.getLogger(SurefireParser.class);
 
     private final Project project;

src/main/java/org/sonar/plugins/objectivec/surefire/SurefireSensor.java

@@ -32,7 +32,7 @@
 
 import java.io.File;
 
-public class SurefireSensor implements Sensor {
+public final class SurefireSensor implements Sensor {
     private static final Logger LOGGER = LoggerFactory.getLogger(SurefireSensor.class);
 
     public static final String REPORTS_PATH_KEY = "sonar.objectivec.junit.reportsPath";