XComp commented on a change in pull request #14847: URL: https://github.com/apache/flink/pull/14847#discussion_r580511819
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/scheduler/stopwithsavepoint/StopWithSavepointTerminationHandlerImplTest.java ########## @@ -0,0 +1,202 @@ +/* + * 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.flink.runtime.scheduler.stopwithsavepoint; + +import org.apache.flink.api.common.JobID; +import org.apache.flink.core.testutils.FlinkMatchers; +import org.apache.flink.runtime.checkpoint.CheckpointProperties; +import org.apache.flink.runtime.checkpoint.CompletedCheckpoint; +import org.apache.flink.runtime.checkpoint.TestingCheckpointScheduling; +import org.apache.flink.runtime.concurrent.Executors; +import org.apache.flink.runtime.execution.ExecutionState; +import org.apache.flink.runtime.scheduler.SchedulerBase; +import org.apache.flink.runtime.scheduler.SchedulerNG; +import org.apache.flink.runtime.scheduler.TestingSchedulerNG; +import org.apache.flink.runtime.state.StreamStateHandle; +import org.apache.flink.runtime.state.testutils.EmptyStreamStateHandle; +import org.apache.flink.runtime.state.testutils.TestCompletedCheckpointStorageLocation; +import org.apache.flink.util.ExceptionUtils; +import org.apache.flink.util.FlinkException; +import org.apache.flink.util.TestLogger; + +import org.junit.Test; + +import java.util.Collections; +import java.util.HashMap; +import java.util.Optional; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.function.Consumer; + +import static org.hamcrest.CoreMatchers.is; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; +import static org.junit.Assert.fail; + +/** + * {@code StopWithSavepointTerminationHandlerImplTest} tests the stop-with-savepoint functionality + * of {@link SchedulerBase#stopWithSavepoint(String, boolean)}. + */ +public class StopWithSavepointTerminationHandlerImplTest extends TestLogger { + + private static final JobID JOB_ID = new JobID(); + + private final TestingCheckpointScheduling checkpointScheduling = + new TestingCheckpointScheduling(false); + + private StopWithSavepointTerminationHandlerImpl createTestInstanceFailingOnGlobalFailOver() { + return createTestInstance( + throwableCausingGlobalFailOver -> fail("No global failover should be triggered.")); + } + + private StopWithSavepointTerminationHandlerImpl createTestInstance( + Consumer<Throwable> handleGlobalFailureConsumer) { + // checkpointing should be always stopped before initiating stop-with-savepoint + checkpointScheduling.stopCheckpointScheduler(); + + final SchedulerNG scheduler = + TestingSchedulerNG.newBuilder() + .setHandleGlobalFailureConsumer(handleGlobalFailureConsumer) + .build(); + return new StopWithSavepointTerminationHandlerImpl( + JOB_ID, scheduler, checkpointScheduling, Executors.directExecutor(), log); + } + + @Test + public void testHappyPath() throws ExecutionException, InterruptedException { + final StopWithSavepointTerminationHandlerImpl testInstance = + createTestInstanceFailingOnGlobalFailOver(); + + final EmptyStreamStateHandle streamStateHandle = new EmptyStreamStateHandle(); + final CompletedCheckpoint completedSavepoint = createCompletedSavepoint(streamStateHandle); + testInstance.handleSavepointCreation(completedSavepoint, null); + testInstance.handleExecutionsTermination(Collections.singleton(ExecutionState.FINISHED)); + + assertThat( + testInstance.getSavepointPath().get(), is(completedSavepoint.getExternalPointer())); + + assertFalse( + "The savepoint should not have been discarded.", streamStateHandle.isDisposed()); + assertFalse("Checkpoint scheduling should be disabled.", checkpointScheduling.isEnabled()); + } + + @Test + public void testSavepointCreationFailure() { + final StopWithSavepointTerminationHandlerImpl testInstance = + createTestInstanceFailingOnGlobalFailOver(); + + final String expectedErrorMessage = "Expected exception during savepoint creation."; + testInstance.handleSavepointCreation(null, new Exception(expectedErrorMessage)); + + try { + testInstance.getSavepointPath().get(); + fail("An ExecutionException is expected."); + } catch (Throwable e) { + final Optional<Throwable> actualException = + ExceptionUtils.findThrowableWithMessage(e, expectedErrorMessage); + assertTrue( + "An exception with the expected error message should have been thrown.", + actualException.isPresent()); + } + + // the checkpoint scheduling should be enabled in case of failure + assertTrue("Checkpoint scheduling should be enabled.", checkpointScheduling.isEnabled()); + } Review comment: Good point. I added two more test cases: 1. Checks that no global failover happens if the execution terminates with a failure. 2. Checks that checkpoint scheduling is not disabled if the execution terminates successfully. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
