Merge pull request #326 from IABTechLab/wzh-uid2-3846-get-rid-of-spy

replace spy with mock

Author: lizk886

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.uid2</groupId>
     <artifactId>uid2-admin</artifactId>
-    <version>5.12.0</version>
+    <version>5.12.1-alpha-85-SNAPSHOT</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

src/main/java/com/uid2/admin/Main.java

@@ -201,7 +201,8 @@ public void run() {
             GlobalScope s3KeyGlobalScope = new GlobalScope(s3KeyMetadataPath);
             RotatingS3KeyProvider s3KeyProvider = new RotatingS3KeyProvider(cloudStorage, s3KeyGlobalScope);
             S3KeyStoreWriter s3KeyStoreWriter = new S3KeyStoreWriter(s3KeyProvider, fileManager, jsonWriter, versionGenerator, clock, s3KeyGlobalScope);
-            S3KeyManager s3KeyManager = new S3KeyManager(s3KeyProvider, s3KeyStoreWriter);
+            IKeyGenerator keyGenerator = new SecureKeyGenerator();
+            S3KeyManager s3KeyManager = new S3KeyManager(s3KeyProvider, s3KeyStoreWriter,keyGenerator);
             try {
                 s3KeyProvider.loadContent();
             } catch (CloudStorageException e) {
@@ -231,7 +232,6 @@ public void run() {
             AdminAuthMiddleware auth = new AdminAuthMiddleware(authProvider, config);
             TokenRefreshHandler tokenRefreshHandler = new TokenRefreshHandler(authProvider.getIdTokenVerifier(), config);
             WriteLock writeLock = new WriteLock();
-            IKeyGenerator keyGenerator = new SecureKeyGenerator();
             KeyHasher keyHasher = new KeyHasher();
             IKeypairGenerator keypairGenerator = new SecureKeypairGenerator();
             ISaltRotation saltRotation = new SaltRotation(config, keyGenerator);

src/main/java/com/uid2/admin/managers/S3KeyManager.java

@@ -23,10 +23,10 @@ public class S3KeyManager {
     private final S3KeyStoreWriter s3KeyStoreWriter;
     private final IKeyGenerator keyGenerator;
 
-    public S3KeyManager(RotatingS3KeyProvider s3KeyProvider, S3KeyStoreWriter s3KeyStoreWriter) {
+    public S3KeyManager(RotatingS3KeyProvider s3KeyProvider, S3KeyStoreWriter s3KeyStoreWriter, IKeyGenerator keyGenerator) {
         this.s3KeyProvider = s3KeyProvider;
         this.s3KeyStoreWriter = s3KeyStoreWriter;
-        this.keyGenerator = new SecureKeyGenerator();
+        this.keyGenerator = keyGenerator;
     }
 
     S3Key generateS3Key(int siteId, long activates, long created) throws Exception {

src/test/java/com/uid2/admin/managers/S3KeyManagerTest.java

@@ -29,12 +29,12 @@ void setUp() {
         s3KeyProvider = mock(RotatingS3KeyProvider.class);
         s3KeyStoreWriter = mock(S3KeyStoreWriter.class);
         keyGenerator = mock(IKeyGenerator.class);
-        s3KeyManager = spy(new S3KeyManager(s3KeyProvider, s3KeyStoreWriter));
+        s3KeyManager = new S3KeyManager(s3KeyProvider, s3KeyStoreWriter,keyGenerator);
     }
 
     @Test
     void testGenerateS3Key() throws Exception {
-        doReturn("randomKeyString").when(s3KeyManager).generateSecret();
+        when(keyGenerator.generateRandomKeyString(32)).thenReturn("randomKeyString");
 
         S3Key s3Key = s3KeyManager.generateS3Key(1, 1000L, 2000L);
 
@@ -178,7 +178,7 @@ void testGetAllS3KeysBySiteId() {
     @Test
     void testCreateAndAddImmediateS3Key() throws Exception {
         when(s3KeyProvider.getAll()).thenReturn(new HashMap<>());
-        doReturn("generatedSecret").when(s3KeyManager).generateSecret();
+        when(keyGenerator.generateRandomKeyString(32)).thenReturn("generatedSecret");
 
         S3Key newKey = s3KeyManager.createAndAddImmediate3Key(100);
 
@@ -308,31 +308,15 @@ void testGenerateKeysForOperators() throws Exception {
         existingKeys.put(1, new S3Key(1, 100, 1000L, 900L, "existingKey1"));
         when(s3KeyProvider.getAll()).thenReturn(existingKeys);
 
-        doReturn("generatedSecret").when(s3KeyManager).generateSecret();
+        when(keyGenerator.generateRandomKeyString(32)).thenReturn("generatedSecret");
 
         s3KeyManager.generateKeysForOperators(operatorKeys, keyActivateInterval, keyCountPerSite);
 
         verify(s3KeyProvider, times(1)).loadContent();
 
-        ArgumentCaptor<S3Key> keyCaptor = ArgumentCaptor.forClass(S3Key.class);
-        verify(s3KeyManager, times(5)).addS3Key(keyCaptor.capture());
-
-        List<S3Key> capturedKeys = keyCaptor.getAllValues();
-        assertEquals(5, capturedKeys.size());
-
-        List<S3Key> site100Keys = capturedKeys.stream()
-                .filter(key -> key.getSiteId() == 100)
-                .sorted(Comparator.comparingLong(S3Key::getActivates))
-                .collect(Collectors.toList());
-        assertEquals(2, site100Keys.size());
-        assertTrue(site100Keys.get(1).getActivates() - site100Keys.get(0).getActivates() >= keyActivateInterval);
-
-        List<S3Key> site200Keys = capturedKeys.stream()
-                .filter(key -> key.getSiteId() == 200)
-                .sorted(Comparator.comparingLong(S3Key::getActivates))
-                .collect(Collectors.toList());
-        assertEquals(3, site200Keys.size());
-        assertTrue(site200Keys.get(1).getActivates() - site200Keys.get(0).getActivates() >= keyActivateInterval);
+        ArgumentCaptor<Map<Integer, S3Key>> mapCaptor = ArgumentCaptor.forClass(Map.class);
+        // 6 keys needed - 1 existed keys = 5 new keys
+        verify(s3KeyStoreWriter, times(5)).upload(mapCaptor.capture(), isNull());
     }
 
     @Test
@@ -351,7 +335,7 @@ void testGenerateKeysForOperators_NoNewKeysNeeded() throws Exception {
 
         s3KeyManager.generateKeysForOperators(operatorKeys, keyActivateInterval, keyCountPerSite);
 
-        verify(s3KeyManager, never()).addS3Key(any());
+        verify(s3KeyStoreWriter, never()).upload(any(), any());
     }
 
     @Test
@@ -407,19 +391,13 @@ void testGenerateKeysForOperators_MultipleSitesWithVaryingExistingKeys() throws
         existingKeys.put(3, new S3Key(3, 200, 3000L, 2900L, "existingKey3"));
         when(s3KeyProvider.getAll()).thenReturn(existingKeys);
 
-        doReturn("generatedSecret").when(s3KeyManager).generateSecret();
+        when(keyGenerator.generateRandomKeyString(32)).thenReturn("generatedSecret");
 
         s3KeyManager.generateKeysForOperators(operatorKeys, keyActivateInterval, keyCountPerSite);
 
-        ArgumentCaptor<S3Key> keyCaptor = ArgumentCaptor.forClass(S3Key.class);
-        verify(s3KeyManager, times(6)).addS3Key(keyCaptor.capture());
-
-        List<S3Key> capturedKeys = keyCaptor.getAllValues();
-        assertEquals(6, capturedKeys.size());
-
-        assertEquals(2, capturedKeys.stream().filter(key -> key.getSiteId() == 100).count());
-        assertEquals(1, capturedKeys.stream().filter(key -> key.getSiteId() == 200).count());
-        assertEquals(3, capturedKeys.stream().filter(key -> key.getSiteId() == 300).count());
+        ArgumentCaptor<Map<Integer, S3Key>> mapCaptor = ArgumentCaptor.forClass(Map.class);
+        // 9 keys needed - 3 existed keys = 6 new keys
+        verify(s3KeyStoreWriter, times(6)).upload(mapCaptor.capture(), isNull());
     }
 
     private OperatorKey createOperatorKey(String keyHash, int siteId) {