| /* |
| * 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.geode.internal.process; |
| |
| import static java.util.concurrent.TimeUnit.MILLISECONDS; |
| import static java.util.concurrent.TimeUnit.MINUTES; |
| import static org.apache.geode.test.awaitility.GeodeAwaitility.await; |
| import static org.assertj.core.api.Assertions.assertThat; |
| import static org.assertj.core.api.Assertions.assertThatThrownBy; |
| import static org.assertj.core.api.Assertions.catchThrowable; |
| import static org.mockito.Mockito.mock; |
| import static org.mockito.Mockito.when; |
| |
| import java.io.File; |
| import java.nio.charset.Charset; |
| import java.util.concurrent.TimeoutException; |
| import java.util.concurrent.atomic.AtomicReference; |
| |
| import org.apache.commons.io.FileUtils; |
| import org.junit.Before; |
| import org.junit.Ignore; |
| import org.junit.Rule; |
| import org.junit.Test; |
| import org.junit.rules.ErrorCollector; |
| import org.junit.rules.TemporaryFolder; |
| import org.junit.rules.TestName; |
| |
| import org.apache.geode.distributed.AbstractLauncher.Status; |
| import org.apache.geode.distributed.LocatorLauncher; |
| import org.apache.geode.distributed.LocatorLauncher.Builder; |
| import org.apache.geode.distributed.LocatorLauncher.LocatorState; |
| import org.apache.geode.internal.process.io.EmptyFileWriter; |
| import org.apache.geode.test.junit.rules.ExecutorServiceRule; |
| |
| /** |
| * Integration tests for {@link FileProcessController}. |
| * |
| * <p> |
| * This test shows one of the more appropriate uses of ErrorCollector Rule -- catching any failed |
| * assertions in another thread that isn't the main JUnit thread. |
| */ |
| public class FileProcessControllerIntegrationTest { |
| |
| private static final String STATUS_JSON = generateStatusJson(); |
| |
| private final AtomicReference<String> statusRef = new AtomicReference<>(); |
| |
| private File pidFile; |
| private File statusFile; |
| private File statusRequestFile; |
| private File stopRequestFile; |
| private int pid; |
| private FileControllerParameters params; |
| |
| @Rule |
| public ExecutorServiceRule executorServiceRule = new ExecutorServiceRule(); |
| |
| @Rule |
| public ErrorCollector errorCollector = new ErrorCollector(); |
| |
| @Rule |
| public TemporaryFolder temporaryFolder = new TemporaryFolder(); |
| |
| @Rule |
| public TestName testName = new TestName(); |
| |
| @Before |
| public void setUp() throws Exception { |
| ProcessType processType = ProcessType.LOCATOR; |
| File directory = temporaryFolder.getRoot(); |
| pidFile = new File(directory, processType.getPidFileName()); |
| statusFile = new File(directory, processType.getStatusFileName()); |
| statusRequestFile = new File(directory, processType.getStatusRequestFileName()); |
| stopRequestFile = new File(directory, processType.getStopRequestFileName()); |
| pid = ProcessUtils.identifyPid(); |
| |
| params = mock(FileControllerParameters.class); |
| when(params.getPidFile()).thenReturn(pidFile); |
| when(params.getProcessId()).thenReturn(pid); |
| when(params.getProcessType()).thenReturn(processType); |
| when(params.getDirectory()).thenReturn(temporaryFolder.getRoot()); |
| } |
| |
| @Test |
| public void statusShouldAwaitTimeoutWhileFileIsEmpty() throws Exception { |
| // given: FileProcessController with empty pidFile |
| FileProcessController controller = new FileProcessController(params, pid, 10, MILLISECONDS); |
| |
| // when: |
| Throwable thrown = catchThrowable(() -> controller.status()); |
| |
| // then: we expect TimeoutException to be thrown |
| assertThat(thrown).isInstanceOf(TimeoutException.class) |
| .hasMessageContaining("Timed out waiting for process to create").hasNoCause(); |
| } |
| |
| @Test |
| public void statusShouldReturnJsonFromStatusFile() throws Exception { |
| // given: FileProcessController with pidFile containing real pid |
| FileUtils.writeStringToFile(pidFile, String.valueOf(pid), Charset.defaultCharset()); |
| FileProcessController controller = new FileProcessController(params, pid, 2, MINUTES); |
| |
| // create an empty dummy stale status file that needs to be deleted before we write our own |
| // "real" status file |
| statusFile.createNewFile(); |
| // when: status is called in one thread |
| executorServiceRule.execute(() -> { |
| try { |
| statusRef.set(controller.status()); |
| } catch (Exception e) { |
| errorCollector.addError(e); |
| } |
| }); |
| await().untilAsserted(() -> assertThat(statusFile.exists()).isEqualTo(false)); |
| |
| // and: json is written to the status file |
| FileUtils.writeStringToFile(statusFile, STATUS_JSON, Charset.defaultCharset()); |
| |
| // then: returned status should be the json in the file |
| await().untilAsserted(() -> assertThat(statusRef.get()).isEqualTo(STATUS_JSON)); |
| } |
| |
| /** |
| * This is a new test written for GEODE-3413: "Overhaul launcher tests and process tests." |
| * Unfortunately, it hangs so I have filed GEODE-3278. This test should be used to fix and verify |
| * that bug. |
| */ |
| @Ignore("GEODE-3278: Empty status file causes status server and status locator to hang") |
| @Test |
| public void emptyStatusFileCausesStatusToHang() throws Exception { |
| // given: FileProcessController with pidFile containing real pid |
| FileUtils.writeStringToFile(pidFile, String.valueOf(pid), Charset.defaultCharset()); |
| FileProcessController controller = new FileProcessController(params, pid, 2, MINUTES); |
| |
| // when: status is called in one thread |
| executorServiceRule.execute(() -> { |
| try { |
| statusRef.set(controller.status()); |
| } catch (Exception e) { |
| errorCollector.addError(e); |
| } |
| }); |
| |
| // and: json is written to the status file |
| new EmptyFileWriter(statusFile).createNewFile(); |
| |
| // then: returned status should be the json in the file |
| await().untilAsserted(() -> assertThat(statusRef.get()).isEqualTo(STATUS_JSON)); |
| } |
| |
| @Test |
| public void stopCreatesStopRequestFile() throws Exception { |
| // arrange |
| FileProcessController controller = new FileProcessController(params, pid); |
| assertThat(stopRequestFile).doesNotExist(); |
| |
| // act |
| controller.stop(); |
| |
| // assert |
| assertThat(stopRequestFile).exists(); |
| } |
| |
| @Test |
| public void stop_withStopRequestFileExists_doesNotFail() throws Exception { |
| // arrange |
| FileProcessController controller = new FileProcessController(params, pid); |
| assertThat(stopRequestFile.createNewFile()).isTrue(); |
| |
| // act |
| controller.stop(); |
| |
| // assert |
| assertThat(stopRequestFile).exists(); |
| } |
| |
| @Test |
| public void status_withStatusRequestFileExists_doesNotFail() throws Exception { |
| // arrange |
| FileProcessController controller = new FileProcessController(params, pid); |
| assertThat(statusRequestFile.createNewFile()).isTrue(); |
| |
| // act |
| executorServiceRule.execute(() -> { |
| try { |
| statusRef.set(controller.status()); |
| } catch (Exception e) { |
| errorCollector.addError(e); |
| } |
| }); |
| |
| FileUtils.writeStringToFile(statusFile, STATUS_JSON, Charset.defaultCharset()); |
| |
| // assert |
| await().untilAsserted(() -> assertThat(statusRequestFile).exists()); |
| } |
| |
| @Test |
| public void statusCreatesStatusRequestFile() throws Exception { |
| // arrange |
| FileUtils.writeStringToFile(pidFile, String.valueOf(pid), Charset.defaultCharset()); |
| FileProcessController controller = new FileProcessController(params, pid, 2, MINUTES); |
| |
| // act |
| executorServiceRule.execute(() -> { |
| try { |
| assertThatThrownBy(() -> statusRef.set(controller.status())) |
| .isInstanceOf(InterruptedException.class); |
| } catch (Throwable t) { |
| errorCollector.addError(t); |
| } |
| }); |
| |
| // assert |
| await().untilAsserted(() -> assertThat(statusRequestFile).exists()); |
| } |
| |
| private static String generateStatusJson() { |
| Builder builder = new Builder(); |
| LocatorLauncher defaultLauncher = builder.build(); |
| Status status = Status.ONLINE; |
| LocatorState locatorState = new LocatorState(defaultLauncher, status); |
| return locatorState.toJson(); |
| } |
| } |