com.ecyshor.cassmig.MigrationFileTransformer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cassandra-migration Show documentation
Java schema migration library for Cassandra
There is a newer version: 1.1.6
package com.ecyshor.cassmig;

import com.ecyshor.cassmig.exception.InvalidDataException;
import com.ecyshor.cassmig.exception.InvalidMigrationsException;
import com.ecyshor.cassmig.exception.MissingRequiredConfiguration;
import com.ecyshor.cassmig.migration.MigrationExtractor;
import com.ecyshor.cassmig.model.MigrationFile;
import com.google.common.base.Throwables;
import com.google.common.collect.Lists;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.util.LinkedList;
import java.util.List;

import static org.apache.commons.beanutils.ConvertUtils.convert;

public class MigrationFileTransformer {

	private static final Logger LOGGER = LoggerFactory.getLogger(MigrationExtractor.class);
	private static final String MIGRATION_START_MARK = "start";
	private static final String MIGRATION_END_MARK = "end";
	private static final String CONFIGURATION_OPTION_PREFIX = "--";
	private static final String MIGRATION_INIT_KEY = "migration_init";
	private static final String KEYSPACE_KEY = "keyspace";
	private static final String DESCRIPTION_KEY = "description";
	private static final String ORDER_KEY = "order";
	private static final String VALUE_SEPARATOR = "=";
	private boolean foundInitFile = false;

	public List transformFilesToMigrations(List files) {
		List migrations = new LinkedList();
		for (InputStream migrationFile : files) {
			MigrationFile migration = transformMigrationFileToMigration(migrationFile);
			migrations.add(migration);
		}
		if (!foundInitFile) {
			throw new InvalidMigrationsException("The initialization file was not provided. Please provide it.");
		}
		return migrations;
	}

	public MigrationFile transformMigrationFileToMigration(InputStream migrationFile) {
		try {
			List lines = readLinesForFile(migrationFile);
			List configurationLines = extractConfigurationLines(lines);
			List migrationLines = extractMigrationLines(lines);
			return transformFileContentToMigration(configurationLines, migrationLines);
		} catch (MissingRequiredConfiguration | InvalidDataException missingRequiredConfiguration) {
			String exceptionMessage = "Invalid file for migration";
			LOGGER.error(exceptionMessage, missingRequiredConfiguration);
			throw new InvalidMigrationsException(exceptionMessage, missingRequiredConfiguration);
		} catch (FileNotFoundException e) {
			throw Throwables.propagate(e);
		}
	}

	private List extractMigrationLines(List lines) {
		List migrationLines = Lists.newArrayList();
		boolean startedMigrationLines = false;
		boolean migrationEnded = false;
		for (String line : lines) {
			String trimmedLine = line.trim();
			migrationEnded = trimmedLine.equalsIgnoreCase(CONFIGURATION_OPTION_PREFIX + MIGRATION_END_MARK);
			if (migrationEnded) {
				break;
			}
			if (startedMigrationLines) {
				migrationLines.add(line);
			}
			if (trimmedLine.equalsIgnoreCase(CONFIGURATION_OPTION_PREFIX + MIGRATION_START_MARK)) {
				startedMigrationLines = true;
			}
		}
		if (!startedMigrationLines) {
			throw new MissingRequiredConfiguration("The migration starting flag was not found, no migration configured in file.");
		}
		if (!migrationEnded) {
			throw new MissingRequiredConfiguration("The migration end flag was not found, migration misconfigured in file.");
		}
		return migrationLines;
	}

	private List extractConfigurationLines(List lines) {
		List configurationLines = Lists.newArrayList();
		for (String line : lines) {
			String trimmedLine = line.trim();
			if (trimmedLine.startsWith(CONFIGURATION_OPTION_PREFIX)) {
				String configuration = trimmedLine.replace(CONFIGURATION_OPTION_PREFIX, "");
				if (!configuration.equalsIgnoreCase(MIGRATION_START_MARK) && !configuration.equalsIgnoreCase(MIGRATION_END_MARK)) {
					configurationLines.add(configuration);
				}
			}
		}
		return configurationLines;
	}

