RWA-4723 standardize IDAM mocking in integration/replica tests via Mockito overrides and shared test configs. (#1579)

* RWA-4723 standardize IDAM mocking in integration/replica tests via Mockito overrides and shared test configs.

  Stub public holiday calendar HTTP calls with WireMock + local fixtures and update calendar tests/URIs.

  Align supporting integration configs/utilities

chore: align calendar support and test config overrides

* RWA-4723 standardize IDAM mocking

Resolve merge conflict.

---------

Co-authored-by: Martin Spasov <martin.y.spasov@gmail.com>

Author: JasonPittockHMCTS

src/integrationTest/java/uk/gov/hmcts/reform/wataskmanagementapi/GetWelcomeTest.java

@@ -4,17 +4,15 @@
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.MvcResult;
+import uk.gov.hmcts.reform.wataskmanagementapi.config.IntegrationTest;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
-@SpringBootTest
-@ActiveProfiles({"integration"})
+@IntegrationTest
 @AutoConfigureMockMvc(addFilters = false)
 class GetWelcomeTest {
 

src/integrationTest/java/uk/gov/hmcts/reform/wataskmanagementapi/auth/IdamTokenGeneratorCacheTest.java

@@ -7,11 +7,10 @@
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
-import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.context.annotation.Bean;
 import org.springframework.test.annotation.DirtiesContext;
-import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.context.bean.override.mockito.MockitoSpyBean;
 import org.springframework.util.LinkedMultiValueMap;
@@ -21,6 +20,7 @@
 import uk.gov.hmcts.reform.wataskmanagementapi.auth.idam.entities.UserIdamTokenGeneratorInfo;
 import uk.gov.hmcts.reform.wataskmanagementapi.auth.idam.entities.UserInfo;
 import uk.gov.hmcts.reform.wataskmanagementapi.clients.IdamWebApi;
+import uk.gov.hmcts.reform.wataskmanagementapi.config.IntegrationTest;
 
 import java.util.UUID;
 import java.util.concurrent.TimeUnit;
@@ -31,15 +31,14 @@
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
-@SpringBootTest(properties = "IA_IDAM_REDIRECT_URI=http://localhost:3002/oauth2/callback")
-@ActiveProfiles("integration")
+@IntegrationTest(properties = "IA_IDAM_REDIRECT_URI=http://localhost:3002/oauth2/callback")
 @DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS)
 public class IdamTokenGeneratorCacheTest {
 
     @MockitoBean(name = "systemUserIdamInfo")
     UserIdamTokenGeneratorInfo systemUserIdamInfo;
 
-    @MockitoBean
+    @Autowired
     private IdamWebApi idamWebApi;
 
     @MockitoSpyBean

src/integrationTest/java/uk/gov/hmcts/reform/wataskmanagementapi/config/IdamMockitoStubber.java

@@ -0,0 +1,54 @@
+package uk.gov.hmcts.reform.wataskmanagementapi.config;
+
+import jakarta.annotation.PostConstruct;
+import uk.gov.hmcts.reform.wataskmanagementapi.auth.idam.entities.Token;
+import uk.gov.hmcts.reform.wataskmanagementapi.auth.idam.entities.UserInfo;
+import uk.gov.hmcts.reform.wataskmanagementapi.clients.IdamWebApi;
+import uk.gov.hmcts.reform.wataskmanagementapi.services.IdamServiceApi;
+import uk.gov.hmcts.reform.wataskmanagementapi.utils.ServiceMocks;
+
+import java.util.List;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.lenient;
+
+public class IdamMockitoStubber {
+
+    private static final String BEARER_PREFIX = "Bearer ";
+
+    private final IdamWebApi idamWebApi;
+    private final IdamServiceApi idamServiceApi;
+
+    public IdamMockitoStubber(IdamWebApi idamWebApi, IdamServiceApi idamServiceApi) {
+        this.idamWebApi = idamWebApi;
+        this.idamServiceApi = idamServiceApi;
+    }
+
+    @PostConstruct
+    void stubDefaults() {
+        String accessToken = stripBearer(ServiceMocks.IDAM_AUTHORIZATION_TOKEN);
+        UserInfo defaultUserInfo = UserInfo.builder()
+            .uid(ServiceMocks.IDAM_USER_ID)
+            .email(ServiceMocks.IDAM_USER_EMAIL)
+            .roles(List.of())
+            .build();
+
+        lenient().when(idamWebApi.userInfo(anyString())).thenReturn(defaultUserInfo);
+        lenient().when(idamWebApi.token(any())).thenReturn(new Token(accessToken, "scope"));
+
+        // Default no-ops for test support endpoints
+        lenient().doNothing().when(idamServiceApi).createTestUser(any());
+        lenient().doNothing().when(idamServiceApi).deleteTestUser(anyString());
+    }
+
+    private static String stripBearer(String token) {
+        if (token == null) {
+            return "stub-token";
+        }
+        if (token.startsWith(BEARER_PREFIX)) {
+            return token.substring(BEARER_PREFIX.length());
+        }
+        return token;
+    }
+}

src/integrationTest/java/uk/gov/hmcts/reform/wataskmanagementapi/config/IntegrationIdamMockitoConfig.java

@@ -0,0 +1,98 @@
+package uk.gov.hmcts.reform.wataskmanagementapi.config;
+
+import org.mockito.Mockito;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Primary;
+import org.springframework.context.annotation.Profile;
+import org.springframework.security.oauth2.client.InMemoryOAuth2AuthorizedClientService;
+import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService;
+import org.springframework.security.oauth2.client.registration.ClientRegistration;
+import org.springframework.security.oauth2.client.registration.ClientRegistrationRepository;
+import org.springframework.security.oauth2.client.registration.InMemoryClientRegistrationRepository;
+import org.springframework.security.oauth2.client.web.AuthenticatedPrincipalOAuth2AuthorizedClientRepository;
+import org.springframework.security.oauth2.client.web.OAuth2AuthorizedClientRepository;
+import org.springframework.security.oauth2.core.AuthorizationGrantType;
+import uk.gov.hmcts.reform.wataskmanagementapi.clients.IdamWebApi;
+import uk.gov.hmcts.reform.wataskmanagementapi.services.IdamServiceApi;
+
+@TestConfiguration
+@Profile({"integration", "replica"})
+public class IntegrationIdamMockitoConfig {
+
+    private static final String IDAM_WEB_API_BEAN =
+        "uk.gov.hmcts.reform.wataskmanagementapi.clients.IdamWebApi";
+    private static final String IDAM_SERVICE_API_BEAN =
+        "uk.gov.hmcts.reform.wataskmanagementapi.services.IdamServiceApi";
+
+    @Bean
+    static BeanDefinitionRegistryPostProcessor idamFeignOverridePostProcessor() {
+        return new BeanDefinitionRegistryPostProcessor() {
+            @Override
+            public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
+                if (registry.containsBeanDefinition(IDAM_WEB_API_BEAN)) {
+                    registry.getBeanDefinition(IDAM_WEB_API_BEAN).setPrimary(false);
+                }
+                if (registry.containsBeanDefinition(IDAM_SERVICE_API_BEAN)) {
+                    registry.getBeanDefinition(IDAM_SERVICE_API_BEAN).setPrimary(false);
+                }
+            }
+
+            @Override
+            public void postProcessBeanFactory(
+                org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory
+            ) {
+                // No-op
+            }
+        };
+    }
+
+    @Bean
+    @Primary
+    public IdamWebApi idamWebApi() {
+        return Mockito.mock(IdamWebApi.class);
+    }
+
+    @Bean
+    @Primary
+    public IdamServiceApi idamServiceApi() {
+        return Mockito.mock(IdamServiceApi.class);
+    }
+
+    @Bean
+    public IdamMockitoStubber idamMockitoStubber(IdamWebApi idamWebApi, IdamServiceApi idamServiceApi) {
+        return new IdamMockitoStubber(idamWebApi, idamServiceApi);
+    }
+
+    @Bean
+    public ClientRegistrationRepository clientRegistrationRepository() {
+        ClientRegistration registration = ClientRegistration.withRegistrationId("oidc")
+            .clientId("integration-test")
+            .clientSecret("integration-test")
+            .authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
+            .redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
+            .scope("openid", "profile")
+            .authorizationUri("http://localhost/oauth2/authorize")
+            .tokenUri("http://localhost/oauth2/token")
+            .userInfoUri("http://localhost/userinfo")
+            .userNameAttributeName("sub")
+            .jwkSetUri("http://localhost/jwks")
+            .clientName("oidc")
+            .build();
+        return new InMemoryClientRegistrationRepository(registration);
+    }
+
+    @Bean
+    public OAuth2AuthorizedClientService oauth2AuthorizedClientService(
+        ClientRegistrationRepository clientRegistrationRepository) {
+        return new InMemoryOAuth2AuthorizedClientService(clientRegistrationRepository);
+    }
+
+    @Bean
+    public OAuth2AuthorizedClientRepository oauth2AuthorizedClientRepository(
+        OAuth2AuthorizedClientService authorizedClientService) {
+        return new AuthenticatedPrincipalOAuth2AuthorizedClientRepository(authorizedClientService);
+    }
+}

src/integrationTest/java/uk/gov/hmcts/reform/wataskmanagementapi/config/IntegrationLaunchDarklyTestConfig.java

@@ -0,0 +1,54 @@
+package uk.gov.hmcts.reform.wataskmanagementapi.config;
+
+import com.launchdarkly.sdk.LDContext;
+import com.launchdarkly.sdk.LDValue;
+import com.launchdarkly.sdk.server.interfaces.LDClientInterface;
+import org.mockito.Mockito;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
+import org.springframework.beans.factory.support.RootBeanDefinition;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyBoolean;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.lenient;
+
+@TestConfiguration
+@SuppressWarnings("HideUtilityClassConstructor") // Spring needs a constructor, its not a utility class
+public class IntegrationLaunchDarklyTestConfig {
+
+    @Bean
+    static BeanDefinitionRegistryPostProcessor launchDarklyOverridePostProcessor() {
+        return new BeanDefinitionRegistryPostProcessor() {
+            @Override
+            public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
+                if (registry.containsBeanDefinition("ldClient")) {
+                    registry.removeBeanDefinition("ldClient");
+                }
+                RootBeanDefinition definition = new RootBeanDefinition(LDClientInterface.class);
+                definition.setPrimary(true);
+                definition.setInstanceSupplier(IntegrationLaunchDarklyTestConfig::createMockClient);
+                registry.registerBeanDefinition("ldClient", definition);
+            }
+
+            @Override
+            public void postProcessBeanFactory(
+                org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory
+            ) {
+                // No-op
+            }
+
+        };
+    }
+
+    private static LDClientInterface createMockClient() {
+        LDClientInterface ldClient = Mockito.mock(LDClientInterface.class);
+        lenient().when(ldClient.boolVariation(anyString(), any(LDContext.class), anyBoolean()))
+            .thenAnswer(invocation -> invocation.getArgument(2));
+        lenient().when(ldClient.jsonValueVariation(anyString(), any(LDContext.class), any(LDValue.class)))
+            .thenAnswer(invocation -> invocation.getArgument(2));
+        return ldClient;
+    }
+}

