|
| 1 | +/* |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | + * contributor license agreements. See the NOTICE file distributed with |
| 4 | + * this work for additional information regarding copyright ownership. |
| 5 | + * The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | + * (the "License"); you may not use this file except in compliance with |
| 7 | + * the License. You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | +package org.apache.camel.cli.connector; |
| 18 | + |
| 19 | +import java.io.File; |
| 20 | +import java.nio.file.Path; |
| 21 | +import java.util.concurrent.CountDownLatch; |
| 22 | +import java.util.concurrent.TimeUnit; |
| 23 | + |
| 24 | +import org.apache.camel.impl.DefaultCamelContext; |
| 25 | +import org.apache.camel.util.json.JsonObject; |
| 26 | +import org.junit.jupiter.api.AfterEach; |
| 27 | +import org.junit.jupiter.api.BeforeEach; |
| 28 | +import org.junit.jupiter.api.Test; |
| 29 | +import org.junit.jupiter.api.io.TempDir; |
| 30 | +import org.junit.jupiter.api.parallel.Isolated; |
| 31 | + |
| 32 | +import static org.assertj.core.api.Assertions.assertThat; |
| 33 | +import static org.awaitility.Awaitility.await; |
| 34 | + |
| 35 | +/** |
| 36 | + * CAMEL-26396: a stop waits for the status write in flight, so a stopped integration leaves no status file behind. The |
| 37 | + * Camel CLI lists a live process with a status file as a running integration: the MCP server, whose scratch contexts |
| 38 | + * ran with the connector, listed itself and took itself for the integration to evaluate in. |
| 39 | + * <p> |
| 40 | + * Isolated because it changes {@code user.home}, and every connector in this JVM writes files named after the same pid. |
| 41 | + */ |
| 42 | +@Isolated |
| 43 | +class FileCliConnectorTransportStopTest { |
| 44 | + |
| 45 | + private static final String PID = String.valueOf(ProcessHandle.current().pid()); |
| 46 | + |
| 47 | + @TempDir |
| 48 | + Path home; |
| 49 | + |
| 50 | + private String oldHome; |
| 51 | + private DefaultCamelContext context; |
| 52 | + |
| 53 | + @BeforeEach |
| 54 | + void useHome() { |
| 55 | + oldHome = System.getProperty("user.home"); |
| 56 | + System.setProperty("user.home", home.toString()); |
| 57 | + context = new DefaultCamelContext(); |
| 58 | + } |
| 59 | + |
| 60 | + @AfterEach |
| 61 | + void restoreHome() { |
| 62 | + context.stop(); |
| 63 | + System.setProperty("user.home", oldHome); |
| 64 | + } |
| 65 | + |
| 66 | + @Test |
| 67 | + void aStatusWriteInFlightDoesNotOutliveTheStop() throws Exception { |
| 68 | + SlowSnapshots snapshots = new SlowSnapshots(); |
| 69 | + FileCliConnectorTransport transport = new FileCliConnectorTransport(); |
| 70 | + transport.configure(context, (action, output) -> false, snapshots, () -> { |
| 71 | + }); |
| 72 | + transport.start(); |
| 73 | + File status = home.resolve(".camel").resolve(PID + "-status.json").toFile(); |
| 74 | + // the first poll collects the status, which takes until the test lets it go on |
| 75 | + assertThat(snapshots.collecting.await(10, TimeUnit.SECONDS)).isTrue(); |
| 76 | + |
| 77 | + Thread stopper = new Thread(transport::stop, "test-stop"); |
| 78 | + stopper.start(); |
| 79 | + // the stop is done, as it was at once before the fix, or it waits for the poll |
| 80 | + await().atMost(10, TimeUnit.SECONDS).until(() -> switch (stopper.getState()) { |
| 81 | + case TERMINATED, WAITING, TIMED_WAITING -> true; |
| 82 | + default -> false; |
| 83 | + }); |
| 84 | + snapshots.collected.countDown(); |
| 85 | + |
| 86 | + stopper.join(10_000); |
| 87 | + assertThat(stopper.isAlive()).isFalse(); |
| 88 | + // the poll has written the status, before the stop removed the files or after |
| 89 | + snapshots.poll.join(10_000); |
| 90 | + assertThat(snapshots.poll.isAlive()).isFalse(); |
| 91 | + assertThat(status).doesNotExist(); |
| 92 | + } |
| 93 | + |
| 94 | + /** |
| 95 | + * Snapshots whose status takes until the test counts down {@link #collected}. |
| 96 | + */ |
| 97 | + private static final class SlowSnapshots implements CliSnapshotProducer { |
| 98 | + |
| 99 | + final CountDownLatch collecting = new CountDownLatch(1); |
| 100 | + final CountDownLatch collected = new CountDownLatch(1); |
| 101 | + volatile Thread poll; |
| 102 | + |
| 103 | + @Override |
| 104 | + public JsonObject status() throws Exception { |
| 105 | + poll = Thread.currentThread(); |
| 106 | + collecting.countDown(); |
| 107 | + collected.await(10, TimeUnit.SECONDS); |
| 108 | + JsonObject context = new JsonObject(); |
| 109 | + context.put("name", "demo"); |
| 110 | + context.put("phase", 4); |
| 111 | + JsonObject root = new JsonObject(); |
| 112 | + root.put("context", context); |
| 113 | + return root; |
| 114 | + } |
| 115 | + |
| 116 | + @Override |
| 117 | + public JsonObject trace() { |
| 118 | + return null; |
| 119 | + } |
| 120 | + |
| 121 | + @Override |
| 122 | + public JsonObject debug() { |
| 123 | + return null; |
| 124 | + } |
| 125 | + |
| 126 | + @Override |
| 127 | + public JsonObject messageHistory() { |
| 128 | + return null; |
| 129 | + } |
| 130 | + |
| 131 | + @Override |
| 132 | + public JsonObject errors() { |
| 133 | + return null; |
| 134 | + } |
| 135 | + |
| 136 | + @Override |
| 137 | + public JsonObject receive() { |
| 138 | + return null; |
| 139 | + } |
| 140 | + |
| 141 | + @Override |
| 142 | + public JsonObject activity() { |
| 143 | + return null; |
| 144 | + } |
| 145 | + } |
| 146 | +} |
0 commit comments