root
/
spring-boot
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Merge pull request #31723 from vpavic

Browse Source 
* gh-31723:
  Polish "Upgrade to Flyway 9.0.1"
  Upgrade to Flyway 9.0.1

Closes gh-31723
pull/31828/head
Andy Wilkinson 2 years ago
parent 785588826e 4bd82bb5af
commit 1aadc2abc9
10 changed files with 77 additions and 180 deletions
Show Stats Download Patch File Download Diff File

9
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/FlywayEndpointDocumentationTests.java
Unescape Escape View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -22,7 +22,6 @@ import java.util.List;
import javax.sql.DataSource;
import org.flywaydb.core.api.MigrationState;
import org.flywaydb.core.api.MigrationType;
import org.junit.jupiter.api.Test;
import org.springframework.boot.actuate.flyway.FlywayEndpoint;
@ -77,10 +76,8 @@ class FlywayEndpointDocumentationTests extends MockMvcEndpointDocumentationTests
.optional(),
fieldWithPath("state")
.description("State of the migration. (" + describeEnumValues(MigrationState.class) + ")"),
fieldWithPath("type")
.description("Type of the migration. (" + describeEnumValues(MigrationType.class) + ")"),
fieldWithPath("version").description("Version of the database after applying the migration, if any.")
.optional());
fieldWithPath("type").description("Type of the migration."), fieldWithPath("version")
.description("Version of the database after applying the migration, if any.").optional());
}
@Configuration(proxyBeanMethods = false)