src/integrationTest/java/uk/gov/hmcts/reform/wataskmanagementapi/config/IntegrationSecurityTestConfig.java

@@ -0,0 +1,72 @@
+package uk.gov.hmcts.reform.wataskmanagementapi.config;
+
+import org.springframework.beans.factory.config.BeanDefinition;
+import org.springframework.beans.factory.support.BeanDefinitionRegistry;
+import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
+import org.springframework.boot.test.context.TestConfiguration;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Primary;
+import org.springframework.context.annotation.Profile;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.oauth2.jwt.Jwt;
+import org.springframework.security.oauth2.jwt.JwtDecoder;
+import org.springframework.security.web.SecurityFilterChain;
+
+import java.time.Instant;
+import java.util.HashMap;
+
+@TestConfiguration
+@Order(Ordered.LOWEST_PRECEDENCE)
+@Profile({"integration", "replica"})
+public class IntegrationSecurityTestConfig {
+
+    @Bean
+    static BeanDefinitionRegistryPostProcessor securityOverridePostProcessor() {
+        return new BeanDefinitionRegistryPostProcessor() {
+            @Override
+            public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
+                removeIfFromSecurityConfiguration(registry, "securityFilterChain");
+                removeIfFromSecurityConfiguration(registry, "jwtDecoder");
+            }
+
+            @Override
+            public void postProcessBeanFactory(
+                org.springframework.beans.factory.config.ConfigurableListableBeanFactory beanFactory
+            ) {
+                // No-op
+            }
+
+            private void removeIfFromSecurityConfiguration(BeanDefinitionRegistry registry, String beanName) {
+                if (!registry.containsBeanDefinition(beanName)) {
+                    return;
+                }
+                BeanDefinition definition = registry.getBeanDefinition(beanName);
+                if ("securityConfiguration".equals(definition.getFactoryBeanName())) {
+                    registry.removeBeanDefinition(beanName);
+                }
+            }
+        };
+    }
+
+    @Bean
+    public JwtDecoder jwtDecoder() {
+        return token -> Jwt.withTokenValue(token)
+            .header("alg", "none")
+            .claim("sub", "integration-test")
+            .issuedAt(Instant.now())
+            .expiresAt(Instant.now().plusSeconds(3600))
+            .claims(claims -> claims.putAll(new HashMap<>()))
+            .build();
+    }
+
+    @Bean
+    @Primary
+    public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
+        http
+            .csrf(csrf -> csrf.disable())
+            .authorizeHttpRequests(authorize -> authorize.anyRequest().permitAll());
+        return http.build();
+    }
+}

