|
| 1 | +/* |
| 2 | + * Copyright OpenSearch Contributors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +package org.opensearch.ml.common.httpclient; |
| 7 | + |
| 8 | +import static org.junit.Assert.assertEquals; |
| 9 | +import static org.junit.Assert.assertNotNull; |
| 10 | +import static org.junit.Assert.assertThrows; |
| 11 | + |
| 12 | +import java.time.Duration; |
| 13 | +import java.util.concurrent.atomic.AtomicBoolean; |
| 14 | + |
| 15 | +import org.junit.Rule; |
| 16 | +import org.junit.Test; |
| 17 | +import org.junit.rules.ExpectedException; |
| 18 | + |
| 19 | +import software.amazon.awssdk.http.async.SdkAsyncHttpClient; |
| 20 | + |
| 21 | +public class MLHttpClientFactoryTests { |
| 22 | + |
| 23 | + private static final String TEST_HOST = "api.openai.com"; |
| 24 | + private static final String HTTP = "http"; |
| 25 | + private static final String HTTPS = "https"; |
| 26 | + private static final AtomicBoolean PRIVATE_IP_DISABLED = new AtomicBoolean(false); |
| 27 | + private static final AtomicBoolean PRIVATE_IP_ENABLED = new AtomicBoolean(true); |
| 28 | + |
| 29 | + @Rule |
| 30 | + public ExpectedException expectedException = ExpectedException.none(); |
| 31 | + |
| 32 | + @Test |
| 33 | + public void test_getSdkAsyncHttpClient_success() { |
| 34 | + SdkAsyncHttpClient client = MLHttpClientFactory.getAsyncHttpClient(Duration.ofSeconds(100), Duration.ofSeconds(100), 100); |
| 35 | + assertNotNull(client); |
| 36 | + } |
| 37 | + |
| 38 | + @Test |
| 39 | + public void test_invalidIP_localHost_privateIPDisabled() { |
| 40 | + IllegalArgumentException e1 = assertThrows( |
| 41 | + IllegalArgumentException.class, |
| 42 | + () -> MLHttpClientFactory.validate(HTTP, "127.0.0.1", 80, PRIVATE_IP_DISABLED) |
| 43 | + ); |
| 44 | + assertEquals("Remote inference host name has private ip address: 127.0.0.1", e1.getMessage()); |
| 45 | + |
| 46 | + IllegalArgumentException e2 = assertThrows( |
| 47 | + IllegalArgumentException.class, |
| 48 | + () -> MLHttpClientFactory.validate(HTTP, "192.168.0.1", 80, PRIVATE_IP_DISABLED) |
| 49 | + ); |
| 50 | + assertEquals("Remote inference host name has private ip address: 192.168.0.1", e2.getMessage()); |
| 51 | + |
| 52 | + IllegalArgumentException e3 = assertThrows( |
| 53 | + IllegalArgumentException.class, |
| 54 | + () -> MLHttpClientFactory.validate(HTTP, "169.254.0.1", 80, PRIVATE_IP_DISABLED) |
| 55 | + ); |
| 56 | + assertEquals("Remote inference host name has private ip address: 169.254.0.1", e3.getMessage()); |
| 57 | + |
| 58 | + IllegalArgumentException e4 = assertThrows( |
| 59 | + IllegalArgumentException.class, |
| 60 | + () -> MLHttpClientFactory.validate(HTTP, "172.16.0.1", 80, PRIVATE_IP_DISABLED) |
| 61 | + ); |
| 62 | + assertEquals("Remote inference host name has private ip address: 172.16.0.1", e4.getMessage()); |
| 63 | + |
| 64 | + IllegalArgumentException e5 = assertThrows( |
| 65 | + IllegalArgumentException.class, |
| 66 | + () -> MLHttpClientFactory.validate(HTTP, "172.31.0.1", 80, PRIVATE_IP_DISABLED) |
| 67 | + ); |
| 68 | + assertEquals("Remote inference host name has private ip address: 172.31.0.1", e5.getMessage()); |
| 69 | + } |
| 70 | + |
| 71 | + @Test |
| 72 | + public void test_validateIp_validIp_noException() throws Exception { |
| 73 | + MLHttpClientFactory.validate(HTTP, TEST_HOST, 80, PRIVATE_IP_DISABLED); |
| 74 | + MLHttpClientFactory.validate(HTTPS, TEST_HOST, 443, PRIVATE_IP_DISABLED); |
| 75 | + MLHttpClientFactory.validate(HTTP, "127.0.0.1", 80, PRIVATE_IP_ENABLED); |
| 76 | + MLHttpClientFactory.validate(HTTPS, "127.0.0.1", 443, PRIVATE_IP_ENABLED); |
| 77 | + MLHttpClientFactory.validate(HTTP, "177.16.0.1", 80, PRIVATE_IP_DISABLED); |
| 78 | + MLHttpClientFactory.validate(HTTP, "177.0.1.1", 80, PRIVATE_IP_DISABLED); |
| 79 | + MLHttpClientFactory.validate(HTTP, "177.0.0.2", 80, PRIVATE_IP_DISABLED); |
| 80 | + MLHttpClientFactory.validate(HTTP, "::ffff", 80, PRIVATE_IP_DISABLED); |
| 81 | + MLHttpClientFactory.validate(HTTP, "172.32.0.1", 80, PRIVATE_IP_ENABLED); |
| 82 | + MLHttpClientFactory.validate(HTTP, "172.2097152", 80, PRIVATE_IP_ENABLED); |
| 83 | + } |
| 84 | + |
| 85 | + @Test |
| 86 | + public void test_validateIp_rarePrivateIp_throwException() throws Exception { |
| 87 | + try { |
| 88 | + MLHttpClientFactory.validate(HTTP, "0254.020.00.01", 80, PRIVATE_IP_DISABLED); |
| 89 | + } catch (IllegalArgumentException e) { |
| 90 | + assertNotNull(e); |
| 91 | + } |
| 92 | + |
| 93 | + try { |
| 94 | + MLHttpClientFactory.validate(HTTP, "172.1048577", 80, PRIVATE_IP_DISABLED); |
| 95 | + } catch (Exception e) { |
| 96 | + assertNotNull(e); |
| 97 | + } |
| 98 | + |
| 99 | + try { |
| 100 | + MLHttpClientFactory.validate(HTTP, "2886729729", 80, PRIVATE_IP_DISABLED); |
| 101 | + } catch (IllegalArgumentException e) { |
| 102 | + assertNotNull(e); |
| 103 | + } |
| 104 | + |
| 105 | + try { |
| 106 | + MLHttpClientFactory.validate(HTTP, "192.11010049", 80, PRIVATE_IP_DISABLED); |
| 107 | + } catch (IllegalArgumentException e) { |
| 108 | + assertNotNull(e); |
| 109 | + } |
| 110 | + |
| 111 | + try { |
| 112 | + MLHttpClientFactory.validate(HTTP, "3232300545", 80, PRIVATE_IP_DISABLED); |
| 113 | + } catch (IllegalArgumentException e) { |
| 114 | + assertNotNull(e); |
| 115 | + } |
| 116 | + |
| 117 | + try { |
| 118 | + MLHttpClientFactory.validate(HTTP, "0:0:0:0:0:ffff:127.0.0.1", 80, PRIVATE_IP_DISABLED); |
| 119 | + } catch (IllegalArgumentException e) { |
| 120 | + assertNotNull(e); |
| 121 | + } |
| 122 | + |
| 123 | + try { |
| 124 | + MLHttpClientFactory.validate(HTTP, "153.24.76.232", 80, PRIVATE_IP_DISABLED); |
| 125 | + } catch (IllegalArgumentException e) { |
| 126 | + assertNotNull(e); |
| 127 | + } |
| 128 | + |
| 129 | + try { |
| 130 | + MLHttpClientFactory.validate(HTTP, "177.0.0.1", 80, PRIVATE_IP_DISABLED); |
| 131 | + } catch (IllegalArgumentException e) { |
| 132 | + assertNotNull(e); |
| 133 | + } |
| 134 | + |
| 135 | + try { |
| 136 | + MLHttpClientFactory.validate(HTTP, "12.16.2.3", 80, PRIVATE_IP_DISABLED); |
| 137 | + } catch (IllegalArgumentException e) { |
| 138 | + assertNotNull(e); |
| 139 | + } |
| 140 | + } |
| 141 | + |
| 142 | + @Test |
| 143 | + public void test_validateIp_rarePrivateIp_NotThrowException() throws Exception { |
| 144 | + MLHttpClientFactory.validate(HTTP, "0254.020.00.01", 80, PRIVATE_IP_ENABLED); |
| 145 | + MLHttpClientFactory.validate(HTTPS, "0254.020.00.01", 443, PRIVATE_IP_ENABLED); |
| 146 | + MLHttpClientFactory.validate(HTTP, "172.1048577", 80, PRIVATE_IP_ENABLED); |
| 147 | + MLHttpClientFactory.validate(HTTP, "2886729729", 80, PRIVATE_IP_ENABLED); |
| 148 | + MLHttpClientFactory.validate(HTTP, "192.11010049", 80, PRIVATE_IP_ENABLED); |
| 149 | + MLHttpClientFactory.validate(HTTP, "3232300545", 80, PRIVATE_IP_ENABLED); |
| 150 | + MLHttpClientFactory.validate(HTTP, "0:0:0:0:0:ffff:127.0.0.1", 80, PRIVATE_IP_ENABLED); |
| 151 | + MLHttpClientFactory.validate(HTTPS, "0:0:0:0:0:ffff:127.0.0.1", 443, PRIVATE_IP_ENABLED); |
| 152 | + MLHttpClientFactory.validate(HTTP, "153.24.76.232", 80, PRIVATE_IP_ENABLED); |
| 153 | + MLHttpClientFactory.validate(HTTP, "10.24.76.186", 80, PRIVATE_IP_ENABLED); |
| 154 | + MLHttpClientFactory.validate(HTTPS, "10.24.76.186", 443, PRIVATE_IP_ENABLED); |
| 155 | + } |
| 156 | + |
| 157 | + @Test |
| 158 | + public void test_validateSchemaAndPort_success() throws Exception { |
| 159 | + MLHttpClientFactory.validate(HTTP, TEST_HOST, 80, PRIVATE_IP_DISABLED); |
| 160 | + } |
| 161 | + |
| 162 | + @Test |
| 163 | + public void test_validateSchemaAndPort_notAllowedSchema_throwException() throws Exception { |
| 164 | + expectedException.expect(IllegalArgumentException.class); |
| 165 | + MLHttpClientFactory.validate("ftp", TEST_HOST, 80, PRIVATE_IP_DISABLED); |
| 166 | + } |
| 167 | + |
| 168 | + @Test |
| 169 | + public void test_validateSchemaAndPort_portNotInRange1_throwException() throws Exception { |
| 170 | + expectedException.expect(IllegalArgumentException.class); |
| 171 | + expectedException.expectMessage("Port out of range: 65537"); |
| 172 | + MLHttpClientFactory.validate(HTTPS, TEST_HOST, 65537, PRIVATE_IP_DISABLED); |
| 173 | + } |
| 174 | + |
| 175 | + @Test |
| 176 | + public void test_validateSchemaAndPort_portNotInRange2_throwException() throws Exception { |
| 177 | + expectedException.expect(IllegalArgumentException.class); |
| 178 | + expectedException.expectMessage("Port out of range: -10"); |
| 179 | + MLHttpClientFactory.validate(HTTP, TEST_HOST, -10, PRIVATE_IP_DISABLED); |
| 180 | + } |
| 181 | + |
| 182 | + @Test |
| 183 | + public void test_validatePort_boundaries_success() throws Exception { |
| 184 | + MLHttpClientFactory.validate(HTTP, TEST_HOST, 65536, PRIVATE_IP_DISABLED); |
| 185 | + MLHttpClientFactory.validate(HTTP, TEST_HOST, 0, PRIVATE_IP_DISABLED); |
| 186 | + MLHttpClientFactory.validate(HTTP, TEST_HOST, -1, PRIVATE_IP_DISABLED); |
| 187 | + MLHttpClientFactory.validate(HTTPS, TEST_HOST, -1, PRIVATE_IP_DISABLED); |
| 188 | + MLHttpClientFactory.validate(null, TEST_HOST, -1, PRIVATE_IP_DISABLED); |
| 189 | + } |
| 190 | + |
| 191 | +} |
0 commit comments