9
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/flyway/FlywayEndpoint.java
Unescape Escape View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -27,7 +27,6 @@ import java.util.stream.Stream;
import org.flywaydb.core.Flyway;
import org.flywaydb.core.api.MigrationInfo;
import org.flywaydb.core.api.MigrationState;
import org.flywaydb.core.api.MigrationType;
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
@ -136,7 +135,7 @@ public class FlywayEndpoint {
*/
public static final class FlywayMigration {
private final MigrationType type;
private final String type;
private final Integer checksum;
@ -157,7 +156,7 @@ public class FlywayEndpoint {
private final Integer executionTime;
private FlywayMigration(MigrationInfo info) {
this.type = info.getType();
this.type = info.getType().name();
this.checksum = info.getChecksum();
this.version = nullSafeToString(info.getVersion());
this.description = info.getDescription();
@ -177,7 +176,7 @@ public class FlywayEndpoint {
return (date != null) ? Instant.ofEpochMilli(date.getTime()) : null;
}
public MigrationType getType() {
public String getType() {
return this.type;
}

4
spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/flyway/FlywayEndpointTests.java
Unescape Escape View File

@ -1,5 +1,5 @@
/*
* Copyright 2012-2019 the original author or authors.
* Copyright 2012-2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -62,7 +62,7 @@ class FlywayEndpointTests {
Map<String, FlywayDescriptor> flywayBeans = context.getBean(FlywayEndpoint.class).flywayBeans()
.getContexts().get(context.getId()).getFlywayBeans();
assertThat(flywayBeans).hasSize(1);
assertThat(flywayBeans.values().iterator().next().getMigrations()).hasSize(3);
assertThat(flywayBeans.values().iterator().next().getMigrations()).hasSize(4);
});
}

23
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration.java
Unescape Escape View File

@ -32,7 +32,6 @@ import org.flywaydb.core.api.MigrationVersion;
import org.flywaydb.core.api.callback.Callback;
import org.flywaydb.core.api.configuration.FluentConfiguration;
import org.flywaydb.core.api.migration.JavaMigration;
import org.flywaydb.core.internal.plugin.PluginRegister;
import org.flywaydb.database.sqlserver.SQLServerConfigurationExtension;
import org.springframework.beans.factory.ObjectProvider;
@ -202,7 +201,6 @@ public class FlywayAutoConfiguration {
map.from(properties.isCleanDisabled()).to(configuration::cleanDisabled);
map.from(properties.isCleanOnValidationError()).to(configuration::cleanOnValidationError);
map.from(properties.isGroup()).to(configuration::group);
configureIgnoredMigrations(configuration, properties, map);
map.from(properties.isMixed()).to(configuration::mixed);
map.from(properties.isOutOfOrder()).to(configuration::outOfOrder);
map.from(properties.isSkipDefaultCallbacks()).to(configuration::skipDefaultCallbacks);
@ -242,7 +240,8 @@ public class FlywayAutoConfiguration {
map.from(properties.getOutputQueryResults())
.to((outputQueryResults) -> configuration.outputQueryResults(outputQueryResults));
map.from(properties.getSqlServerKerberosLoginFile()).whenNonNull()
.to(this::configureSqlServerKerberosLoginFile);
.to((sqlServerKerberosLoginFile) -> configureSqlServerKerberosLoginFile(configuration,
sqlServerKerberosLoginFile));
// No method reference for compatibility with Flyway 6.x
map.from(properties.getSkipExecutingMigrations())
.to((skipExecutingMigrations) -> configuration.skipExecutingMigrations(skipExecutingMigrations));
@ -253,18 +252,6 @@ public class FlywayAutoConfiguration {
// No method reference for compatibility with Flyway version < 7.9
map.from(properties.getDetectEncoding())
.to((detectEncoding) -> configuration.detectEncoding(detectEncoding));
// No method reference for compatibility with Flyway version < 8.0
map.from(properties.getBaselineMigrationPrefix())
.to((baselineMigrationPrefix) -> configuration.baselineMigrationPrefix(baselineMigrationPrefix));
}
@SuppressWarnings("deprecation")
private void configureIgnoredMigrations(FluentConfiguration configuration, FlywayProperties properties,
PropertyMapper map) {
map.from(properties.isIgnoreMissingMigrations()).to(configuration::ignoreMissingMigrations);
map.from(properties.isIgnoreIgnoredMigrations()).to(configuration::ignoreIgnoredMigrations);
map.from(properties.isIgnorePendingMigrations()).to(configuration::ignorePendingMigrations);
map.from(properties.isIgnoreFutureMigrations()).to(configuration::ignoreFutureMigrations);
}
private void configureFailOnMissingLocations(FluentConfiguration configuration,
@ -286,9 +273,11 @@ public class FlywayAutoConfiguration {
}
}
private void configureSqlServerKerberosLoginFile(String sqlServerKerberosLoginFile) {
SQLServerConfigurationExtension sqlServerConfigurationExtension = PluginRegister
private void configureSqlServerKerberosLoginFile(FluentConfiguration configuration,
String sqlServerKerberosLoginFile) {
SQLServerConfigurationExtension sqlServerConfigurationExtension = configuration.getPluginRegister()
.getPlugin(SQLServerConfigurationExtension.class);
Assert.state(sqlServerConfigurationExtension != null, "Flyway SQL Server extension missing");
sqlServerConfigurationExtension.setKerberosLoginFile(sqlServerKerberosLoginFile);
}

95
spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java
Unescape Escape View File

@ -28,7 +28,6 @@ import java.util.List;
import java.util.Map;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
import org.springframework.boot.convert.DurationUnit;
/**
@ -209,7 +208,7 @@ public class FlywayProperties {
/**
* Whether to disable cleaning of the database.
*/
private boolean cleanDisabled;
private boolean cleanDisabled = true;
/**
* Whether to automatically call clean when a validation error occurs.
@ -222,30 +221,6 @@ public class FlywayProperties {
*/
private boolean group;
/**
* Whether to ignore missing migrations when reading the schema history table.
*/
@Deprecated
private boolean ignoreMissingMigrations;
/**
* Whether to ignore ignored migrations when reading the schema history table.
*/
@Deprecated
private boolean ignoreIgnoredMigrations;
/**
* Whether to ignore pending migrations when reading the schema history table.
*/
@Deprecated
private boolean ignorePendingMigrations;
/**
* Whether to ignore future migrations when reading the schema history table.
*/
@Deprecated
private boolean ignoreFutureMigrations = true;
/**
* Whether to allow mixing transactional and non-transactional statements within the
* same migration.
@ -377,11 +352,6 @@ public class FlywayProperties {
*/
private Boolean detectEncoding;
/**
* Filename prefix for baseline migrations. Requires Flyway Teams.
*/
private String baselineMigrationPrefix;
/**
* Prefix of placeholders in migration scripts.
*/
@ -664,50 +634,6 @@ public class FlywayProperties {
this.group = group;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = "spring.flyway.ignore-migration-patterns")
public boolean isIgnoreMissingMigrations() {
return this.ignoreMissingMigrations;
}
@Deprecated
public void setIgnoreMissingMigrations(boolean ignoreMissingMigrations) {
this.ignoreMissingMigrations = ignoreMissingMigrations;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = "spring.flyway.ignore-migration-patterns")
public boolean isIgnoreIgnoredMigrations() {
return this.ignoreIgnoredMigrations;
}
@Deprecated
public void setIgnoreIgnoredMigrations(boolean ignoreIgnoredMigrations) {
this.ignoreIgnoredMigrations = ignoreIgnoredMigrations;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = "spring.flyway.ignore-migration-patterns")
public boolean isIgnorePendingMigrations() {
return this.ignorePendingMigrations;
}
@Deprecated
public void setIgnorePendingMigrations(boolean ignorePendingMigrations) {
this.ignorePendingMigrations = ignorePendingMigrations;
}
@Deprecated
@DeprecatedConfigurationProperty(replacement = "spring.flyway.ignore-migration-patterns")
public boolean isIgnoreFutureMigrations() {
return this.ignoreFutureMigrations;
}
@Deprecated
public void setIgnoreFutureMigrations(boolean ignoreFutureMigrations) {
this.ignoreFutureMigrations = ignoreFutureMigrations;
}
public boolean isMixed() {
return this.mixed;
}
@ -860,17 +786,6 @@ public class FlywayProperties {
this.oracleKerberosCacheFile = oracleKerberosCacheFile;
}
@DeprecatedConfigurationProperty(replacement = "spring.flyway.kerberos-config-file")
@Deprecated
public String getOracleKerberosConfigFile() {
return getKerberosConfigFile();
}
@Deprecated
public void setOracleKerberosConfigFile(String oracleKerberosConfigFile) {
setKerberosConfigFile(oracleKerberosConfigFile);
}
public Boolean getOutputQueryResults() {
return this.outputQueryResults;
}
@ -911,14 +826,6 @@ public class FlywayProperties {
this.detectEncoding = detectEncoding;
}
public String getBaselineMigrationPrefix() {
return this.baselineMigrationPrefix;
}
public void setBaselineMigrationPrefix(String baselineMigrationPrefix) {
this.baselineMigrationPrefix = baselineMigrationPrefix;
}
public String getScriptPlaceholderPrefix() {
return this.scriptPlaceholderPrefix;
}

55
spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
Unescape Escape View File

@ -992,7 +992,12 @@
},
{
"name": "spring.flyway.baseline-migration-prefix",
"defaultValue": "B"
"defaultValue": "B",
"description": "Filename prefix for baseline migrations. Requires Flyway Teams.",
"deprecation": {
"level": "error",
"reason": "Removed in Flyway 9.0"
}
},
{
"name": "spring.flyway.check-location",
@ -1022,6 +1027,46 @@
"reason": "Flyway pro edition only."
}
},
{
"name": "spring.flyway.ignore-future-migrations",
"type": "java.lang.Boolean",
"description": "Whether to ignore future migrations when reading the schema history table.",
"deprecation": {
"level": "error",
"reason": "Removed in Flyway 9.0",
"replacement": "spring.flyway.ignore-migration-patterns"
}
},
{
"name": "spring.flyway.ignore-ignored-migrations",
"type": "java.lang.Boolean",
"description": "Whether to ignore ignored migrations when reading the schema history table.",
"deprecation": {
"level": "error",
"reason": "Removed in Flyway 9.0",
"replacement": "spring.flyway.ignore-migration-patterns"
}
},
{
"name": "spring.flyway.ignore-missing-migrations",
"type": "java.lang.Boolean",
"description": "Whether to ignore missing migrations when reading the schema history table.",
"deprecation": {
"level": "error",
"reason": "Removed in Flyway 9.0",
"replacement": "spring.flyway.ignore-migration-patterns"
}
},
{
"name": "spring.flyway.ignore-pending-migrations",
"type": "java.lang.Boolean",
"description": "Whether to ignore pending migrations when reading the schema history table.",
"deprecation": {
"level": "error",
"reason": "Removed in Flyway 9.0",
"replacement": "spring.flyway.ignore-migration-patterns"
}
},
{
"name": "spring.flyway.locations",
"sourceType": "org.springframework.boot.autoconfigure.flyway.FlywayProperties",
@ -1033,6 +1078,14 @@
"name": "spring.flyway.lock-retry-count",
"defaultValue": 50
},
{
"name": "spring.flyway.oracle-kerberos-config-file",
"type": "java.lang.String",
"deprecation": {
"replacement": "spring.flyway.kerberos-config-file",
"level": "error"
}
},
{
"name": "spring.flyway.placeholder-separator",
"defaultValue": ":"

10
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/flyway/Flyway5xAutoConfigurationTests.java
Unescape Escape View File

@ -103,11 +103,6 @@ class Flyway5xAutoConfigurationTests {
return 1;
}
@Override
public boolean isUndo() {
return false;
}
@Override
public boolean canExecuteInTransaction() {
return true;
@ -118,11 +113,6 @@ class Flyway5xAutoConfigurationTests {
}
@Override
public boolean isBaselineMigration() {
return false;
}
}
}

43
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfigurationTests.java
Unescape Escape View File

@ -33,8 +33,6 @@ import org.flywaydb.core.api.callback.Context;
import org.flywaydb.core.api.callback.Event;
import org.flywaydb.core.api.migration.JavaMigration;
import org.flywaydb.core.internal.license.FlywayTeamsUpgradeRequiredException;
import org.flywaydb.core.internal.plugin.PluginRegister;
import org.flywaydb.database.sqlserver.SQLServerConfigurationExtension;
import org.hibernate.engine.transaction.jta.platform.internal.NoJtaPlatform;
import org.jooq.DSLContext;
import org.jooq.SQLDialect;
@ -493,8 +491,8 @@ class FlywayAutoConfigurationTests {
void licenseKeyIsCorrectlyMapped(CapturedOutput output) {
this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
.withPropertyValues("spring.flyway.license-key=<<secret>>")
.run((context) -> assertThat(output).contains(
"Flyway Teams Edition upgrade required: licenseKey is not supported by Flyway Community Edition."));
.run((context) -> assertThat(output).contains("License key detected - in order to use Teams or "
+ "Enterprise features, download Flyway Teams Edition & Flyway Enterprise Edition"));
}
@Test
@ -573,14 +571,6 @@ class FlywayAutoConfigurationTests {
.run(validateFlywayTeamsPropertyOnly("kerberosConfigFile"));
}
@Test
@Deprecated
void oracleKerberosConfigFileIsCorrectlyMappedToReplacementProperty() {
this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
.withPropertyValues("spring.flyway.oracle-kerberos-config-file=/tmp/config")
.run(validateFlywayTeamsPropertyOnly("kerberosConfigFile"));
}
@Test
void oracleKerberosCacheFileIsCorrectlyMapped() {
this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
@ -597,15 +587,9 @@ class FlywayAutoConfigurationTests {
@Test
void sqlServerKerberosLoginFileIsCorrectlyMapped() {
try {
this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
.withPropertyValues("spring.flyway.sql-server-kerberos-login-file=/tmp/config")
.run(validateFlywayTeamsPropertyOnly("sqlserver.kerberos.login.file"));
}
finally {
// Reset to default value
PluginRegister.getPlugin(SQLServerConfigurationExtension.class).setKerberosLoginFile(null);
}
this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
.withPropertyValues("spring.flyway.sql-server-kerberos-login-file=/tmp/config")
.run(validateFlywayTeamsPropertyOnly("sqlserver.kerberos.login.file"));
}
@Test
@ -643,13 +627,6 @@ class FlywayAutoConfigurationTests {
});
}
@Test
void baselineMigrationPrefixIsCorrectlyMapped() {
this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
.withPropertyValues("spring.flyway.baseline-migration-prefix=BL")
.run(validateFlywayTeamsPropertyOnly("baselineMigrationPrefix"));
}
@Test
void scriptPlaceholderPrefixIsCorrectlyMapped() {
this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
@ -1003,11 +980,6 @@ class FlywayAutoConfigurationTests {
return 1;
}
@Override
public boolean isUndo() {
return false;
}
@Override
public boolean canExecuteInTransaction() {
return true;
@ -1018,11 +990,6 @@ class FlywayAutoConfigurationTests {
}
@Override
public boolean isBaselineMigration() {
return false;
}
}
}

7
spring-boot-project/spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/flyway/FlywayPropertiesTests.java
Unescape Escape View File

@ -44,7 +44,6 @@ import static org.assertj.core.api.Assertions.assertThat;
*/
class FlywayPropertiesTests {
@SuppressWarnings("deprecation")
@Test
void defaultValuesAreConsistent() {
FlywayProperties properties = new FlywayProperties();
@ -86,10 +85,6 @@ class FlywayPropertiesTests {
assertThat(configuration.isCleanDisabled()).isEqualTo(properties.isCleanDisabled());
assertThat(configuration.isCleanOnValidationError()).isEqualTo(properties.isCleanOnValidationError());
assertThat(configuration.isGroup()).isEqualTo(properties.isGroup());
assertThat(configuration.isIgnoreMissingMigrations()).isEqualTo(properties.isIgnoreMissingMigrations());
assertThat(configuration.isIgnoreIgnoredMigrations()).isEqualTo(properties.isIgnoreIgnoredMigrations());
assertThat(configuration.isIgnorePendingMigrations()).isEqualTo(properties.isIgnorePendingMigrations());
assertThat(configuration.isIgnoreFutureMigrations()).isEqualTo(properties.isIgnoreFutureMigrations());
assertThat(configuration.isMixed()).isEqualTo(properties.isMixed());
assertThat(configuration.isOutOfOrder()).isEqualTo(properties.isOutOfOrder());
assertThat(configuration.isSkipDefaultCallbacks()).isEqualTo(properties.isSkipDefaultCallbacks());
@ -113,7 +108,7 @@ class FlywayPropertiesTests {
ignoreProperties(properties, "sqlServerKerberosLoginFile");
// High level object we can't set with properties
ignoreProperties(configuration, "callbacks", "classLoader", "dataSource", "javaMigrations",
"javaMigrationClassProvider", "resourceProvider", "resolvers");
"javaMigrationClassProvider", "pluginRegister", "resourceProvider", "resolvers");
// Properties we don't want to expose
ignoreProperties(configuration, "resolversAsClassNames", "callbacksAsClassNames", "loggers", "driver");
// Handled by the conversion service

2
spring-boot-project/spring-boot-dependencies/build.gradle
Unescape Escape View File

@ -229,7 +229,7 @@ bom {
]
}
}
library("Flyway", "8.5.13") {
library("Flyway", "9.0.1") {
group("org.flywaydb") {
modules = [
"flyway-core",

Write Preview
Loading…
Cancel
Save