voonhous commented on code in PR #19485: URL: https://github.com/apache/hudi/pull/19485#discussion_r3957273057
########## hudi-utilities/src/test/java/org/apache/hudi/utilities/deltastreamer/TestDeltaStreamerTestHelpers.java: ########## @@ -0,0 +1,268 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.hudi.utilities.deltastreamer; + +import org.apache.hudi.common.testutils.JavaTestUtils; +import org.apache.hudi.utilities.streamer.NoNewDataTerminationStrategy; + +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import static org.apache.hudi.utilities.deltastreamer.HoodieDeltaStreamerTestBase.TestHelpers.describeTimeout; +import static org.apache.hudi.utilities.deltastreamer.HoodieDeltaStreamerTestBase.TestHelpers.waitFor; +import static org.apache.hudi.utilities.deltastreamer.HoodieDeltaStreamerTestBase.TestHelpers.waitTillCondition; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * Covers the deltastreamer test helpers every continuous-mode test runs on: the wait in + * {@code HoodieDeltaStreamerTestBase.TestHelpers} and the runner in {@code TestHoodieDeltaStreamer}. + * + * <p>The wait used to fail with a bare {@code TimeoutException} naming only the helper, with the + * condition's own error logged at debug and discarded, so a timeout said nothing about which assertion + * never held (HUDI-6843). + */ +class TestDeltaStreamerTestHelpers { + + /** A deltastreamer future that never finishes, as a continuous-mode job would be. */ + private static final Future<?> RUNNING = new CompletableFuture<>(); + + /** + * The poll interval these tests drive the helper at, so the class does not spend the production 2s cadence + * asleep. + */ + private static final long FAST_POLL_INTERVAL_MS = 50; + + /** + * With the fast poll above, one second still leaves room for many evaluations to be recorded, which is what + * the timeout report needs. + */ + private static final int CONDITION_TIMEOUT_SECS = 1; + + /** For the cases that are not meant to time out: they finish long before this, so it is never reached. */ + private static final int NEVER_REACHED_TIMEOUT_SECS = 30; + + @Test + void timeoutFailureNamesTheLastConditionFailure() { + String assertionText = "assertAtleastNDeltaCommits: expected at least 3 delta commits but got 2"; + + AssertionError error = assertThrows(AssertionError.class, + () -> waitTillCondition( + ignored -> { + throw new AssertionError(assertionText); + }, RUNNING, CONDITION_TIMEOUT_SECS, FAST_POLL_INTERVAL_MS)); + + assertTrue(error.getMessage().contains("was not met within " + CONDITION_TIMEOUT_SECS + " seconds"), + () -> "The failure should say the condition timed out, but was: " + error.getMessage()); + assertTrue(error.getMessage().contains(assertionText), + () -> "The failure should carry the condition's own error, which is the only clue to why the " + + "wait timed out, but was: " + error.getMessage()); + assertFalse(error.getMessage().contains("returned false without throwing"), + () -> "The failure should carry the condition's error, not the 'kept returning false' branch, " + + "but was: " + error.getMessage()); + assertInstanceOf(TimeoutException.class, error.getSuppressed()[0], + "the timeout should stay attached as a suppressed exception once the condition's error becomes the cause"); + } + + /** + * {@code shutdownNow} interrupts the polling thread, but {@code Thread.sleep} clears the interrupt flag + * when it throws, so a catch-all around the sleep would swallow it and keep polling for the life of the + * JVM. This pins that the worker actually stops. + */ + @Test + void pollingStopsOnceTheWaitHasGivenUp() throws Exception { + AtomicInteger polls = new AtomicInteger(); + AtomicReference<Thread> poller = new AtomicReference<>(); + + assertThrows(AssertionError.class, + () -> waitTillCondition( + ignored -> { + poller.set(Thread.currentThread()); + polls.incrementAndGet(); + throw new AssertionError("never true"); + }, RUNNING, CONDITION_TIMEOUT_SECS, FAST_POLL_INTERVAL_MS)); + + int pollsWhenItGaveUp = polls.get(); + assertTrue(pollsWhenItGaveUp > 0, + "the condition should have been evaluated at least once before the wait gave up, otherwise the " + + "comparison below passes trivially"); + poller.get().join(TimeUnit.SECONDS.toMillis(5)); + assertFalse(poller.get().isAlive(), + "the polling thread should have exited once the wait gave up, not still be running after the join"); + assertEquals(pollsWhenItGaveUp, polls.get(), + "the polling thread should have stopped when the wait gave up, not carried on in the background"); + } + + /** + * The interrupt from {@code shutdownNow} is delivered once, and {@code Thread.sleep} clears the flag when it + * throws, so a condition that swallows it without restoring it leaves the loop with no interrupt to see. The + * {@code executor.isShutdown()} guard is what stops the worker in that case. + */ + @Test + void pollingStopsEvenWhenTheConditionSwallowsTheInterrupt() throws Exception { + AtomicInteger polls = new AtomicInteger(); + AtomicReference<Thread> poller = new AtomicReference<>(); + + assertThrows(AssertionError.class, + () -> waitTillCondition( + ignored -> { + poller.set(Thread.currentThread()); + polls.incrementAndGet(); + try { + Thread.sleep(TimeUnit.SECONDS.toMillis(60)); + } catch (InterruptedException interrupted) { + // The missing Thread.currentThread().interrupt() is the point of the test: a condition that + // swallows the interrupt is exactly what the isShutdown() guard exists for, so do not "fix" + // this catch. + } + return false; + }, RUNNING, CONDITION_TIMEOUT_SECS, FAST_POLL_INTERVAL_MS)); + + int pollsWhenItGaveUp = polls.get(); + assertTrue(pollsWhenItGaveUp > 0, + "the condition should have been evaluated at least once before the wait gave up, otherwise the " + + "comparison below passes trivially"); + poller.get().join(TimeUnit.SECONDS.toMillis(5)); + assertFalse(poller.get().isAlive(), + "the isShutdown() guard should have stopped the polling thread even though the condition swallowed " + + "the interrupt without restoring the flag"); + assertEquals(pollsWhenItGaveUp, polls.get(), + "the polling thread should have stopped when the wait gave up, not carried on in the background"); + } + + /** + * A condition that hangs part-way through its first evaluation is a different failure from one that keeps + * returning false, and the report has to say which: with no completed evaluation there is no last error, + * and claiming the condition "returned false without throwing" would assert the wrong thing. + */ + @Test + void timeoutDistinguishesAConditionThatNeverCompletedAnEvaluation() { + AssertionError error = assertThrows(AssertionError.class, + () -> waitTillCondition( + ignored -> { + try { + Thread.sleep(60_000); Review Comment: Done in `aca668b`, applied as suggested. ########## hudi-utilities/src/test/java/org/apache/hudi/utilities/deltastreamer/TestDeltaStreamerTestHelpers.java: ########## @@ -0,0 +1,268 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.hudi.utilities.deltastreamer; + +import org.apache.hudi.common.testutils.JavaTestUtils; +import org.apache.hudi.utilities.streamer.NoNewDataTerminationStrategy; + +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; + +import static org.apache.hudi.utilities.deltastreamer.HoodieDeltaStreamerTestBase.TestHelpers.describeTimeout; +import static org.apache.hudi.utilities.deltastreamer.HoodieDeltaStreamerTestBase.TestHelpers.waitFor; +import static org.apache.hudi.utilities.deltastreamer.HoodieDeltaStreamerTestBase.TestHelpers.waitTillCondition; +import static org.junit.jupiter.api.Assertions.assertDoesNotThrow; +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * Covers the deltastreamer test helpers every continuous-mode test runs on: the wait in + * {@code HoodieDeltaStreamerTestBase.TestHelpers} and the runner in {@code TestHoodieDeltaStreamer}. + * + * <p>The wait used to fail with a bare {@code TimeoutException} naming only the helper, with the + * condition's own error logged at debug and discarded, so a timeout said nothing about which assertion + * never held (HUDI-6843). + */ +class TestDeltaStreamerTestHelpers { + + /** A deltastreamer future that never finishes, as a continuous-mode job would be. */ + private static final Future<?> RUNNING = new CompletableFuture<>(); + + /** + * The poll interval these tests drive the helper at, so the class does not spend the production 2s cadence + * asleep. + */ + private static final long FAST_POLL_INTERVAL_MS = 50; + + /** + * With the fast poll above, one second still leaves room for many evaluations to be recorded, which is what + * the timeout report needs. + */ + private static final int CONDITION_TIMEOUT_SECS = 1; + + /** For the cases that are not meant to time out: they finish long before this, so it is never reached. */ + private static final int NEVER_REACHED_TIMEOUT_SECS = 30; + + @Test + void timeoutFailureNamesTheLastConditionFailure() { + String assertionText = "assertAtleastNDeltaCommits: expected at least 3 delta commits but got 2"; + + AssertionError error = assertThrows(AssertionError.class, + () -> waitTillCondition( + ignored -> { + throw new AssertionError(assertionText); + }, RUNNING, CONDITION_TIMEOUT_SECS, FAST_POLL_INTERVAL_MS)); + + assertTrue(error.getMessage().contains("was not met within " + CONDITION_TIMEOUT_SECS + " seconds"), + () -> "The failure should say the condition timed out, but was: " + error.getMessage()); + assertTrue(error.getMessage().contains(assertionText), + () -> "The failure should carry the condition's own error, which is the only clue to why the " + + "wait timed out, but was: " + error.getMessage()); + assertFalse(error.getMessage().contains("returned false without throwing"), + () -> "The failure should carry the condition's error, not the 'kept returning false' branch, " + + "but was: " + error.getMessage()); + assertInstanceOf(TimeoutException.class, error.getSuppressed()[0], Review Comment: Done in `aca668b`. Deviated slightly from the suggestion: rather than repeat the same message on both assertions, the length check carries its own text and prints the actual suppressed list, and the `assertInstanceOf` message now just names what the element should be. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
