GJL commented on a change in pull request #9672: [FLINK-14047][rest] Let JobConfigHandler replace sensitive values from user configuration URL: https://github.com/apache/flink/pull/9672#discussion_r323225997
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/rest/handler/job/JobConfigHandlerTest.java ########## @@ -0,0 +1,97 @@ +/* + * 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; + +import org.apache.flink.api.common.ArchivedExecutionConfig; +import org.apache.flink.api.common.JobID; +import org.apache.flink.configuration.ConfigurationUtils; +import org.apache.flink.runtime.executiongraph.AccessExecutionGraph; +import org.apache.flink.runtime.rest.handler.HandlerRequest; +import org.apache.flink.runtime.rest.handler.HandlerRequestException; +import org.apache.flink.runtime.rest.handler.legacy.ExecutionGraphCache; +import org.apache.flink.runtime.rest.handler.legacy.utils.ArchivedExecutionConfigBuilder; +import org.apache.flink.runtime.rest.handler.legacy.utils.ArchivedExecutionGraphBuilder; +import org.apache.flink.runtime.rest.messages.EmptyRequestBody; +import org.apache.flink.runtime.rest.messages.JobConfigHeaders; +import org.apache.flink.runtime.rest.messages.JobConfigInfo; +import org.apache.flink.runtime.rest.messages.JobIDPathParameter; +import org.apache.flink.runtime.rest.messages.JobMessageParameters; +import org.apache.flink.runtime.testingUtils.TestingUtils; +import org.apache.flink.util.TestLogger; + +import org.junit.Test; + +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +import static org.hamcrest.CoreMatchers.equalTo; +import static org.hamcrest.CoreMatchers.is; +import static org.hamcrest.MatcherAssert.assertThat; + +/** + * Test for the {@link JobConfigHandler}. + */ +public class JobConfigHandlerTest extends TestLogger { + + @Test + public void handleRequest_executionConfigWithSecretValues_excludesSecretValuesFromResponse() throws HandlerRequestException { + final JobConfigHandler jobConfigHandler = new JobConfigHandler( + () -> null, + TestingUtils.TIMEOUT(), + Collections.emptyMap(), + JobConfigHeaders.getInstance(), + new ExecutionGraphCache(TestingUtils.TIMEOUT(), TestingUtils.TIMEOUT()), + TestingUtils.defaultExecutor()); + + final Map<String, String> globalJobParameters = new HashMap<>(); + globalJobParameters.put("foobar", "barfoo"); + globalJobParameters.put("bar.secret.foo", "my secret"); + globalJobParameters.put("password.to.my.safe", "12345"); + + final ArchivedExecutionConfig archivedExecutionConfig = new ArchivedExecutionConfigBuilder() + .setGlobalJobParameters(globalJobParameters) + .build(); + final AccessExecutionGraph archivedExecutionGraph = new ArchivedExecutionGraphBuilder() + .setArchivedExecutionConfig(archivedExecutionConfig) + .build(); + final HandlerRequest<EmptyRequestBody, JobMessageParameters> handlerRequest = createRequest(archivedExecutionGraph.getJobID()); + + final JobConfigInfo jobConfigInfoResponse = jobConfigHandler.handleRequest(handlerRequest, archivedExecutionGraph); + + final Map<String, String> filteredGlobalJobParameters = filterSecretValues(globalJobParameters); + + assertThat(jobConfigInfoResponse.getExecutionConfigInfo().getGlobalJobParameters(), is(equalTo(filteredGlobalJobParameters))); + } + + private Map<String, String> filterSecretValues(Map<String, String> globalJobParameters) { + return ConfigurationUtils.hideSensitiveValues(globalJobParameters); + } + + private HandlerRequest<EmptyRequestBody, JobMessageParameters> createRequest(JobID jobId) throws HandlerRequestException { + final HashMap<String, String> pathParameters = new HashMap<>(); Review comment: Imo we should be strict and declare `pathParameters` as `Map<String, String>`. It would also be consistent with the rest of this file. ---------------------------------------------------------------- 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 With regards, Apache Git Services
