SONAR-1817: Squid rule to create violation on each NOSONAR tag occurence

7 files changed, 86 insertions, 18 deletions

diff --git a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/SquidScanner.java b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/SquidScanner.java
index 42cba38d6ca..f3ecbc425e2 100644
--- a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/SquidScanner.java
+++ b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/SquidScanner.java
@@ -27,8 +27,8 @@ import org.sonar.java.squid.check.SquidCheck;
 import org.sonar.java.squid.visitor.SquidVisitor;
 import org.sonar.squid.api.CodeScanner;
 import org.sonar.squid.api.CodeVisitor;
-import org.sonar.squid.api.SourceClass;
 import org.sonar.squid.api.SourceCode;
+import org.sonar.squid.api.SourceFile;
 import org.sonar.squid.indexer.QueryByType;
 import org.sonar.squid.indexer.SquidIndex;
 
@@ -41,14 +41,14 @@ public class SquidScanner extends CodeScanner<CodeVisitor> {
   }
 
   public void scan() {
-    Collection<SourceCode> classes = indexer.search(new QueryByType(SourceClass.class));
-    notifySquidVisitors(classes);
+    Collection<SourceCode> files = indexer.search(new QueryByType(SourceFile.class));
+    notifySquidVisitors(files);
   }
 
-  private void notifySquidVisitors(Collection<SourceCode> classes) {
+  private void notifySquidVisitors(Collection<SourceCode> files) {
     SquidVisitor[] visitorArray = getVisitors().toArray(new SquidVisitor[getVisitors().size()]);
-    for (SourceCode sourceClass : classes) {
-      SquidVisitorNotifier visitorNotifier = new SquidVisitorNotifier((SourceClass) sourceClass, visitorArray);
+    for (SourceCode sourceFile : files) {
+      SquidVisitorNotifier visitorNotifier = new SquidVisitorNotifier((SourceFile) sourceFile, visitorArray);
       visitorNotifier.notifyVisitors(indexer);
     }
   }
diff --git a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/SquidVisitorNotifier.java b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/SquidVisitorNotifier.java
index 98ef164fca4..59eb5af86f7 100644
--- a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/SquidVisitorNotifier.java
+++ b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/SquidVisitorNotifier.java
@@ -3,33 +3,49 @@ package org.sonar.java.squid;
 import org.sonar.java.squid.visitor.SquidVisitor;
 import org.sonar.squid.api.SourceClass;
 import org.sonar.squid.api.SourceCode;
+import org.sonar.squid.api.SourceFile;
 import org.sonar.squid.api.SourceMethod;
 import org.sonar.squid.indexer.SquidIndex;
 
 public class SquidVisitorNotifier {
 
-  private final SourceClass sourceClass;
+  private final SourceFile sourceFile;
   private final SquidVisitor[] squidVisitors;
 
-  public SquidVisitorNotifier(SourceClass sourceClass, SquidVisitor[] squidVisitors) {
-    this.sourceClass = sourceClass;
+  public SquidVisitorNotifier(SourceFile sourceFile, SquidVisitor[] squidVisitors) {
+    this.sourceFile = sourceFile;
     this.squidVisitors = new SquidVisitor[squidVisitors.length];
     System.arraycopy(squidVisitors, 0, this.squidVisitors, 0, squidVisitors.length);
   }
 
   public void notifyVisitors(SquidIndex indexer) {
-    callVisitClass();
-    callVisitMethod();
+    callVisitFile();
   }
 
-  private void callVisitClass() {
+  private void callVisitFile() {
     for (SquidVisitor visitor : squidVisitors) {
-      visitor.visitClass(sourceClass);
+      visitor.visitFile(sourceFile);
     }
+    callVisitClass(sourceFile);
   }
 
-  private void callVisitMethod() {
-    if (sourceClass.getChildren() == null) { // TODO Most probably SourceCode#hasChildren() shouldn't be protected
+  private void callVisitClass(SourceFile sourceFile) {
+    if ( !sourceFile.hasChildren()) {
+      return;
+    }
+    for (SourceCode sourceCode : sourceFile.getChildren()) {
+      if (sourceCode instanceof SourceClass) {
+        SourceClass sourceClass = (SourceClass) sourceCode;
+        for (SquidVisitor visitor : squidVisitors) {
+          visitor.visitClass(sourceClass);
+        }
+        callVisitMethod(sourceClass);
+      }
+    }
+  }
+
+  private void callVisitMethod(SourceClass sourceClass) {
+    if ( !sourceClass.hasChildren()) {
       return;
     }
     for (SourceCode sourceCode : sourceClass.getChildren()) {
@@ -41,4 +57,5 @@ public class SquidVisitorNotifier {
       }
     }
   }
+
 }
diff --git a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/check/NoSonarCheck.java b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/check/NoSonarCheck.java
new file mode 100644
index 00000000000..add1a0cd6eb
--- /dev/null
+++ b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/check/NoSonarCheck.java
@@ -0,0 +1,43 @@
+/*
+ * Sonar, open source software quality management tool.
+ * Copyright (C) 2009 SonarSource SA
+ * mailto:contact AT sonarsource DOT com
+ *
+ * Sonar 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.
+ *
+ * Sonar 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 Sonar; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
+ */
+
+package org.sonar.java.squid.check;
+
+import org.sonar.check.IsoCategory;
+import org.sonar.check.Priority;
+import org.sonar.check.Rule;
+import org.sonar.squid.api.CheckMessage;
+import org.sonar.squid.api.SourceFile;
+
+@Rule(key = "NoSonarCheck", name = "NOSONAR occurence", isoCategory = IsoCategory.Maintainability, priority = Priority.INFO,
+    description = "")
+public class NoSonarCheck extends SquidCheck {
+
+  @Override
+  public void visitFile(SourceFile sourceFile) {
+    for (Integer line : sourceFile.getNoSonarTagLines()) {
+      CheckMessage message = new CheckMessage(this, "NOSONAR occurence");
+      message.setForced(true);
+      message.setLine(line);
+      sourceFile.log(message);
+    }
+  }
+
+}
diff --git a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/check/SquidCheck.java b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/check/SquidCheck.java
index 2bbdfd3f274..4cf44a75a9a 100644
--- a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/check/SquidCheck.java
+++ b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/check/SquidCheck.java
@@ -23,6 +23,7 @@ package org.sonar.java.squid.check;
 import org.sonar.java.squid.visitor.SquidVisitor;
 import org.sonar.squid.api.CodeCheck;
 import org.sonar.squid.api.SourceClass;
+import org.sonar.squid.api.SourceFile;
 import org.sonar.squid.api.SourceMethod;
 
 public class SquidCheck implements SquidVisitor, CodeCheck {
@@ -31,6 +32,9 @@ public class SquidCheck implements SquidVisitor, CodeCheck {
     return getClass().getSimpleName();
   }
 
+  public void visitFile(SourceFile sourceFile) {
+  }
+
   public void visitClass(SourceClass sourceClass) {
   }
 
diff --git a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/visitor/SquidVisitor.java b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/visitor/SquidVisitor.java
index 5d02669df5b..e5b9bcd3ede 100644
--- a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/visitor/SquidVisitor.java
+++ b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/java/squid/visitor/SquidVisitor.java
@@ -21,10 +21,13 @@ package org.sonar.java.squid.visitor;
 
 import org.sonar.squid.api.CodeVisitor;
 import org.sonar.squid.api.SourceClass;
+import org.sonar.squid.api.SourceFile;
 import org.sonar.squid.api.SourceMethod;
 
 public interface SquidVisitor extends CodeVisitor {
 
+  void visitFile(SourceFile sourceFile);
+
   void visitClass(SourceClass sourceClass);
 
   void visitMethod(SourceMethod sourceMethod);
diff --git a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/plugins/squid/SquidRuleRepository.java b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/plugins/squid/SquidRuleRepository.java
index 3b47ff28e18..ef9fa2e531e 100644
--- a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/plugins/squid/SquidRuleRepository.java
+++ b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/plugins/squid/SquidRuleRepository.java
@@ -37,6 +37,7 @@ import org.sonar.java.bytecode.check.UnusedProtectedMethodCheck;
 import org.sonar.java.squid.check.ClassComplexityCheck;
 import org.sonar.java.squid.check.DITCheck;
 import org.sonar.java.squid.check.MethodComplexityCheck;
+import org.sonar.java.squid.check.NoSonarCheck;
 
 public final class SquidRuleRepository extends RuleRepository {
   private AnnotationRuleParser ruleParser;
@@ -58,8 +59,8 @@ public final class SquidRuleRepository extends RuleRepository {
         (Class) CallToDeprecatedMethodCheck.class, UnusedPrivateMethodCheck.class, UnusedProtectedMethodCheck.class,
         ArchitectureCheck.class,
         // AST checks
-        UndocumentedApiCheck.class, ContinueCheck.class, BreakCheck.class, ClassComplexityCheck.class, MethodComplexityCheck.class,
+        UndocumentedApiCheck.class, ContinueCheck.class, BreakCheck.class,
         // Squid checks
-        DITCheck.class);
+        DITCheck.class, ClassComplexityCheck.class, MethodComplexityCheck.class, NoSonarCheck.class);
   }
 }
diff --git a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/plugins/squid/bridges/ChecksBridge.java b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/plugins/squid/bridges/ChecksBridge.java
index 60530fc5fd9..9caf6f482c2 100644
--- a/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/plugins/squid/bridges/ChecksBridge.java
+++ b/plugins/sonar-squid-java-plugin/src/main/java/org/sonar/plugins/squid/bridges/ChecksBridge.java
@@ -44,7 +44,7 @@ public class ChecksBridge extends Bridge {
         violation.setLineId(checkMessage.getLine());
         violation.setMessage(checkMessage.getText(Locale.ENGLISH));
         violation.setCost(checkMessage.getCost());
-        context.saveViolation(violation);
+        context.saveViolation(violation, checkMessage.isForced());
       }
     }
   }