jdk-24/test/jdk/java/net/httpclient/EscapedOctetsInURI.java
2023-04-27 08:25:40 +00:00

290 lines
12 KiB
Java

/*
* Copyright (c) 2018, 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @summary Preserve URI component escaped octets when converting to HTTP headers
* @bug 8198716
* @library /test/lib /test/jdk/java/net/httpclient/lib
* @build jdk.httpclient.test.lib.http2.Http2TestServer jdk.test.lib.net.SimpleSSLContext
* @run testng/othervm
* -Djdk.httpclient.HttpClient.log=reqeusts,headers
* EscapedOctetsInURI
*/
import java.io.Closeable;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.URI;
import javax.net.ssl.SSLContext;
import java.net.http.HttpClient;
import java.net.http.HttpClient.Version;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import jdk.httpclient.test.lib.common.HttpServerAdapters;
import jdk.test.lib.net.SimpleSSLContext;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import static java.lang.System.err;
import static java.lang.System.out;
import static java.net.http.HttpClient.Version.HTTP_1_1;
import static java.net.http.HttpClient.Version.HTTP_2;
import static java.nio.charset.StandardCharsets.US_ASCII;
import static java.net.http.HttpClient.Builder.NO_PROXY;
import static org.testng.Assert.assertEquals;
public class EscapedOctetsInURI implements HttpServerAdapters {
SSLContext sslContext;
HttpTestServer httpTestServer; // HTTP/1.1 [ 4 servers ]
HttpTestServer httpsTestServer; // HTTPS/1.1
HttpTestServer http2TestServer; // HTTP/2 ( h2c )
HttpTestServer https2TestServer; // HTTP/2 ( h2 )
String httpURI;
String httpsURI;
String http2URI;
String https2URI;
private volatile HttpClient sharedClient;
static final String[][] pathsAndQueryStrings = new String[][] {
// partial-path URI query
{ "/001/noSpace", "?noQuotedOctets" },
{ "/002/noSpace", "?name=chegar,address=Dublin%20Ireland", },
{ "/003/noSpace", "?target=http%3A%2F%2Fwww.w3.org%2Fns%2Foa%23hasBody" },
{ "/010/with%20space", "?noQuotedOctets" },
{ "/011/with%20space", "?name=chegar,address=Dublin%20Ireland" },
{ "/012/with%20space", "?target=http%3A%2F%2Fwww.w3.org%2Fns%2Foa%23hasBody" },
};
@DataProvider(name = "variants")
public Object[][] variants() {
List<Object[]> list = new ArrayList<>();
for (boolean sameClient : new boolean[] { false, true }) {
Arrays.asList(pathsAndQueryStrings).stream()
.map(e -> new Object[] {httpURI + e[0] + e[1], sameClient})
.forEach(list::add);
Arrays.asList(pathsAndQueryStrings).stream()
.map(e -> new Object[] {httpsURI + e[0] + e[1], sameClient})
.forEach(list::add);
Arrays.asList(pathsAndQueryStrings).stream()
.map(e -> new Object[] {http2URI + e[0] + e[1], sameClient})
.forEach(list::add);
Arrays.asList(pathsAndQueryStrings).stream()
.map(e -> new Object[] {https2URI + e[0] + e[1], sameClient})
.forEach(list::add);
}
return list.stream().toArray(Object[][]::new);
}
static final int ITERATION_COUNT = 3; // checks upgrade and re-use
static final long start = System.nanoTime();
public static String now() {
long now = System.nanoTime() - start;
long secs = now / 1000_000_000;
long mill = (now % 1000_000_000) / 1000_000;
long nan = now % 1000_000;
return String.format("[%d s, %d ms, %d ns] ", secs, mill, nan);
}
static Version version(String uri) {
if (uri.contains("/http1/") || uri.contains("/https1/"))
return HTTP_1_1;
if (uri.contains("/http2/") || uri.contains("/https2/"))
return HTTP_2;
return null;
}
private HttpClient makeNewClient() {
return HttpClient.newBuilder()
.proxy(NO_PROXY)
.sslContext(sslContext)
.build();
}
HttpClient newHttpClient(boolean share) {
if (!share) return makeNewClient();
HttpClient shared = sharedClient;
if (shared != null) return shared;
synchronized (this) {
shared = sharedClient;
if (shared == null) {
shared = sharedClient = makeNewClient();
}
return shared;
}
}
record CloseableClient(HttpClient client, boolean shared)
implements Closeable {
public void close() {
if (shared) return;
client.close();
}
}
@Test(dataProvider = "variants")
void test(String uriString, boolean sameClient) throws Exception {
System.out.println("\n--- Starting ");
// The single-argument factory requires any illegal characters in its
// argument to be quoted and preserves any escaped octets and other
// characters that are present.
URI uri = URI.create(uriString);
HttpClient client = null;
for (int i=0; i< ITERATION_COUNT; i++) {
if (!sameClient || client == null) {
client = newHttpClient(sameClient);
}
try (var cl = new CloseableClient(client, sameClient)) {
HttpRequest request = HttpRequest.newBuilder(uri).build();
HttpResponse<String> resp = client.send(request, BodyHandlers.ofString());
out.println("Got response: " + resp);
out.println("Got body: " + resp.body());
assertEquals(resp.statusCode(), 200,
"Expected 200, got:" + resp.statusCode());
// the response body should contain the exact escaped request URI
URI retrievedURI = URI.create(resp.body());
assertEquals(retrievedURI.getRawPath(), uri.getRawPath());
assertEquals(retrievedURI.getRawQuery(), uri.getRawQuery());
assertEquals(resp.version(), version(uriString));
}
}
}
@Test(dataProvider = "variants")
void testAsync(String uriString, boolean sameClient) throws Exception {
System.out.println("\n--- Starting ");
URI uri = URI.create(uriString);
HttpClient client = null;
for (int i=0; i< ITERATION_COUNT; i++) {
if (!sameClient || client == null) {
client = newHttpClient(sameClient);
}
try (var cl = new CloseableClient(client, sameClient)) {
HttpRequest request = HttpRequest.newBuilder(uri).build();
client.sendAsync(request, BodyHandlers.ofString())
.thenApply(response -> {
out.println("Got response: " + response);
out.println("Got body: " + response.body());
assertEquals(response.statusCode(), 200);
assertEquals(response.version(), version(uriString));
return response.body();
})
.thenApply(body -> URI.create(body))
.thenAccept(retrievedURI -> {
// the body should contain the exact escaped request URI
assertEquals(retrievedURI.getRawPath(), uri.getRawPath());
assertEquals(retrievedURI.getRawQuery(), uri.getRawQuery());
}).join();
}
}
}
@BeforeTest
public void setup() throws Exception {
out.println(now() + "begin setup");
sslContext = new SimpleSSLContext().get();
if (sslContext == null)
throw new AssertionError("Unexpected null sslContext");
InetSocketAddress sa = new InetSocketAddress(InetAddress.getLoopbackAddress(), 0);
httpTestServer = HttpTestServer.create(HTTP_1_1);
httpTestServer.addHandler(new HttpASCIIUriStringHandler(), "/http1/get");
httpURI = "http://" + httpTestServer.serverAuthority() + "/http1/get";
httpsTestServer = HttpTestServer.create(HTTP_1_1, sslContext);
httpsTestServer.addHandler(new HttpASCIIUriStringHandler(), "/https1/get");
httpsURI = "https://" + httpsTestServer.serverAuthority() + "/https1/get";
http2TestServer = HttpTestServer.create(HTTP_2);
http2TestServer.addHandler(new HttpASCIIUriStringHandler(), "/http2/get");
http2URI = "http://" + http2TestServer.serverAuthority() + "/http2/get";
https2TestServer = HttpTestServer.create(HTTP_2, sslContext);
https2TestServer.addHandler(new HttpASCIIUriStringHandler(), "/https2/get");
https2URI = "https://" + https2TestServer.serverAuthority() + "/https2/get";
err.println(now() + "Starting servers");
httpTestServer.start();
httpsTestServer.start();
http2TestServer.start();
https2TestServer.start();
out.println("HTTP/1.1 server (http) listening at: " + httpTestServer.serverAuthority());
out.println("HTTP/1.1 server (TLS) listening at: " + httpsTestServer.serverAuthority());
out.println("HTTP/2 server (h2c) listening at: " + http2TestServer.serverAuthority());
out.println("HTTP/2 server (h2) listening at: " + https2TestServer.serverAuthority());
out.println(now() + "setup done");
err.println(now() + "setup done");
}
@AfterTest
public void teardown() throws Exception {
sharedClient.close();
httpTestServer.stop();
httpsTestServer.stop();
http2TestServer.stop();
https2TestServer.stop();
}
/** A handler that returns as its body the exact escaped request URI. */
static class HttpASCIIUriStringHandler implements HttpTestHandler {
@Override
public void handle(HttpTestExchange t) throws IOException {
String asciiUriString = t.getRequestURI().toASCIIString();
out.println("HttpASCIIUriString received, asciiUriString: " + asciiUriString);
try (InputStream is = t.getRequestBody();
OutputStream os = t.getResponseBody()) {
is.readAllBytes();
byte[] bytes = asciiUriString.getBytes(US_ASCII);
t.sendResponseHeaders(200, bytes.length);
os.write(bytes);
}
}
}
}