SONAR-7330 RegisterRules is now using RuleIndexer

server/sonar-server/src/main/java/org/sonar/server/rule/RegisterRules.java

@@ -20,16 +20,19 @@
 package org.sonar.server.rule;
 
 import com.google.common.base.Function;
+import com.google.common.base.Optional;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Iterables;
 import com.google.common.collect.Maps;
 import com.google.common.collect.Sets;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import org.apache.commons.lang.ObjectUtils;
 import org.apache.commons.lang.StringUtils;
@@ -39,6 +42,7 @@
 import org.sonar.api.rule.RuleStatus;
 import org.sonar.api.server.debt.DebtRemediationFunction;
 import org.sonar.api.server.rule.RulesDefinition;
+import org.sonar.api.utils.System2;
 import org.sonar.api.utils.log.Logger;
 import org.sonar.api.utils.log.Loggers;
 import org.sonar.api.utils.log.Profiler;
@@ -50,7 +54,9 @@
 import org.sonar.db.rule.RuleParamDto;
 import org.sonar.server.db.DbClient;
 import org.sonar.server.qualityprofile.RuleActivator;
+import org.sonar.server.rule.index.RuleIndexer;
 
+import static com.google.common.base.Preconditions.checkNotNull;
 import static com.google.common.collect.Lists.newArrayList;
 
 /**
@@ -63,13 +69,18 @@ public class RegisterRules implements Startable {
   private final RuleDefinitionsLoader defLoader;
   private final RuleActivator ruleActivator;
   private final DbClient dbClient;
+  private final RuleIndexer ruleIndexer;
   private final Languages languages;
+  private final System2 system2;
 
-  public RegisterRules(RuleDefinitionsLoader defLoader, RuleActivator ruleActivator, DbClient dbClient, Languages languages) {
+  public RegisterRules(RuleDefinitionsLoader defLoader, RuleActivator ruleActivator, DbClient dbClient, RuleIndexer ruleIndexer,
+                       Languages languages, System2 system2) {
     this.defLoader = defLoader;
     this.ruleActivator = ruleActivator;
     this.dbClient = dbClient;
+    this.ruleIndexer = ruleIndexer;
     this.languages = languages;
+    this.system2 = system2;
   }
 
   @Override
@@ -91,6 +102,7 @@ public void start() {
       List<RuleDto> activeRules = processRemainingDbRules(allRules.values(), session);
       removeActiveRulesOnStillExistingRepositories(session, activeRules, context);
       session.commit();
+      ruleIndexer.setEnabled(true).index();
       profiler.stopDebug();
     } finally {
       session.close();
@@ -121,15 +133,15 @@ private void registerRule(RulesDefinition.Rule ruleDef, Map<RuleKey, RuleDto> al
     }
 
     if (executeUpdate) {
-      dbClient.deprecatedRuleDao().update(session, rule);
+      update(session, rule);
     }
 
     mergeParams(ruleDef, rule, session);
   }
 
   private Map<RuleKey, RuleDto> loadRules(DbSession session) {
     Map<RuleKey, RuleDto> rules = new HashMap<>();
-    for (RuleDto rule : dbClient.deprecatedRuleDao().selectByNonManual(session)) {
+    for (RuleDto rule : dbClient.ruleDao().selectByNonManual(session)) {
       rules.put(rule.getKey(), rule);
     }
     return rules;
@@ -159,7 +171,11 @@ private RuleDto createRuleDto(RulesDefinition.Rule ruleDef, DbSession session) {
       .setSeverity(ruleDef.severity())
       .setStatus(ruleDef.status())
       .setEffortToFixDescription(ruleDef.effortToFixDescription())
-      .setSystemTags(ruleDef.tags());
+      .setSystemTags(ruleDef.tags())
+      .setCreatedAtInMs(system2.now())
+      .setUpdatedAtInMs(system2.now());
+    ruleDto.setCreatedAt(new Date(system2.now()));
+    ruleDto.setUpdatedAt(new Date(system2.now()));
     if (ruleDef.htmlDescription() != null) {
       ruleDto.setDescription(ruleDef.htmlDescription());
       ruleDto.setDescriptionFormat(Format.HTML);
@@ -168,7 +184,7 @@ private RuleDto createRuleDto(RulesDefinition.Rule ruleDef, DbSession session) {
       ruleDto.setDescriptionFormat(Format.MARKDOWN);
     }
 
-    dbClient.deprecatedRuleDao().insert(session, ruleDto);
+    dbClient.ruleDao().insert(session, ruleDto);
     return ruleDto;
   }
 
@@ -262,17 +278,17 @@ private boolean mergeDebtDefinitions(RuleDto dto, @Nullable String remediationFu
   }
 
   private void mergeParams(RulesDefinition.Rule ruleDef, RuleDto rule, DbSession session) {
-    List<RuleParamDto> paramDtos = dbClient.deprecatedRuleDao().selectRuleParamsByRuleKey(session, rule.getKey());
+    List<RuleParamDto> paramDtos = dbClient.ruleDao().selectRuleParamsByRuleKey(session, rule.getKey());
     Map<String, RuleParamDto> existingParamsByName = Maps.newHashMap();
 
     for (RuleParamDto paramDto : paramDtos) {
       RulesDefinition.Param paramDef = ruleDef.param(paramDto.getName());
       if (paramDef == null) {
         dbClient.activeRuleDao().deleteParamsByRuleParam(session, rule, paramDto.getName());
-        dbClient.deprecatedRuleDao().deleteRuleParam(session, rule, paramDto);
+        dbClient.ruleDao().deleteRuleParam(session, paramDto.getId());
       } else {
         if (mergeParam(paramDto, paramDef)) {
-          dbClient.deprecatedRuleDao().updateRuleParam(session, rule, paramDto);
+          dbClient.ruleDao().updateRuleParam(session, rule, paramDto);
         }
         existingParamsByName.put(paramDto.getName(), paramDto);
       }
@@ -287,7 +303,7 @@ private void mergeParams(RulesDefinition.Rule ruleDef, RuleDto rule, DbSession s
           .setDescription(param.description())
           .setDefaultValue(param.defaultValue())
           .setType(param.type().toString());
-        dbClient.deprecatedRuleDao().insertRuleParam(session, rule, paramDto);
+        dbClient.ruleDao().insertRuleParam(session, rule, paramDto);
         if (!StringUtils.isEmpty(param.defaultValue())) {
           // Propagate the default value to existing active rules
           for (ActiveRuleDto activeRule : dbClient.activeRuleDao().selectByRule(session, rule)) {
@@ -346,10 +362,12 @@ private List<RuleDto> processRemainingDbRules(Collection<RuleDto> existingRules,
     }
 
     for (RuleDto customRule : customRules) {
-      RuleDto template = dbClient.deprecatedRuleDao().selectTemplate(customRule, session);
-      if (template != null && template.getStatus() != RuleStatus.REMOVED) {
-        if (updateCustomRuleFromTemplateRule(customRule, template)) {
-          dbClient.deprecatedRuleDao().update(session, customRule);
+      Integer templateId = customRule.getTemplateId();
+      checkNotNull(templateId, "Template id of the custom rule '%s' is null", customRule);
+      Optional<RuleDto> template = dbClient.ruleDao().selectById(templateId, session);
+      if (template.isPresent() && template.get().getStatus() != RuleStatus.REMOVED) {
+        if (updateCustomRuleFromTemplateRule(customRule, template.get())) {
+          update(session, customRule);
         }
       } else {
         removeRule(session, removedRules, customRule);
@@ -365,7 +383,7 @@ private void removeRule(DbSession session, List<RuleDto> removedRules, RuleDto r
     rule.setStatus(RuleStatus.REMOVED);
     rule.setSystemTags(Collections.<String>emptySet());
     rule.setTags(Collections.<String>emptySet());
-    dbClient.deprecatedRuleDao().update(session, rule);
+    update(session, rule);
     removedRules.add(rule);
     if (removedRules.size() % 100 == 0) {
       session.commit();
@@ -423,7 +441,7 @@ private static boolean updateCustomRuleFromTemplateRule(RuleDto customRule, Rule
   private void removeActiveRulesOnStillExistingRepositories(DbSession session, Collection<RuleDto> removedRules, RulesDefinition.Context context) {
     List<String> repositoryKeys = newArrayList(Iterables.transform(context.repositories(), new Function<RulesDefinition.Repository, String>() {
       @Override
-      public String apply(RulesDefinition.Repository input) {
+      public String apply(@Nonnull RulesDefinition.Repository input) {
         return input.key();
       }
     }
@@ -436,4 +454,10 @@ public String apply(RulesDefinition.Repository input) {
       }
     }
   }
+
+  private void update(DbSession session, RuleDto rule){
+    rule.setUpdatedAtInMs(system2.now());
+    rule.setUpdatedAt(new Date(system2.now()));
+    dbClient.ruleDao().update(session, rule);
+  }
 }

server/sonar-server/src/main/java/org/sonar/server/rule/db/RuleDao.java

@@ -20,6 +20,8 @@
 package org.sonar.server.rule.db;
 
 import com.google.common.base.Preconditions;
+import java.util.List;
+import javax.annotation.CheckForNull;
 import org.sonar.api.rule.RuleKey;
 import org.sonar.api.utils.System2;
 import org.sonar.db.DbSession;
@@ -29,10 +31,6 @@
 import org.sonar.server.db.BaseDao;
 import org.sonar.server.search.IndexDefinition;
 
-import javax.annotation.CheckForNull;
-
-import java.util.List;
-
 public class RuleDao extends BaseDao<RuleMapper, RuleDto, RuleKey> {
 
   public RuleDao(System2 system) {
@@ -65,11 +63,7 @@ protected void doDeleteByKey(DbSession session, RuleKey key) {
     throw new UnsupportedOperationException("Rules cannot be deleted");
   }
 
-  /**
-   * @deprecated use keys.
-   */
   @CheckForNull
