BaselineMigrationResolver.java

/*-
 * ========================LICENSE_START=================================
 * flyway-core
 * ========================================================================
 * Copyright (C) 2010 - 2026 Red Gate Software Ltd
 * ========================================================================
 * 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.
 * =========================LICENSE_END==================================
 */
package org.flywaydb.core.api.migration.baseline;

import lombok.CustomLog;
import org.flywaydb.core.api.ResourceProvider;
import org.flywaydb.core.api.callback.Event;
import org.flywaydb.core.api.configuration.Configuration;
import org.flywaydb.core.api.resolver.MigrationResolver;
import org.flywaydb.core.api.resolver.ResolvedMigration;
import org.flywaydb.core.api.resource.LoadableResource;
import org.flywaydb.core.api.resource.Resource;
import org.flywaydb.core.extensibility.MigrationType;
import org.flywaydb.core.internal.resolver.ChecksumCalculator;
import org.flywaydb.core.internal.resolver.ResolvedMigrationComparator;
import org.flywaydb.core.internal.resolver.sql.SqlMigrationExecutor;
import org.flywaydb.core.internal.resource.ResourceName;
import org.flywaydb.core.internal.resource.ResourceNameParser;
import org.flywaydb.core.internal.sqlscript.SqlScript;
import org.flywaydb.core.internal.sqlscript.SqlScriptExecutorFactory;
import org.flywaydb.core.internal.sqlscript.SqlScriptFactory;

import java.util.*;
import java.util.stream.Collectors;

@CustomLog
public class BaselineMigrationResolver implements MigrationResolver {

    protected static boolean isSqlCallback(final ResourceName result) {
        return Event.fromId(result.getPrefix()) != null;
    }

    @Override
    public Collection<ResolvedMigration> resolveMigrations(final Context context) {
        final List<ResolvedMigration> migrations = new ArrayList<>();

        final BaselineMigrationConfigurationExtension configurationExtension = context.configuration.getPluginRegister()
            .getExact(BaselineMigrationConfigurationExtension.class);
        final Configuration configuration = context.configuration;

        addMigrations(migrations,
            configurationExtension.getBaselineMigrationPrefix(),
            configuration,
            context.resourceProvider,
            context.sqlScriptFactory,
            context.sqlScriptExecutorFactory);

        migrations.sort(new ResolvedMigrationComparator());
        return migrations;
    }

    @Override
    public MigrationType getDefaultMigrationType() {
        return BaselineMigrationType.SQL_BASELINE;
    }

    @Override
    public String getPrefix(final Configuration configuration) {
        return configuration.getPluginRegister()
            .getExact(BaselineMigrationConfigurationExtension.class)
            .getBaselineMigrationPrefix();
    }

    private void addMigrations(final List<ResolvedMigration> migrations,
        final String prefix,
        final Configuration configuration,
        final ResourceProvider resourceProvider,
        final SqlScriptFactory sqlScriptFactory,
        final SqlScriptExecutorFactory sqlScriptExecutorFactory) {
        final ResourceNameParser resourceNameParser = new ResourceNameParser(configuration);

        for (final LoadableResource resource : resourceProvider.getResources(prefix,
            configuration.getSqlMigrationSuffixes())) {
            final String filename = resource.getFilename();
            final ResourceName result = resourceNameParser.parse(filename);
            if (!result.isValid() || isSqlCallback(result) || !prefix.equals(result.getPrefix())) {
                continue;
            }

            final SqlScript sqlScript = sqlScriptFactory.createSqlScript(resource,
                configuration.isMixed(),
                resourceProvider);

            final List<LoadableResource> resources = new ArrayList<>();
            resources.add(resource);

            if (sqlScript.includeReferencedScriptsInChecksum()) {
                final SortedSet<LoadableResource> referencedResources = new TreeSet<>();
                for (final SqlScript referencedSqlScript : sqlScript.getReferencedSqlScripts()) {
                    referencedResources.add(referencedSqlScript.getResource());
                }
                if (!referencedResources.isEmpty()) {
                    LOG.debug("Calculating checksum for '"
                        + filename
                        + "' using the following referenced scripts: "
                        + referencedResources.stream().map(Resource::getFilename).collect(Collectors.joining(",")));
                }
                resources.addAll(referencedResources);
            }

            final Integer checksum = getChecksumForLoadableResource(resources);

            migrations.add(new BaselineResolvedMigration(result.getVersion(),
                result.getDescription(),
                resource.getRelativePath(),
                checksum,
                null,
                resource.getAbsolutePathOnDisk(),
                new SqlMigrationExecutor(sqlScriptExecutorFactory, sqlScript, false, configuration.isBatch()),
                configuration));
        }
    }

    private Integer getChecksumForLoadableResource(final List<LoadableResource> loadableResources) {
        return ChecksumCalculator.calculate(loadableResources.toArray(LoadableResource[]::new));
    }
}