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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2024 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.ce.task.projectexport.steps;
  21
  22 import com.sonarsource.governance.projectdump.protobuf.ProjectDump;
  23 import java.util.List;
  24 import java.util.Set;
  25 import org.slf4j.LoggerFactory;
  26 import org.sonar.ce.task.step.ComputationStep;
  27 import org.sonar.db.DbClient;
  28 import org.sonar.db.DbSession;
  29 import org.sonar.db.property.PropertyDto;
  30
  31 import static java.lang.String.format;
  32 import static org.apache.commons.lang.StringUtils.defaultString;
  33
  34 public class ExportSettingsStep implements ComputationStep {
  35
  36   /**
  37    * These properties are not exported as values depend on environment data that are not
  38    * exported within the dump (Quality Gate, users).
  39    */
  40   private static final Set<String> IGNORED_KEYS = Set.of("sonar.issues.defaultAssigneeLogin");
  41
  42   private final DbClient dbClient;
  43   private final ProjectHolder projectHolder;
  44   private final DumpWriter dumpWriter;
  45
  46   public ExportSettingsStep(DbClient dbClient, ProjectHolder projectHolder, DumpWriter dumpWriter) {
  47     this.dbClient = dbClient;
  48     this.projectHolder = projectHolder;
  49     this.dumpWriter = dumpWriter;
  50   }
  51
  52   @Override
  53   public void execute(Context context) {
  54     long count = 0L;
  55     try (
  56       StreamWriter<ProjectDump.Setting> output = dumpWriter.newStreamWriter(DumpElement.SETTINGS);
  57       DbSession dbSession = dbClient.openSession(false)) {
  58
  59       final ProjectDump.Setting.Builder builder = ProjectDump.Setting.newBuilder();
  60       final List<PropertyDto> properties = dbClient.projectExportDao()
  61         .selectPropertiesForExport(dbSession, projectHolder.projectDto().getUuid())
  62         .stream()
  63         .filter(dto -> dto.getEntityUuid() != null)
  64         .filter(dto -> !IGNORED_KEYS.contains(dto.getKey()))
  65         .toList();
  66       for (PropertyDto property : properties) {
  67         builder.clear()
  68           .setKey(property.getKey())
  69           .setValue(defaultString(property.getValue()));
  70         output.write(builder.build());
  71         ++count;
  72       }
  73
  74       LoggerFactory.getLogger(getClass()).debug("{} settings exported", count);
  75     } catch (Exception e) {
  76       throw new IllegalStateException(format("Settings Export failed after processing %d settings successfully", count), e);
  77     }
  78   }
  79
  80   @Override
  81   public String getDescription() {
  82     return "Export settings";
  83   }
  84 }