PropertiesMigrationListener wrongly reports property as deprecated

[martinvisser]

With the following configuration:

spring:
  kafka:
    producer:
      client-id: some-id
      ssl:
        key-password: secret
        key-store-location: classpath:keystore.jks # line 18
        key-store-password: secret
        trust-store-location: classpath:truststore.jks
        trust-store-password: secret

I get the following message:

[WARN] org.springframework.boot.context.properties.migrator.PropertiesMigrationListener - 
The use of configuration keys that have been renamed was found in the environment:

Property source 'migrate-Config resource 'class path resource [application-integration.yml]' via location 'optional:classpath:/'':
	Key: spring.kafka.producer.ssl.keystore-location
		Line: 18
		Replacement: spring.kafka.producer.ssl.key-store-location
	Key: spring.kafka.producer.ssl.keystore-password
		Line: 19
		Replacement: spring.kafka.producer.ssl.key-store-password
	Key: spring.kafka.producer.ssl.truststore-location
		Line: 20
		Replacement: spring.kafka.producer.ssl.trust-store-location
	Key: spring.kafka.producer.ssl.truststore-password
		Line: 21
		Replacement: spring.kafka.producer.ssl.trust-store-password

Property source 'Config resource 'class path resource [application-integration.yml]' via location 'optional:classpath:/'':
	Key: spring.kafka.producer.ssl.keystore-location
		Line: 18
		Replacement: spring.kafka.producer.ssl.key-store-location
	Key: spring.kafka.producer.ssl.keystore-password
		Line: 19
		Replacement: spring.kafka.producer.ssl.key-store-password
	Key: spring.kafka.producer.ssl.truststore-location
		Line: 20
		Replacement: spring.kafka.producer.ssl.trust-store-location
	Key: spring.kafka.producer.ssl.truststore-password
		Line: 21
		Replacement: spring.kafka.producer.ssl.trust-store-password


Each configuration key has been temporarily mapped to its replacement for your convenience. To silence this warning, please update your configuration to use the new keys.

But I already changed them to the new one. It's just a warning, but it seems to be incorrect. Also interesting it shows it twice with different property source names.

[mhalbritter]

This indeed looks like a bug. The org.springframework.boot.context.properties.migrator.PropertiesMigrationReporter#getMatchingProperties returns it as deprecated properties, because this line:

ConfigurationProperty match = propertySource.getConfigurationProperty(metadataName);

returns a non-null match when invoked with e.g. "spring.kafka.producer.ssl.keystore-location". I assume this is because of the relaxed mapping support in SpringIterableConfigurationPropertySource and "keystore" and "key-store" map to the same relaxed value.

However, I can't reproduce that you get those messages two times. Could you maybe provide a small sample which reproduces this double printing issue?

[martinvisser]

I see you added 2.7.x milestone, but forgot to mention this (also) happened using Spring Boot 3.1.0

[mhalbritter]

I suspect the underlying cause is in Boot 2.7.x too. When we fix that bug there, we forward merge to 3.0.x and 3.1.x.