@MicronautTest regressions in Micronaut 5

[auloin]

After upgrading from Micronaut <4.x version> to Micronaut <5.0.x>, some existing tests began failing in ways I believe relate to how properties/environments are resolved in Micronaut 5. I couldn't find much prior discussion, so I'm opening this to understand what changed.

1. Properties not available when the shutdown hook is called

In JobRunr we use a startup hook to startup different processes and a shutdown hook to stop them. We use configuration properties to determine what needs to be started or stopped. See https://github.com/jobrunr/jobrunr/blob/reproducer/micronaut-5-regression/framework-support/jobrunr-micronaut-feature/jobrunr-micronaut/src/main/java/org/jobrunr/micronaut/autoconfigure/JobRunrStarter.java.

The issue is that since the upgrade to Micronaut 5, the web server which is started in different test cases is not stopped after being enabled. The flag set by the test is not available to the shutdown hook, but it's available to the startup hook. This seems to only happen in tests.

To reproduce you may start JobRunrFactoryTest: https://github.com/jobrunr/jobrunr/blob/reproducer/micronaut-5-regression/framework-support/jobrunr-micronaut-feature/jobrunr-micronaut/src/test/java/org/jobrunr/micronaut/autoconfigure/JobRunrFactoryTest.java.

(This issue is easy to workaround, we can rely on the Bean's presence instead of the configuration flag)

2. Placeholders not resolvable with @MicronautTest(rebuildContext = true)

When a property value placeholder is included in tests, the following exception is thrown:

Could not resolve placeholder ${recurring-job.cron}
io.micronaut.context.exceptions.ConfigurationException: Could not resolve placeholder ${recurring-job.cron}
	at io.micronaut.context.env.DefaultPropertyPlaceholderResolver$PlaceholderSegment.getValue(DefaultPropertyPlaceholderResolver.java:397)
	at io.micronaut.context.env.DefaultPropertyPlaceholderResolver.resolveRequiredPlaceholdersString(DefaultPropertyPlaceholderResolver.java:129)
	at io.micronaut.context.env.DefaultPropertyPlaceholderResolver.resolveRequiredPlaceholders(DefaultPropertyPlaceholderResolver.java:114)
	at io.micronaut.inject.annotation.AbstractEnvironmentAnnotationMetadata$1.apply(AbstractEnvironmentAnnotationMetadata.java:66)
	at io.micronaut.inject.annotation.DefaultAnnotationMetadata.getRawSingleValue(DefaultAnnotationMetadata.java:1530)
	at io.micronaut.inject.annotation.DefaultAnnotationMetadata.stringValue(DefaultAnnotationMetadata.java:712)
	at io.micronaut.inject.annotation.DefaultAnnotationMetadata.stringValue(DefaultAnnotationMetadata.java:640)
	at io.micronaut.inject.annotation.AnnotationMetadataHierarchy.stringValue(AnnotationMetadataHierarchy.java:859)
	at io.micronaut.inject.annotation.AbstractEnvironmentAnnotationMetadata.stringValue(AbstractEnvironmentAnnotationMetadata.java:190)
	at io.micronaut.inject.annotation.AnnotationMetadataHierarchy.stringValue(AnnotationMetadataHierarchy.java:861)
	at io.micronaut.inject.annotation.AbstractEnvironmentAnnotationMetadata.stringValue(AbstractEnvironmentAnnotationMetadata.java:190)
	at io.micronaut.core.annotation.AnnotationMetadataDelegate.stringValue(AnnotationMetadataDelegate.java:207)
	at org.jobrunr.scheduling.JobRunrRecurringJobScheduler.getCron(JobRunrRecurringJobScheduler.java:66)
	at org.jobrunr.scheduling.JobRunrRecurringJobScheduler.schedule(JobRunrRecurringJobScheduler.java:35)
	at org.jobrunr.micronaut.autoconfigure.RecurringMethodProcessor.process(RecurringMethodProcessor.java:29)
	at io.micronaut.context.DefaultBeanContext.processExecutableMethodsProcessAtStartup(DefaultBeanContext.java:1865)
	at io.micronaut.context.DefaultBeanContext.initializeContext(DefaultBeanContext.java:1822)
	at io.micronaut.context.DefaultBeanContext.configureAndStartContext(DefaultBeanContext.java:3011)
	at io.micronaut.context.DefaultBeanContext.start(DefaultBeanContext.java:330)
	at io.micronaut.context.DefaultApplicationContext.start(DefaultApplicationContext.java:293)
	at io.micronaut.test.extensions.AbstractMicronautExtension.startApplicationContext(AbstractMicronautExtension.java:552)
	at io.micronaut.test.extensions.AbstractMicronautExtension.beforeEach(AbstractMicronautExtension.java:463)
	at io.micronaut.test.extensions.junit5.MicronautJunit5Extension.beforeEach(MicronautJunit5Extension.java:245)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1612)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1612)

My understanding is that when the test class is instantiated, the placeholder is resolved. But the above exception is thrown for each test case. I believe this to be related to the context being rebuilt. Once the flag rebuildContext = true is removed, the exception is no longer thrown. Essentially, property placeholders can't be used in combination with @MicronautTest(rebuildContext = true).

As it stands, we basically need to design our tests to avoid the combination of placeholders and rebuildContext = true.

To reproduce you may start AsyncJobTest: https://github.com/jobrunr/jobrunr/blob/reproducer/micronaut-5-regression/framework-support/jobrunr-micronaut-feature/jobrunr-micronaut-tests/src/test/java/org/jobrunr/scheduling/AsyncJobTest.java

[graemerocher]

thanks for the feedback, did you report some issues?

[auloin]

Hi @graemerocher, I'm not sure what you mean by this. I haven't opened any issues about this because I can't tell whether these behaviours are actually bugs or intended behaviour.

[graemerocher]

the second one sounds like a bug, the first is not clear

[auloin]

@graemerocher I've created a minimal reproducer for the first issue: https://github.com/auloin/micronaut-5-regressions.

[graemerocher]

thanks can you create an issue with a link to the repository

[auloin]

@graemerocher I've created issues #12829 and #12830.

I'd like help with #12781, how should we proceed with that warning?