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