NET-504 Clean up RuleDefinition UTs

Author: alex-meseldzija-sonarsource

sonar-csharp-plugin/src/test/java/org/sonar/plugins/csharp/CSharpRulesDefinitionTest.java

@@ -16,131 +16,51 @@
  */
 package org.sonar.plugins.csharp;
 
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.sonar.api.SonarEdition;
 import org.sonar.api.SonarQubeSide;
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.internal.SonarRuntimeImpl;
-import org.sonar.api.rule.RuleStatus;
-import org.sonar.api.rules.RuleType;
-import org.sonar.api.server.debt.DebtRemediationFunction;
-import org.sonar.api.server.rule.RuleParamType;
 import org.sonar.api.server.rule.RulesDefinition;
-import org.sonar.api.server.rule.RulesDefinition.Context;
-import org.sonar.api.server.rule.RulesDefinition.Rule;
 import org.sonar.api.utils.Version;
 import org.sonarsource.dotnet.shared.plugins.DotNetRulesDefinition;
 import org.sonarsource.dotnet.shared.plugins.RoslynRules;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
 class CSharpRulesDefinitionTest {
-  private static final String SECURITY_HOTSPOT_RULE_KEY = "S4502";
-  private static final String VULNERABILITY_RULE_KEY = "S2115";
-  private static final String NO_TAGS_RULE_KEY = "S1048";
-  private static final String SINGLE_PARAM_RULE_KEY = "S1200";
-  private static final String MULTI_PARAM_RULE_KEY = "S110";
-
+  private static final RulesDefinition.Context CONTEXT = new RulesDefinition.Context();
   private static final SonarRuntime SONAR_RUNTIME = SonarRuntimeImpl.forSonarQube(Version.create(10, 10), SonarQubeSide.SCANNER,
     SonarEdition.COMMUNITY);
   private static final RoslynRules ROSLYN_RULES = new RoslynRules(CSharpPlugin.METADATA);
 
+  private static RulesDefinition.Repository ruleRepo;
 
-  @Test
-  void test() {
-    Context context = new Context();
-    assertThat(context.repositories()).isEmpty();
-
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    definition.define(context);
-
-    assertThat(context.repositories()).hasSize(1);
-    assertThat(context.repository("csharpsquid").rules()).isNotEmpty();
-
-    Rule s100 = context.repository("csharpsquid").rule("S100");
-    assertThat(s100.name()).isEqualTo("Methods and properties should be named in PascalCase");
-    assertThat(s100.type()).isEqualTo(RuleType.CODE_SMELL);
-    assertThat(s100.status()).isEqualTo(RuleStatus.READY);
-    assertThat(s100.severity()).isEqualTo("MINOR");
-    assertThat(s100.debtRemediationFunction().type()).isEqualTo(DebtRemediationFunction.Type.CONSTANT_ISSUE);
-    assertThat(s100.debtRemediationFunction().baseEffort()).isEqualTo("5min");
-    assertThat(s100.params()).isEmpty();
-    assertThat(s100.tags()).hasSize(1).containsExactly("convention");
-  }
-
-  @Test
-  void test_symbolic_execution_rules_are_not_defined() {
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    assertThat(context.repositories()).isEmpty();
-
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    definition.define(context);
-
-    assertThat(context.repositories()).hasSize(1);
-
-    assertThat(context.repository("csharpsquid").rule("S2259")).isNull();
-  }
-
-  @Test
-  void test_security_hotspot() {
+  @BeforeAll
+  static void setupContext() {
     DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Repository repository = context.repository("csharpsquid");
-
-    RulesDefinition.Rule hardcodedCredentialsRule = repository.rule(SECURITY_HOTSPOT_RULE_KEY);
-    assertThat(hardcodedCredentialsRule.type()).isEqualTo(RuleType.SECURITY_HOTSPOT);
-    assertThat(hardcodedCredentialsRule.activatedByDefault()).isTrue();
+    definition.define(CONTEXT);
+    ruleRepo = CONTEXT.repository("csharpsquid");
   }
 
   @Test
-  void test_security_hotspot_has_correct_type_and_security_standards() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Repository repository = context.repository("csharpsquid");
-
-    RulesDefinition.Rule rule = repository.rule(SECURITY_HOTSPOT_RULE_KEY);
-    assertThat(rule.type()).isEqualTo(RuleType.SECURITY_HOTSPOT);
-    assertThat(rule.securityStandards()).containsExactlyInAnyOrder(
-      "cwe:352",
-      "owaspTop10:a6",
-      "owaspTop10-2021:a1",
-      "pciDss-3.2:6.5.9",
-      "pciDss-4.0:6.2.4",
-      "owaspAsvs-4.0:13.2.3",
-      "owaspAsvs-4.0:4.2.2",
-      "stig-ASD_V5R3:V-222603");
+  void rules_areDefined() {
+    assertThat(CONTEXT.repositories()).hasSize(1);
+    RulesDefinition.Rule s100 = ruleRepo.rule("S100");
+    assertThat(s100).isNotNull();
+    assertThat(s100.name()).isEqualTo("Methods and properties should be named in PascalCase");
   }
 
   @Test
-  void test_security_standards_with_vulnerability() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Repository repository = context.repository("csharpsquid");
-
-    RulesDefinition.Rule rule = repository.rule(VULNERABILITY_RULE_KEY);
-    assertThat(rule.type()).isEqualTo(RuleType.VULNERABILITY);
-    assertThat(rule.securityStandards()).containsExactlyInAnyOrder(
-      "cwe:521",
-      "owaspAsvs-4.0:9.2.2",
-      "owaspAsvs-4.0:9.2.3",
-      "owaspTop10:a2",
-      "owaspTop10:a3",
-      "owaspTop10-2021:a7",
-      "pciDss-3.2:6.5.10",
-      "pciDss-4.0:6.2.4");
+  void symbolicExecutionRules_areNotDefined() {
+    assertThat(CONTEXT.repositories()).hasSize(1);
+    assertThat(ruleRepo.rule("S2259")).isNull();
   }
 
   @Test
-  void test_all_rules_have_metadata_set() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Repository repository = context.repository("csharpsquid");
-
-    for (RulesDefinition.Rule rule : repository.rules()) {
+  void allRules_haveMetadata() {
+    for (RulesDefinition.Rule rule : ruleRepo.rules()) {
       assertThat(rule.name()).isNotEmpty();
       assertThat(rule.type()).isNotNull();
       assertThat(rule.status()).isNotNull();
@@ -149,92 +69,9 @@ void test_all_rules_have_metadata_set() {
   }
 
   @Test
-  void test_all_rules_have_htmldescription() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Repository repository = context.repository("csharpsquid");
-
-    for (RulesDefinition.Rule rule : repository.rules()) {
+  void allRules_haveHtmlDescription() {
+    for (RulesDefinition.Rule rule : ruleRepo.rules()) {
       assertThat(rule.htmlDescription()).isNotEmpty().hasSizeGreaterThan(100);
     }
   }
-
-  @Test
-  void test_tags_are_set() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Rule rule = context.repository("csharpsquid").rule(SECURITY_HOTSPOT_RULE_KEY);
-
-    assertThat(rule.tags()).containsExactly("cwe");
-  }
-
-  @Test
-  void test_tags_are_empty() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Rule rule = context.repository("csharpsquid").rule(NO_TAGS_RULE_KEY);
-
-    assertThat(rule.tags()).isEmpty();
-  }
-
-  @Test
-  void test_remediation_is_set() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Repository repository = context.repository("csharpsquid");
-
-    // We don't have rule with Linear to assert. That path is tested in AbstractRulesDefinition.test_remediation_is_set_linear()
-    assertThat(repository.rule("S100").debtRemediationFunction()).hasToString("DebtRemediationFunction{type=CONSTANT_ISSUE, gap " +
-      "multiplier=null, base effort=5min}");
-    assertThat(repository.rule("S110").debtRemediationFunction()).hasToString("DebtRemediationFunction{type=LINEAR_OFFSET, gap " +
-      "multiplier=30min, base effort=4h}");
-  }
-
-  @Test
-  void test_no_params() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Rule rule = context.repository("csharpsquid").rule(SECURITY_HOTSPOT_RULE_KEY);
-
-    assertThat(rule.params()).isEmpty();
-  }
-
-  @Test
-  void test_single_params() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Rule rule = context.repository("csharpsquid").rule(SINGLE_PARAM_RULE_KEY);
-
-    assertThat(rule.params()).hasSize(1);
-    assertParam(rule.params().get(0), "max", RuleParamType.INTEGER, "30", "Maximum number of types a single type is allowed to depend " +
-      "upon");
-  }
-
-  @Test
-  void test_multiple_params() {
-    DotNetRulesDefinition definition = new DotNetRulesDefinition(CSharpPlugin.METADATA, SONAR_RUNTIME, ROSLYN_RULES);
-    RulesDefinition.Context context = new RulesDefinition.Context();
-    definition.define(context);
-    RulesDefinition.Rule rule = context.repository("csharpsquid").rule(MULTI_PARAM_RULE_KEY);
-
-    assertThat(rule.params()).hasSize(2);
-    assertParam(rule.params().get(0), "max", RuleParamType.INTEGER, "5", "Maximum depth of the inheritance tree. (Number)");
-    assertParam(rule.params().get(1), "filteredClasses", RuleParamType.STRING, null,
-      "Comma-separated list of classes or records to be filtered out of the count of inheritance. Depth counting will stop when a " +
-        "filtered class or record is reached. For example: System.Windows.Controls.UserControl, System.Windows.*. (String)");
-  }
-
-  private static void assertParam(RulesDefinition.Param param, String expectedKey, RuleParamType expectedType,
-    String expectedDefaultValue, String expectedDescription) {
-    assertThat(param.key()).isEqualTo(expectedKey);
-    assertThat(param.type()).isEqualTo(expectedType);
-    assertThat(param.defaultValue()).isEqualTo(expectedDefaultValue);
-    assertThat(param.description()).isEqualTo(expectedDescription);
-  }
 }