File: RequestMethodEquality.java

package info (click to toggle)
openjdk-21 21.0.8%2B9-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 823,976 kB
  • sloc: java: 5,613,338; xml: 1,643,607; cpp: 1,296,296; ansic: 420,291; asm: 404,850; objc: 20,994; sh: 15,271; javascript: 11,245; python: 6,895; makefile: 2,362; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (140 lines) | stat: -rw-r--r-- 5,842 bytes parent folder | download | duplicates (15)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*
 * Copyright (c) 2021, 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 This test checks that a broken HttpClient is not returned from the KeepAliveCache
 *          when the intial HttpURLConnection.setRequest method is passed a 'new String("POST")'
 *          rather than the "POST" String literal
 * @bug 8274779
 * @library /test/lib
 * @modules java.base/sun.net.www.http
 *          java.base/sun.net.www.protocol.http
 * @build java.base/sun.net.www.http.HttpClientAccess
 * @run testng/othervm RequestMethodEquality
 */

import com.sun.net.httpserver.HttpExchange;
import com.sun.net.httpserver.HttpHandler;
import com.sun.net.httpserver.HttpServer;
import jdk.test.lib.net.URIBuilder;
import org.testng.Assert;
import org.testng.annotations.AfterTest;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;
import sun.net.www.http.HttpClient;
import sun.net.www.http.HttpClientAccess;
import sun.net.www.http.KeepAliveCache;
import sun.net.www.protocol.http.HttpURLConnection;

import java.io.IOException;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.net.Proxy;
import java.net.URL;

public class RequestMethodEquality {
    private static final String TEST_CONTEXT = "/reqmethodtest";
    private HttpServer server;
    private CustomHandler handler;
    private HttpClientAccess httpClientAccess;

    @BeforeTest
    public void setup() throws Exception {
        handler = new CustomHandler();
        server = createServer(handler);
        httpClientAccess = new HttpClientAccess();
    }

    @AfterTest
    public void tearDown() throws Exception {
        if (server != null) {
            server.stop(0);
        }
    }

    @Test
    public void testHttpClient() throws Exception {
        HttpURLConnection conn = null;
        try {
            URL url = URIBuilder.newBuilder()
                    .scheme("http")
                    .host(server.getAddress().getAddress())
                    .port(server.getAddress().getPort())
                    .path(TEST_CONTEXT)
                    .toURL();

            conn = (HttpURLConnection) url.openConnection();
            conn.setChunkedStreamingMode(8); // ensures the call to HttpURLConnection.streaming() passes

            int firstConnectTimeout = 1234;
            HttpClient freshClient = HttpClient.New(url, Proxy.NO_PROXY, firstConnectTimeout, true, conn);
            freshClient.closeServer(); // ensures that the call to HttpClient.available() fails

            httpClientAccess.setInCache(freshClient, true); // allows the assertion in HttpClient.New to pass

            // Injecting a mock KeepAliveCache that the HttpClient can use
            KeepAliveCache kac = httpClientAccess.getKeepAliveCache();
            kac.put(url, null, freshClient);

            // The 'new' keyword is important here as the original code
            // used '==' rather than String.equals to compare request methods
            conn.setRequestMethod(new String("POST"));

            // Before the fix, the value returned to 'cachedClient' would have been the (broken) cached
            // 'freshClient' as HttpClient.available() could never be checked
            int secondConnectTimeout = 4321;
            HttpClient cachedClient = HttpClient.New(url, Proxy.NO_PROXY, secondConnectTimeout, true, conn);
            cachedClient.closeServer();

            int originalConnectTimeout = freshClient.getConnectTimeout();
            int cachedConnectTimeout = cachedClient.getConnectTimeout();

            // If both connectTimeout values are equal, it means the test retrieved the same broken
            // HttpClient from the cache and is trying to re-use it.
            Assert.assertNotEquals(originalConnectTimeout, cachedConnectTimeout, "Both connectTimeout values are equal.\nThis means the test is reusing a broken HttpClient rather than creating a new one.");
        } finally {
            if (conn != null) {
                conn.disconnect();
            }
        }
    }

    private static HttpServer createServer(final HttpHandler handler) throws IOException {
        final InetSocketAddress serverAddress = new InetSocketAddress(InetAddress.getLoopbackAddress(), 0);
        final int backlog = -1;
        final HttpServer server = HttpServer.create(serverAddress, backlog);
        server.createContext(TEST_CONTEXT, handler);
        server.start();
        System.out.println("Server started on " + server.getAddress());
        return server;
    }

    private static class CustomHandler implements HttpHandler {
        @Override
        public void handle(HttpExchange exchange) throws IOException {
            // We'll always send 200 OK - We don't care about the server logic
            exchange.sendResponseHeaders(200, 1);
            exchange.close();
        }
    }
}