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
  35 import javax.annotation.Nullable;
  36 import java.util.Collection;
  37 import java.util.Date;
  38 import java.util.List;
  39
  40 /**
  41  * See http://jira.codehaus.org/browse/SONAR-5575
  42  *
  43  * Add missing parameters (with no value) on each custom rules
  44  *
  45  * @since 4.5.1
  46  */
  47 public class AddMissingCustomRuleParametersMigration implements DatabaseMigration {
  48
  49   private final DbClient db;
  50   private final System2 system;
  51
  52   public AddMissingCustomRuleParametersMigration(DbClient db, System2 system) {
  53     this.db = db;
  54     this.system = system;
  55   }
  56
  57   @Override
  58   public void execute() {
  59     DbSession session = db.openSession(false);
  60     try {
  61       Migration45Mapper mapper = session.getMapper(Migration45Mapper.class);
  62
  63       List<RuleParameter> templateRuleParams = mapper.selectAllTemplateRuleParameters();
  64       Multimap<Integer, RuleParameter> templateRuleParamsByRuleId = ArrayListMultimap.create();
  65       for (RuleParameter templateRuleParam : templateRuleParams) {
  66         templateRuleParamsByRuleId.put(templateRuleParam.getRuleId(), templateRuleParam);
  67       }
  68
  69       List<Rule> customRules = mapper.selectAllCustomRules();
  70       Multimap<Integer, Integer> customRuleIdsByTemplateRuleId = HashMultimap.create();
  71       for (Rule customRule : customRules) {
  72         customRuleIdsByTemplateRuleId.put(customRule.getTemplateId(), customRule.getId());
  73       }
  74
  75       List<RuleParameter> customRuleParams = mapper.selectAllCustomRuleParameters();
  76       Multimap<Integer, RuleParameter> customRuleParamsByRuleId = ArrayListMultimap.create();
  77       for (RuleParameter customRuleParam : customRuleParams) {
  78         customRuleParamsByRuleId.put(customRuleParam.getRuleId(), customRuleParam);
  79       }
  80
  81       // For each parameters of template rules, verify that each custom rules has the parameter
  82       for (Integer templateRuleId : templateRuleParamsByRuleId.keySet()) {
  83         for (RuleParameter templateRuleParam : templateRuleParamsByRuleId.get(templateRuleId)) {
  84           // Each custom rule should have this parameter
  85           for (Integer customRuleId : customRuleIdsByTemplateRuleId.get(templateRuleId)) {
  86             if (!hasParameter(templateRuleParam.getName(), customRuleParamsByRuleId.get(customRuleId))) {
  87               // Insert new custom rule parameter
  88               mapper.insertRuleParameter(new RuleParameter()
  89                 .setRuleId(customRuleId)
  90                 .setRuleTemplateId(templateRuleId)
  91                 .setName(templateRuleParam.getName())
  92                 .setDescription(templateRuleParam.getDescription())
  93                 .setType(templateRuleParam.getType())
  94               );
  95
  96               // Update updated at date of custom rule in order to allow E/S indexation
  97               mapper.updateRuleUpdateAt(customRuleId, new Date(system.now()));
  98             }
  99           }
 100         }
 101       }
 102
 103       session.commit();
 104     } finally {
 105       session.close();
 106     }
 107   }
 108
 109   private boolean hasParameter(final String parameter, Collection<RuleParameter> customRuleParams) {
 110     return Iterables.any(customRuleParams, new Predicate<RuleParameter>() {
 111       @Override
 112       public boolean apply(@Nullable RuleParameter input) {
 113         return input != null && input.getName().equals(parameter);
 114       }
 115     });
 116   }
 117 }