	private List readLinesForFile(InputStream migrationFile) throws FileNotFoundException {
		try {
			return IOUtils.readLines(migrationFile);
		} catch (IOException e) {
			String exceptionMessage = "Exception while reading migration file";
			LOGGER.error(exceptionMessage, e);
			throw Throwables.propagate(e);
		} finally {
			IOUtils.closeQuietly(migrationFile);
		}
	}

	private MigrationFile transformFileContentToMigration(List configurationLines, List migrationLines)
			throws MissingRequiredConfiguration {
		for (String configurationLine : configurationLines) {
			if (configurationLine.startsWith(MIGRATION_INIT_KEY  + VALUE_SEPARATOR)) {
				return transformFileContentToInitialization(configurationLines, migrationLines);
			}
		}
		return transformFileContentToNormalMigrationFile(configurationLines, migrationLines);
	}

	private MigrationFile transformFileContentToInitialization(List configurationLines, List migrationLines)
			throws MissingRequiredConfiguration {
		foundInitFile = true;
		InputStream initializationSchema = this.getClass().getClassLoader().getResourceAsStream("migration.cql");
		try {
			List migrationTable = IOUtils.readLines(initializationSchema);
			List migrations = StatementBuilder.buildStatementsFromLines(migrationLines);
			List migrationTableStatements = StatementBuilder.buildStatementsFromLines(migrationTable);
			String keyspace = findValueForKey(configurationLines, KEYSPACE_KEY);
			String description = findValueForKey(configurationLines, DESCRIPTION_KEY);
			String schema = findValueForKey(configurationLines, MIGRATION_INIT_KEY);
			migrationTableStatements.set(0, String.format(migrationTableStatements.get(0), keyspace));
			migrations.addAll(migrationTableStatements);
			return new MigrationFile(schema, -100, description, migrations, keyspace, false);
		} catch (IOException e) {
			String exceptionMessage = "Exception while trying to read the schema for the migration table. The migrations will be aborted.";
			LOGGER.error(exceptionMessage, e);
			throw Throwables.propagate(e);
		}
	}

	private MigrationFile transformFileContentToNormalMigrationFile(List configurationLines, List migrationLines)
			throws MissingRequiredConfiguration {
		List statements = StatementBuilder.buildStatementsFromLines(migrationLines);
		int order = findValueForKey(configurationLines, ORDER_KEY, Integer.class);
		String keyspace = findValueForKey(configurationLines, KEYSPACE_KEY);
		String description = findValueForKey(configurationLines, DESCRIPTION_KEY);
		if (order < 0)
			throw new InvalidDataException("The value " + order + " is not a valid order for the file. This must be a positive integer.");
		return new MigrationFile(order, description, statements, keyspace);
	}

	@SuppressWarnings("unchecked")
	private  T findValueForKey(List configurationLines, String key, Class clazz)
			throws MissingRequiredConfiguration {
		return (T) convert(findValueForKey(configurationLines, key), clazz);
	}

	private String findValueForKey(List configurationLines, String key)
			throws MissingRequiredConfiguration {
		for (String configurationLine : configurationLines) {
			String completeKey = key + VALUE_SEPARATOR;
			if (configurationLine.startsWith(completeKey)) {
				String valueForKey = configurationLine.replace(completeKey, "").trim();
				if (org.apache.commons.lang3.StringUtils.isEmpty(valueForKey)) {
					throw new MissingRequiredConfiguration("The key " + key + " is provided but does not have a value.");
				}
				configurationLines.remove(configurationLine);
				return valueForKey;
			}
		}
		throw new MissingRequiredConfiguration("The key " + key + " is not provided");
	}

}