io.liftwizard.dropwizard.bundle.liquibase.LiftwizardLiquibaseMigrationBundle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of liftwizard-bundle-liquibase-migration Show documentation
The newest version!
/*
 * Copyright 2024 Craig Motlin
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.liftwizard.dropwizard.bundle.liquibase;

import java.io.OutputStreamWriter;
import java.nio.charset.StandardCharsets;
import java.sql.SQLException;
import java.util.List;

import javax.annotation.Nonnull;
import javax.sql.DataSource;

import com.google.auto.service.AutoService;
import io.dropwizard.db.ManagedDataSource;
import io.dropwizard.setup.Environment;
import io.liftwizard.dropwizard.bundle.prioritized.PrioritizedBundle;
import io.liftwizard.dropwizard.configuration.datasource.NamedDataSourceProvider;
import io.liftwizard.dropwizard.configuration.liquibase.migration.LiquibaseDataSourceMigrationFactory;
import io.liftwizard.dropwizard.configuration.liquibase.migration.LiquibaseMigrationFactory;
import io.liftwizard.dropwizard.configuration.liquibase.migration.LiquibaseMigrationFactoryProvider;
import io.liftwizard.dropwizard.configuration.liquibase.migration.MigrationFileLocation;
import liquibase.Scope;
import liquibase.Scope.Attr;
import liquibase.database.Database;
import liquibase.database.DatabaseConnection;
import liquibase.database.DatabaseFactory;
import liquibase.database.jvm.JdbcConnection;
import liquibase.exception.LiquibaseException;
import liquibase.resource.ClassLoaderResourceAccessor;
import liquibase.resource.FileSystemResourceAccessor;
import liquibase.resource.ResourceAccessor;
import liquibase.ui.LoggerUIService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@AutoService(PrioritizedBundle.class)
public class LiftwizardLiquibaseMigrationBundle
        implements PrioritizedBundle
{
    private static final Logger LOGGER = LoggerFactory.getLogger(LiftwizardLiquibaseMigrationBundle.class);

    @Override
    public int getPriority()
    {
        return -6;
    }

    @Override
    public void runWithMdc(@Nonnull Object configuration, @Nonnull Environment environment)
            throws Exception
    {
        LiquibaseMigrationFactoryProvider liquibaseFactoryProvider = this.safeCastConfiguration(
                LiquibaseMigrationFactoryProvider.class,
                configuration);
        if (liquibaseFactoryProvider == null)
        {
            LOGGER.info("{} disabled.", this.getClass().getSimpleName());
            return;
        }

        LiquibaseMigrationFactory liquibaseMigrationFactory = liquibaseFactoryProvider.getLiquibaseMigrationFactory();
        if (!liquibaseMigrationFactory.isEnabled())
        {
            LOGGER.info("{} disabled.", this.getClass().getSimpleName());
            return;
        }

        NamedDataSourceProvider dataSourceProvider = this.safeCastConfiguration(
                NamedDataSourceProvider.class,
                configuration);

        LOGGER.info("Running {}.", this.getClass().getSimpleName());

        Scope.child(
                Attr.ui,
                new LoggerUIService(),
                () -> this.runWithLogger(environment, liquibaseMigrationFactory, dataSourceProvider));

        LOGGER.info("Completing {}.", this.getClass().getSimpleName());
    }

    private void runWithLogger(
            @Nonnull Environment environment,
            LiquibaseMigrationFactory liquibaseMigrationFactory,
            NamedDataSourceProvider dataSourceProvider)
    {
        boolean dryRun = liquibaseMigrationFactory.isDryRun();

        boolean dropEntireSchemaOnStartupAndShutdown = liquibaseMigrationFactory.isDropEntireSchemaOnStartupAndShutdown();

        for (LiquibaseDataSourceMigrationFactory factory : liquibaseMigrationFactory.getDataSourceMigrations())
        {
            String dataSourceName = factory.getDataSourceName();
            ManagedDataSource dataSource = dataSourceProvider.getNamedDataSourcesFactory().getDataSourceByName(
                    dataSourceName,
                    environment.metrics(),
                    environment.lifecycle());
            String catalogName = factory.getCatalogName();
            String schemaName = factory.getSchemaName();
            String migrationFile = factory.getMigrationFileName();
            MigrationFileLocation migrationFileLocation = factory.getMigrationFileLocation();
            List contexts = factory.getContexts();
            String context = String.join(",", contexts);

            try (
                    CloseableLiquibase liquibase = this.openLiquibase(
                            dataSource,
                            catalogName,
                            schemaName,
                            migrationFile,
                            migrationFileLocation))
            {
                if (dryRun)
                {
                    liquibase.update(context, new OutputStreamWriter(System.out, StandardCharsets.UTF_8));
                }
                else
                {
                    if (dropEntireSchemaOnStartupAndShutdown)
                    {
                        liquibase.dropAll();
                    }
                    liquibase.update(context);
                }
            }
            catch (Exception e)
            {
                throw new RuntimeException(e);
            }
        }
    }

    private CloseableLiquibase openLiquibase(
            ManagedDataSource dataSource,
            String catalogName,
            String schemaName,
            String migrationsFile,
            MigrationFileLocation migrationFileLocation)
            throws SQLException, LiquibaseException
    {
        Database database = this.createDatabase(dataSource, catalogName, schemaName);
        ResourceAccessor resourceAccessor = getResourceAccessor(migrationFileLocation);
        return new CloseableLiquibase(migrationsFile, resourceAccessor, database, dataSource);
    }

    @Nonnull
    private static ResourceAccessor getResourceAccessor(MigrationFileLocation migrationFileLocation)
    {
        return switch (migrationFileLocation)
        {
            case CLASSPATH -> new ClassLoaderResourceAccessor();
            case FILESYSTEM -> new FileSystemResourceAccessor();
        };
    }

    private Database createDatabase(DataSource dataSource, String catalogName, String schemaName)
            throws SQLException, LiquibaseException
    {
        DatabaseConnection connection = new JdbcConnection(dataSource.getConnection());
        Database database = DatabaseFactory.getInstance().findCorrectDatabaseImplementation(connection);

        if (database.supportsCatalogs() && catalogName != null)
        {
            database.setDefaultCatalogName(catalogName);
            database.setOutputDefaultCatalog(true);
        }
        if (database.supportsSchemas() && schemaName != null)
        {
            database.setDefaultSchemaName(schemaName);
            database.setOutputDefaultSchema(true);
        }

        return database;
    }
}