-  @Deprecated
   public RuleDto selectById(DbSession session, int id) {
     return mapper(session).selectById(id);
   }

server/sonar-server/src/main/java/org/sonar/server/rule/index/RuleIndex.java

@@ -75,6 +75,7 @@
 
 import static com.google.common.collect.Lists.newArrayList;
 
+@Deprecated
 public class RuleIndex extends BaseIndex<Rule, RuleDto, RuleKey> {
 
   public static final String FACET_LANGUAGES = "languages";

server/sonar-server/src/main/java/org/sonar/server/rule/index/RuleIndexer.java

@@ -19,6 +19,7 @@
  */
 package org.sonar.server.rule.index;
 
+import com.google.common.annotations.VisibleForTesting;
 import java.util.Iterator;
 import org.elasticsearch.action.index.IndexRequest;
 import org.sonar.db.DbClient;
@@ -45,7 +46,8 @@ protected long doIndex(long lastUpdatedAt) {
     return doIndex(createBulkIndexer(false), lastUpdatedAt);
   }
 
-  public void index(Iterator<RuleDoc> rules) {
+  @VisibleForTesting
+  void index(Iterator<RuleDoc> rules) {
     doIndex(createBulkIndexer(false), rules);
   }
 

server/sonar-server/src/main/java/org/sonar/server/rule/index/RuleQuery.java

@@ -27,6 +27,8 @@
 import org.sonar.api.rule.RuleStatus;
 import org.sonar.api.rule.Severity;
 
+import static java.util.Arrays.asList;
+
 public class RuleQuery {
 
   private String key;
@@ -135,6 +137,13 @@ public RuleQuery setSeverities(@Nullable Collection<String> severities) {
     return this;
   }
 
+  public RuleQuery setSeverities(@Nullable String... severities) {
+    if (severities != null) {
+      return setSeverities(asList(severities));
+    }
+    return this;
+  }
+
   @CheckForNull
   public Collection<RuleStatus> getStatuses() {
     return statuses;

server/sonar-server/src/test/java/org/sonar/server/es/EsTester.java

@@ -22,12 +22,14 @@
 import com.google.common.base.Function;
 import com.google.common.base.Throwables;
 import com.google.common.collect.Collections2;
+import com.google.common.collect.FluentIterable;
 import com.google.common.collect.Iterables;
 import java.io.File;
 import java.io.FileInputStream;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
+import javax.annotation.Nonnull;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang.math.RandomUtils;
 import org.apache.commons.lang.reflect.ConstructorUtils;
@@ -220,6 +222,10 @@ public T apply(SearchHit input) {
     }));
   }
 
+  public List<String> getIds(String indexName, String typeName){
+    return FluentIterable.from(getDocuments(indexName, typeName)).transform(SearchHitToId.INSTANCE).toList();
+  }
+
   public Node node() {
     return node;
   }
@@ -228,4 +234,13 @@ public EsClient client() {
     return client;
   }
 
+  private enum SearchHitToId implements Function<SearchHit, String>{
+    INSTANCE;
+
+    @Override
+    public String apply(@Nonnull org.elasticsearch.search.SearchHit input) {
+      return input.id();
+    }
+  }
+
 }