honeymoose
/
hapi-fhir
mirror of https://github.com/hapifhir/hapi-fhir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added schema migration validation

This commit is contained in:
Ken Stevens 2019-10-31 14:56:55 -04:00
parent 9c9193b401
commit f95e4d387d
8 changed files with 163 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
hapi-fhir-cli/hapi-fhir-cli-api/src/main/java/ca/uhn/fhir/cli/HapiFlywayMigrateDatabaseCommand.java
View File

@ -42,7 +42,8 @@ public class HapiFlywayMigrateDatabaseCommand extends BaseFlywayMigrateDatabaseC
@Override
protected void addTasks(FlywayMigrator theMigrator) {
// FIXME KHS if no shrink columns set, apply null migration with same id
List<BaseTask<?>> tasks = new HapiFhirJpaMigrationTasks(getFlags()).getAllTasks(VersionEnum.values());
tasks.forEach(theMigrator::addTask);
theMigrator.addTasks(tasks);
}
}

13
hapi-fhir-jpaserver-migrate/src/main/java/ca/uhn/fhir/jpa/migrate/DriverTypeEnum.java
View File

@ -66,6 +66,19 @@ public enum DriverTypeEnum {
myDerby = theDerby;
}
public String getDriverClassName() {
return myDriverClassName;
}
public static DriverTypeEnum fromDriverClassName(String theDriverClassName) {
for (DriverTypeEnum driverTypeEnum : DriverTypeEnum.values()) {
if (driverTypeEnum.myDriverClassName.equals(theDriverClassName)) {
return driverTypeEnum;
}
}
return null;
}
public ConnectionProperties newConnectionProperties(String theUrl, String theUsername, String thePassword) {
Driver driver;

27
hapi-fhir-jpaserver-migrate/src/main/java/ca/uhn/fhir/jpa/migrate/FlywayMigrator.java
View File

@ -21,12 +21,14 @@ package ca.uhn.fhir.jpa.migrate;
*/
import ca.uhn.fhir.jpa.migrate.taskdef.BaseTask;
import org.apache.commons.dbcp2.BasicDataSource;
import org.flywaydb.core.Flyway;
import org.flywaydb.core.api.MigrationInfoService;
import org.flywaydb.core.api.migration.JavaMigration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.sql.Driver;
import java.util.ArrayList;
import java.util.List;
@ -42,6 +44,23 @@ public class FlywayMigrator {
private boolean myDryRun;
private boolean myNoColumnShrink;
public FlywayMigrator() {}
public FlywayMigrator(BasicDataSource theDataSource) {
myConnectionUrl = theDataSource.getUrl();
myUsername = theDataSource.getUsername();
myPassword = theDataSource.getPassword();
String driverClassName = theDataSource.getDriverClassName();
if (driverClassName == null) {
ourLog.error(this.getClass().getSimpleName() + " constructed without a database driver");
} else {
myDriverType = DriverTypeEnum.fromDriverClassName(driverClassName);
if (myDriverType == null) {
ourLog.error("Unknown driver class " + driverClassName);
}
}
}
public void setDriverType(DriverTypeEnum theDriverType) {
myDriverType = theDriverType;
}
@ -117,11 +136,13 @@ public class FlywayMigrator {
return myNoColumnShrink;
}
public boolean migrationRequired() {
public MigrationInfoService getMigrationInfo() {
if (myDriverType == null) {
return null;
}
try (DriverTypeEnum.ConnectionProperties connectionProperties = myDriverType.newConnectionProperties(myConnectionUrl, myUsername, myPassword)) {
Flyway flyway = initFlyway(connectionProperties);
MigrationInfoService info = flyway.info();
return info.pending().length > 0;
return flyway.info();
}
}
}

58
hapi-fhir-jpaserver-migrate/src/main/java/ca/uhn/fhir/jpa/migrate/MigrationValidator.java Normal file
View File

@ -0,0 +1,58 @@
package ca.uhn.fhir.jpa.migrate;
import ca.uhn.fhir.context.ConfigurationException;
import ca.uhn.fhir.jpa.migrate.taskdef.BaseTask;
import ca.uhn.fhir.jpa.subscription.module.subscriber.websocket.WebsocketConnectionValidator;
import org.apache.commons.dbcp2.BasicDataSource;
import org.flywaydb.core.api.MigrationInfo;
import org.flywaydb.core.api.MigrationInfoService;
import org.flywaydb.core.api.MigrationVersion;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.List;
public class MigrationValidator {
private static final Logger ourLog = LoggerFactory.getLogger(WebsocketConnectionValidator.class);
private final BasicDataSource myDataSource;
private final FlywayMigrator myMigrator;
public MigrationValidator(BasicDataSource theDataSource, List<BaseTask<?>> theMigrationTasks) {
myDataSource = theDataSource;
myMigrator = new FlywayMigrator(theDataSource);
myMigrator.addTasks(theMigrationTasks);
}
public void validate() {
try (Connection connection = myDataSource.getConnection()) {
MigrationInfoService migrationInfo = myMigrator.getMigrationInfo();
if (migrationInfo.pending().length > 0) {
throw new ConfigurationException("The database schema for " + connection.getCatalog() + " is out of date. " +
"Current database schema version is " + getCurrentVersion(migrationInfo) + ". Schema version required by application is " +
getLastVersion(migrationInfo) + ". Please run the database migrator.");
}
ourLog.info("Database schema confirmed at expected version " + getCurrentVersion(migrationInfo));
} catch (SQLException e) {
throw new ConfigurationException("Unable to connect to " + myDataSource.toString(), e);
}
}
private String getCurrentVersion(MigrationInfoService theMigrationInfo) {
MigrationInfo migrationInfo = theMigrationInfo.current();
if (migrationInfo == null) {
return "unknown";
}
return migrationInfo.getVersion().toString();
}
private String getLastVersion(MigrationInfoService theMigrationInfo) {
MigrationInfo[] pending = theMigrationInfo.pending();
if (pending.length > 0) {
return pending[pending.length - 1].getVersion().toString();
}
return "unknown";
}
}

32
hapi-fhir-jpaserver-migrate/src/test/java/ca/uhn/fhir/jpa/migrate/MigrationValidatorTest.java Normal file
View File

@ -0,0 +1,32 @@
package ca.uhn.fhir.jpa.migrate;
import ca.uhn.fhir.context.ConfigurationException;
import ca.uhn.fhir.jpa.migrate.taskdef.AddTableRawSqlTask;
import ca.uhn.fhir.jpa.migrate.taskdef.BaseTest;
import org.junit.Before;
import org.junit.Test;
import java.util.Collections;
import static org.junit.Assert.*;
public class MigrationValidatorTest extends BaseTest {
@Test
public void migrationRequired() {
AddTableRawSqlTask task = new AddTableRawSqlTask("1", "1");
task.setTableName("SOMETABLE");
task.addSql(DriverTypeEnum.H2_EMBEDDED, "create table SOMETABLE (PID bigint not null, TEXTCOL varchar(255))");
getMigrator().addTask(task);
MigrationValidator migrationValidator = new MigrationValidator(getDataSource(), Collections.singletonList(task));
try {
migrationValidator.validate();
fail();
} catch (ConfigurationException e) {
assertEquals("The database schema for " + getDatabaseName() + " is out of date. Current database schema version is unknown. Schema version required by application is " + task.getFlywayVersion() + ". Please run the database migrator.", e.getMessage());
}
getMigrator().migrate();
migrationValidator.validate();
}
}

8
hapi-fhir-jpaserver-migrate/src/test/java/ca/uhn/fhir/jpa/migrate/taskdef/AddIdGeneratorTaskTest.java
View File

@ -19,15 +19,15 @@ public class AddIdGeneratorTaskTest extends BaseTest {
public void testAddIdGenerator() throws SQLException {
assertThat(JdbcUtils.getSequenceNames(getConnectionProperties()), empty());
MyMigrationTasks migrator = new MyMigrationTasks("123456.7");
getMigrator().addTasks(migrator.getTasks(VersionEnum.V3_3_0, VersionEnum.V3_6_0));
MyMigrationTasks migrationTasks = new MyMigrationTasks("123456.7");
getMigrator().addTasks(migrationTasks.getTasks(VersionEnum.V3_3_0, VersionEnum.V3_6_0));
getMigrator().migrate();
assertThat(JdbcUtils.getSequenceNames(getConnectionProperties()), containsInAnyOrder("SEQ_FOO"));
// Second time, should produce no action
migrator = new MyMigrationTasks("123456.8");
getMigrator().addTasks(migrator.getTasks(VersionEnum.V3_3_0, VersionEnum.V3_6_0));
migrationTasks = new MyMigrationTasks("123456.8");
getMigrator().addTasks(migrationTasks.getTasks(VersionEnum.V3_3_0, VersionEnum.V3_6_0));
getMigrator().migrate();
assertThat(JdbcUtils.getSequenceNames(getConnectionProperties()), containsInAnyOrder("SEQ_FOO"));

39
hapi-fhir-jpaserver-migrate/src/test/java/ca/uhn/fhir/jpa/migrate/taskdef/BaseTest.java
View File

@ -3,6 +3,7 @@ package ca.uhn.fhir.jpa.migrate.taskdef;
import ca.uhn.fhir.jpa.migrate.DriverTypeEnum;
import ca.uhn.fhir.jpa.migrate.FlywayMigrator;
import ca.uhn.fhir.jpa.migrate.Migrator;
import org.apache.commons.dbcp2.BasicDataSource;
import org.intellij.lang.annotations.Language;
import org.junit.After;
import org.junit.Before;
@ -13,10 +14,12 @@ import java.util.Map;
public class BaseTest {
private static final String DATABASE_NAME = "DATABASE";
private static int ourDatabaseUrl = 0;
private String myUrl;
private FlywayMigrator myMigrator;
private DriverTypeEnum.ConnectionProperties myConnectionProperties;
private final BasicDataSource myDataSource = new BasicDataSource();
public String getUrl() {
return myUrl;
@ -26,6 +29,28 @@ public class BaseTest {
return myConnectionProperties;
}
@Before()
public void before() {
org.h2.Driver.class.toString();
++ourDatabaseUrl;
myUrl = "jdbc:h2:mem:" + getDatabaseName();
myConnectionProperties = DriverTypeEnum.H2_EMBEDDED.newConnectionProperties(myUrl, "SA", "SA");
myDataSource.setUrl(myUrl);
myDataSource.setUsername("SA");
myDataSource.setPassword("SA");
myDataSource.setDriverClassName(DriverTypeEnum.H2_EMBEDDED.getDriverClassName());
myMigrator = new FlywayMigrator(myDataSource);
}
protected String getDatabaseName() {
return DATABASE_NAME + ourDatabaseUrl;
}
protected BasicDataSource getDataSource() {
return myDataSource;
}
@After
public void resetMigrationVersion() {
executeSql("DELETE from \"flyway_schema_history\" where \"installed_rank\" > 0");
@ -53,19 +78,5 @@ public class BaseTest {
myConnectionProperties.close();
}
@Before()
public void before() {
org.h2.Driver.class.toString();
myUrl = "jdbc:h2:mem:database" + (ourDatabaseUrl++);
myConnectionProperties = DriverTypeEnum.H2_EMBEDDED.newConnectionProperties(myUrl, "SA", "SA");
myMigrator = new FlywayMigrator();
myMigrator.setConnectionUrl(myUrl);
myMigrator.setDriverType(DriverTypeEnum.H2_EMBEDDED);
myMigrator.setUsername("SA");
myMigrator.setPassword("SA");
}
}

9
hapi-fhir-jpaserver-migrate/src/test/java/ca/uhn/fhir/jpa/migrate/taskdef/DropTableTest.java
View File

@ -4,8 +4,9 @@ import ca.uhn.fhir.jpa.migrate.JdbcUtils;
import org.junit.Test;
import java.sql.SQLException;
import java.util.Collections;
import static org.hamcrest.Matchers.hasItems;
import static org.hamcrest.Matchers.*;
import static org.hamcrest.core.IsNot.not;
import static org.junit.Assert.*;
@ -58,7 +59,7 @@ public class DropTableTest extends BaseTest {
}
@Test
public void testFlywayMigrationRequired() throws SQLException {
public void testFlywayGetMigrationInfo() throws SQLException {
executeSql("create table SOMETABLE (PID bigint not null, TEXTCOL varchar(255))");
DropTableTask task = new DropTableTask("1", "1");
@ -67,9 +68,9 @@ public class DropTableTest extends BaseTest {
assertThat(JdbcUtils.getTableNames(getConnectionProperties()), (hasItems("SOMETABLE")));
assertTrue(getMigrator().migrationRequired());
assertThat(getMigrator().getMigrationInfo().pending().length, greaterThan(0));
getMigrator().migrate();
assertFalse(getMigrator().migrationRequired());
assertThat(getMigrator().getMigrationInfo().pending().length, equalTo(0));
assertThat(JdbcUtils.getTableNames(getConnectionProperties()), not(hasItems("SOMETABLE")));
}