GJL commented on a change in pull request #11542: [FLINK-16303][rest] Enable retrieval of custom JobManager log files URL: https://github.com/apache/flink/pull/11542#discussion_r407753394
########## File path: flink-runtime/src/test/java/org/apache/flink/runtime/rest/handler/cluster/JobManagerLogListHandlerTest.java ########## @@ -0,0 +1,142 @@ +/* + * 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.cluster; + +import org.apache.flink.configuration.Configuration; +import org.apache.flink.configuration.WebOptions; +import org.apache.flink.runtime.dispatcher.DispatcherGateway; +import org.apache.flink.runtime.rest.handler.HandlerRequest; +import org.apache.flink.runtime.rest.handler.HandlerRequestException; +import org.apache.flink.runtime.rest.messages.EmptyMessageParameters; +import org.apache.flink.runtime.rest.messages.EmptyRequestBody; +import org.apache.flink.runtime.rest.messages.LogInfo; +import org.apache.flink.runtime.rest.messages.LogListInfo; +import org.apache.flink.runtime.rest.messages.cluster.JobManagerLogListHeaders; +import org.apache.flink.runtime.testingUtils.TestingUtils; +import org.apache.flink.runtime.webmonitor.TestingDispatcherGateway; +import org.apache.flink.runtime.webmonitor.WebMonitorUtils; +import org.apache.flink.util.TestLogger; + +import org.apache.commons.io.FileUtils; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Rule; +import org.junit.Test; +import org.junit.rules.TemporaryFolder; + +import java.io.File; +import java.io.IOException; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; +import java.util.concurrent.CompletableFuture; + +import static org.hamcrest.Matchers.empty; +import static org.hamcrest.Matchers.hasSize; +import static org.hamcrest.Matchers.is; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertThat; + +/** + * Test for the {@link JobManagerLogListHandler}. + */ +public class JobManagerLogListHandlerTest extends TestLogger { + + private DispatcherGateway mockRestfulGateway; + + private static HandlerRequest<EmptyRequestBody, EmptyMessageParameters> testRequest; + + @Rule + public TemporaryFolder temporaryFolder = new TemporaryFolder(); + + @BeforeClass + public static void setupClass() throws HandlerRequestException { + testRequest = new HandlerRequest<>(EmptyRequestBody.getInstance(), EmptyMessageParameters.getInstance(), Collections.emptyMap(), Collections.emptyMap()); + } + + @Before + public void setUp() throws Exception { + mockRestfulGateway = new TestingDispatcherGateway.Builder().build(); + } + + @Test + public void testGetJobManagerLogsList() throws Exception { + String jobmanagerLogContent = "jobmanager log content"; + String jobmanagerStdoutContent = "jobmanager stdout content"; + String jobmanagerCustomLogContent = "jobmanager custom log content"; + + LogInfo jobmanagerLog = new LogInfo("jobmanager.log", jobmanagerLogContent.length()); + LogInfo jobmanagerStdout = new LogInfo("jobmanager.out", jobmanagerStdoutContent.length()); + LogInfo customLog = new LogInfo("test.log", jobmanagerCustomLogContent.length()); + + Map<LogInfo, String> logInfo2ContentMap = new HashMap<>(3); + logInfo2ContentMap.put(jobmanagerLog, jobmanagerLogContent); + logInfo2ContentMap.put(jobmanagerStdout, jobmanagerStdoutContent); + logInfo2ContentMap.put(customLog, jobmanagerCustomLogContent); + + Map<String, LogInfo> fileNameAndLogInfoMap = new HashMap<>(3); + fileNameAndLogInfoMap.put(jobmanagerLog.getName(), jobmanagerLog); + fileNameAndLogInfoMap.put(jobmanagerStdout.getName(), jobmanagerStdout); + fileNameAndLogInfoMap.put(customLog.getName(), customLog); + + JobManagerLogListHandler jobManagerLogListHandler = createHandler(logInfo2ContentMap); + LogListInfo logListInfo = jobManagerLogListHandler.handleRequest(testRequest, mockRestfulGateway).get(); + + assertThat(logListInfo.getLogInfos(), hasSize(logInfo2ContentMap.size())); + for (LogInfo logInfo : logListInfo.getLogInfos()) { + assertEquals(logInfo, fileNameAndLogInfoMap.get(logInfo.getName())); + } + } + + @Test + public void testGetJobManagerLogsListWhenLogDirIsNull() throws Exception { + JobManagerLogListHandler jobManagerLogListHandler = createHandler(Collections.emptyMap()); + LogListInfo logListInfo = jobManagerLogListHandler.handleRequest(testRequest, mockRestfulGateway).get(); + assertThat(logListInfo.getLogInfos(), is(empty())); + } + + private JobManagerLogListHandler createHandler(Map<LogInfo, String> logInfo2ContentMap) { + WebMonitorUtils.LogFileLocation logFileLocation = createLogFileLocation(logInfo2ContentMap); + return new JobManagerLogListHandler( + () -> CompletableFuture.completedFuture(null), + TestingUtils.TIMEOUT(), + Collections.emptyMap(), + JobManagerLogListHeaders.getInstance(), + logFileLocation.logDir); + } + + private WebMonitorUtils.LogFileLocation createLogFileLocation(Map<LogInfo, String> logInfo2ContentMap) { + Configuration config = new Configuration(); + try { + for (Map.Entry<LogInfo, String> logInfo2Content : logInfo2ContentMap.entrySet()) { + LogInfo logInfo = logInfo2Content.getKey(); + String content = logInfo2Content.getValue(); + File file = temporaryFolder.newFile(logInfo.getName()); + FileUtils.writeStringToFile(file, content); Review comment: We should make sure that the file is UTF-8 or ASCII encoded otherwise we risk that one ASCII character is not one byte. `writeStringToFile` uses the system's default character set. I fixed it before merging. ---------------------------------------------------------------- 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
