]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-4908 rename some methods of RuleDefinitions
authorSimon Brandhof <simon.brandhof@gmail.com>
Thu, 9 Jan 2014 15:27:11 +0000 (16:27 +0100)
committerSimon Brandhof <simon.brandhof@gmail.com>
Thu, 9 Jan 2014 15:27:11 +0000 (16:27 +0100)
sonar-plugin-api/src/main/java/org/sonar/api/rule/RuleDefinitions.java
sonar-plugin-api/src/test/java/org/sonar/api/rule/RuleDefinitionsTest.java

index a76fba20722a7fe59960a64092712fcfa442e21b..8b9f47082ae877e1bbbb14b367b93159f089b7c8 100644 (file)
@@ -172,7 +172,7 @@ public interface RuleDefinitions extends ServerExtension {
 
   public static class NewRule {
     private final String repoKey, key;
-    private String name, htmlDescription, metadata, severity = Severity.MAJOR;
+    private String name, htmlDescription, metadata, defaultSeverity = Severity.MAJOR;
     private final Set<String> tags = Sets.newHashSet();
     private final Map<String, NewParam> params = Maps.newHashMap();
     // TODO cardinality ? or template boolean ?
@@ -198,15 +198,15 @@ public interface RuleDefinitions extends ServerExtension {
       return this;
     }
 
-    public String severity() {
-      return severity;
+    public String defaultSeverity() {
+      return defaultSeverity;
     }
 
-    public NewRule setSeverity(String s) {
+    public NewRule setDefaultSeverity(String s) {
       if (!Severity.ALL.contains(s)) {
-        throw new IllegalArgumentException("Severity of rule " + this + " is not correct: " + s);
+        throw new IllegalArgumentException("Default severity of rule " + this + " is not correct: " + s);
       }
-      this.severity = s;
+      this.defaultSeverity = s;
       return this;
     }
 
@@ -387,6 +387,6 @@ public interface RuleDefinitions extends ServerExtension {
   /**
    * This method is executed when server is started.
    */
-  void define(Context context);
+  void defineRules(Context context);
 
-}
\ No newline at end of file
+}
index fc04abd76165b28ec0ce2aea1009a2901495582f..8c8fb960663c58001a0acd2790619100aa051387 100644 (file)
@@ -47,7 +47,7 @@ public class RuleDefinitionsTest {
     assertThat(context.getRepository("unknown")).isNull();
 
     // test equals() and hashCode()
-    assertThat(findbugs).isEqualTo(findbugs).isNotEqualTo(checkstyle).isNotEqualTo("findbugs");
+    assertThat(findbugs).isEqualTo(findbugs).isNotEqualTo(checkstyle).isNotEqualTo("findbugs").isNotEqualTo(null);
     assertThat(findbugs.hashCode()).isEqualTo(findbugs.hashCode());
   }
 
@@ -63,7 +63,7 @@ public class RuleDefinitionsTest {
     findbugs.newRule("NPE")
         .setName("Detect NPE")
         .setHtmlDescription("Detect <code>java.lang.NullPointerException</code>")
-        .setSeverity(Severity.BLOCKER)
+        .setDefaultSeverity(Severity.BLOCKER)
         .setMetadata("/something")
         .setTags("valuable", "bug");
     findbugs.newRule("ABC");
@@ -73,7 +73,7 @@ public class RuleDefinitionsTest {
     RuleDefinitions.NewRule npeRule = findbugs.getRule("NPE");
     assertThat(npeRule.key()).isEqualTo("NPE");
     assertThat(npeRule.name()).isEqualTo("Detect NPE");
-    assertThat(npeRule.severity()).isEqualTo(Severity.BLOCKER);
+    assertThat(npeRule.defaultSeverity()).isEqualTo(Severity.BLOCKER);
     assertThat(npeRule.htmlDescription()).isEqualTo("Detect <code>java.lang.NullPointerException</code>");
     assertThat(npeRule.tags()).containsOnly("valuable", "bug");
     assertThat(npeRule.getParams()).isEmpty();
@@ -81,7 +81,7 @@ public class RuleDefinitionsTest {
 
     // test equals() and hashCode()
     RuleDefinitions.NewRule otherRule = findbugs.getRule("ABC");
-    assertThat(npeRule).isEqualTo(npeRule).isNotEqualTo(otherRule).isNotEqualTo("NPE");
+    assertThat(npeRule).isEqualTo(npeRule).isNotEqualTo(otherRule).isNotEqualTo("NPE").isNotEqualTo(null);
     assertThat(npeRule.hashCode()).isEqualTo(npeRule.hashCode());
   }
 
@@ -92,7 +92,7 @@ public class RuleDefinitionsTest {
     RuleDefinitions.NewRule rule = context.getRepository("findbugs").getRule("NPE");
     assertThat(rule.key()).isEqualTo("NPE");
     assertThat(rule.name()).isEqualTo("NPE");
-    assertThat(rule.severity()).isEqualTo(Severity.MAJOR);
+    assertThat(rule.defaultSeverity()).isEqualTo(Severity.MAJOR);
     assertThat(rule.htmlDescription()).isNull();
     assertThat(rule.getParams()).isEmpty();
     assertThat(rule.metadata()).isNull();
@@ -122,7 +122,7 @@ public class RuleDefinitionsTest {
     assertThat(effort.defaultValue()).isNull();
 
     // test equals() and hashCode()
-    assertThat(level).isEqualTo(level).isNotEqualTo(effort).isNotEqualTo("level");
+    assertThat(level).isEqualTo(level).isNotEqualTo(effort).isNotEqualTo("level").isNotEqualTo(null);
     assertThat(level.hashCode()).isEqualTo(level.hashCode());
   }
 
@@ -211,10 +211,10 @@ public class RuleDefinitionsTest {
   @Test
   public void fail_if_bad_rule_severity() {
     try {
-      context.newRepository("findbugs", "java").newRule("NPE").setSeverity("VERY HIGH");
+      context.newRepository("findbugs", "java").newRule("NPE").setDefaultSeverity("VERY HIGH");
       fail();
     } catch (IllegalArgumentException e) {
-      assertThat(e).hasMessage("Severity of rule [repository=findbugs, key=NPE] is not correct: VERY HIGH");
+      assertThat(e).hasMessage("Default severity of rule [repository=findbugs, key=NPE] is not correct: VERY HIGH");
     }
   }
 }