move shared rule classes to server-common

2 files changed, 239 insertions, 0 deletions

diff --git a/server/sonar-server-common/src/test/java/org/sonar/server/rule/DefaultRuleFinderTest.java b/server/sonar-server-common/src/test/java/org/sonar/server/rule/DefaultRuleFinderTest.java
new file mode 100644
index 00000000000..a8e8f668d82
--- /dev/null
+++ b/server/sonar-server-common/src/test/java/org/sonar/server/rule/DefaultRuleFinderTest.java
@@ -0,0 +1,175 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2018 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * 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  02110-1301, USA.
+ */
+package org.sonar.server.rule;
+
+import com.google.common.collect.ImmutableSet;
+import org.junit.Before;
+import org.junit.Test;
+import org.sonar.api.rule.RuleStatus;
+import org.sonar.api.rules.Rule;
+import org.sonar.api.rules.RuleQuery;
+import org.sonar.api.utils.System2;
+import org.sonar.db.DbClient;
+import org.sonar.db.DbSession;
+import org.sonar.db.DbTester;
+import org.sonar.db.organization.OrganizationDto;
+import org.sonar.db.rule.RuleDefinitionDto;
+import org.sonar.db.rule.RuleDto;
+import org.sonar.db.rule.RuleDto.Scope;
+import org.sonar.server.organization.DefaultOrganizationProvider;
+import org.sonar.server.organization.TestDefaultOrganizationProvider;
+
+import static org.apache.commons.lang.RandomStringUtils.randomAlphanumeric;
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class DefaultRuleFinderTest {
+
+  @org.junit.Rule
+  public DbTester dbTester = DbTester.create(System2.INSTANCE);
+
+  private DbClient dbClient = dbTester.getDbClient();
+  private DbSession session = dbTester.getSession();
+  private DefaultOrganizationProvider defaultOrganizationProvider = TestDefaultOrganizationProvider.from(dbTester);
+
+  private RuleDto rule1 = new RuleDto()
+    .setName("Check Header")
+    .setConfigKey("Checker/Treewalker/HeaderCheck")
+    .setRuleKey("com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck")
+    .setRepositoryKey("checkstyle")
+    .setSeverity(4)
+    .setScope(Scope.MAIN)
+    .setStatus(RuleStatus.READY);
+
+  private RuleDto rule2 = new RuleDto()
+    .setName("Disabled checked")
+    .setConfigKey("Checker/Treewalker/DisabledCheck")
+    .setRuleKey("DisabledCheck")
+    .setRepositoryKey("checkstyle")
+    .setSeverity(4)
+    .setScope(Scope.MAIN)
+    .setStatus(RuleStatus.REMOVED);
+
+  private RuleDto rule3 = new RuleDto()
+    .setName("Check Annotation")
+    .setConfigKey("Checker/Treewalker/AnnotationUseStyleCheck")
+    .setRuleKey("com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck")
+    .setRepositoryKey("checkstyle")
+    .setSeverity(4)
+    .setScope(Scope.MAIN)
+    .setStatus(RuleStatus.READY);
+
+  private RuleDto rule4 = new RuleDto()
+    .setName("Call Super First")
+    .setConfigKey("rulesets/android.xml/CallSuperFirst")
+    .setRuleKey("CallSuperFirst")
+    .setRepositoryKey("pmd")
+    .setSeverity(2)
+    .setScope(Scope.MAIN)
+    .setStatus(RuleStatus.READY);
+
+  private DefaultRuleFinder underTest = new DefaultRuleFinder(dbClient, defaultOrganizationProvider);
+
+  @Before
+  public void setup() {
+    dbTester.rules().insertRule(rule1);
+    dbTester.rules().insertRule(rule2);
+    dbTester.rules().insertRule(rule3);
+    dbTester.rules().insertRule(rule4);
+    session.commit();
+  }
+
+  @Test
+  public void should_success_finder_wrap() {
+    // has Id
+    assertThat(underTest.findById(rule1.getId()).getId()).isEqualTo(rule1.getId());
+
+    // should_find_by_id
+    assertThat(underTest.findById(rule3.getId()).getConfigKey()).isEqualTo("Checker/Treewalker/AnnotationUseStyleCheck");
+
+    // should_not_find_disabled_rule_by_id
+    assertThat(underTest.findById(rule2.getId())).isNull();
+
+    // should_find_by_key
+    Rule rule = underTest.findByKey("checkstyle", "com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck");
+    assertThat(rule).isNotNull();
+    assertThat(rule.getKey()).isEqualTo(("com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck"));
+    assertThat(rule.isEnabled()).isTrue();
+
+    // find_should_return_null_if_no_results
+    assertThat(underTest.findByKey("checkstyle", "unknown")).isNull();
+    assertThat(underTest.find(RuleQuery.create().withRepositoryKey("checkstyle").withConfigKey("unknown"))).isNull();
+
+    // find_repository_rules
+    assertThat(underTest.findAll(RuleQuery.create().withRepositoryKey("checkstyle"))).hasSize(2);
+
+    // find_all_enabled
+    assertThat(underTest.findAll(RuleQuery.create())).extracting("id").containsOnly(rule1.getId(), rule3.getId(), rule4.getId());
+    assertThat(underTest.findAll(RuleQuery.create())).hasSize(3);
+
+    // do_not_find_disabled_rules
+    assertThat(underTest.findByKey("checkstyle", "DisabledCheck")).isNull();
+
+    // do_not_find_unknown_rules
+    assertThat(underTest.findAll(RuleQuery.create().withRepositoryKey("unknown_repository"))).isEmpty();
+  }
+
+  @Test
+  public void find_id_return_null_on_removed_rule() {
+    // find rule with id 2 is REMOVED
+    assertThat(underTest.findById(rule2.getId())).isNull();
+  }
+
+  @Test
+  public void find_all_not_include_removed_rule() {
+    // find rule with id 2 is REMOVED
+    assertThat(underTest.findAll(RuleQuery.create())).extracting("id").containsOnly(rule1.getId(), rule3.getId(), rule4.getId());
+  }
+
+  @Test
+  public void findById_populates_system_tags_but_not_tags() {
+    RuleDefinitionDto ruleDefinition = dbTester.rules()
+      .insert(t -> t.setSystemTags(ImmutableSet.of(randomAlphanumeric(5), randomAlphanumeric(6))));
+    OrganizationDto organization = dbTester.organizations().insert();
+    dbTester.rules().insertRule(organization);
+
+    Rule rule = underTest.findById(ruleDefinition.getId());
+    assertThat(rule.getSystemTags())
+      .containsOnlyElementsOf(ruleDefinition.getSystemTags());
+    assertThat(rule.getTags()).isEmpty();
+  }
+
+  @Test
+  public void findByKey_populates_system_tags_but_not_tags() {
+    RuleDefinitionDto ruleDefinition = dbTester.rules()
+      .insert(t -> t.setSystemTags(ImmutableSet.of(randomAlphanumeric(5), randomAlphanumeric(6))));
+    OrganizationDto organization = dbTester.organizations().insert();
+    dbTester.rules().insertRule(organization);
+
+    Rule rule = underTest.findByKey(ruleDefinition.getKey());
+    assertThat(rule.getSystemTags())
+      .containsOnlyElementsOf(ruleDefinition.getSystemTags());
+    assertThat(rule.getTags()).isEmpty();
+
+    rule = underTest.findByKey(ruleDefinition.getRepositoryKey(), ruleDefinition.getRuleKey());
+    assertThat(rule.getSystemTags())
+      .containsOnlyElementsOf(ruleDefinition.getSystemTags());
+    assertThat(rule.getTags()).isEmpty();
+  }
+}
diff --git a/server/sonar-server-common/src/test/java/org/sonar/server/rule/ExternalRuleCreatorTest.java b/server/sonar-server-common/src/test/java/org/sonar/server/rule/ExternalRuleCreatorTest.java
new file mode 100644
index 00000000000..32b9d329e79
--- /dev/null
+++ b/server/sonar-server-common/src/test/java/org/sonar/server/rule/ExternalRuleCreatorTest.java
@@ -0,0 +1,64 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2018 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * 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  02110-1301, USA.
+ */
+package org.sonar.server.rule;
+
+import org.junit.Test;
+import org.sonar.api.rule.RuleKey;
+import org.sonar.api.utils.System2;
+import org.sonar.db.DbSession;
+import org.sonar.db.DbTester;
+import org.sonar.db.rule.RuleDto;
+import org.sonar.server.es.EsTester;
+import org.sonar.server.rule.index.RuleIndexer;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class ExternalRuleCreatorTest {
+
+  @org.junit.Rule
+  public DbTester dbTester = DbTester.create(System2.INSTANCE);
+  @org.junit.Rule
+  public EsTester es = EsTester.create();
+
+  private RuleIndexer indexer = new RuleIndexer(es.client(), dbTester.getDbClient());
+  private ExternalRuleCreator underTest = new ExternalRuleCreator(dbTester.getDbClient(), System2.INSTANCE, indexer);
+  private DbSession dbSession = dbTester.getSession();
+
+  @Test
+  public void create_external_rule() {
+    RuleKey ruleKey = RuleKey.of("eslint", "no-cond-assign");
+    NewExternalRule externalRule = new NewExternalRule.Builder()
+      .setKey(ruleKey)
+      .setPluginKey("eslint")
+      .setName("name")
+      .build();
+
+    RuleDto rule1 = underTest.persistAndIndex(dbSession, externalRule);
+
+    assertThat(rule1).isNotNull();
+    assertThat(rule1.isExternal()).isTrue();
+    assertThat(rule1.getId()).isGreaterThan(0);
+    assertThat(rule1.getKey()).isEqualTo(ruleKey);
+    assertThat(rule1.getPluginKey()).isEqualTo("eslint");
+    assertThat(rule1.getName()).isEqualTo("name");
+    assertThat(rule1.getType()).isEqualTo(0);
+  }
+
+}