org.sonar.server.platform.db.migration.AutoDbMigration.java Source code

Introduction

Here is the source code for org.sonar.server.platform.db.migration.AutoDbMigration.java

Source

/*
 * SonarQube
 * Copyright (C) 2009-2017 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.platform.db.migration;

import com.google.common.annotations.VisibleForTesting;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import org.apache.commons.dbutils.DbUtils;
import org.picocontainer.Startable;
import org.sonar.api.platform.ServerUpgradeStatus;
import org.sonar.api.utils.log.Loggers;
import org.sonar.db.DbClient;
import org.sonar.db.DbSession;
import org.sonar.db.DdlUtils;
import org.sonar.db.dialect.Dialect;
import org.sonar.db.dialect.H2;
import org.sonar.server.platform.db.migration.engine.MigrationEngine;
import org.sonar.server.platform.db.migration.step.MigrationSteps;

/**
 * FIXME fix this class to remove use of DdlUtils.createSchema
 */
public class AutoDbMigration implements Startable {
    private final ServerUpgradeStatus serverUpgradeStatus;
    private final DbClient dbClient;
    private final MigrationEngine migrationEngine;
    private final MigrationSteps migrationSteps;

    public AutoDbMigration(ServerUpgradeStatus serverUpgradeStatus, DbClient dbClient,
            MigrationEngine migrationEngine, MigrationSteps migrationSteps) {
        this.serverUpgradeStatus = serverUpgradeStatus;
        this.dbClient = dbClient;
        this.migrationEngine = migrationEngine;
        this.migrationSteps = migrationSteps;
    }

    @Override
    public void start() {
        if (!serverUpgradeStatus.isFreshInstall()) {
            return;
        }

        Loggers.get(getClass()).info("Automatically perform DB migration on fresh install");
        Dialect dialect = dbClient.getDatabase().getDialect();
        if (H2.ID.equals(dialect.getId())) {
            installH2();
        } else {
            migrationEngine.execute();
        }
    }

    @VisibleForTesting
    void installH2() {
        Connection connection = null;
        try (DbSession session = dbClient.openSession(false)) {
            connection = session.getConnection();
            createH2Schema(connection, dbClient.getDatabase().getDialect().getId());
        } finally {
            DbUtils.closeQuietly(connection);
        }
    }

    @VisibleForTesting
    protected void createH2Schema(Connection connection, String dialectId) {
        DdlUtils.createSchema(connection, dialectId, false);
        populateSchemaMigration(connection, migrationSteps.getMaxMigrationNumber());
        hackFixForProjectMeasureTreeQueries(connection);
    }

    private static void populateSchemaMigration(Connection connection, long maxMigrationNumber) {
        try (PreparedStatement preparedStatement = connection
                .prepareStatement("INSERT INTO SCHEMA_MIGRATIONS(VERSION) VALUES (?)")) {
            batchExecute(0, maxMigrationNumber + 1, preparedStatement, connection,
                    (statement, counter) -> statement.setString(1, String.valueOf(counter)));
        } catch (SQLException e) {
            throw new RuntimeException("Failed to insert rows into table SCHEMA_MIGRATIONS", e);
        }
    }

    /**
     * see SONAR-8586
     */
    private static void hackFixForProjectMeasureTreeQueries(Connection connection) {
        int metricId = 1;
        try (PreparedStatement preparedStatement = connection.prepareStatement(
                "insert into PROJECT_MEASURES (METRIC_ID,COMPONENT_UUID,ANALYSIS_UUID) values (?,?,?);")) {
            batchExecute(1, 1000, preparedStatement, connection, (stmt, counter) -> {
                preparedStatement.setInt(1, metricId);
                preparedStatement.setString(2, "foo_" + counter);
                preparedStatement.setString(3, "bar_" + counter);
            });
        } catch (SQLException e) {
            throw new RuntimeException("Failed to insert fake rows into table PROJECT_MEASURES", e);
        }
    }

    /**
     * @param start included
     * @param end excluded
     */
    private static void batchExecute(long start, long end, PreparedStatement preparedStatement,
            Connection connection, Preparer preparer) throws SQLException {
        for (long i = start; i < end; i++) {
            preparer.prepare(preparedStatement, i);
            preparedStatement.addBatch();
            if (i % 250 == 0) {
                preparedStatement.executeBatch();
                connection.commit();
            }
        }
        preparedStatement.executeBatch();
        connection.commit();
    }

    @FunctionalInterface
    private interface Preparer {
        void prepare(PreparedStatement statement, long counter) throws SQLException;
    }

    @Override
    public void stop() {
        // nothing to do
    }
}