source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube, open source software quality management tool.
   3  * Copyright (C) 2008-2014 SonarSource
   4  * mailto:contact AT sonarsource DOT com
   5  *
   6  * SonarQube is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * SonarQube is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.db.migrations.v451;
  21
  22 import com.google.common.base.Predicate;
  23 import com.google.common.collect.ArrayListMultimap;
  24 import com.google.common.collect.HashMultimap;
  25 import com.google.common.collect.Iterables;
  26 import com.google.common.collect.Multimap;
  27 import org.sonar.api.utils.System2;
  28 import org.sonar.core.persistence.DbSession;
  29 import org.sonar.core.persistence.migration.v45.Migration45Mapper;
  30 import org.sonar.core.persistence.migration.v45.Rule;
  31 import org.sonar.core.persistence.migration.v45.RuleParameter;
  32 import org.sonar.server.db.DbClient;
  33 import org.sonar.server.db.migrations.DatabaseMigration;
  34 import org.sonar.server.util.ProgressLogger;
  35
  36 import javax.annotation.Nullable;
  37
  38 import java.util.Collection;
  39 import java.util.Date;
  40 import java.util.List;
  41 import java.util.concurrent.atomic.AtomicLong;
  42
  43 /**
  44  * See http://jira.codehaus.org/browse/SONAR-5575
  45  *
  46  * Add missing parameters (with no value) on each custom rules
  47  *
  48  * @since 4.5.1
  49  */
  50 public class AddMissingCustomRuleParametersMigration implements DatabaseMigration {
  51
  52   private final DbClient db;
  53   private final System2 system;
  54
  55   private final AtomicLong counter = new AtomicLong(0L);
  56   private final ProgressLogger progress = ProgressLogger.create(getClass(), counter);
  57
  58   public AddMissingCustomRuleParametersMigration(DbClient db, System2 system) {
  59     this.db = db;
  60     this.system = system;
  61   }
  62
  63   @Override
  64   public void execute() {
  65     progress.start();
  66
  67     DbSession session = db.openSession(false);
  68     try {
  69       Migration45Mapper mapper = session.getMapper(Migration45Mapper.class);
  70
  71       List<RuleParameter> templateRuleParams = mapper.selectAllTemplateRuleParameters();
  72       Multimap<Integer, RuleParameter> templateRuleParamsByRuleId = ArrayListMultimap.create();
  73       for (RuleParameter templateRuleParam : templateRuleParams) {
  74         templateRuleParamsByRuleId.put(templateRuleParam.getRuleId(), templateRuleParam);
  75       }
  76
  77       List<Rule> customRules = mapper.selectAllCustomRules();
  78       Multimap<Integer, Integer> customRuleIdsByTemplateRuleId = HashMultimap.create();
  79       for (Rule customRule : customRules) {
  80         customRuleIdsByTemplateRuleId.put(customRule.getTemplateId(), customRule.getId());
  81       }
  82
  83       List<RuleParameter> customRuleParams = mapper.selectAllCustomRuleParameters();
  84       Multimap<Integer, RuleParameter> customRuleParamsByRuleId = ArrayListMultimap.create();
  85       for (RuleParameter customRuleParam : customRuleParams) {
  86         customRuleParamsByRuleId.put(customRuleParam.getRuleId(), customRuleParam);
  87       }
  88
  89       // For each parameters of template rules, verify that each custom rules has the parameter
  90       for (Integer templateRuleId : templateRuleParamsByRuleId.keySet()) {
  91         for (RuleParameter templateRuleParam : templateRuleParamsByRuleId.get(templateRuleId)) {
  92           // Each custom rule should have this parameter
  93           insertCustomRuleParameterIfNotAlreadyExisting(templateRuleParam, templateRuleId, customRuleIdsByTemplateRuleId, customRuleParamsByRuleId, session);
  94         }
  95       }
  96
  97       session.commit();
  98
  99       // log the total number of process rows
 100       progress.log();
 101     } finally {
 102       session.close();
 103       progress.stop();
 104     }
 105   }
 106
 107   private void insertCustomRuleParameterIfNotAlreadyExisting(RuleParameter templateRuleParam, Integer templateRuleId,
 108     Multimap<Integer, Integer> customRuleIdsByTemplateRuleId,
 109     Multimap<Integer, RuleParameter> customRuleParamsByRuleId,
 110     DbSession session) {
 111     for (Integer customRuleId : customRuleIdsByTemplateRuleId.get(templateRuleId)) {
 112       if (!hasParameter(templateRuleParam.getName(), customRuleParamsByRuleId.get(customRuleId))) {
 113         // Insert new custom rule parameter
 114         session.getMapper(Migration45Mapper.class).insertRuleParameter(new RuleParameter()
 115           .setRuleId(customRuleId)
 116           .setRuleTemplateId(templateRuleId)
 117           .setName(templateRuleParam.getName())
 118           .setDescription(templateRuleParam.getDescription())
 119           .setType(templateRuleParam.getType())
 120           );
 121
 122         // Update updated at date of custom rule in order to allow E/S indexation
 123         session.getMapper(Migration45Mapper.class).updateRuleUpdateAt(customRuleId, new Date(system.now()));
 124
 125         counter.getAndIncrement();
 126       }
 127     }
 128   }
 129
 130   private boolean hasParameter(final String parameter, Collection<RuleParameter> customRuleParams) {
 131     return Iterables.any(customRuleParams, new Predicate<RuleParameter>() {
 132       @Override
 133       public boolean apply(@Nullable RuleParameter input) {
 134         return input != null && input.getName().equals(parameter);
 135       }
 136     });
 137   }
 138 }