oscerd commented on code in PR #26734: URL: https://github.com/apache/camel/pull/26734#discussion_r4080201259
########## core/camel-core/src/test/java/org/apache/camel/util/HttpResourceTimeoutTest.java: ########## @@ -0,0 +1,173 @@ +/* + * 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.camel.util; + +import java.io.IOException; +import java.net.ServerSocket; +import java.net.Socket; +import java.net.SocketTimeoutException; +import java.util.Properties; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import org.apache.camel.CamelContext; +import org.apache.camel.impl.DefaultCamelContext; +import org.apache.camel.impl.engine.DefaultResourceResolvers; +import org.apache.camel.spi.Resource; +import org.apache.camel.support.ResourceHelper; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * An {@code http:} resource must not be able to stall the caller forever. + * <p/> + * The server here accepts the connection and then never answers, which is the only shape that reproduces the problem: a + * refused connection fails fast on its own, so nothing is proven by pointing at a closed port. + * <p/> + * The timeouts below are deliberately {@code SEPARATE_THREAD}: the default mode only measures elapsed time once the + * test method returns, so a regression that restores the indefinite wait would hang the build instead of failing it. + */ +public class HttpResourceTimeoutTest { Review Comment: Not applying this one, and I want to lay out why rather than just say no — I checked the citation before acting on it. **The rule is not in CLAUDE.md.** Grepping the file for a test-visibility convention returns nothing; the only `public`-related rules are the `@since` tag requirements for `core/camel-api`: ``` $ grep -icE "test (class|method).*(public|visibility)" CLAUDE.md 0 ``` **And the convention runs the other way.** In the module this test lives in: | | count | |---|---| | `public class …Test` in `core/camel-core` | 2725 | | package-private `class …Test` | 112 | The immediate neighbour, which this test sits beside and was written to match, is `public class ResourceHelperTest extends TestSupport`. So making this class and its five methods package-private would make it the outlier, which is the opposite of what a consistency rule is for. JUnit 5 is happy either way, so there is no technical driver either. Happy to switch if a committer tells me the project is deliberately moving to package-private test classes and the 112 are the leading edge rather than the tail — but that would be a project-wide decision and a much larger change than this PR, not something to settle in one new file. This is the second review this week to cite a convention I could not find in the file, so I have started grepping before applying rather than taking the citation at face value. Flagging it in case the same source is generating it elsewhere. _Claude Code on behalf of @oscerd_ ########## core/camel-core/src/test/java/org/apache/camel/util/HttpResourceTimeoutTest.java: ########## @@ -0,0 +1,173 @@ +/* + * 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.camel.util; + +import java.io.IOException; +import java.net.ServerSocket; +import java.net.Socket; +import java.net.SocketTimeoutException; +import java.util.Properties; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import org.apache.camel.CamelContext; +import org.apache.camel.impl.DefaultCamelContext; +import org.apache.camel.impl.engine.DefaultResourceResolvers; +import org.apache.camel.spi.Resource; +import org.apache.camel.support.ResourceHelper; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * An {@code http:} resource must not be able to stall the caller forever. + * <p/> + * The server here accepts the connection and then never answers, which is the only shape that reproduces the problem: a + * refused connection fails fast on its own, so nothing is proven by pointing at a closed port. + * <p/> + * The timeouts below are deliberately {@code SEPARATE_THREAD}: the default mode only measures elapsed time once the + * test method returns, so a regression that restores the indefinite wait would hang the build instead of failing it. + */ +public class HttpResourceTimeoutTest { + + private ServerSocket server; + private Thread acceptor; + private CountDownLatch accepted; + private volatile boolean stopped; + + @BeforeEach + void startMuteServer() throws Exception { + server = new ServerSocket(0); + accepted = new CountDownLatch(1); + acceptor = new Thread(() -> { + while (!stopped) { + try (Socket socket = server.accept()) { + accepted.countDown(); + // hold the connection open and write nothing at all, so the client is left waiting on a read + while (!stopped && !socket.isClosed()) { + Thread.onSpinWait(); + } + } catch (IOException e) { + return; + } + } + }, "mute-http-server"); + acceptor.setDaemon(true); + acceptor.start(); + stopped = false; + } + + @AfterEach + void stopMuteServer() throws Exception { + stopped = true; + server.close(); + acceptor.join(TimeUnit.SECONDS.toMillis(5)); + } + + private CamelContext contextWithReadTimeout(String millis) { + CamelContext context = new DefaultCamelContext(); + Properties properties = new Properties(); + properties.setProperty(DefaultResourceResolvers.HTTP_READ_TIMEOUT_PROPERTY, millis); + context.getPropertiesComponent().setInitialProperties(properties); + context.start(); + return context; + } + + private String muteUrl() { + return "http://localhost:"; + server.getLocalPort() + "/policy.rego"; + } + + @Test + @Timeout(value = 30, threadMode = Timeout.ThreadMode.SEPARATE_THREAD) + public void getInputStreamGivesUpOnAServerThatNeverAnswers() throws Exception { Review Comment: Covered by the reply on the class-declaration thread: the CLAUDE.md test-visibility rule this follows from is not in the file, and `core/camel-core` is 2725 public test classes to 112 package-private, with `ResourceHelperTest` next door public. Leaving the method as-is for consistency with the module. _Claude Code on behalf of @oscerd_ ########## core/camel-core/src/test/java/org/apache/camel/util/HttpResourceTimeoutTest.java: ########## @@ -0,0 +1,173 @@ +/* + * 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.camel.util; + +import java.io.IOException; +import java.net.ServerSocket; +import java.net.Socket; +import java.net.SocketTimeoutException; +import java.util.Properties; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import org.apache.camel.CamelContext; +import org.apache.camel.impl.DefaultCamelContext; +import org.apache.camel.impl.engine.DefaultResourceResolvers; +import org.apache.camel.spi.Resource; +import org.apache.camel.support.ResourceHelper; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * An {@code http:} resource must not be able to stall the caller forever. + * <p/> + * The server here accepts the connection and then never answers, which is the only shape that reproduces the problem: a + * refused connection fails fast on its own, so nothing is proven by pointing at a closed port. + * <p/> + * The timeouts below are deliberately {@code SEPARATE_THREAD}: the default mode only measures elapsed time once the + * test method returns, so a regression that restores the indefinite wait would hang the build instead of failing it. + */ +public class HttpResourceTimeoutTest { + + private ServerSocket server; + private Thread acceptor; + private CountDownLatch accepted; + private volatile boolean stopped; + + @BeforeEach + void startMuteServer() throws Exception { + server = new ServerSocket(0); + accepted = new CountDownLatch(1); + acceptor = new Thread(() -> { + while (!stopped) { + try (Socket socket = server.accept()) { + accepted.countDown(); + // hold the connection open and write nothing at all, so the client is left waiting on a read + while (!stopped && !socket.isClosed()) { + Thread.onSpinWait(); + } + } catch (IOException e) { + return; + } + } + }, "mute-http-server"); + acceptor.setDaemon(true); + acceptor.start(); + stopped = false; + } + + @AfterEach + void stopMuteServer() throws Exception { + stopped = true; + server.close(); + acceptor.join(TimeUnit.SECONDS.toMillis(5)); + } + + private CamelContext contextWithReadTimeout(String millis) { + CamelContext context = new DefaultCamelContext(); + Properties properties = new Properties(); + properties.setProperty(DefaultResourceResolvers.HTTP_READ_TIMEOUT_PROPERTY, millis); + context.getPropertiesComponent().setInitialProperties(properties); + context.start(); + return context; + } + + private String muteUrl() { + return "http://localhost:"; + server.getLocalPort() + "/policy.rego"; + } + + @Test + @Timeout(value = 30, threadMode = Timeout.ThreadMode.SEPARATE_THREAD) + public void getInputStreamGivesUpOnAServerThatNeverAnswers() throws Exception { + CamelContext context = contextWithReadTimeout("500"); + try { + Resource resource = ResourceHelper.resolveResource(context, muteUrl()); + + assertThrows(SocketTimeoutException.class, resource::getInputStream); + assertTrue(accepted.await(5, TimeUnit.SECONDS), + "the server should have accepted the connection - a refused connect proves nothing"); + } finally { + context.stop(); + } + } + + @Test + @Timeout(value = 30, threadMode = Timeout.ThreadMode.SEPARATE_THREAD) + public void existsGivesUpOnAServerThatNeverAnswers() throws Exception { Review Comment: Covered by the reply on the class-declaration thread: the CLAUDE.md test-visibility rule this follows from is not in the file, and `core/camel-core` is 2725 public test classes to 112 package-private, with `ResourceHelperTest` next door public. Leaving the method as-is for consistency with the module. _Claude Code on behalf of @oscerd_ ########## core/camel-core/src/test/java/org/apache/camel/util/HttpResourceTimeoutTest.java: ########## @@ -0,0 +1,173 @@ +/* + * 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.camel.util; + +import java.io.IOException; +import java.net.ServerSocket; +import java.net.Socket; +import java.net.SocketTimeoutException; +import java.util.Properties; +import java.util.concurrent.CountDownLatch; +import java.util.concurrent.TimeUnit; + +import org.apache.camel.CamelContext; +import org.apache.camel.impl.DefaultCamelContext; +import org.apache.camel.impl.engine.DefaultResourceResolvers; +import org.apache.camel.spi.Resource; +import org.apache.camel.support.ResourceHelper; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.Timeout; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * An {@code http:} resource must not be able to stall the caller forever. + * <p/> + * The server here accepts the connection and then never answers, which is the only shape that reproduces the problem: a + * refused connection fails fast on its own, so nothing is proven by pointing at a closed port. + * <p/> + * The timeouts below are deliberately {@code SEPARATE_THREAD}: the default mode only measures elapsed time once the + * test method returns, so a regression that restores the indefinite wait would hang the build instead of failing it. + */ +public class HttpResourceTimeoutTest { + + private ServerSocket server; + private Thread acceptor; + private CountDownLatch accepted; + private volatile boolean stopped; + + @BeforeEach + void startMuteServer() throws Exception { + server = new ServerSocket(0); + accepted = new CountDownLatch(1); + acceptor = new Thread(() -> { + while (!stopped) { + try (Socket socket = server.accept()) { + accepted.countDown(); + // hold the connection open and write nothing at all, so the client is left waiting on a read + while (!stopped && !socket.isClosed()) { + Thread.onSpinWait(); + } + } catch (IOException e) { + return; + } + } + }, "mute-http-server"); + acceptor.setDaemon(true); + acceptor.start(); + stopped = false; + } + + @AfterEach + void stopMuteServer() throws Exception { + stopped = true; + server.close(); + acceptor.join(TimeUnit.SECONDS.toMillis(5)); + } + + private CamelContext contextWithReadTimeout(String millis) { + CamelContext context = new DefaultCamelContext(); + Properties properties = new Properties(); + properties.setProperty(DefaultResourceResolvers.HTTP_READ_TIMEOUT_PROPERTY, millis); + context.getPropertiesComponent().setInitialProperties(properties); + context.start(); + return context; + } + + private String muteUrl() { + return "http://localhost:"; + server.getLocalPort() + "/policy.rego"; + } + + @Test + @Timeout(value = 30, threadMode = Timeout.ThreadMode.SEPARATE_THREAD) + public void getInputStreamGivesUpOnAServerThatNeverAnswers() throws Exception { + CamelContext context = contextWithReadTimeout("500"); + try { + Resource resource = ResourceHelper.resolveResource(context, muteUrl()); + + assertThrows(SocketTimeoutException.class, resource::getInputStream); + assertTrue(accepted.await(5, TimeUnit.SECONDS), + "the server should have accepted the connection - a refused connect proves nothing"); + } finally { + context.stop(); + } + } + + @Test + @Timeout(value = 30, threadMode = Timeout.ThreadMode.SEPARATE_THREAD) + public void existsGivesUpOnAServerThatNeverAnswers() throws Exception { + CamelContext context = contextWithReadTimeout("500"); + try { + Resource resource = ResourceHelper.resolveResource(context, muteUrl()); + + // exists() wraps the IOException rather than declaring it, so the timeout surfaces as the cause + IllegalArgumentException e = assertThrows(IllegalArgumentException.class, resource::exists); + assertEquals(SocketTimeoutException.class, e.getCause().getClass()); + } finally { + context.stop(); + } + } + + @Test + @Timeout(value = 30, threadMode = Timeout.ThreadMode.SEPARATE_THREAD) + public void httpsResourcesAreBoundedToo() throws Exception { Review Comment: Covered by the reply on the class-declaration thread: the CLAUDE.md test-visibility rule this follows from is not in the file, and `core/camel-core` is 2725 public test classes to 112 package-private, with `ResourceHelperTest` next door public. Leaving the method as-is for consistency with the module. _Claude Code on behalf of @oscerd_ -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
