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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2022 SonarSource SA
   4  * mailto:info AT sonarsource DOT com
   5  *
   6  * This program 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  * This program 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.qualityprofile;
  21
  22 import java.io.Reader;
  23 import java.io.Writer;
  24 import java.util.ArrayList;
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.Comparator;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Set;
  31 import java.util.function.Function;
  32 import java.util.stream.Collectors;
  33 import javax.annotation.Nullable;
  34 import org.apache.commons.lang.builder.CompareToBuilder;
  35 import org.sonar.api.rule.RuleKey;
  36 import org.sonar.api.rule.RuleStatus;
  37 import org.sonar.api.rules.RuleType;
  38 import org.sonar.api.server.ServerSide;
  39 import org.sonar.db.DbClient;
  40 import org.sonar.db.DbSession;
  41 import org.sonar.db.qualityprofile.ExportRuleDto;
  42 import org.sonar.db.qualityprofile.ExportRuleParamDto;
  43 import org.sonar.db.qualityprofile.QProfileDto;
  44 import org.sonar.db.rule.DeprecatedRuleKeyDto;
  45 import org.sonar.db.rule.RuleDefinitionDto;
  46 import org.sonar.server.qualityprofile.builtin.QProfileName;
  47 import org.sonar.server.rule.NewCustomRule;
  48 import org.sonar.server.rule.NewRuleDescriptionSection;
  49 import org.sonar.server.rule.RuleCreator;
  50
  51 import static com.google.common.base.Preconditions.checkArgument;
  52 import static java.util.function.Function.identity;
  53 import static java.util.stream.Collectors.toSet;
  54
  55 @ServerSide
  56 public class QProfileBackuperImpl implements QProfileBackuper {
  57
  58   private final DbClient db;
  59   private final QProfileReset profileReset;
  60   private final QProfileFactory profileFactory;
  61   private final RuleCreator ruleCreator;
  62   private final QProfileParser qProfileParser;
  63
  64   public QProfileBackuperImpl(DbClient db, QProfileReset profileReset, QProfileFactory profileFactory,
  65     RuleCreator ruleCreator, QProfileParser qProfileParser) {
  66     this.db = db;
  67     this.profileReset = profileReset;
  68     this.profileFactory = profileFactory;
  69     this.ruleCreator = ruleCreator;
  70     this.qProfileParser = qProfileParser;
  71   }
  72
  73   @Override
  74   public void backup(DbSession dbSession, QProfileDto profile, Writer writer) {
  75     List<ExportRuleDto> rulesToExport = db.qualityProfileExportDao().selectRulesByProfile(dbSession, profile);
  76     rulesToExport.sort(BackupActiveRuleComparator.INSTANCE);
  77     qProfileParser.writeXml(writer, profile, rulesToExport.iterator());
  78   }
  79
  80   @Override
  81   public QProfileRestoreSummary copy(DbSession dbSession, QProfileDto from, QProfileDto to) {
  82     List<ExportRuleDto> rulesToExport = db.qualityProfileExportDao().selectRulesByProfile(dbSession, from);
  83     rulesToExport.sort(BackupActiveRuleComparator.INSTANCE);
  84
  85     ImportedQProfile qProfile = toImportedQProfile(rulesToExport, to.getName(), to.getLanguage());
  86     return restore(dbSession, qProfile, name -> to);
  87   }
  88
  89   private static ImportedQProfile toImportedQProfile(List<ExportRuleDto> exportRules, String profileName, String profileLang) {
  90     List<ImportedRule> importedRules = new ArrayList<>(exportRules.size());
  91
  92     for (ExportRuleDto exportRuleDto : exportRules) {
  93       var ruleKey = exportRuleDto.getRuleKey();
  94       ImportedRule importedRule = new ImportedRule();
  95       importedRule.setName(exportRuleDto.getName());
  96       importedRule.setRepository(ruleKey.repository());
  97       importedRule.setKey(ruleKey.rule());
  98       importedRule.setSeverity(exportRuleDto.getSeverityString());
  99       if (importedRule.isCustomRule()) {
 100         importedRule.setTemplate(exportRuleDto.getTemplateRuleKey().rule());
 101       }
 102       importedRule.setType(exportRuleDto.getRuleType().name());
 103       exportRuleDto.getRuleDescriptionSections()
 104         .stream()
 105         .map(r -> new NewRuleDescriptionSection(r.getKey(), r.getContent()))
 106         .forEach(importedRule::addRuleDescriptionSection);
 107       importedRule.setParameters(exportRuleDto.getParams().stream().collect(Collectors.toMap(ExportRuleParamDto::getKey, ExportRuleParamDto::getValue)));
 108       importedRules.add(importedRule);
 109     }
 110
 111     return new ImportedQProfile(profileName, profileLang, importedRules);
 112   }
 113
 114   @Override
 115   public QProfileRestoreSummary restore(DbSession dbSession, Reader backup, @Nullable String overriddenProfileName) {
 116     return restore(dbSession, backup, nameInBackup -> {
 117       QProfileName targetName = nameInBackup;
 118       if (overriddenProfileName != null) {
 119         targetName = new QProfileName(nameInBackup.getLanguage(), overriddenProfileName);
 120       }
 121       return profileFactory.getOrCreateCustom(dbSession, targetName);
 122     });
 123   }
 124
 125   @Override
 126   public QProfileRestoreSummary restore(DbSession dbSession, Reader backup, QProfileDto profile) {
 127     return restore(dbSession, backup, nameInBackup -> {
 128       checkArgument(profile.getLanguage().equals(nameInBackup.getLanguage()),
 129         "Can't restore %s backup on %s profile with key [%s]. Languages are different.", nameInBackup.getLanguage(), profile.getLanguage(), profile.getKee());
 130       return profile;
 131     });
 132   }
 133
 134   private QProfileRestoreSummary restore(DbSession dbSession, Reader backup, Function<QProfileName, QProfileDto> profileLoader) {
 135     ImportedQProfile qProfile = qProfileParser.readXml(backup);
 136     return restore(dbSession, qProfile, profileLoader);
 137   }
 138
 139   private QProfileRestoreSummary restore(DbSession dbSession, ImportedQProfile qProfile, Function<QProfileName, QProfileDto> profileLoader) {
 140     QProfileName targetName = new QProfileName(qProfile.getProfileLang(), qProfile.getProfileName());
 141     QProfileDto targetProfile = profileLoader.apply(targetName);
 142
 143     List<ImportedRule> importedRules = qProfile.getRules();
 144
 145     Map<RuleKey, RuleDefinitionDto> ruleDefinitionsByKey = getImportedRulesDefinitions(dbSession, importedRules);
 146     checkIfRulesFromExternalEngines(ruleDefinitionsByKey.values());
 147
 148     Map<RuleKey, RuleDefinitionDto> customRulesDefinitions = createCustomRulesIfNotExist(dbSession, importedRules, ruleDefinitionsByKey);
 149     ruleDefinitionsByKey.putAll(customRulesDefinitions);
 150
 151     List<RuleActivation> ruleActivations = toRuleActivations(importedRules, ruleDefinitionsByKey);
 152
 153     BulkChangeResult changes = profileReset.reset(dbSession, targetProfile, ruleActivations);
 154     return new QProfileRestoreSummary(targetProfile, changes);
 155   }
 156
 157   /**
 158    * Returns map of rule definition for an imported rule key.
 159    * The imported rule key may refer to a deprecated rule key, in which case the the RuleDefinitionDto will correspond to a different key (the new key).
 160    */
 161   private Map<RuleKey, RuleDefinitionDto> getImportedRulesDefinitions(DbSession dbSession, List<ImportedRule> rules) {
 162     Set<RuleKey> ruleKeys = rules.stream()
 163       .map(ImportedRule::getRuleKey)
 164       .collect(toSet());
 165     Map<RuleKey, RuleDefinitionDto> rulesDefinitions = db.ruleDao().selectDefinitionByKeys(dbSession, ruleKeys).stream()
 166       .collect(Collectors.toMap(RuleDefinitionDto::getKey, identity()));
 167
 168     Set<RuleKey> unrecognizedRuleKeys = ruleKeys.stream()
 169       .filter(r -> !rulesDefinitions.containsKey(r))
 170       .collect(toSet());
 171
 172     if (!unrecognizedRuleKeys.isEmpty()) {
 173       Map<String, DeprecatedRuleKeyDto> deprecatedRuleKeysByUuid = db.ruleDao().selectAllDeprecatedRuleKeys(dbSession).stream()
 174         .filter(r -> r.getNewRepositoryKey() != null && r.getNewRuleKey() != null)
 175         .filter(r -> unrecognizedRuleKeys.contains(RuleKey.of(r.getOldRepositoryKey(), r.getOldRuleKey())))
 176         // ignore deprecated rule if the new rule key was already found in the list of imported rules
 177         .filter(r -> !ruleKeys.contains(RuleKey.of(r.getNewRepositoryKey(), r.getNewRuleKey())))
 178         .collect(Collectors.toMap(DeprecatedRuleKeyDto::getRuleUuid, identity()));
 179
 180       List<RuleDefinitionDto> rulesBasedOnDeprecatedKeys = db.ruleDao().selectDefinitionByUuids(dbSession, deprecatedRuleKeysByUuid.keySet());
 181       for (RuleDefinitionDto rule : rulesBasedOnDeprecatedKeys) {
 182         DeprecatedRuleKeyDto deprecatedRuleKey = deprecatedRuleKeysByUuid.get(rule.getUuid());
 183         RuleKey oldRuleKey = RuleKey.of(deprecatedRuleKey.getOldRepositoryKey(), deprecatedRuleKey.getOldRuleKey());
 184         rulesDefinitions.put(oldRuleKey, rule);
 185       }
 186     }
 187
 188     return rulesDefinitions;
 189   }
 190
 191   private static void checkIfRulesFromExternalEngines(Collection<RuleDefinitionDto> ruleDefinitions) {
 192     List<RuleDefinitionDto> externalRules = ruleDefinitions.stream()
 193       .filter(RuleDefinitionDto::isExternal)
 194       .collect(Collectors.toList());
 195
 196     if (!externalRules.isEmpty()) {
 197       throw new IllegalArgumentException("The quality profile cannot be restored as it contains rules from external rule engines: "
 198         + externalRules.stream().map(r -> r.getKey().toString()).collect(Collectors.joining(", ")));
 199     }
 200   }
 201
 202   private Map<RuleKey, RuleDefinitionDto> createCustomRulesIfNotExist(DbSession dbSession, List<ImportedRule> rules, Map<RuleKey, RuleDefinitionDto> ruleDefinitionsByKey) {
 203     List<NewCustomRule> customRulesToCreate = rules.stream()
 204       .filter(r -> ruleDefinitionsByKey.get(r.getRuleKey()) == null && r.isCustomRule())
 205       .map(QProfileBackuperImpl::importedRuleToNewCustomRule)
 206       .collect(Collectors.toList());
 207
 208     if (!customRulesToCreate.isEmpty()) {
 209       return db.ruleDao().selectDefinitionByKeys(dbSession, ruleCreator.create(dbSession, customRulesToCreate))
 210         .stream()
 211         .collect(Collectors.toMap(RuleDefinitionDto::getKey, identity()));
 212     }
 213     return Collections.emptyMap();
 214   }
 215
 216   private static NewCustomRule importedRuleToNewCustomRule(ImportedRule r) {
 217     return NewCustomRule.createForCustomRule(r.getRuleKey().rule(), r.getTemplateKey())
 218       .setName(r.getName())
 219       .setSeverity(r.getSeverity())
 220       .setStatus(RuleStatus.READY)
 221       .setPreventReactivation(true)
 222       .setType(RuleType.valueOf(r.getType()))
 223       .setMarkdownDescription(r.getDescription())
 224       .setRuleDescriptionSections(r.getRuleDescriptionSections())
 225       .setParameters(r.getParameters());
 226   }
 227
 228   private static List<RuleActivation> toRuleActivations(List<ImportedRule> rules, Map<RuleKey, RuleDefinitionDto> ruleDefinitionsByKey) {
 229     List<RuleActivation> activatedRule = new ArrayList<>();
 230
 231     for (ImportedRule r : rules) {
 232       RuleDefinitionDto ruleDefinition = ruleDefinitionsByKey.get(r.getRuleKey());
 233       if (ruleDefinition == null) {
 234         continue;
 235       }
 236       activatedRule.add(RuleActivation.create(ruleDefinition.getUuid(), r.getSeverity(), r.getParameters()));
 237     }
 238     return activatedRule;
 239   }
 240
 241   private enum BackupActiveRuleComparator implements Comparator<ExportRuleDto> {
 242     INSTANCE;
 243
 244     @Override
 245     public int compare(ExportRuleDto o1, ExportRuleDto o2) {
 246       RuleKey rk1 = o1.getRuleKey();
 247       RuleKey rk2 = o2.getRuleKey();
 248       return new CompareToBuilder()
 249         .append(rk1.repository(), rk2.repository())
 250         .append(rk1.rule(), rk2.rule())
 251         .toComparison();
 252     }
 253   }
 254 }