src/integrationTest/java/uk/gov/hmcts/reform/wataskmanagementapi/config/IntegrationTest.java

@@ -0,0 +1,34 @@
+package uk.gov.hmcts.reform.wataskmanagementapi.config;
+
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.annotation.Import;
+import org.springframework.core.annotation.AliasFor;
+import org.springframework.test.context.ActiveProfiles;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Inherited;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Inherited
+@SpringBootTest
+@ActiveProfiles("integration")
+@Import({
+    IntegrationIdamMockitoConfig.class,
+    IntegrationSecurityTestConfig.class,
+    IntegrationLaunchDarklyTestConfig.class
+})
+public @interface IntegrationTest {
+
+    @AliasFor(annotation = SpringBootTest.class, attribute = "classes")
+    Class<?>[] classes() default {};
+
+    @AliasFor(annotation = SpringBootTest.class, attribute = "properties")
+    String[] properties() default {};
+
+    @AliasFor(annotation = SpringBootTest.class, attribute = "webEnvironment")
+    SpringBootTest.WebEnvironment webEnvironment() default SpringBootTest.WebEnvironment.MOCK;
+}

src/integrationTest/java/uk/gov/hmcts/reform/wataskmanagementapi/config/OpenAPIPublisherTest.java

@@ -5,9 +5,7 @@
 import org.junit.jupiter.api.TestInstance;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
-import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.annotation.DirtiesContext;
-import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.web.servlet.MockMvc;
 
 import java.io.OutputStream;
@@ -18,8 +16,7 @@
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
 
-@SpringBootTest
-@ActiveProfiles({"integration"})
+@IntegrationTest
 @AutoConfigureMockMvc(addFilters = false)
 @TestInstance(PER_CLASS)
 @DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS)