test: additional logs in BatcherImplTest

Investigating issue googleapis#1931.
suztomo · Dec 4, 2023 · a097345 · a097345
1 parent a621b8c
commit a097345
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -20,8 +20,11 @@ jobs:
       - run: java -version
       - name: Unit Tests
         run: |
+          # The logging option is to investigate a flaky test in 
+          # https://github.com/googleapis/sdk-platform-java/issues/1931
           mvn test --batch-mode --no-transfer-progress -Dcheckstyle.skip \
-              -Dfmt.skip -DenableTestCoverage
+              -Dfmt.skip -DenableTestCoverage \
+              -Djava.util.logging.SimpleFormatter.format="%1$tY %1$tl:%1$tM:%1$tS.%1$tL %2$s %4$s: %5$s%6$s%n"
       - run: bazelisk version
       - name: Install Maven modules
         run: |

diff --git a/.github/workflows/nightly.yaml b/.github/workflows/nightly.yaml
@@ -24,7 +24,11 @@ jobs:
           cache: maven
       - run: mvn -version
       - name: Unit Tests
-        run: mvn install --errors --batch-mode --no-transfer-progress -Dcheckstyle.skip -T 1C
+        run: |
+          # The logging option is to investigate a flaky test in 
+          # https://github.com/googleapis/sdk-platform-java/issues/1931
+          mvn install --errors --batch-mode --no-transfer-progress -Dcheckstyle.skip -T 1C \
+              -Djava.util.logging.SimpleFormatter.format="%1$tY %1$tl:%1$tM:%1$tS.%1$tL %2$s %4$s: %5$s%6$s%n"
       - name: Create issue if previous step fails
         if: ${{ failure() }}
         env:
@@ -59,7 +63,11 @@ jobs:
       - run: mvn -version
       - name: Test with Java 8
         # Direct goal invocation ("surefire:test") prevents recompiling tests
-        run: mvn surefire:test --errors --batch-mode --no-transfer-progress -T 1C
+        run: |
+          # The logging option is to investigate a flaky test in 
+          # https://github.com/googleapis/sdk-platform-java/issues/1931
+          mvn surefire:test --errors --batch-mode --no-transfer-progress -T 1C \
+              -Djava.util.logging.SimpleFormatter.format="%1$tY %1$tl:%1$tM:%1$tS.%1$tL %2$s %4$s: %5$s%6$s%n"
       - name: Create issue if previous step fails
         if: ${{ failure() }}
         env:

diff --git a/gax-java/gax/src/test/java/com/google/api/gax/batching/BatcherImplTest.java b/gax-java/gax/src/test/java/com/google/api/gax/batching/BatcherImplTest.java
@@ -85,6 +85,8 @@
 @RunWith(JUnit4.class)
 public class BatcherImplTest {
 
+  private static final Logger logger = Logger.getLogger(BatcherImplTest.class.getName());
+
   private static final ScheduledExecutorService EXECUTOR =
       Executors.newSingleThreadScheduledExecutor();
 
@@ -889,15 +891,20 @@ public void run() {
           () -> {
             try {
               Thread.sleep(throttledTime);
+              logger.info("Calling flowController.release");
               flowController.release(1, 1);
+              logger.info("Called flowController.release");
             } catch (InterruptedException e) {
             }
           });
 
       try {
+        logger.info("Calling future.get(10 ms)");
         future.get(10, TimeUnit.MILLISECONDS);
+        logger.info("future.get(10 ms) unexpectedly returned.");
         assertWithMessage("adding elements to batcher should be blocked by FlowControlled").fail();
       } catch (TimeoutException e) {
+        logger.info("future.get(10 ms) timed out expectedly.");
         // expected
       }