-
Notifications
You must be signed in to change notification settings - Fork 26.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace usage of removed SocketUtils in Spring 6 with TestSocketUtils
- Loading branch information
Showing
5 changed files
with
118 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
108 changes: 108 additions & 0 deletions
108
...t/dubbo-test-common/src/main/java/org/apache/dubbo/test/common/utils/TestSocketUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /* | ||
| * Copyright 2002-2022 the original author or authors. | ||
| * | ||
| * Licensed 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 | ||
| * | ||
| * https://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.dubbo.test.common.utils; | ||
|
|
||
| import java.net.InetAddress; | ||
| import java.net.ServerSocket; | ||
| import java.security.SecureRandom; | ||
|
|
||
| import javax.net.ServerSocketFactory; | ||
|
|
||
| import org.apache.dubbo.common.utils.Assert; | ||
|
|
||
| /** | ||
| * Simple utility for finding available TCP ports on {@code localhost} for use in | ||
| * integration testing scenarios. | ||
| * | ||
| * <p>{@code TestSocketUtils} can be used in integration tests which start an | ||
| * external server on an available random port. However, these utilities make no | ||
| * guarantee about the subsequent availability of a given port and are therefore | ||
| * unreliable. Instead of using {@code TestSocketUtils} to find an available local | ||
| * port for a server, it is recommended that you rely on a server's ability to | ||
| * start on a random <em>ephemeral</em> port that it selects or is assigned by the | ||
| * operating system. To interact with that server, you should query the server | ||
| * for the port it is currently using. | ||
| * | ||
| * @since 3.2 | ||
| */ | ||
| public class TestSocketUtils { | ||
|
|
||
| /** | ||
| * The minimum value for port ranges used when finding an available TCP port. | ||
| */ | ||
| static final int PORT_RANGE_MIN = 1024; | ||
|
|
||
| /** | ||
| * The maximum value for port ranges used when finding an available TCP port. | ||
| */ | ||
| static final int PORT_RANGE_MAX = 65535; | ||
|
|
||
| private static final int PORT_RANGE_PLUS_ONE = PORT_RANGE_MAX - PORT_RANGE_MIN + 1; | ||
|
|
||
| private static final int MAX_ATTEMPTS = 1_000; | ||
|
|
||
| private static final SecureRandom random = new SecureRandom(); | ||
|
|
||
| private static final TestSocketUtils INSTANCE = new TestSocketUtils(); | ||
|
|
||
| private TestSocketUtils() { | ||
| } | ||
|
|
||
| /** | ||
| * Find an available TCP port randomly selected from the range [1024, 65535]. | ||
| * @return an available TCP port number | ||
| * @throws IllegalStateException if no available port could be found | ||
| */ | ||
| public static int findAvailableTcpPort() { | ||
| return INSTANCE.findAvailableTcpPortInternal(); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Internal implementation of {@link #findAvailableTcpPort()}. | ||
| * <p>Package-private solely for testing purposes. | ||
| */ | ||
| int findAvailableTcpPortInternal() { | ||
| int candidatePort; | ||
| int searchCounter = 0; | ||
| do { | ||
| Assert.assertTrue(++searchCounter <= MAX_ATTEMPTS, String.format( | ||
| "Could not find an available TCP port in the range [%d, %d] after %d attempts", | ||
| PORT_RANGE_MIN, PORT_RANGE_MAX, MAX_ATTEMPTS)); | ||
| candidatePort = PORT_RANGE_MIN + random.nextInt(PORT_RANGE_PLUS_ONE); | ||
| } | ||
| while (!isPortAvailable(candidatePort)); | ||
|
|
||
| return candidatePort; | ||
| } | ||
|
|
||
| /** | ||
| * Determine if the specified TCP port is currently available on {@code localhost}. | ||
| * <p>Package-private solely for testing purposes. | ||
| */ | ||
| boolean isPortAvailable(int port) { | ||
| try { | ||
| ServerSocket serverSocket = ServerSocketFactory.getDefault() | ||
| .createServerSocket(port, 1, InetAddress.getByName("localhost")); | ||
| serverSocket.close(); | ||
| return true; | ||
| } | ||
| catch (Exception ex) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters