CORE-69: resolve @MockBean/@SpyBean compile warnings (#247)

* MockBean -> MockitoBean * SpyBean -> MockitoSpyBean
DataBiosphere · Mar 3, 2025 · 1473323 · 1473323
1 parent 466a362
commit 1473323
Show file tree

Hide file tree

Showing 26 changed files with 141 additions and 129 deletions.
diff --git a/service/src/main/java/bio/terra/externalcreds/services/ProviderOAuthClientCache.java b/service/src/main/java/bio/terra/externalcreds/services/ProviderOAuthClientCache.java
@@ -36,10 +36,11 @@ public ClientRegistration getProviderClient(Provider provider) {
 
     ClientRegistration.Builder builder =
         switch (provider) {
-          case RAS -> ClientRegistrations.fromOidcIssuerLocation(providerInfo.getIssuer())
-              .clientId(providerInfo.getClientId())
-              .clientSecret(providerInfo.getClientSecret())
-              .issuerUri(providerInfo.getIssuer());
+          case RAS ->
+              ClientRegistrations.fromOidcIssuerLocation(providerInfo.getIssuer())
+                  .clientId(providerInfo.getClientId())
+                  .clientSecret(providerInfo.getClientSecret())
+                  .issuerUri(providerInfo.getIssuer());
           case GITHUB -> {
             String redirectUri =
                 providerInfo.getAllowedRedirectUriPatterns().stream()
@@ -54,12 +55,12 @@ public ClientRegistration getProviderClient(Provider provider) {
                 .redirectUri(redirectUri)
                 .userNameAttributeName(providerInfo.getUserNameAttributeName());
           }
-          case FENCE, DCF_FENCE, ANVIL, KIDS_FIRST -> ClientRegistrations.fromOidcIssuerLocation(
-                  providerInfo.getIssuer())
-              .clientId(providerInfo.getClientId())
-              .clientSecret(providerInfo.getClientSecret())
-              .issuerUri(providerInfo.getIssuer())
-              .authorizationGrantType(AuthorizationGrantType.CLIENT_CREDENTIALS);
+          case FENCE, DCF_FENCE, ANVIL, KIDS_FIRST ->
+              ClientRegistrations.fromOidcIssuerLocation(providerInfo.getIssuer())
+                  .clientId(providerInfo.getClientId())
+                  .clientSecret(providerInfo.getClientSecret())
+                  .issuerUri(providerInfo.getIssuer())
+                  .authorizationGrantType(AuthorizationGrantType.CLIENT_CREDENTIALS);
           case ERA_COMMONS -> {
             if (externalCredsConfig.getEraCommonsLinkingEnabled()) {
               yield ClientRegistrations.fromOidcIssuerLocation(providerInfo.getIssuer())

diff --git a/service/src/main/java/bio/terra/externalcreds/services/ProviderTokenClientCache.java b/service/src/main/java/bio/terra/externalcreds/services/ProviderTokenClientCache.java
@@ -37,11 +37,11 @@ public ClientRegistration getProviderClient(Provider provider) {
 
     ClientRegistration.Builder builder =
         switch (provider) {
-          case RAS, FENCE, DCF_FENCE, ANVIL, KIDS_FIRST -> ClientRegistrations
-              .fromOidcIssuerLocation(providerInfo.getIssuer())
-              .clientId(providerInfo.getClientId())
-              .clientSecret(providerInfo.getClientSecret())
-              .issuerUri(providerInfo.getIssuer());
+          case RAS, FENCE, DCF_FENCE, ANVIL, KIDS_FIRST ->
+              ClientRegistrations.fromOidcIssuerLocation(providerInfo.getIssuer())
+                  .clientId(providerInfo.getClientId())
+                  .clientSecret(providerInfo.getClientSecret())
+                  .issuerUri(providerInfo.getIssuer());
           case GITHUB -> {
             String redirectUri =
                 providerInfo.getAllowedRedirectUriPatterns().stream()

diff --git a/service/src/main/java/bio/terra/externalcreds/visaComparators/VisaComparator.java b/service/src/main/java/bio/terra/externalcreds/visaComparators/VisaComparator.java
@@ -3,7 +3,9 @@
 import bio.terra.externalcreds.models.GA4GHVisa;
 
 public interface VisaComparator {
-  /** @return true if visas represent the same authorizations */
+  /**
+   * @return true if visas represent the same authorizations
+   */
   boolean authorizationsMatch(GA4GHVisa visa1, GA4GHVisa visa2);
 
   boolean matchesCriterion(GA4GHVisa visa, VisaCriterionInternal criterion);

diff --git a/service/src/test/java/bio/terra/externalcreds/controllers/AdminApiControllerTest.java b/service/src/test/java/bio/terra/externalcreds/controllers/AdminApiControllerTest.java
@@ -27,8 +27,8 @@
 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.mock.mockito.MockBean;
 import org.springframework.http.MediaType;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.MockMvc;
 
 @AutoConfigureMockMvc
@@ -38,9 +38,9 @@ class AdminApiControllerTest extends BaseTest {
   @Autowired private MockMvc mvc;
   @Autowired private ExternalCredsConfig externalCredsConfig;
 
-  @MockBean private LinkedAccountService linkedAccountService;
-  @MockBean private PassportService passportService;
-  @MockBean private ExternalCredsSamUserFactory samUserFactoryMock;
+  @MockitoBean private LinkedAccountService linkedAccountService;
+  @MockitoBean private PassportService passportService;
+  @MockitoBean private ExternalCredsSamUserFactory samUserFactoryMock;
 
   @Nested
   class PutLinkedAccountWithFakeToken {

diff --git a/...e/src/test/java/bio/terra/externalcreds/controllers/FenceAccountKeyApiControllerTest.java b/...e/src/test/java/bio/terra/externalcreds/controllers/FenceAccountKeyApiControllerTest.java
@@ -25,20 +25,20 @@
 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.mock.mockito.MockBean;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.MockMvc;
 
 @AutoConfigureMockMvc
 class FenceAccountKeyApiControllerTest extends BaseTest {
 
   @Autowired private MockMvc mvc;
 
-  @MockBean private LinkedAccountService linkedAccountServiceMock;
-  @MockBean private FenceProviderService fenceProviderServiceMock;
+  @MockitoBean private LinkedAccountService linkedAccountServiceMock;
+  @MockitoBean private FenceProviderService fenceProviderServiceMock;
 
-  @MockBean private ExternalCredsSamUserFactory samUserFactoryMock;
-  @MockBean private FenceAccountKeyService fenceAccountKeyServiceMock;
-  @MockBean private AuditLogger auditLoggerMock;
+  @MockitoBean private ExternalCredsSamUserFactory samUserFactoryMock;
+  @MockitoBean private FenceAccountKeyService fenceAccountKeyServiceMock;
+  @MockitoBean private AuditLogger auditLoggerMock;
   private Provider provider = Provider.FENCE;
 
   @Nested

diff --git a/service/src/test/java/bio/terra/externalcreds/controllers/GlobalExceptionHandlerTest.java b/service/src/test/java/bio/terra/externalcreds/controllers/GlobalExceptionHandlerTest.java
@@ -9,12 +9,12 @@
 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.mock.mockito.MockBean;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.MockMvc;
 
 @AutoConfigureMockMvc
 public class GlobalExceptionHandlerTest extends BaseTest {
-  @MockBean PublicApiController publicApiControllerMock;
+  @MockitoBean PublicApiController publicApiControllerMock;
   @Autowired private MockMvc mvc;
 
   @Test

diff --git a/service/src/test/java/bio/terra/externalcreds/controllers/OauthApiControllerTest.java b/service/src/test/java/bio/terra/externalcreds/controllers/OauthApiControllerTest.java
@@ -39,8 +39,8 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
-import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.http.MediaType;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.util.LinkedMultiValueMap;
 
@@ -50,26 +50,26 @@ class OauthApiControllerTest extends BaseTest {
 
   @Autowired private MockMvc mvc;
 
-  @MockBean private LinkedAccountService linkedAccountServiceMock;
+  @MockitoBean private LinkedAccountService linkedAccountServiceMock;
 
-  @MockBean
+  @MockitoBean
   @Qualifier("providerService")
   private ProviderService providerServiceMock;
 
-  @MockBean
+  @MockitoBean
   @Qualifier("passportProviderService")
   private PassportProviderService passportProviderServiceMock;
 
-  @MockBean
+  @MockitoBean
   @Qualifier("tokenProviderService")
   private TokenProviderService tokenProviderServiceMock;
 
-  @MockBean
+  @MockitoBean
   @Qualifier("fenceProviderService")
   private FenceProviderService fenceProviderServiceMock;
 
-  @MockBean private ExternalCredsSamUserFactory samUserFactoryMock;
-  @MockBean private AuditLogger auditLoggerMock;
+  @MockitoBean private ExternalCredsSamUserFactory samUserFactoryMock;
+  @MockitoBean private AuditLogger auditLoggerMock;
 
   private Provider provider = Provider.RAS;
 
@@ -79,7 +79,10 @@ void testListProviders() throws Exception {
         .thenReturn(Set.of("fake-provider2", "fake-provider1"));
 
     mvc.perform(get("/api/oidc/v1/providers"))
-        .andExpect(content().json("""
+        .andExpect(
+            content()
+                .json(
+                    """
             ["fake-provider1","fake-provider2"]"""));
   }
 

diff --git a/service/src/test/java/bio/terra/externalcreds/controllers/OidcApiControllerTest.java b/service/src/test/java/bio/terra/externalcreds/controllers/OidcApiControllerTest.java
@@ -40,7 +40,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
-import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.util.LinkedMultiValueMap;
 
@@ -51,19 +51,19 @@ class OidcApiControllerTest extends BaseTest {
 
   @Autowired private MockMvc mvc;
 
-  @MockBean private LinkedAccountService linkedAccountServiceMock;
+  @MockitoBean private LinkedAccountService linkedAccountServiceMock;
 
-  @MockBean
+  @MockitoBean
   @Qualifier("providerService")
   private ProviderService providerServiceMock;
 
-  @MockBean
+  @MockitoBean
   @Qualifier("passportProviderService")
   private PassportProviderService passportProviderServiceMock;
 
-  @MockBean private ExternalCredsSamUserFactory samUserFactoryMock;
-  @MockBean private PassportService passportServiceMock;
-  @MockBean private AuditLogger auditLoggerMock;
+  @MockitoBean private ExternalCredsSamUserFactory samUserFactoryMock;
+  @MockitoBean private PassportService passportServiceMock;
+  @MockitoBean private AuditLogger auditLoggerMock;
   private Provider provider = Provider.RAS;
 
   @Test
@@ -72,7 +72,10 @@ void testListProviders() throws Exception {
         .thenReturn(Set.of("fake-provider2", "fake-provider1"));
 
     mvc.perform(get("/api/oidc/v1/providers"))
-        .andExpect(content().json("""
+        .andExpect(
+            content()
+                .json(
+                    """
             ["fake-provider1","fake-provider2"]"""));
   }
 

diff --git a/service/src/test/java/bio/terra/externalcreds/controllers/PassportApiControllerTest.java b/service/src/test/java/bio/terra/externalcreds/controllers/PassportApiControllerTest.java
@@ -20,8 +20,8 @@
 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.mock.mockito.MockBean;
 import org.springframework.http.MediaType;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.MockMvc;
 
 @AutoConfigureMockMvc
@@ -31,7 +31,7 @@ public class PassportApiControllerTest extends BaseTest {
 
   @Autowired private ObjectMapper objectMapper;
 
-  @MockBean private PassportService passportServiceMock;
+  @MockitoBean private PassportService passportServiceMock;
 
   @Test
   void testValidatePassport() throws Exception {

diff --git a/service/src/test/java/bio/terra/externalcreds/controllers/PublicApiControllerTest.java b/service/src/test/java/bio/terra/externalcreds/controllers/PublicApiControllerTest.java
@@ -14,23 +14,26 @@
 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.mock.mockito.MockBean;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.web.servlet.MockMvc;
 
 @AutoConfigureMockMvc
 public class PublicApiControllerTest extends BaseTest {
 
   @Autowired private MockMvc mvc;
 
-  @MockBean private ExternalCredsConfig externalCredsConfig;
-  @MockBean private StatusService statusService;
+  @MockitoBean private ExternalCredsConfig externalCredsConfig;
+  @MockitoBean private StatusService statusService;
 
   @Test
   void testGetStatus() throws Exception {
     when(statusService.getSystemStatus())
         .thenReturn(new SystemStatus().ok(true).putSystemsItem("postgres", true));
     mvc.perform(get("/status"))
-        .andExpect(content().json("""
+        .andExpect(
+            content()
+                .json(
+                    """
             {"ok": true,"systems": { "postgres": true }}"""));
   }
 

diff --git a/service/src/test/java/bio/terra/externalcreds/dataAccess/GA4GHPassportDAOTest.java b/service/src/test/java/bio/terra/externalcreds/dataAccess/GA4GHPassportDAOTest.java
@@ -16,16 +16,16 @@
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.dao.DuplicateKeyException;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 
 class GA4GHPassportDAOTest extends BaseTest {
 
   @Autowired private LinkedAccountDAO linkedAccountDAO;
   @Autowired private GA4GHPassportDAO passportDAO;
   @Autowired private GA4GHVisaDAO visaDAO;
 
-  @MockBean private ExternalCredsConfig externalCredsConfig;
+  @MockitoBean private ExternalCredsConfig externalCredsConfig;
 
   @Test
   void testGetMissingPassport() {

diff --git a/service/src/test/java/bio/terra/externalcreds/dataAccess/LinkedAccountDAOTest.java b/service/src/test/java/bio/terra/externalcreds/dataAccess/LinkedAccountDAOTest.java
@@ -25,14 +25,14 @@
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 
 class LinkedAccountDAOTest extends BaseTest {
 
   @Autowired private LinkedAccountDAO linkedAccountDAO;
   @Autowired private GA4GHPassportDAO passportDAO;
   @Autowired private GA4GHVisaDAO visaDAO;
-  @MockBean private ExternalCredsConfig externalCredsConfig;
+  @MockitoBean private ExternalCredsConfig externalCredsConfig;
 
   @BeforeEach
   void setUp() {

diff --git a/service/src/test/java/bio/terra/externalcreds/pact/VerifyServicePacts.java b/service/src/test/java/bio/terra/externalcreds/pact/VerifyServicePacts.java
@@ -37,13 +37,13 @@
 import org.junit.platform.commons.util.StringUtils;
 import org.mockito.Mock;
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.security.oauth2.client.registration.ClientRegistration;
 import org.springframework.security.oauth2.core.OAuth2AccessToken;
 import org.springframework.security.oauth2.core.OAuth2AccessToken.TokenType;
 import org.springframework.security.oauth2.core.OAuth2RefreshToken;
 import org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse;
 import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 
 @ExtendWith(SpringExtension.class)
@@ -71,12 +71,12 @@ public static SelectorBuilder consumerVersionSelectors() {
     }
   }
 
-  @MockBean StatusDAO statusDAO;
-  @MockBean LinkedAccountDAO linkedAccountDAO;
-  @MockBean AccessTokenCacheDAO accessTokenCacheDAO;
-  @MockBean SamUserFactory samUserFactory;
-  @MockBean OAuth2Service oAuth2Service;
-  @MockBean StatusServiceCache statusServiceCache;
+  @MockitoBean StatusDAO statusDAO;
+  @MockitoBean LinkedAccountDAO linkedAccountDAO;
+  @MockitoBean AccessTokenCacheDAO accessTokenCacheDAO;
+  @MockitoBean SamUserFactory samUserFactory;
+  @MockitoBean OAuth2Service oAuth2Service;
+  @MockitoBean StatusServiceCache statusServiceCache;
   @Mock private OAuth2AccessTokenResponse mockAccessTokenResponse;
 
   @BeforeEach

diff --git a/service/src/test/java/bio/terra/externalcreds/services/AccessTokenCacheServiceTest.java b/service/src/test/java/bio/terra/externalcreds/services/AccessTokenCacheServiceTest.java
@@ -22,20 +22,20 @@
 import java.util.UUID;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.security.oauth2.core.OAuth2AccessToken;
 import org.springframework.security.oauth2.core.OAuth2RefreshToken;
 import org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse;
+import org.springframework.test.context.bean.override.mockito.MockitoBean;
 
 class AccessTokenCacheServiceTest extends BaseTest {
 
   @Autowired private AccessTokenCacheService accessTokenCacheService;
 
-  @MockBean private LinkedAccountService linkedAccountService;
-  @MockBean private ProviderTokenClientCache providerTokenClientCacheMock;
-  @MockBean private OAuth2Service oAuth2ServiceMock;
-  @MockBean private AccessTokenCacheDAO accessTokenCacheDAO;
-  @MockBean private AuditLogger auditLoggerMock;
+  @MockitoBean private LinkedAccountService linkedAccountService;
+  @MockitoBean private ProviderTokenClientCache providerTokenClientCacheMock;
+  @MockitoBean private OAuth2Service oAuth2ServiceMock;
+  @MockitoBean private AccessTokenCacheDAO accessTokenCacheDAO;
+  @MockitoBean private AuditLogger auditLoggerMock;
 
   private final String clientIP = "127.0.0.1";
   private final Random random = new Random();