GJL commented on a change in pull request #8486: [FLINK-12372] [runtime] implement ExecutionSlotAllocator URL: https://github.com/apache/flink/pull/8486#discussion_r291090481
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/scheduler/DefaultExecutionSlotAllocatorTest.java ########## @@ -0,0 +1,257 @@ +/* + * 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; + +import org.apache.flink.api.common.time.Time; +import org.apache.flink.runtime.clusterframework.types.AllocationID; +import org.apache.flink.runtime.executiongraph.TestingSlotProvider; +import org.apache.flink.runtime.jobgraph.JobVertexID; +import org.apache.flink.runtime.jobmaster.LogicalSlot; +import org.apache.flink.runtime.jobmaster.SlotRequestId; +import org.apache.flink.runtime.jobmaster.TestingLogicalSlot; +import org.apache.flink.runtime.scheduler.strategy.ExecutionVertexID; +import org.apache.flink.util.TestLogger; + +import org.junit.Before; +import org.junit.Test; + +import java.util.ArrayDeque; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.Queue; +import java.util.Set; +import java.util.concurrent.CompletableFuture; + +import static org.hamcrest.Matchers.contains; +import static org.hamcrest.Matchers.containsInAnyOrder; +import static org.hamcrest.Matchers.hasSize; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; + +/** + * Tests for {@link DefaultExecutionSlotAllocator}. + */ +public class DefaultExecutionSlotAllocatorTest extends TestLogger { + + private TestingSlotProvider slotProvider; + + private Queue<CompletableFuture<LogicalSlot>> slotFutures; + + private List<SlotRequestId> receivedSlotRequestIds; + + private List<SlotRequestId> cancelledSlotRequestIds; + + @Before + public void setUp() throws Exception { + receivedSlotRequestIds = new ArrayList<>(); + cancelledSlotRequestIds = new ArrayList<>(); + slotFutures = new ArrayDeque<>(); + + slotProvider = new TestingSlotProvider(slotRequestId -> { + receivedSlotRequestIds.add(slotRequestId); + return slotFutures.poll(); + }); + slotProvider.setSlotCanceller(slotRequestId -> cancelledSlotRequestIds.add(slotRequestId)); + } + + /** + * Tests that consumers will get slots after producers are fulfilled. + */ + @Test + public void testConsumersAssignedToSlotsAfterProducers() { + slotFutures.add(CompletableFuture.completedFuture(new TestingLogicalSlot())); + slotFutures.add(CompletableFuture.completedFuture(new TestingLogicalSlot())); + final ExecutionVertexID producerId = new ExecutionVertexID(new JobVertexID(), 0); + final ExecutionVertexID consumerId = new ExecutionVertexID(new JobVertexID(), 0); + + final TestingInputsLocationsRetriever inputsLocationsRetriever = new TestingInputsLocationsRetriever.Builder() + .connectConsumerToProducer(consumerId, producerId) + .build(); + + final DefaultExecutionSlotAllocator executionSlotAllocator = createExecutionSlotAllocator(inputsLocationsRetriever); + + inputsLocationsRetriever.markScheduled(producerId); + inputsLocationsRetriever.markScheduled(consumerId); + + final List<ExecutionVertexSchedulingRequirements> schedulingRequirements = createSchedulingRequirements(producerId, consumerId); + final Collection<SlotExecutionVertexAssignment> slotExecutionVertexAssignments = executionSlotAllocator.allocateSlotsFor(schedulingRequirements); + assertThat(slotExecutionVertexAssignments, hasSize(2)); + + final SlotExecutionVertexAssignment producerSlotAssignment = findSlotAssignmentByExecutionVertexId(producerId, slotExecutionVertexAssignments); + final SlotExecutionVertexAssignment consumerSlotAssignment = findSlotAssignmentByExecutionVertexId(consumerId, slotExecutionVertexAssignments); + + assertTrue(producerSlotAssignment.getLogicalSlotFuture().isDone()); + assertFalse(consumerSlotAssignment.getLogicalSlotFuture().isDone()); + + inputsLocationsRetriever.assignTaskManagerLocation(producerId); + + assertTrue(consumerSlotAssignment.getLogicalSlotFuture().isDone()); + assertThat(executionSlotAllocator.getPendingSlotAssignments().keySet(), hasSize(0)); + } + + /** + * Tests that cancels an execution vertex which is not existed. + */ + @Test + public void testCancelNonExistingExecutionVertex() { + final TestingInputsLocationsRetriever inputsLocationsRetriever = new TestingInputsLocationsRetriever.Builder() + .build(); + + final DefaultExecutionSlotAllocator executionSlotAllocator = createExecutionSlotAllocator(inputsLocationsRetriever); + + ExecutionVertexID inValidExecutionVertexId = new ExecutionVertexID(new JobVertexID(), 0); + executionSlotAllocator.cancel(inValidExecutionVertexId); + + assertThat(cancelledSlotRequestIds, hasSize(0)); + } + + /** + * Tests that cancels a slot request which has already been fulfilled. + */ + @Test + public void testCancelFulfilledSlotRequest() { + slotFutures.add(CompletableFuture.completedFuture(new TestingLogicalSlot())); + final ExecutionVertexID producerId = new ExecutionVertexID(new JobVertexID(), 0); + + final TestingInputsLocationsRetriever inputsLocationsRetriever = new TestingInputsLocationsRetriever.Builder() + .build(); + + final DefaultExecutionSlotAllocator executionSlotAllocator = createExecutionSlotAllocator(inputsLocationsRetriever); + + final List<ExecutionVertexSchedulingRequirements> schedulingRequirements = + createSchedulingRequirements(producerId); + executionSlotAllocator.allocateSlotsFor(schedulingRequirements); + + executionSlotAllocator.cancel(producerId); + + assertThat(cancelledSlotRequestIds, hasSize(0)); + } + + /** + * Tests that cancels a slot request which has not been fulfilled. + */ + @Test + public void testCancelUnFulfilledSlotRequest() { + slotFutures.add(new CompletableFuture<>()); + final ExecutionVertexID producerId = new ExecutionVertexID(new JobVertexID(), 0); + + final TestingInputsLocationsRetriever inputsLocationsRetriever = new TestingInputsLocationsRetriever.Builder() + .build(); + + final DefaultExecutionSlotAllocator executionSlotAllocator = createExecutionSlotAllocator(inputsLocationsRetriever); + + final List<ExecutionVertexSchedulingRequirements> schedulingRequirements = + createSchedulingRequirements(producerId); + executionSlotAllocator.allocateSlotsFor(schedulingRequirements); + + executionSlotAllocator.cancel(producerId); + + assertThat(cancelledSlotRequestIds, hasSize(1)); + assertThat(cancelledSlotRequestIds, contains(receivedSlotRequestIds.toArray())); + } + + /** + * Tests that all unfulfilled slot requests will be cancelled when stopped. + */ + @Test + public void testStop() { + slotFutures.add(new CompletableFuture<>()); + final ExecutionVertexID producerId = new ExecutionVertexID(new JobVertexID(), 0); + final ExecutionVertexID consumerId = new ExecutionVertexID(new JobVertexID(), 0); + + final TestingInputsLocationsRetriever inputsLocationsRetriever = new TestingInputsLocationsRetriever.Builder() + .connectConsumerToProducer(consumerId, producerId) + .build(); + + final DefaultExecutionSlotAllocator executionSlotAllocator = createExecutionSlotAllocator(inputsLocationsRetriever); + + inputsLocationsRetriever.markScheduled(producerId); + + final List<ExecutionVertexSchedulingRequirements> schedulingRequirements = + createSchedulingRequirements(producerId, consumerId); + executionSlotAllocator.allocateSlotsFor(schedulingRequirements); + + executionSlotAllocator.stop().getNow(null); + + assertThat(cancelledSlotRequestIds, hasSize(1)); + assertThat(cancelledSlotRequestIds, contains(receivedSlotRequestIds.toArray())); + assertThat(executionSlotAllocator.getPendingSlotAssignments().keySet(), hasSize(0)); + } + + /** + * Tests that all prior allocation ids are computed by union all previous allocation ids in scheduling requirements. + */ + @Test + public void testComputeAllPriorAllocationIds() { + List<AllocationID> expectAllocationIds = Arrays.asList(new AllocationID(), new AllocationID()); + List<ExecutionVertexSchedulingRequirements> testSchedulingRequirements = Arrays.asList( + new ExecutionVertexSchedulingRequirements.Builder(). + withExecutionVertexId(new ExecutionVertexID(new JobVertexID(), 0)). + withPreviousAllocationId(expectAllocationIds.get(0)). + build(), + new ExecutionVertexSchedulingRequirements.Builder(). + withExecutionVertexId(new ExecutionVertexID(new JobVertexID(), 1)). + withPreviousAllocationId(expectAllocationIds.get(0)). + build(), + new ExecutionVertexSchedulingRequirements.Builder(). + withExecutionVertexId(new ExecutionVertexID(new JobVertexID(), 2)). + withPreviousAllocationId(expectAllocationIds.get(1)). + build(), + new ExecutionVertexSchedulingRequirements.Builder(). + withExecutionVertexId(new ExecutionVertexID(new JobVertexID(), 3)). + build() + ); + + final TestingInputsLocationsRetriever inputsLocationsRetriever = new TestingInputsLocationsRetriever.Builder() + .build(); + final DefaultExecutionSlotAllocator executionSlotAllocator = createExecutionSlotAllocator(inputsLocationsRetriever); + + Set<AllocationID> allPriorAllocationIds = executionSlotAllocator.computeAllPriorAllocationIds(testSchedulingRequirements); + assertThat(allPriorAllocationIds, containsInAnyOrder(expectAllocationIds.toArray())); + } + + private DefaultExecutionSlotAllocator createExecutionSlotAllocator(InputsLocationsRetriever inputsLocationsRetriever) { + + return new DefaultExecutionSlotAllocator(slotProvider, inputsLocationsRetriever, Time.seconds(10)); + } + + private List<ExecutionVertexSchedulingRequirements> createSchedulingRequirements(ExecutionVertexID... executionVertexIds) { + List<ExecutionVertexSchedulingRequirements> schedulingRequirements = new ArrayList<>(executionVertexIds.length); + + for (ExecutionVertexID executionVertexId : executionVertexIds) { + schedulingRequirements.add(new ExecutionVertexSchedulingRequirements.Builder() + .withExecutionVertexId(executionVertexId).build()); + } + return schedulingRequirements; + } + + private SlotExecutionVertexAssignment findSlotAssignmentByExecutionVertexId( + ExecutionVertexID executionVertexId, + Collection<SlotExecutionVertexAssignment> slotExecutionVertexAssignments) { + for (SlotExecutionVertexAssignment slotExecutionVertexAssignment : slotExecutionVertexAssignments) { + if (slotExecutionVertexAssignment.getExecutionVertexId().equals(executionVertexId)) { + return slotExecutionVertexAssignment; + } + } + return null; Review comment: This method should throw `IllegalArgumentException` instead of returning `null` otherwise the error will just surface as a `NullPointerException` a bit later in the code. For example: ``` private static SlotExecutionVertexAssignment findSlotAssignmentByExecutionVertexId( ExecutionVertexID executionVertexId, Collection<SlotExecutionVertexAssignment> slotExecutionVertexAssignments) { return slotExecutionVertexAssignments.stream() .filter(slotExecutionVertexAssignment -> slotExecutionVertexAssignment.getExecutionVertexId().equals(executionVertexId)) .findFirst() .orElseThrow(() -> new IllegalArgumentException(String.format( "SlotExecutionVertexAssignment with execution vertex id %s not found", executionVertexId))); } ``` ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services
