Add sanity check on adding a new rule property (#4222)

SonarSource · Sep 29, 2023 · 3e7b253 · 3e7b253
1 parent c7d9904
commit 3e7b253
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/sonar-plugin/css/src/test/java/org/sonar/css/rules/CssRuleTest.java b/sonar-plugin/css/src/test/java/org/sonar/css/rules/CssRuleTest.java
@@ -26,10 +26,13 @@
 import java.util.Set;
 import org.junit.jupiter.api.Test;
 import org.mockito.internal.util.collections.Sets;
+import org.sonar.check.RuleProperty;
 import org.sonar.css.CssRules;
 
 class CssRuleTest {
 
+  private static final int RULES_PROPERTIES_COUNT = 9;
+
   @Test
   void class_name_should_match_stylelint_key()
     throws NoSuchMethodException, IllegalAccessException, InvocationTargetException, InstantiationException {
@@ -64,6 +67,24 @@ void rules_default_is_empty()
     }
   }
 
+  /*
+   * This test raises awareness of the consequence of a rule adding or removing a rule property.
+   * If a new rule property is added to an existing rule, we should inform the SonarCloud team
+   * about it on release. Rule properties of newly added rules are not concerned by that.
+   */
+  @Test
+  void rules_properties_count() {
+    var count = 0;
+    for (var clazz : CssRules.getRuleClasses()) {
+      for (var field : clazz.getDeclaredFields()) {
+        if (field.isAnnotationPresent(RuleProperty.class)) {
+          count++;
+        }
+      }
+    }
+    assertThat(count).isEqualTo(RULES_PROPERTIES_COUNT);
+  }
+
   @Test
   void selector_pseudo_class_options() {
     SelectorPseudoClassNoUnknown selectorPseudoClassNoUnknown = new SelectorPseudoClassNoUnknown();

diff --git a/sonar-plugin/javascript-checks/src/test/java/org/sonar/javascript/checks/CheckListTest.java b/sonar-plugin/javascript-checks/src/test/java/org/sonar/javascript/checks/CheckListTest.java
@@ -29,11 +29,14 @@
 import java.util.Set;
 import java.util.stream.Collectors;
 import org.junit.jupiter.api.Test;
+import org.sonar.check.RuleProperty;
 import org.sonar.plugins.javascript.api.EslintBasedCheck;
 import org.sonar.plugins.javascript.api.JavaScriptCheck;
 
 class CheckListTest {
 
+  private static final int CHECKS_PROPERTIES_COUNT = 35;
+
   /**
    * Enforces that each check declared in list.
    */
@@ -133,6 +136,24 @@ void testEveryCheckBelongsToLanguage() {
     assertThat(allChecks).isEqualTo(tsAndJsChecks);
   }
 
+  /*
+   * This test raises awareness of the consequence of a rule adding or removing a rule property.
+   * If a new rule property is added to an existing rule, we should inform the SonarCloud team
+   * about it on release. Rule properties of newly added rules are not concerned by that.
+   */
+  @Test
+  void testChecksPropertiesCount() {
+    var count = 0;
+    for (var clazz : CheckList.getAllChecks()) {
+      for (var field : clazz.getDeclaredFields()) {
+        if (field.isAnnotationPresent(RuleProperty.class)) {
+          count++;
+        }
+      }
+    }
+    assertThat(count).isEqualTo(CHECKS_PROPERTIES_COUNT);
+  }
+
   private boolean isEslintBasedCheck(Class<? extends JavaScriptCheck> cls) {
     try {
       cls.getMethod("eslintKey");