XComp commented on a change in pull request #18536: URL: https://github.com/apache/flink/pull/18536#discussion_r796724224
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/dispatcher/cleanup/DispatcherResourceCleanerFactoryTest.java ########## @@ -0,0 +1,420 @@ +/* + * 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.dispatcher.cleanup; + +import org.apache.flink.api.common.JobID; +import org.apache.flink.configuration.Configuration; +import org.apache.flink.runtime.blob.BlobServer; +import org.apache.flink.runtime.blob.BlobStore; +import org.apache.flink.runtime.blob.TestingBlobStoreBuilder; +import org.apache.flink.runtime.checkpoint.CheckpointRecoveryFactory; +import org.apache.flink.runtime.dispatcher.JobManagerRunnerRegistry; +import org.apache.flink.runtime.highavailability.HighAvailabilityServices; +import org.apache.flink.runtime.highavailability.JobResultStore; +import org.apache.flink.runtime.jobgraph.JobGraph; +import org.apache.flink.runtime.jobmanager.JobGraphStore; +import org.apache.flink.runtime.jobmanager.JobGraphWriter; +import org.apache.flink.runtime.leaderelection.LeaderElectionService; +import org.apache.flink.runtime.leaderretrieval.LeaderRetrievalService; +import org.apache.flink.runtime.metrics.MetricRegistry; +import org.apache.flink.runtime.metrics.groups.JobManagerMetricGroup; +import org.apache.flink.runtime.metrics.util.TestingMetricRegistry; +import org.apache.flink.util.concurrent.Executors; +import org.apache.flink.util.concurrent.FutureUtils; + +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import java.io.File; +import java.io.IOException; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.Executor; +import java.util.concurrent.TimeoutException; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * {@code DispatcherResourceCleanerFactoryTest} verifies that the resources are properly cleaned up + * for both, the {@link GloballyCleanableResource} and {@link LocallyCleanableResource} of the + * {@link org.apache.flink.runtime.dispatcher.Dispatcher}. + */ +public class DispatcherResourceCleanerFactoryTest { + + private static final JobID JOB_ID = new JobID(); + + private CleanableJobManagerRegistry jobManagerRunnerRegistry; + private CleanableJobGraphWriter jobGraphWriter; + private CleanableBlobServer blobServer; + private CleanableHighAvailabilityServices highAvailabilityServices; + private JobManagerMetricGroup jobManagerMetricGroup; + + private DispatcherResourceCleanerFactory testInstance; + + @BeforeEach + public void setup() throws IOException { + jobManagerRunnerRegistry = new CleanableJobManagerRegistry(); + jobGraphWriter = new CleanableJobGraphWriter(); + blobServer = new CleanableBlobServer(); + highAvailabilityServices = new CleanableHighAvailabilityServices(); + + MetricRegistry metricRegistry = TestingMetricRegistry.builder().build(); + jobManagerMetricGroup = + JobManagerMetricGroup.createJobManagerMetricGroup( + metricRegistry, "ignored hostname"); + jobManagerMetricGroup.addJob(JOB_ID, "ignored job name"); + + testInstance = + new DispatcherResourceCleanerFactory( + Executors.directExecutor(), + jobManagerRunnerRegistry, + jobGraphWriter, + blobServer, + highAvailabilityServices, + jobManagerMetricGroup); + } + + @Test + public void testLocalResourceCleaning() { + assertGlobalCleanupNotTriggered(); + assertLocalCleanupNotTriggered(); + assertJobManagerMetricGroupNotCleaned(); + + final CompletableFuture<Void> cleanupResultFuture = + testInstance.createLocalResourceCleaner().cleanupAsync(JOB_ID); + + assertGlobalCleanupNotTriggered(); + assertLocalCleanupTriggeredWaitingForJobManagerRunnerRegistry(); + assertJobManagerMetricGroupNotCleaned(); + + assertThat(cleanupResultFuture).isNotCompleted(); + + jobManagerRunnerRegistry.completeLocalCleanup(); + + assertGlobalCleanupNotTriggered(); + assertLocalCleanupTriggered(); + assertJobManagerMetricGroupCleaned(); + + assertThat(cleanupResultFuture).isCompleted(); + } + + @Test + public void testGlobalResourceCleaning() + throws ExecutionException, InterruptedException, TimeoutException { + assertGlobalCleanupNotTriggered(); + assertLocalCleanupNotTriggered(); + assertJobManagerMetricGroupNotCleaned(); + + final CompletableFuture<Void> cleanupResultFuture = + testInstance.createGlobalResourceCleaner().cleanupAsync(JOB_ID); + + assertGlobalCleanupTriggeredWaitingForJobManagerRunnerRegistry(); + assertLocalCleanupNotTriggered(); + assertJobManagerMetricGroupNotCleaned(); + + assertThat(cleanupResultFuture).isNotCompleted(); + + jobManagerRunnerRegistry.completeGlobalCleanup(); + + assertGlobalCleanupTriggered(); + assertLocalCleanupNotTriggered(); + assertJobManagerMetricGroupCleaned(); + + assertThat(cleanupResultFuture).isCompleted(); + } + + private void assertLocalCleanupNotTriggered() { + assertThat(jobManagerRunnerRegistry.getLocalCleanupFuture()).isNotDone(); + assertThat(jobGraphWriter.getLocalCleanupFuture()).isNotDone(); + assertThat(blobServer.getLocalCleanupFuture()).isNotDone(); + assertThat(highAvailabilityServices.getLocalCleanupFuture()).isNotDone(); + } + + private void assertLocalCleanupTriggeredWaitingForJobManagerRunnerRegistry() { + assertThat(jobManagerRunnerRegistry.getLocalCleanupFuture()).isDone(); + + // the JobManagerRunnerRegistry needs to be cleaned up first + assertThat(jobGraphWriter.getLocalCleanupFuture()).isNotDone(); + assertThat(blobServer.getLocalCleanupFuture()).isNotDone(); + assertThat(highAvailabilityServices.getLocalCleanupFuture()).isNotDone(); + } + + private void assertGlobalCleanupNotTriggered() { + assertThat(jobManagerRunnerRegistry.getGlobalCleanupFuture()).isNotDone(); + assertThat(jobGraphWriter.getGlobalCleanupFuture()).isNotDone(); + assertThat(blobServer.getGlobalCleanupFuture()).isNotDone(); + assertThat(highAvailabilityServices.getGlobalCleanupFuture()).isNotDone(); + } + + private void assertGlobalCleanupTriggeredWaitingForJobManagerRunnerRegistry() { + assertThat(jobManagerRunnerRegistry.getGlobalCleanupFuture()).isDone(); + + // the JobManagerRunnerRegistry needs to be cleaned up first + assertThat(jobGraphWriter.getGlobalCleanupFuture()).isNotDone(); + assertThat(blobServer.getGlobalCleanupFuture()).isNotDone(); + assertThat(highAvailabilityServices.getGlobalCleanupFuture()).isNotDone(); + } + + private void assertJobManagerMetricGroupNotCleaned() { + assertThat(jobManagerMetricGroup.numRegisteredJobMetricGroups()).isEqualTo(1); + } + + private void assertLocalCleanupTriggered() { + assertThat(jobManagerRunnerRegistry.getLocalCleanupFuture()).isCompleted(); + assertThat(jobGraphWriter.getLocalCleanupFuture()).isCompleted(); + assertThat(blobServer.getLocalCleanupFuture()).isCompleted(); + assertThat(highAvailabilityServices.getLocalCleanupFuture()).isCompleted(); + } + + private void assertGlobalCleanupTriggered() { + assertThat(jobManagerRunnerRegistry.getGlobalCleanupFuture()).isCompleted(); + assertThat(jobGraphWriter.getGlobalCleanupFuture()).isCompleted(); + assertThat(blobServer.getGlobalCleanupFuture()).isCompleted(); + assertThat(highAvailabilityServices.getGlobalCleanupFuture()).isCompleted(); + } + + private void assertJobManagerMetricGroupCleaned() { + assertThat(jobManagerMetricGroup.numRegisteredJobMetricGroups()).isEqualTo(0); + } + + private static class AbstractTestingCleanableResource + implements LocallyCleanableResource, GloballyCleanableResource { + + private final CompletableFuture<JobID> localCleanupFuture = new CompletableFuture<>(); + private final CompletableFuture<JobID> globalCleanupFuture = new CompletableFuture<>(); + + @Override + public void globalCleanup(JobID jobId) { + throw new UnsupportedOperationException("Synchronous globalCleanup is not supported."); + } + + @Override + public void localCleanup(JobID jobId) { + throw new UnsupportedOperationException("Synchronous localCleanup is not supported."); + } + + @Override + public CompletableFuture<Void> localCleanupAsync(JobID jobId, Executor ignoredExecutor) { + localCleanupFuture.complete(jobId); + + return FutureUtils.completedVoidFuture(); + } + + @Override + public CompletableFuture<Void> globalCleanupAsync(JobID jobId, Executor ignoredExecutor) { + globalCleanupFuture.complete(jobId); + + return FutureUtils.completedVoidFuture(); + } + + public CompletableFuture<JobID> getLocalCleanupFuture() { + return localCleanupFuture; + } + + public CompletableFuture<JobID> getGlobalCleanupFuture() { + return globalCleanupFuture; + } + } + + private static class CleanableJobGraphWriter extends AbstractTestingCleanableResource + implements JobGraphWriter { + + @Override + public void putJobGraph(JobGraph jobGraph) { + throw new UnsupportedOperationException("putJobGraph operation not supported."); + } + } + + private static class CleanableHighAvailabilityServices extends AbstractTestingCleanableResource Review comment: fair point. I refactored it. -- 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]
