Merge pull request #26456 from kedar-joshi

* pr/26456: Polish "Upgrade to Flyway 7.9.2" Upgrade to Flyway 7.9.2 Closes gh-26456
spring-projects · Jun 14, 2021 · a72da74 · a72da74
2 parents 5985234 + 05acfaa
commit a72da74
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 1 deletion.
diff --git a/.../src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration.java b/.../src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration.java
@@ -175,6 +175,7 @@ private void configureProperties(FluentConfiguration configuration, FlywayProper
 			PropertyMapper map = PropertyMapper.get().alwaysApplyingWhenNonNull();
 			String[] locations = new LocationResolver(configuration.getDataSource())
 					.resolveLocations(properties.getLocations()).toArray(new String[0]);
+			configureFailOnMissingLocations(configuration, properties.isFailOnMissingLocations());
 			map.from(locations).to(configuration::locations);
 			map.from(properties.getEncoding()).to(configuration::encoding);
 			map.from(properties.getConnectRetries()).to(configuration::connectRetries);
@@ -252,6 +253,23 @@ private void configureProperties(FluentConfiguration configuration, FlywayProper
 			map.from(properties.getVaultToken()).to((vaultToken) -> configuration.vaultToken(vaultToken));
 			map.from(properties.getVaultSecrets()).whenNot(List::isEmpty)
 					.to((vaultSecrets) -> configuration.vaultSecrets(vaultSecrets.toArray(new String[0])));
+			// No method reference for compatibility with Flyway < 7.8
+			map.from(properties.getIgnoreMigrationPatterns()).whenNot(List::isEmpty)
+					.to((ignoreMigrationPatterns) -> configuration
+							.ignoreMigrationPatterns(ignoreMigrationPatterns.toArray(new String[0])));
+			// No method reference for compatibility with Flyway version < 7.9
+			map.from(properties.getDetectEncoding())
+					.to((detectEncoding) -> configuration.detectEncoding(detectEncoding));
+		}
+
+		private void configureFailOnMissingLocations(FluentConfiguration configuration,
+				boolean failOnMissingLocations) {
+			try {
+				configuration.failOnMissingLocations(failOnMissingLocations);
+			}
+			catch (NoSuchMethodError ex) {
+				// Flyway < 7.9
+			}
 		}
 
 		private void configureCreateSchemas(FluentConfiguration configuration, boolean createSchemas) {

diff --git a/...nfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java b/...nfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java
@@ -52,6 +52,11 @@ public class FlywayProperties {
 	@Deprecated
 	private boolean checkLocation = true;
 
+	/**
+	 * Whether to fail if a location of migration scripts doesn't exist.
+	 */
+	private boolean failOnMissingLocations;
+
 	/**
 	 * Locations of migrations scripts. Can contain the special "{vendor}" placeholder to
 	 * use vendor-specific locations.
@@ -355,6 +360,18 @@ public class FlywayProperties {
 	 */
 	private List<String> vaultSecrets;
 
+	/**
+	 * Ignore migrations that match this comma-separated list of patterns when validating
+	 * migrations. Requires Flyway Teams.
+	 */
+	private List<String> ignoreMigrationPatterns;
+
+	/**
+	 * Whether to attempt to automatically detect SQL migration file encoding. Requires
+	 * Flyway Teams.
+	 */
+	private Boolean detectEncoding;
+
 	public boolean isEnabled() {
 		return this.enabled;
 	}
@@ -375,6 +392,14 @@ public void setCheckLocation(boolean checkLocation) {
 		this.checkLocation = checkLocation;
 	}
 
+	public boolean isFailOnMissingLocations() {
+		return this.failOnMissingLocations;
+	}
+
+	public void setFailOnMissingLocations(boolean failOnMissingLocations) {
+		this.failOnMissingLocations = failOnMissingLocations;
+	}
+
 	public List<String> getLocations() {
 		return this.locations;
 	}
@@ -842,4 +867,20 @@ public void setVaultSecrets(List<String> vaultSecrets) {
 		this.vaultSecrets = vaultSecrets;
 	}
 
+	public List<String> getIgnoreMigrationPatterns() {
+		return this.ignoreMigrationPatterns;
+	}
+
+	public void setIgnoreMigrationPatterns(List<String> ignoreMigrationPatterns) {
+		this.ignoreMigrationPatterns = ignoreMigrationPatterns;
+	}
+
+	public Boolean getDetectEncoding() {
+		return this.detectEncoding;
+	}
+
+	public void setDetectEncoding(final Boolean detectEncoding) {
+		this.detectEncoding = detectEncoding;
+	}
+
 }
diff --git a/...test/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfigurationTests.java b/...test/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfigurationTests.java
@@ -288,6 +288,7 @@ void changeLogDoesNotExist() {
 	}
 
 	@Test
+	@Deprecated
 	void checkLocationsAllMissing() {
 		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
 				.withPropertyValues("spring.flyway.locations:classpath:db/missing1,classpath:db/migration2")
@@ -299,26 +300,69 @@ void checkLocationsAllMissing() {
 	}
 
 	@Test
+	@Deprecated
 	void checkLocationsAllExist() {
 		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
 				.withPropertyValues("spring.flyway.locations:classpath:db/changelog,classpath:db/migration")
 				.run((context) -> assertThat(context).hasNotFailed());
 	}
 
 	@Test
+	@Deprecated
 	void checkLocationsAllExistWithImplicitClasspathPrefix() {
 		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
 				.withPropertyValues("spring.flyway.locations:db/changelog,db/migration")
 				.run((context) -> assertThat(context).hasNotFailed());
 	}
 
 	@Test
+	@Deprecated
 	void checkLocationsAllExistWithFilesystemPrefix() {
 		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
 				.withPropertyValues("spring.flyway.locations:filesystem:src/test/resources/db/migration")
 				.run((context) -> assertThat(context).hasNotFailed());
 	}
 
+	@Test
+	void failOnMissingLocationsAllMissing() {
+		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
+				.withPropertyValues("spring.flyway.check-location=false",
+						"spring.flyway.fail-on-missing-locations=true")
+				.withPropertyValues("spring.flyway.locations:classpath:db/missing1,classpath:db/migration2")
+				.run((context) -> {
+					assertThat(context).hasFailed();
+					assertThat(context).getFailure().isInstanceOf(BeanCreationException.class);
+					assertThat(context).getFailure().hasMessageContaining("Unable to resolve location");
+				});
+	}
+
+	@Test
+	void failOnMissingLocationsAllExist() {
+		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
+				.withPropertyValues("spring.flyway.check-location=false",
+						"spring.flyway.fail-on-missing-locations=true")
+				.withPropertyValues("spring.flyway.locations:classpath:db/changelog,classpath:db/migration")
+				.run((context) -> assertThat(context).hasNotFailed());
+	}
+
+	@Test
+	void failOnMissingLocationsAllExistWithImplicitClasspathPrefix() {
+		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
+				.withPropertyValues("spring.flyway.check-location=false",
+						"spring.flyway.fail-on-missing-locations=true")
+				.withPropertyValues("spring.flyway.locations:db/changelog,db/migration")
+				.run((context) -> assertThat(context).hasNotFailed());
+	}
+
+	@Test
+	void failOnMissingLocationsAllExistWithFilesystemPrefix() {
+		this.contextRunner.withUserConfiguration(EmbeddedDataSourceConfiguration.class)
+				.withPropertyValues("spring.flyway.check-location=false",
+						"spring.flyway.fail-on-missing-locations=true")
+				.withPropertyValues("spring.flyway.locations:filesystem:src/test/resources/db/migration")
+				.run((context) -> assertThat(context).hasNotFailed());
+	}
+
 	@Test
 	void customFlywayMigrationStrategy() {
 		this.contextRunner

diff --git a/...re/src/test/java/org/springframework/boot/autoconfigure/flyway/FlywayPropertiesTests.java b/...re/src/test/java/org/springframework/boot/autoconfigure/flyway/FlywayPropertiesTests.java
@@ -48,6 +48,7 @@ class FlywayPropertiesTests {
 	void defaultValuesAreConsistent() {
 		FlywayProperties properties = new FlywayProperties();
 		Configuration configuration = new FluentConfiguration();
+		assertThat(configuration.getFailOnMissingLocations()).isEqualTo(properties.isFailOnMissingLocations());
 		assertThat(properties.getLocations().stream().map(Location::new).toArray(Location[]::new))
 				.isEqualTo(configuration.getLocations());
 		assertThat(properties.getEncoding()).isEqualTo(configuration.getEncoding());
@@ -91,6 +92,7 @@ void defaultValuesAreConsistent() {
 		assertThat(configuration.isSkipDefaultResolvers()).isEqualTo(properties.isSkipDefaultResolvers());
 		assertThat(configuration.isValidateMigrationNaming()).isEqualTo(properties.isValidateMigrationNaming());
 		assertThat(configuration.isValidateOnMigrate()).isEqualTo(properties.isValidateOnMigrate());
+		assertThat(properties.getDetectEncoding()).isNull();
 	}
 
 	@Test
@@ -119,6 +121,8 @@ void expectedPropertiesAreManaged() {
 		ignoreProperties(configuration, "shouldCreateSchemas");
 		// Getters for the DataSource settings rather than actual properties
 		ignoreProperties(configuration, "password", "url", "user");
+		// Properties not exposed by Flyway
+		ignoreProperties(configuration, "failOnMissingTarget");
 		List<String> configurationKeys = new ArrayList<>(configuration.keySet());
 		Collections.sort(configurationKeys);
 		List<String> propertiesKeys = new ArrayList<>(properties.keySet());

diff --git a/spring-boot-project/spring-boot-dependencies/build.gradle b/spring-boot-project/spring-boot-dependencies/build.gradle
@@ -306,7 +306,7 @@ bom {
 			]
 		}
 	}
-	library("Flyway", "7.7.3") {
+	library("Flyway", "7.9.2") {
 		group("org.flywaydb") {
 			modules = [
 				"flyway-core"