ca.uhn.fhir.jpa.migrate.tasks.api.BaseMigrationTasks Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-sql-migrate Show documentation
Tooling for migrating SQL schemas.
The newest version!
/*-
 * #%L
 * HAPI FHIR Server - SQL Migration
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * 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.
 * #L%
 */
package ca.uhn.fhir.jpa.migrate.tasks.api;

import ca.uhn.fhir.i18n.Msg;
import ca.uhn.fhir.jpa.migrate.MigrationTaskList;
import ca.uhn.fhir.jpa.migrate.taskdef.BaseTask;
import com.google.common.collect.Multimap;
import com.google.common.collect.MultimapBuilder;
import jakarta.annotation.Nonnull;
import org.apache.commons.lang3.EnumUtils;
import org.apache.commons.lang3.Validate;
import org.flywaydb.core.api.MigrationVersion;

import java.util.Collection;

import static java.util.Objects.nonNull;

public class BaseMigrationTasks {
	MigrationVersion lastVersion;
	private Multimap myTasks =
			MultimapBuilder.hashKeys().arrayListValues().build();

	@SuppressWarnings("unchecked")
	public MigrationTaskList getTaskList(@Nonnull T theFrom, @Nonnull T theTo) {
		Validate.notNull(theFrom);
		Validate.notNull(theTo);
		Validate.isTrue(theFrom.ordinal() < theTo.ordinal(), "From version must be lower than to version");

		MigrationTaskList retVal = new MigrationTaskList();
		for (Object nextVersion : EnumUtils.getEnumList(theFrom.getClass())) {
			if (((T) nextVersion).ordinal() <= theFrom.ordinal()) {
				continue;
			}
			if (((T) nextVersion).ordinal() > theTo.ordinal()) {
				continue;
			}

			Collection nextValues = myTasks.get((T) nextVersion);
			retVal.addAll(nextValues);
		}

		return retVal;
	}

	public Builder forVersion(T theRelease) {
		IAcceptsTasks sink = theTask -> {
			theTask.validate();
			myTasks.put(theRelease, theTask);
		};
		return new Builder(toReleaseName(theRelease), sink);
	}

	@Nonnull
	protected String toReleaseName(T theRelease) {
		return theRelease.name();
	}

	public MigrationTaskList getAllTasks(T... theVersionEnumValues) {
		MigrationTaskList retval = new MigrationTaskList();
		for (T nextVersion : theVersionEnumValues) {
			Collection nextValues = myTasks.get(nextVersion);
			if (nextValues != null) {
				validate(nextValues);
				retval.addAll(nextValues);
			}
		}

		return retval;
	}

	public boolean hasTasksForVersion(T theRelease) {
		Collection baseTasks = myTasks.get(theRelease);
		return nonNull(baseTasks) && !baseTasks.isEmpty();
	}

	protected BaseTask getTaskWithVersion(String theMigrationVersion) {
		// First normalize the version number
		String expectedVersion =
				MigrationVersion.fromVersion(theMigrationVersion).getVersion();

		return myTasks.values().stream()
				.filter(task -> expectedVersion.equals(task.getMigrationVersion()))
				.findFirst()
				.get();
	}

	void validate(Collection theTasks) {
		for (BaseTask task : theTasks) {
			task.validateVersion();
			String version = task.getMigrationVersion();
			MigrationVersion migrationVersion = MigrationVersion.fromVersion(version);
			if (lastVersion != null) {
				if (migrationVersion.compareTo(lastVersion) <= 0) {
					throw new IllegalStateException(
							Msg.code(51) + "Migration version " + migrationVersion + " found after migration version "
									+ lastVersion + ".  Migrations need to be in order by version number.");
				}
			}
			lastVersion = migrationVersion;
		}
	}

	public interface IAcceptsTasks {
		void addTask(BaseTask theTask);
	}
}