3 * Copyright (C) 2009-2023 SonarSource SA
4 * mailto:info AT sonarsource DOT com
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.
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.
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.
20 package org.sonar.server.platform.db.migration.engine;
22 import java.util.List;
23 import java.util.Optional;
24 import org.sonar.api.config.Configuration;
25 import org.sonar.api.utils.AnnotationUtils;
26 import org.sonar.core.platform.SpringComponentContainer;
27 import org.sonar.process.ProcessProperties;
28 import org.sonar.server.platform.db.migration.SupportsBlueGreen;
29 import org.sonar.server.platform.db.migration.history.MigrationHistory;
30 import org.sonar.server.platform.db.migration.step.MigrationSteps;
31 import org.sonar.server.platform.db.migration.step.MigrationStepsExecutor;
32 import org.sonar.server.platform.db.migration.step.MigrationStepsExecutorImpl;
33 import org.sonar.server.platform.db.migration.step.RegisteredMigrationStep;
35 import static java.lang.String.format;
37 public class MigrationEngineImpl implements MigrationEngine {
38 private final MigrationHistory migrationHistory;
39 private final SpringComponentContainer serverContainer;
40 private final MigrationSteps migrationSteps;
41 private final Configuration configuration;
43 public MigrationEngineImpl(MigrationHistory migrationHistory, SpringComponentContainer serverContainer, MigrationSteps migrationSteps, Configuration configuration) {
44 this.migrationHistory = migrationHistory;
45 this.serverContainer = serverContainer;
46 this.migrationSteps = migrationSteps;
47 this.configuration = configuration;
51 public void execute() {
52 MigrationContainer migrationContainer = new MigrationContainerImpl(serverContainer, MigrationStepsExecutorImpl.class);
53 boolean blueGreen = configuration.getBoolean(ProcessProperties.Property.BLUE_GREEN_ENABLED.getKey()).orElse(false);
55 MigrationStepsExecutor stepsExecutor = migrationContainer.getComponentByType(MigrationStepsExecutor.class);
56 Optional<Long> lastMigrationNumber = migrationHistory.getLastMigrationNumber();
58 List<RegisteredMigrationStep> steps = lastMigrationNumber
59 .map(i -> migrationSteps.readFrom(i + 1))
60 .orElse(migrationSteps.readAll());
63 ensureSupportBlueGreen(steps);
66 stepsExecutor.execute(steps);
69 migrationContainer.cleanup();
73 private static void ensureSupportBlueGreen(List<RegisteredMigrationStep> steps) {
74 for (RegisteredMigrationStep step : steps) {
75 if (AnnotationUtils.getAnnotation(step.getStepClass(), SupportsBlueGreen.class) == null) {
76 throw new IllegalStateException(format("All migrations canceled. #%d does not support blue/green deployment: %s",
77 step.getMigrationNumber(), step.getDescription()));