Extension is no longer configuring WireMock for default instance due to @EnableWireMock being repeatable

[kzander91]

Proposal

I'm not sure if the new or the old behaviour is/was correct/intended, but this change broke our tests:

With #123, when both a test class and its parent declare @EnableWireMock(@ConfigureWireMock(...)), no WireMock instance is configured as the default anymore.
Before that change, the instance configured on the test class itself was used as the default.

One could argue that in such a scenario, there shouldn't be a default because multiple instances exist, however it is a breaking change nonetheless.

Reproduction steps

@EnableWireMock(@ConfigureWireMock(name = "parent-instance"))
class Parent {}

@EnableWireMock(@ConfigureWireMock(name = "child-instance"))
class Child extends Parent {
  @Test
  void foo() {
    stubFor(...); // <-- Fails with 3.10.6, because no default instance exists. With 3.10.0, `child-instance` was configured as the default
  }
}

References

With #123, @EnableWireMock became repeatable and WireMockSpringJunitExtension.getEnableWireMockAnnotations() was changed such that it now returns all annotations from the test class hierarchy, when before it found only the first/closest one:

wiremock-spring-boot/src/main/java/org/wiremock/spring/internal/WireMockSpringJunitExtension.java

Lines 92 to 100 in 270e49a

	private List<EnableWireMock> getEnableWireMockAnnotations(List<Object> instances) {
	return instances.stream()
	.flatMap(
	it ->
	AnnotationSupport.findRepeatableAnnotations(it.getClass(), EnableWireMock.class)
	.stream())
	.filter(it -> it != null)
	.toList();
	}

Compare this with 3.10.0:

wiremock-spring-boot/src/main/java/org/wiremock/spring/internal/WireMockSpringJunitExtension.java

Lines 93 to 98 in 3c91092

	private List<EnableWireMock> getEnableWireMockAnnotations(List<Object> instances) {
	return instances.stream()
	.map(it -> AnnotationUtils.findAnnotation(it.getClass(), EnableWireMock.class))
	.filter(it -> it != null)
	.toList();
	}

As a result, WireMockSpringJunitExtension.configureWireMockForDefaultInstance() is now finding multiple configurations and skips configuring one as the default.

[tomasbjerre]

Perhaps if the closest @EnableWireMock only has one ConfigureWireMock, it should be the default.

Which behavior would you prefer?

[kzander91]

Yes that was the previous behaviour and I found it somewhat intuitive. However I could also understand the new behaviour to be "correct", considering that there are multiple instances...

What do you think about restoring the previous behaviour in another patch release, and keeping the new behaviour for the next major/minor and adding a declarative way to explicitly specify which instance should be the default? Maybe something like @ConfigureWireMock(defaultInstance = true) (should probably throw if multiple configs declare themselves as default...)?

[tomasbjerre]

I think this can be left "as is". I don't know, but I don't think many users are using it this way.

[kzander91]

Okay, as I said I can accept the new behaviour as well. I'll have to update my tests to no longer rely on the default instance but explicitly inject and configure the intended instance.

Thanks for your consideration in any case, feel free to close this issue if you don't intend to change anything 👍