Use Awaitility to instead of Thread sleep method. (#389)

mattisonchao · web-flow · commit 4dffb5e658b2 · 2021-07-12T12:50:55.000+02:00
diff --git a/curator-client/pom.xml b/curator-client/pom.xml
@@ -82,6 +82,11 @@
             <artifactId>slf4j-log4j12</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/curator-client/src/test/java/org/apache/curator/BasicTests.java b/curator-client/src/test/java/org/apache/curator/BasicTests.java
@@ -23,21 +23,21 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.fail;
+import java.time.Duration;
 import org.apache.curator.ensemble.fixed.FixedEnsembleProvider;
 import org.apache.curator.retry.RetryOneTime;
 import org.apache.curator.test.BaseClassForTests;
 import org.apache.curator.test.Timing;
 import org.apache.curator.utils.ZookeeperFactory;
 import org.apache.zookeeper.CreateMode;
 import org.apache.zookeeper.KeeperException;
-import org.apache.zookeeper.WatchedEvent;
 import org.apache.zookeeper.Watcher;
 import org.apache.zookeeper.ZooDefs;
 import org.apache.zookeeper.ZooKeeper;
+import org.awaitility.Awaitility;
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
-import java.util.concurrent.Callable;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicBoolean;
 
@@ -47,14 +47,8 @@ public class BasicTests extends BaseClassForTests
     public void     testFactory() throws Exception
     {
         final ZooKeeper         mockZookeeper = Mockito.mock(ZooKeeper.class);
-        ZookeeperFactory        zookeeperFactory = new ZookeeperFactory()
-        {
-            @Override
-            public ZooKeeper newZooKeeper(String connectString, int sessionTimeout, Watcher watcher, boolean canBeReadOnly) throws Exception
-            {
-                return mockZookeeper;
-            }
-        };
+        ZookeeperFactory        zookeeperFactory =
+                (connectString, sessionTimeout, watcher, canBeReadOnly) -> mockZookeeper;
         CuratorZookeeperClient  client = new CuratorZookeeperClient(zookeeperFactory, new FixedEnsembleProvider(server.getConnectString()), 10000, 10000, null, new RetryOneTime(1), false);
         client.start();
         assertEquals(client.getZooKeeper(), mockZookeeper);
@@ -68,15 +62,10 @@ public void     testExpiredSession() throws Exception
         final Timing                  timing = new Timing();
 
         final CountDownLatch    latch = new CountDownLatch(1);
-        Watcher                 watcher = new Watcher()
-        {
-            @Override
-            public void process(WatchedEvent event)
+        Watcher                 watcher = event -> {
+            if ( event.getState() == Watcher.Event.KeeperState.Expired )
             {
-                if ( event.getState() == Event.KeeperState.Expired )
-                {
-                    latch.countDown();
-                }
+                latch.countDown();
             }
         };
 
@@ -88,11 +77,7 @@ public void process(WatchedEvent event)
             RetryLoop.callWithRetry
             (
                 client,
-                new Callable<Object>()
-                {
-                    @Override
-                    public Object call() throws Exception
-                    {
+                    () -> {
                         if ( firstTime.compareAndSet(true, false) )
                         {
                             try
@@ -113,7 +98,6 @@ public Object call() throws Exception
                         assertNotNull(zooKeeper.exists("/foo", false));
                         return null;
                     }
-                }
             );
         }
         finally
@@ -166,34 +150,16 @@ public void     testSimple() throws Exception
     }
 
     @Test
-    public void     testBackgroundConnect() throws Exception
+    public void  testBackgroundConnect() throws Exception
     {
         final int CONNECTION_TIMEOUT_MS = 4000;
-
-        CuratorZookeeperClient client = new CuratorZookeeperClient(server.getConnectString(), 10000, CONNECTION_TIMEOUT_MS, null, new RetryOneTime(1));
-        try
-        {
+        try (CuratorZookeeperClient client = new CuratorZookeeperClient(server.getConnectString(), 10000,
+                CONNECTION_TIMEOUT_MS, null, new RetryOneTime(1))) {
             assertFalse(client.isConnected());
             client.start();
-
-            outer: do
-            {
-                for ( int i = 0; i < (CONNECTION_TIMEOUT_MS / 1000); ++i )
-                {
-                    if ( client.isConnected() )
-                    {
-                        break outer;
-                    }
-
-                    Thread.sleep(CONNECTION_TIMEOUT_MS);
-                }
-
-                fail();
-            } while ( false );
-        }
-        finally
-        {
-            client.close();
+            Awaitility.await()
+                    .atMost(Duration.ofMillis(CONNECTION_TIMEOUT_MS))
+                    .untilAsserted(() -> Assertions.assertTrue(client.isConnected()));
         }
     }
 }
diff --git a/curator-client/src/test/java/org/apache/curator/utils/TestCloseableExecutorService.java b/curator-client/src/test/java/org/apache/curator/utils/TestCloseableExecutorService.java
@@ -22,6 +22,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import com.google.common.collect.Lists;
+import org.awaitility.Awaitility;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -89,11 +90,7 @@ public void testBasicCallable() throws InterruptedException
         {
             service.submit
             (
-                new Callable<Void>()
-                {
-                    @Override
-                    public Void call() throws Exception
-                    {
+                    (Callable<Void>) () -> {
                         try
                         {
                             startLatch.countDown();
@@ -109,7 +106,6 @@ public Void call() throws Exception
                         }
                         return null;
                     }
-                }
             );
         }
 
@@ -128,11 +124,7 @@ public void testListeningRunnable() throws InterruptedException
         {
             Future<?> future = service.submit
             (
-                new Runnable()
-                {
-                    @Override
-                    public void run()
-                    {
+                    () -> {
                         try
                         {
                             startLatch.countDown();
@@ -143,7 +135,6 @@ public void run()
                             Thread.currentThread().interrupt();
                         }
                     }
-                }
             );
             futures.add(future);
         }
@@ -168,11 +159,7 @@ public void testListeningCallable() throws InterruptedException
         {
             Future<?> future = service.submit
             (
-                new Callable<Void>()
-                {
-                    @Override
-                    public Void call() throws Exception
-                    {
+                    (Callable<Void>) () -> {
                         try
                         {
                             startLatch.countDown();
@@ -184,7 +171,6 @@ public Void call() throws Exception
                         }
                         return null;
                     }
-                }
             );
             futures.add(future);
         }
@@ -204,11 +190,7 @@ public void testPartialRunnable() throws InterruptedException
         final CountDownLatch outsideLatch = new CountDownLatch(1);
         executorService.submit
         (
-            new Runnable()
-            {
-                @Override
-                public void run()
-                {
+                () -> {
                     try
                     {
                         Thread.currentThread().join();
@@ -222,7 +204,6 @@ public void run()
                         outsideLatch.countDown();
                     }
                 }
-            }
         );
 
         CloseableExecutorService service = new CloseableExecutorService(executorService);
@@ -233,10 +214,7 @@ public void run()
             submitRunnable(service, startLatch, latch);
         }
 
-        while ( service.size() < QTY )
-        {
-            Thread.sleep(100);
-        }
+        Awaitility.await().until(()-> service.size() >= QTY);
 
         assertTrue(startLatch.await(3, TimeUnit.SECONDS));
         service.close();
@@ -248,11 +226,7 @@ private void submitRunnable(CloseableExecutorService service, final CountDownLat
     {
         service.submit
             (
-                new Runnable()
-                {
-                    @Override
-                    public void run()
-                    {
+                    () -> {
                         try
                         {
                             startLatch.countDown();
@@ -267,7 +241,6 @@ public void run()
                             latch.countDown();
                         }
                     }
-                }
             );
     }
 }
diff --git a/curator-framework/pom.xml b/curator-framework/pom.xml
@@ -86,6 +86,11 @@
             <artifactId>slf4j-log4j12</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.awaitility</groupId>
+            <artifactId>awaitility</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/curator-framework/src/test/java/org/apache/curator/framework/imps/TestCleanState.java b/curator-framework/src/test/java/org/apache/curator/framework/imps/TestCleanState.java
@@ -24,6 +24,7 @@
 import org.apache.curator.utils.CloseableUtils;
 import org.apache.zookeeper.ZooKeeper;
 import java.util.concurrent.Callable;
+import org.awaitility.Awaitility;
 
 public class TestCleanState
 {
@@ -43,10 +44,8 @@ public static void closeAndTestClean(CuratorFramework client)
             EnsembleTracker ensembleTracker = internalClient.getEnsembleTracker();
             if ( ensembleTracker != null )
             {
-                while ( ensembleTracker.hasOutstanding() )
-                {
-                    Thread.sleep(100);
-                }
+                Awaitility.await()
+                        .until(() -> !ensembleTracker.hasOutstanding());
                 ensembleTracker.close();
             }
             ZooKeeper zooKeeper = internalClient.getZooKeeper();
diff --git a/pom.xml b/pom.xml
@@ -100,6 +100,7 @@
         <dropwizard-version>3.2.5</dropwizard-version>
         <snappy-version>1.1.7</snappy-version>
         <build-helper-maven-plugin-version>3.1.0</build-helper-maven-plugin-version>
+        <awaitility-version>4.1.0</awaitility-version>
 
         <!-- OSGi Properties -->
         <osgi.export.package />
@@ -627,6 +628,14 @@
                 <artifactId>snappy-java</artifactId>
                 <version>${snappy-version}</version>
             </dependency>
+
+            <dependency>
+                <groupId>org.awaitility</groupId>
+                <artifactId>awaitility</artifactId>
+                <version>${awaitility-version}</version>
+                <scope>test</scope>
+            </dependency>
+
         </dependencies>
     </dependencyManagement>
 

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`	`import static org.junit.jupiter.api.Assertions.assertEquals;`
`23`	`23`	`import static org.junit.jupiter.api.Assertions.assertTrue;`
`24`	`24`	`import com.google.common.collect.Lists;`
	`25`	`+import org.awaitility.Awaitility;`
`25`	`26`	`import org.junit.jupiter.api.AfterEach;`
`26`	`27`	`import org.junit.jupiter.api.BeforeEach;`
`27`	`28`	`import org.junit.jupiter.api.Test;`
`@@ -89,11 +90,7 @@ public void testBasicCallable() throws InterruptedException`
`89`	`90`	`{`
`90`	`91`	`service.submit`
`91`	`92`	`(`
`92`		`- new Callable<Void>()`
`93`		`- {`
`94`		`- @Override`
`95`		`- public Void call() throws Exception`
`96`		`- {`
	`93`	`+ (Callable<Void>) () -> {`
`97`	`94`	`try`
`98`	`95`	`{`
`99`	`96`	`startLatch.countDown();`
`@@ -109,7 +106,6 @@ public Void call() throws Exception`
`109`	`106`	`}`
`110`	`107`	`return null;`
`111`	`108`	`}`
`112`		`- }`
`113`	`109`	`);`
`114`	`110`	`}`
`115`	`111`
`@@ -128,11 +124,7 @@ public void testListeningRunnable() throws InterruptedException`
`128`	`124`	`{`
`129`	`125`	`Future<?> future = service.submit`
`130`	`126`	`(`
`131`		`- new Runnable()`
`132`		`- {`
`133`		`- @Override`
`134`		`- public void run()`
`135`		`- {`
	`127`	`+ () -> {`
`136`	`128`	`try`
`137`	`129`	`{`
`138`	`130`	`startLatch.countDown();`
`@@ -143,7 +135,6 @@ public void run()`
`143`	`135`	`Thread.currentThread().interrupt();`
`144`	`136`	`}`
`145`	`137`	`}`
`146`		`- }`
`147`	`138`	`);`
`148`	`139`	`futures.add(future);`
`149`	`140`	`}`
`@@ -168,11 +159,7 @@ public void testListeningCallable() throws InterruptedException`
`168`	`159`	`{`
`169`	`160`	`Future<?> future = service.submit`
`170`	`161`	`(`
`171`		`- new Callable<Void>()`
`172`		`- {`
`173`		`- @Override`
`174`		`- public Void call() throws Exception`
`175`		`- {`
	`162`	`+ (Callable<Void>) () -> {`
`176`	`163`	`try`
`177`	`164`	`{`
`178`	`165`	`startLatch.countDown();`
`@@ -184,7 +171,6 @@ public Void call() throws Exception`
`184`	`171`	`}`
`185`	`172`	`return null;`
`186`	`173`	`}`
`187`		`- }`
`188`	`174`	`);`
`189`	`175`	`futures.add(future);`
`190`	`176`	`}`
`@@ -204,11 +190,7 @@ public void testPartialRunnable() throws InterruptedException`
`204`	`190`	`final CountDownLatch outsideLatch = new CountDownLatch(1);`
`205`	`191`	`executorService.submit`
`206`	`192`	`(`
`207`		`- new Runnable()`
`208`		`- {`
`209`		`- @Override`
`210`		`- public void run()`
`211`		`- {`
	`193`	`+ () -> {`
`212`	`194`	`try`
`213`	`195`	`{`
`214`	`196`	`Thread.currentThread().join();`
`@@ -222,7 +204,6 @@ public void run()`
`222`	`204`	`outsideLatch.countDown();`
`223`	`205`	`}`
`224`	`206`	`}`
`225`		`- }`
`226`	`207`	`);`
`227`	`208`
`228`	`209`	`CloseableExecutorService service = new CloseableExecutorService(executorService);`
`@@ -233,10 +214,7 @@ public void run()`
`233`	`214`	`submitRunnable(service, startLatch, latch);`
`234`	`215`	`}`
`235`	`216`
`236`		`- while ( service.size() < QTY )`
`237`		`- {`
`238`		`- Thread.sleep(100);`
`239`		`- }`
	`217`	`+ Awaitility.await().until(()-> service.size() >= QTY);`
`240`	`218`
`241`	`219`	`assertTrue(startLatch.await(3, TimeUnit.SECONDS));`
`242`	`220`	`service.close();`
`@@ -248,11 +226,7 @@ private void submitRunnable(CloseableExecutorService service, final CountDownLat`
`248`	`226`	`{`
`249`	`227`	`service.submit`
`250`	`228`	`(`
`251`		`- new Runnable()`
`252`		`- {`
`253`		`- @Override`
`254`		`- public void run()`
`255`		`- {`
	`229`	`+ () -> {`
`256`	`230`	`try`
`257`	`231`	`{`
`258`	`232`	`startLatch.countDown();`
`@@ -267,7 +241,6 @@ public void run()`
`267`	`241`	`latch.countDown();`
`268`	`242`	`}`
`269`	`243`	`}`
`270`		`- }`
`271`	`244`	`);`
`272`	`245`	`}`
`273`	`246`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`import org.apache.curator.utils.CloseableUtils;`
`25`	`25`	`import org.apache.zookeeper.ZooKeeper;`
`26`	`26`	`import java.util.concurrent.Callable;`
	`27`	`+import org.awaitility.Awaitility;`
`27`	`28`
`28`	`29`	`public class TestCleanState`
`29`	`30`	`{`
`@@ -43,10 +44,8 @@ public static void closeAndTestClean(CuratorFramework client)`
`43`	`44`	`EnsembleTracker ensembleTracker = internalClient.getEnsembleTracker();`
`44`	`45`	`if ( ensembleTracker != null )`
`45`	`46`	`{`
`46`		`- while ( ensembleTracker.hasOutstanding() )`
`47`		`- {`
`48`		`- Thread.sleep(100);`
`49`		`- }`
	`47`	`+ Awaitility.await()`
	`48`	`+ .until(() -> !ensembleTracker.hasOutstanding());`
`50`	`49`	`ensembleTracker.close();`
`51`	`50`	`}`
`52`	`51`	`ZooKeeper zooKeeper = internalClient.getZooKeeper();`