/* * 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.rest.handler.job.savepoints; import org.apache.flink.api.common.JobID; import org.apache.flink.api.common.time.Time; import org.apache.flink.runtime.concurrent.FutureUtils; import org.apache.flink.runtime.rest.handler.HandlerRequest; import org.apache.flink.runtime.rest.handler.HandlerRequestException; import org.apache.flink.runtime.rest.handler.RestHandlerException; import org.apache.flink.runtime.rest.handler.async.AsynchronousOperationResult; import org.apache.flink.runtime.rest.messages.EmptyRequestBody; import org.apache.flink.runtime.rest.messages.JobIDPathParameter; import org.apache.flink.runtime.rest.messages.TriggerId; import org.apache.flink.runtime.rest.messages.TriggerIdPathParameter; import org.apache.flink.runtime.rest.messages.job.savepoints.SavepointInfo; import org.apache.flink.runtime.rest.messages.job.savepoints.SavepointStatusMessageParameters; import org.apache.flink.runtime.rest.messages.job.savepoints.SavepointTriggerMessageParameters; import org.apache.flink.runtime.rest.messages.job.savepoints.stop.StopWithSavepointRequestBody; import org.apache.flink.runtime.rest.messages.queue.QueueStatus; import org.apache.flink.runtime.webmonitor.RestfulGateway; import org.apache.flink.runtime.webmonitor.TestingRestfulGateway; import org.apache.flink.runtime.webmonitor.retriever.GatewayRetriever; import org.apache.flink.util.TestLogger; import org.apache.flink.shaded.netty4.io.netty.handler.codec.http.HttpResponseStatus; import org.junit.Before; import org.junit.Test; import java.util.Collections; import java.util.HashMap; import java.util.Map; import java.util.concurrent.CompletableFuture; import static org.hamcrest.Matchers.equalTo; import static org.hamcrest.Matchers.instanceOf; import static org.hamcrest.Matchers.notNullValue; import static org.junit.Assert.assertThat; import static org.junit.Assert.fail; /** * Test for the {@link org.apache.flink.runtime.rest.handler.job.savepoints.SavepointHandlers.StopWithSavepointHandler}. * * <p>Shamelessly copied from {@link SavepointHandlersTest}. */ public class StopWithSavepointHandlersTest extends TestLogger { private static final Time TIMEOUT = Time.seconds(10); private static final JobID JOB_ID = new JobID(); private static final String COMPLETED_SAVEPOINT_EXTERNAL_POINTER = "/tmp/stop-savepoint-0d2fb9-8d5e0106041a"; private static final String DEFAULT_REQUESTED_SAVEPOINT_TARGET_DIRECTORY = "/tmp"; private SavepointHandlers.StopWithSavepointHandler savepointTriggerHandler; private SavepointHandlers.SavepointStatusHandler savepointStatusHandler; private GatewayRetriever<RestfulGateway> leaderRetriever; @Before public void setUp() throws Exception { leaderRetriever = () -> CompletableFuture.completedFuture(null); final SavepointHandlers savepointHandlers = new SavepointHandlers(null); savepointTriggerHandler = savepointHandlers.new StopWithSavepointHandler( leaderRetriever, TIMEOUT, Collections.emptyMap()); savepointStatusHandler = savepointHandlers.new SavepointStatusHandler( leaderRetriever, TIMEOUT, Collections.emptyMap()); } @Test public void testSavepointCompletedSuccessfully() throws Exception { final TestingRestfulGateway testingRestfulGateway = new TestingRestfulGateway.Builder() .setStopWithSavepointFunction((JobID jobId, String targetDirectory) -> CompletableFuture.completedFuture(COMPLETED_SAVEPOINT_EXTERNAL_POINTER)) .build(); final TriggerId triggerId = savepointTriggerHandler.handleRequest( triggerSavepointRequest(), testingRestfulGateway).get().getTriggerId(); AsynchronousOperationResult<SavepointInfo> savepointResponseBody; savepointResponseBody = savepointStatusHandler.handleRequest( savepointStatusRequest(triggerId), testingRestfulGateway).get(); assertThat( savepointResponseBody.queueStatus().getId(), equalTo(QueueStatus.Id.COMPLETED)); assertThat(savepointResponseBody.resource(), notNullValue()); assertThat( savepointResponseBody.resource().getLocation(), equalTo(COMPLETED_SAVEPOINT_EXTERNAL_POINTER)); } @Test public void testTriggerSavepointWithDefaultDirectory() throws Exception { final CompletableFuture<String> targetDirectoryFuture = new CompletableFuture<>(); final TestingRestfulGateway testingRestfulGateway = new TestingRestfulGateway.Builder() .setStopWithSavepointFunction( (JobID jobId, String targetDirectory) -> { targetDirectoryFuture.complete(targetDirectory); return CompletableFuture.completedFuture(COMPLETED_SAVEPOINT_EXTERNAL_POINTER); }) .build(); final String defaultSavepointDir = "/other/dir"; final SavepointHandlers savepointHandlers = new SavepointHandlers(defaultSavepointDir); final SavepointHandlers.StopWithSavepointHandler savepointTriggerHandler = savepointHandlers.new StopWithSavepointHandler( leaderRetriever, TIMEOUT, Collections.emptyMap()); savepointTriggerHandler.handleRequest( triggerSavepointRequestWithDefaultDirectory(), testingRestfulGateway).get(); assertThat(targetDirectoryFuture.get(), equalTo(defaultSavepointDir)); } @Test public void testTriggerSavepointNoDirectory() throws Exception { TestingRestfulGateway testingRestfulGateway = new TestingRestfulGateway.Builder() .setStopWithSavepointFunction((JobID jobId, String directory) -> CompletableFuture.completedFuture(COMPLETED_SAVEPOINT_EXTERNAL_POINTER)) .build(); try { savepointTriggerHandler.handleRequest( triggerSavepointRequestWithDefaultDirectory(), testingRestfulGateway).get(); fail("Expected exception not thrown."); } catch (RestHandlerException rhe) { assertThat( rhe.getMessage(), equalTo("Config key [state.savepoints.dir] is not set. " + "Property [targetDirectory] must be provided.")); assertThat(rhe.getHttpResponseStatus(), equalTo(HttpResponseStatus.BAD_REQUEST)); } } @Test public void testSavepointCompletedWithException() throws Exception { TestingRestfulGateway testingRestfulGateway = new TestingRestfulGateway.Builder() .setStopWithSavepointFunction((JobID jobId, String directory) -> FutureUtils.completedExceptionally(new RuntimeException("expected"))) .build(); final TriggerId triggerId = savepointTriggerHandler.handleRequest( triggerSavepointRequest(), testingRestfulGateway).get().getTriggerId(); final AsynchronousOperationResult<SavepointInfo> savepointResponseBody = savepointStatusHandler.handleRequest( savepointStatusRequest(triggerId), testingRestfulGateway).get(); assertThat(savepointResponseBody.queueStatus().getId(), equalTo(QueueStatus.Id.COMPLETED)); assertThat(savepointResponseBody.resource(), notNullValue()); assertThat(savepointResponseBody.resource().getFailureCause(), notNullValue()); final Throwable savepointError = savepointResponseBody.resource() .getFailureCause() .deserializeError(ClassLoader.getSystemClassLoader()); assertThat(savepointError.getMessage(), equalTo("expected")); assertThat(savepointError, instanceOf(RuntimeException.class)); } private static HandlerRequest<StopWithSavepointRequestBody, SavepointTriggerMessageParameters> triggerSavepointRequest() throws HandlerRequestException { return triggerSavepointRequest(DEFAULT_REQUESTED_SAVEPOINT_TARGET_DIRECTORY); } private static HandlerRequest<StopWithSavepointRequestBody, SavepointTriggerMessageParameters> triggerSavepointRequestWithDefaultDirectory() throws HandlerRequestException { return triggerSavepointRequest(null); } private static HandlerRequest<StopWithSavepointRequestBody, SavepointTriggerMessageParameters> triggerSavepointRequest( final String targetDirectory ) throws HandlerRequestException { return new HandlerRequest<>( new StopWithSavepointRequestBody(targetDirectory, false), new SavepointTriggerMessageParameters(), Collections.singletonMap(JobIDPathParameter.KEY, JOB_ID.toString()), Collections.emptyMap()); } private static HandlerRequest<EmptyRequestBody, SavepointStatusMessageParameters> savepointStatusRequest( final TriggerId triggerId) throws HandlerRequestException { final Map<String, String> pathParameters = new HashMap<>(); pathParameters.put(JobIDPathParameter.KEY, JOB_ID.toString()); pathParameters.put(TriggerIdPathParameter.KEY, triggerId.toString()); return new HandlerRequest<>( EmptyRequestBody.getInstance(), new SavepointStatusMessageParameters(), pathParameters, Collections.emptyMap()); } }