Skip to content

Commit f505396

Browse files
author
Julia Boes
committedDec 1, 2021
8277459: Add jwebserver tool
Reviewed-by: michaelm, dfuchs, ihse
·
JEP-429-branchpoint
1 parent 84aa0a1 commit f505396

17 files changed

+1028
-70
lines changed
 

‎make/modules/jdk.httpserver/Launcher.gmk

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#
2+
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
3+
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
#
5+
# This code is free software; you can redistribute it and/or modify it
6+
# under the terms of the GNU General Public License version 2 only, as
7+
# published by the Free Software Foundation. Oracle designates this
8+
# particular file as subject to the "Classpath" exception as provided
9+
# by Oracle in the LICENSE file that accompanied this code.
10+
#
11+
# This code is distributed in the hope that it will be useful, but WITHOUT
12+
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13+
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14+
# version 2 for more details (a copy is included in the LICENSE file that
15+
# accompanied this code).
16+
#
17+
# You should have received a copy of the GNU General Public License version
18+
# 2 along with this work; if not, write to the Free Software Foundation,
19+
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20+
#
21+
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22+
# or visit www.oracle.com if you need additional information or have any
23+
# questions.
24+
#
25+
26+
include LauncherCommon.gmk
27+
28+
$(eval $(call SetupBuildLauncher, jwebserver, \
29+
MAIN_CLASS := sun.net.httpserver.simpleserver.JWebServer, \
30+
))

‎src/jdk.httpserver/share/classes/com/sun/net/httpserver/SimpleFileServer.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,12 @@
104104
* server.start();
105105
* }</pre>
106106
*
107-
* <h2>Main entry point</h2>
107+
* <h2>jwebserver Tool</h2>
108108
*
109-
* <p>A <a id="server-impl">simple HTTP file server implementation</a> is
110-
* provided via the
111-
* <a href="{@docRoot}/jdk.httpserver/module-summary.html#entry-point">main entry point</a>
112-
* of the {@code jdk.httpserver} module.
109+
* <p>A simple HTTP file server implementation is provided via the
110+
* {@code jwebserver} tool.
111+
*
112+
* @toolGuide jwebserver
113113
*
114114
* @since 18
115115
*/

‎src/jdk.httpserver/share/classes/com/sun/net/httpserver/package-info.java

+18-7
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,24 @@
3131
Any HTTP functionality not provided by this API can be implemented by application code
3232
using the API.
3333
<p>
34+
* The main components are:
35+
* <ul>
36+
* <li>the {@link com.sun.net.httpserver.HttpExchange} class that describes a
37+
* request and response pair,</li>
38+
* <li>the {@link com.sun.net.httpserver.HttpHandler} interface to handle
39+
* incoming requests, plus the {@link com.sun.net.httpserver.HttpHandlers} class
40+
* that provides useful handler implementations,</li>
41+
* <li>the {@link com.sun.net.httpserver.HttpContext} class that maps a URI path
42+
* to a {@code HttpHandler},</li>
43+
* <li>the {@link com.sun.net.httpserver.HttpServer} class to listen for
44+
* connections and dispatch requests to handlers,</li>
45+
* <li>the {@link com.sun.net.httpserver.Filter} class that allows pre- and post-
46+
* processing of requests.</li></ul>
47+
* <p>
48+
* The {@link com.sun.net.httpserver.SimpleFileServer} class offers a simple
49+
* HTTP-only file server (intended for testing, development and debugging purposes
50+
* only). A default implementation is provided via the {@code jwebserver} tool.
51+
<p>
3452
Programmers must implement the {@link com.sun.net.httpserver.HttpHandler} interface. This interface
3553
provides a callback which is invoked to handle incoming requests from clients.
3654
A HTTP request and its response is known as an exchange. HTTP exchanges are
@@ -120,13 +138,6 @@ public void configure (HttpsParameters params) {
120138
}
121139
});
122140
</pre></blockquote>
123-
<p>
124-
The {@link com.sun.net.httpserver.SimpleFileServer} class offers a simple
125-
HTTP file server (intended for testing, development and debugging purposes
126-
only). A default implementation is provided via the
127-
<a href="{@docRoot}/jdk.httpserver/module-summary.html#entry-point">main entry point</a>
128-
of the {@code jdk.httpserver} module.
129-
130141
@since 1.6
131142
*/
132143
package com.sun.net.httpserver;

‎src/jdk.httpserver/share/classes/module-info.java

+15-35
Original file line numberDiff line numberDiff line change
@@ -24,41 +24,21 @@
2424
*/
2525

2626
/**
27-
* Defines the JDK-specific HTTP server API.
28-
* <p>
29-
* A basic high-level API for building embedded servers. Both HTTP and
30-
* HTTPS are supported.
31-
* <p>
32-
* The main components are:
33-
* <ul>
34-
* <li>the {@link com.sun.net.httpserver.HttpExchange} class that describes a
35-
* request and response pair,</li>
36-
* <li>the {@link com.sun.net.httpserver.HttpHandler} interface to handle
37-
* incoming requests, plus the {@link com.sun.net.httpserver.HttpHandlers} class
38-
* that provides useful handler implementations,</li>
39-
* <li>the {@link com.sun.net.httpserver.HttpContext} class that maps a URI path
40-
* to a {@code HttpHandler},</li>
41-
* <li>the {@link com.sun.net.httpserver.HttpServer} class to listen for
42-
* connections and dispatch requests to handlers,</li>
43-
* <li>the {@link com.sun.net.httpserver.Filter} class that allows pre- and post-
44-
* processing of requests.</li></ul>
45-
* <p>
46-
* The {@link com.sun.net.httpserver.SimpleFileServer} class offers a simple
47-
* HTTP file server (intended for testing, development and debugging purposes
48-
* only). A default implementation is provided via the <a id="entry-point"></a>
49-
* main entry point of the {@code jdk.httpserver} module, which can be used on
50-
* the command line as such:
51-
* <pre>{@code
52-
* Usage: java -m jdk.httpserver [-b bind address] [-p port] [-d directory]
53-
* [-o none|info|verbose] [-h to show options]
54-
* Options:
55-
* -b, --bind-address - Address to bind to. Default: 127.0.0.1 or ::1 (loopback).
56-
* For all interfaces use "-b 0.0.0.0" or "-b ::".
57-
* -d, --directory - Directory to serve. Default: current directory.
58-
* -o, --output - Output format. none|info|verbose. Default: info.
59-
* -p, --port - Port to listen on. Default: 8000.
60-
* -h, -?, --help - Print this help message.
61-
* }</pre>
27+
* Defines the JDK-specific HTTP server API, and provides the jwebserver tool
28+
* for running a minimal HTTP server.
29+
*
30+
* <p>The {@link com.sun.net.httpserver} package defines a high-level API for
31+
* building servers that support HTTP and HTTPS. The SimpleFileServer class
32+
* implements a simple HTTP-only file server intended for testing, development
33+
* and debugging purposes. A default implementation is provided via the
34+
* {@code jwebserver} tool and the main entry point of the module, which can
35+
* also be invoked with {@code java -m jdk.httpserver}.
36+
*
37+
* <p>The {@link com.sun.net.httpserver.spi} package specifies a Service Provider
38+
* Interface (SPI) for locating HTTP server implementations based on the
39+
* {@code com.sun.net.httpserver} API.
40+
*
41+
* @toolGuide jwebserver
6242
*
6343
* @uses com.sun.net.httpserver.spi.HttpServerProvider
6444
*

‎src/jdk.httpserver/share/classes/sun/net/httpserver/simpleserver/JWebServer.java

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
/*
2+
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
package sun.net.httpserver.simpleserver;
25+
26+
import java.io.PrintWriter;
27+
import static java.nio.charset.StandardCharsets.UTF_8;
28+
29+
/**
30+
* Programmatic entry point to start the jwebserver tool.
31+
*
32+
* <p><b> This is NOT part of any supported API.
33+
* If you write code that depends on this, you do so at your own risk.
34+
* This code and its internal interface are subject to change or deletion
35+
* without notice.</b>
36+
*/
37+
public class JWebServer {
38+
39+
/**
40+
* This constructor should never be called.
41+
*/
42+
private JWebServer() { throw new AssertionError(); }
43+
44+
/**
45+
* The main entry point.
46+
*
47+
* <p> The command line arguments are parsed and the server is started. If
48+
* started successfully, the server will run on a new non-daemon thread,
49+
* and this method will return. Otherwise, if the server is not started
50+
* successfully, e.g. an error is encountered while parsing the arguments
51+
* or an I/O error occurs, the server is not started and this method invokes
52+
* System::exit with an appropriate exit code.
53+
*
54+
* @param args the command-line options
55+
* @throws NullPointerException if {@code args} is {@code null}, or if there
56+
* are any {@code null} values in the {@code args} array
57+
*/
58+
public static void main(String... args) {
59+
int ec = SimpleFileServerImpl.start(new PrintWriter(System.out, true, UTF_8), "jwebserver", args);
60+
if (ec != 0) {
61+
System.exit(ec);
62+
} // otherwise, the server has either been started successfully and
63+
// runs in another non-daemon thread, or -h or -version have been
64+
// passed and the main thread has exited normally.
65+
}
66+
}

‎src/jdk.httpserver/share/classes/sun/net/httpserver/simpleserver/Main.java

+6-5
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import static java.nio.charset.StandardCharsets.UTF_8;
2828

2929
/**
30-
* Programmatic entry point to start the simpleserver tool.
30+
* Programmatic entry point to start "java -m jdk.httpserver".
3131
*
3232
* <p><b> This is NOT part of any supported API.
3333
* If you write code that depends on this, you do so at your own risk.
@@ -56,10 +56,11 @@ public class Main {
5656
* are any {@code null} values in the {@code args} array
5757
*/
5858
public static void main(String... args) {
59-
int ec = SimpleFileServerImpl.start(new PrintWriter(System.out, true, UTF_8), args);
60-
if (ec != 0)
59+
int ec = SimpleFileServerImpl.start(new PrintWriter(System.out, true, UTF_8), "java", args);
60+
if (ec != 0) {
6161
System.exit(ec);
62-
// otherwise the server has been started successfully and runs in
63-
// another non-daemon thread.
62+
} // otherwise, the server has either been started successfully and
63+
// runs in another non-daemon thread, or -h or -version have been
64+
// passed and the main thread has exited normally.
6465
}
6566
}

‎src/jdk.httpserver/share/classes/sun/net/httpserver/simpleserver/SimpleFileServerImpl.java

+16-7
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,12 @@ final class SimpleFileServerImpl {
7171
*
7272
* @param writer the writer to which output should be written
7373
* @param args the command line options
74+
* @param launcher the launcher the server is started from
7475
* @throws NullPointerException if any of the arguments are {@code null},
7576
* or if there are any {@code null} values in the {@code args} array
7677
* @return startup status code
7778
*/
78-
static int start(PrintWriter writer, String[] args) {
79+
static int start(PrintWriter writer, String launcher, String[] args) {
7980
Objects.requireNonNull(args);
8081
for (var arg : args) {
8182
Objects.requireNonNull(arg);
@@ -96,7 +97,11 @@ static int start(PrintWriter writer, String[] args) {
9697
option = options.next();
9798
switch (option) {
9899
case "-h", "-?", "--help" -> {
99-
out.showHelp();
100+
out.showHelp(launcher);
101+
return Startup.OK.statusCode;
102+
}
103+
case "-version", "--version" -> {
104+
out.showVersion(launcher);
100105
return Startup.OK.statusCode;
101106
}
102107
case "-b", "--bind-address" -> {
@@ -115,7 +120,7 @@ static int start(PrintWriter writer, String[] args) {
115120
}
116121
} catch (AssertionError ae) {
117122
out.reportError(ResourceBundleHelper.getMessage("err.unknown.option", option));
118-
out.showUsage();
123+
out.showUsage(launcher);
119124
return Startup.CMDERR.statusCode;
120125
} catch (NoSuchElementException nsee) {
121126
out.reportError(ResourceBundleHelper.getMessage("err.missing.arg", option));
@@ -169,12 +174,16 @@ void printStartMessage(Path root, HttpServer server)
169174
}
170175
}
171176

172-
void showUsage() {
173-
writer.println(ResourceBundleHelper.getMessage("usage"));
177+
void showUsage(String launcher) {
178+
writer.println(ResourceBundleHelper.getMessage("usage." + launcher));
179+
}
180+
181+
void showVersion(String launcher) {
182+
writer.println(ResourceBundleHelper.getMessage("version", launcher, System.getProperty("java.version")));
174183
}
175184

176-
void showHelp() {
177-
writer.println(ResourceBundleHelper.getMessage("usage"));
185+
void showHelp(String launcher) {
186+
writer.println(ResourceBundleHelper.getMessage("usage." + launcher));
178187
writer.println(ResourceBundleHelper.getMessage("options", LOOPBACK_ADDR.getHostAddress()));
179188
}
180189

‎src/jdk.httpserver/share/classes/sun/net/httpserver/simpleserver/resources/simpleserver.properties

+13-3
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,18 @@
2323
# questions.
2424
#
2525

26-
usage=\
26+
usage.java=\
2727
Usage: java -m jdk.httpserver [-b bind address] [-p port] [-d directory]\n\
28-
\ [-o none|info|verbose] [-h to show options]
28+
\ [-o none|info|verbose] [-h to show options]\n\
29+
\ [-version to show version information]
30+
31+
usage.jwebserver=\
32+
Usage: jwebserver [-b bind address] [-p port] [-d directory]\n\
33+
\ [-o none|info|verbose] [-h to show options]\n\
34+
\ [-version to show version information]
35+
36+
version=\
37+
{0} {1}
2938

3039
options=\
3140
Options:\n\
@@ -34,7 +43,8 @@ Options:\n\
3443
-d, --directory - Directory to serve. Default: current directory.\n\
3544
-o, --output - Output format. none|info|verbose. Default: info.\n\
3645
-p, --port - Port to listen on. Default: 8000.\n\
37-
-h, -?, --help - Print this help message.\n\
46+
-h, -?, --help - Prints this help message and exits.\n\
47+
-version, --version - Prints version information and exits.\n\
3848
To stop the server, press Ctrl + C.
3949

4050
opt.bindaddress=\

‎src/jdk.httpserver/share/man/jwebserver.1

+175
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
.\" Automatically generated by Pandoc 2.3.1
2+
.\"
3+
.TH "JWEBSERVER" "1" "2021" "JDK 18\-internal" "JDK Commands"
4+
.hy
5+
.SH NAME
6+
.PP
7+
jwebserver \- launch the Java Simple Web Server
8+
.SH SYNOPSIS
9+
.PP
10+
\f[CB]jwebserver\f[R] [\f[I]options\f[R]]
11+
.TP
12+
.B \f[I]options\f[R]
13+
Command\-line options.
14+
For a detailed description of the options, see \f[B]Options\f[R].
15+
.RS
16+
.RE
17+
.SH DESCRIPTION
18+
.PP
19+
The \f[CB]jwebserver\f[R] tool provides a minimal HTTP server, designed to
20+
be used for prototyping, testing, and debugging.
21+
It serves a single directory hierarchy, and only serves static files.
22+
Only HTTP/1.1 is supported; HTTP/2 and HTTPS are not supported.
23+
.PP
24+
Only idempotent HEAD and GET requests are served.
25+
Any other requests receive a \f[CB]501\ \-\ Not\ Implemented\f[R] or a
26+
\f[CB]405\ \-\ Not\ Allowed\f[R] response.
27+
GET requests are mapped to the directory being served, as follows:
28+
.IP \[bu] 2
29+
If the requested resource is a file, its content is served.
30+
.IP \[bu] 2
31+
If the requested resource is a directory that contains an index file,
32+
the content of the index file is served.
33+
.IP \[bu] 2
34+
Otherwise, the names of all files and subdirectories of the directory
35+
are listed.
36+
Symbolic links and hidden files are not listed or served.
37+
.PP
38+
MIME types are configured automatically, using the built\-in table.
39+
For example, \f[CB]\&.html\f[R] files are served as \f[CB]text/html\f[R] and
40+
\f[CB]\&.java\f[R] files are served as \f[CB]text/plain\f[R].
41+
.PP
42+
\f[CB]jwebserver\f[R] is located in the jdk.httpserver module, and can
43+
alternatively be started with \f[CB]java\ \-m\ jdk.httpserver\f[R].
44+
It is based on the web server implementation in the
45+
\f[CB]com.sun.net.httpserver\f[R] package.
46+
The \f[CB]com.sun.net.httpserver.SimpleFileServer\f[R] class provides a
47+
programmatic way to retrieve the server and its components for reuse and
48+
extension.
49+
.SH USAGE
50+
.IP
51+
.nf
52+
\f[CB]
53+
jwebserver\ [\-b\ bind\ address]\ [\-p\ port]\ [\-d\ directory]
54+
\ \ \ \ \ \ \ \ \ \ \ [\-o\ none|info|verbose]\ [\-h\ to\ show\ options]
55+
\ \ \ \ \ \ \ \ \ \ \ [\-version\ to\ show\ version\ information]
56+
\f[R]
57+
.fi
58+
.SH OPTIONS
59+
.TP
60+
.B \f[CB]\-h\f[R] or \f[CB]\-?\f[R] or \f[CB]\-\-help\f[R]
61+
Prints the help message and exits.
62+
.RS
63+
.RE
64+
.TP
65+
.B \f[CB]\-b\f[R] \f[I]addr\f[R] or \f[CB]\-\-bind\-address\f[R] \f[I]addr\f[R]
66+
Specifies the address to bind to.
67+
Default: 127.0.0.1 or ::1 (loopback).
68+
For all interfaces use \f[CB]\-b\ 0.0.0.0\f[R] or \f[CB]\-b\ ::\f[R].
69+
.RS
70+
.RE
71+
.TP
72+
.B \f[CB]\-d\f[R] \f[I]dir\f[R] or \f[CB]\-\-directory\f[R] \f[I]dir\f[R]
73+
Specifies the directory to serve.
74+
Default: current directory.
75+
.RS
76+
.RE
77+
.TP
78+
.B \f[CB]\-o\f[R] \f[I]level\f[R] or \f[CB]\-\-output\f[R] \f[I]level\f[R]
79+
Specifies the output format.
80+
\f[CB]none\f[R] | \f[CB]info\f[R] | \f[CB]verbose\f[R].
81+
Default: \f[CB]info\f[R].
82+
.RS
83+
.RE
84+
.TP
85+
.B \f[CB]\-p\f[R] \f[I]port\f[R] or \f[CB]\-\-port\f[R] \f[I]port\f[R]
86+
Specifies the port to listen on.
87+
Default: 8000.
88+
.RS
89+
.RE
90+
.TP
91+
.B \f[CB]\-version\f[R] or \f[CB]\-\-version\f[R]
92+
Prints the version information and exits.
93+
.RS
94+
.RE
95+
.PP
96+
To stop the server, press \f[CB]Ctrl\ +\ C\f[R].
97+
.SH STARTING THE SERVER
98+
.PP
99+
The following command starts the Simple Web Server:
100+
.IP
101+
.nf
102+
\f[CB]
103+
$\ jwebserver
104+
\f[R]
105+
.fi
106+
.PP
107+
If startup is successful, the server prints a message to
108+
\f[CB]System.out\f[R] listing the local address and the absolute path of
109+
the directory being served.
110+
For example:
111+
.IP
112+
.nf
113+
\f[CB]
114+
$\ jwebserver
115+
Binding\ to\ loopback\ by\ default.\ For\ all\ interfaces\ use\ "\-b\ 0.0.0.0"\ or\ "\-b\ ::".
116+
Serving\ /cwd\ and\ subdirectories\ on\ 127.0.0.1\ port\ 8000
117+
URL\ http://127.0.0.1:8000/
118+
\f[R]
119+
.fi
120+
.SH CONFIGURATION
121+
.PP
122+
By default, the server runs in the foreground and binds to the loopback
123+
address and port 8000.
124+
This can be changed with the \f[CB]\-b\f[R] and \f[CB]\-p\f[R] options.
125+
.PD 0
126+
.P
127+
.PD
128+
For example, to bind the Simple Web Server to all interfaces, use:
129+
.IP
130+
.nf
131+
\f[CB]
132+
$\ jwebserver\ \-b\ 0.0.0.0
133+
Serving\ /cwd\ and\ subdirectories\ on\ 0.0.0.0\ (all\ interfaces)\ port\ 8000
134+
URL\ http://123.456.7.891:8000/
135+
\f[R]
136+
.fi
137+
.PP
138+
Note that this makes the web server accessible to all hosts on the
139+
network.
140+
\f[I]Do not do this unless you are sure the server cannot leak any
141+
sensitive information.\f[R]
142+
.PP
143+
As another example, use the following command to run on port 9000:
144+
.IP
145+
.nf
146+
\f[CB]
147+
$\ jwebserver\ \-p\ 9000
148+
\f[R]
149+
.fi
150+
.PP
151+
By default, the files of the current directory are served.
152+
A different directory can be specified with the \f[CB]\-d\f[R] option.
153+
.PP
154+
By default, every request is logged on the console.
155+
The output looks like this:
156+
.IP
157+
.nf
158+
\f[CB]
159+
127.0.0.1\ \-\ \-\ [10/Feb/2021:14:34:11\ +0000]\ "GET\ /some/subdirectory/\ HTTP/1.1"\ 200\ \-
160+
\f[R]
161+
.fi
162+
.PP
163+
Logging output can be changed with the \f[CB]\-o\f[R] option.
164+
The default setting is \f[CB]info\f[R].
165+
The \f[CB]verbose\f[R] setting additionally includes the request and
166+
response headers as well as the absolute path of the requested resource.
167+
.SH STOPPING THE SERVER
168+
.PP
169+
Once started successfully, the server runs until it is stopped.
170+
On Unix platforms, the server can be stopped by sending it a
171+
\f[CB]SIGINT\f[R] signal (\f[CB]Ctrl+C\f[R] in a terminal window).
172+
.SH HELP OPTION
173+
.PP
174+
The \f[CB]\-h\f[R] option displays a help message describing the usage and
175+
the options of the \f[CB]jwebserver\f[R].

‎test/jdk/com/sun/net/httpserver/simpleserver/CommandLineNegativeTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
/*
2525
* @test
26-
* @summary Negative tests for simpleserver command-line tool
26+
* @summary Negative tests for java -m jdk.httpserver command
2727
* @library /test/lib
2828
* @modules jdk.httpserver
2929
* @run testng/othervm CommandLineNegativeTest

‎test/jdk/com/sun/net/httpserver/simpleserver/CommandLinePortNotSpecifiedTest.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/*
2525
* @test
2626
* @bug 8276848
27-
* @summary Tests the command-line tool with port not specified
27+
* @summary Tests the java -m jdk.httpserver command with port not specified
2828
* @modules jdk.httpserver
2929
* @library /test/lib
3030
* @run testng/othervm/manual CommandLinePortNotSpecifiedTest
@@ -118,7 +118,8 @@ static String getJava(Path image) {
118118
-d, --directory - Directory to serve. Default: current directory.
119119
-o, --output - Output format. none|info|verbose. Default: info.
120120
-p, --port - Port to listen on. Default: 8000.
121-
-h, -?, --help - Print this help message.
121+
-h, -?, --help - Prints this help message and exits.
122+
-version, --version - Prints version information and exits.
122123
To stop the server, press Ctrl + C.""".formatted(LOOPBACK_ADDR);
123124

124125
// The stdout/stderr output line to wait for when starting the simpleserver

‎test/jdk/com/sun/net/httpserver/simpleserver/CommandLinePositiveTest.java

+21-4
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
/*
2525
* @test
26-
* @summary Positive tests for simpleserver command-line tool
26+
* @summary Positive tests for java -m jdk.httpserver command
2727
* @library /test/lib
2828
* @modules jdk.httpserver
2929
* @run testng/othervm CommandLinePositiveTest
@@ -46,6 +46,7 @@
4646

4747
public class CommandLinePositiveTest {
4848

49+
static final String JAVA_VERSION = System.getProperty("java.version");
4950
static final Path JAVA_HOME = Path.of(System.getProperty("java.home"));
5051
static final String JAVA = getJava(JAVA_HOME);
5152
static final Path CWD = Path.of(".").toAbsolutePath().normalize();
@@ -106,7 +107,8 @@ public void testPort(String opt) throws Throwable {
106107

107108
static final String USAGE_TEXT = """
108109
Usage: java -m jdk.httpserver [-b bind address] [-p port] [-d directory]
109-
[-o none|info|verbose] [-h to show options]""";
110+
[-o none|info|verbose] [-h to show options]
111+
[-version to show version information]""";
110112

111113
static final String OPTIONS_TEXT = """
112114
Options:
@@ -115,7 +117,8 @@ public void testPort(String opt) throws Throwable {
115117
-d, --directory - Directory to serve. Default: current directory.
116118
-o, --output - Output format. none|info|verbose. Default: info.
117119
-p, --port - Port to listen on. Default: 8000.
118-
-h, -?, --help - Print this help message.
120+
-h, -?, --help - Prints this help message and exits.
121+
-version, --version - Prints version information and exits.
119122
To stop the server, press Ctrl + C.""".formatted(LOOPBACK_ADDR);
120123

121124
@Test(dataProvider = "helpOptions")
@@ -129,6 +132,18 @@ public void testHelp(String opt) throws Throwable {
129132
.shouldContain(OPTIONS_TEXT);
130133
}
131134

135+
@DataProvider
136+
public Object[][] versionOptions() { return new Object[][] {{"-version"}, {"--version"}}; }
137+
138+
@Test(dataProvider = "versionOptions")
139+
public void testVersion(String opt) throws Throwable {
140+
out.println("\n--- testVersion, opt=\"%s\" ".formatted(opt));
141+
simpleserver(WaitForLine.VERSION_STARTUP_LINE,
142+
false, // do not explicitly destroy the process
143+
JAVA, "-m", "jdk.httpserver", opt)
144+
.shouldHaveExitValue(0);
145+
}
146+
132147
@DataProvider
133148
public Object[][] bindOptions() { return new Object[][] {{"-b"}, {"--bind-address"}}; }
134149

@@ -207,11 +222,13 @@ static String getJava(Path image) {
207222

208223
static final String REGULAR_STARTUP_LINE1_STRING = "Serving";
209224
static final String REGULAR_STARTUP_LINE2_STRING = "URL http://";
225+
static final String VERSION_STARTUP_LINE_STRING = "java " + JAVA_VERSION;
210226

211227
// The stdout/stderr output line to wait for when starting the simpleserver
212228
enum WaitForLine {
213229
REGULAR_STARTUP_LINE (REGULAR_STARTUP_LINE2_STRING) ,
214-
HELP_STARTUP_LINE (OPTIONS_TEXT.lines().reduce((first, second) -> second).orElseThrow());
230+
HELP_STARTUP_LINE (OPTIONS_TEXT.lines().reduce((first, second) -> second).orElseThrow()),
231+
VERSION_STARTUP_LINE (VERSION_STARTUP_LINE_STRING);
215232

216233
final String value;
217234
WaitForLine(String value) { this.value = value; }

‎test/jdk/com/sun/net/httpserver/simpleserver/jwebserver/CommandLineNegativeTest.java

+245
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,245 @@
1+
/*
2+
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
/*
25+
* @test
26+
* @summary Negative tests for the jwebserver command-line tool
27+
* @library /test/lib
28+
* @modules jdk.httpserver
29+
* @run testng/othervm CommandLineNegativeTest
30+
*/
31+
32+
import java.io.IOException;
33+
import java.net.InetAddress;
34+
import java.nio.file.Files;
35+
import java.nio.file.Path;
36+
import jdk.test.lib.Platform;
37+
import jdk.test.lib.process.OutputAnalyzer;
38+
import jdk.test.lib.process.ProcessTools;
39+
import jdk.test.lib.util.FileUtils;
40+
import org.testng.SkipException;
41+
import org.testng.annotations.AfterTest;
42+
import org.testng.annotations.BeforeTest;
43+
import org.testng.annotations.DataProvider;
44+
import org.testng.annotations.Test;
45+
import static java.lang.System.out;
46+
import static org.testng.Assert.assertFalse;
47+
48+
public class CommandLineNegativeTest {
49+
50+
static final Path JAVA_HOME = Path.of(System.getProperty("java.home"));
51+
static final String JWEBSERVER = getJwebserver(JAVA_HOME);
52+
static final Path CWD = Path.of(".").toAbsolutePath().normalize();
53+
static final Path TEST_DIR = CWD.resolve("CommandLineNegativeTest");
54+
static final Path TEST_FILE = TEST_DIR.resolve("file.txt");
55+
static final String LOOPBACK_ADDR = InetAddress.getLoopbackAddress().getHostAddress();
56+
57+
@BeforeTest
58+
public void setup() throws IOException {
59+
if (Files.exists(TEST_DIR)) {
60+
FileUtils.deleteFileTreeWithRetry(TEST_DIR);
61+
}
62+
Files.createDirectories(TEST_DIR);
63+
Files.createFile(TEST_FILE);
64+
}
65+
66+
@DataProvider
67+
public Object[][] unknownOption() {
68+
return new Object[][] {
69+
{"--unknownOption"},
70+
{"null"}
71+
};
72+
}
73+
74+
@Test(dataProvider = "unknownOption")
75+
public void testBadOption(String opt) throws Throwable {
76+
out.println("\n--- testUnknownOption, opt=\"%s\" ".formatted(opt));
77+
simpleserver(JWEBSERVER, opt)
78+
.shouldNotHaveExitValue(0)
79+
.shouldContain("Error: unknown option: " + opt);
80+
}
81+
82+
@DataProvider
83+
public Object[][] tooManyOptionArgs() {
84+
return new Object[][] {
85+
{"-b", "localhost"},
86+
{"-d", "/some/path"},
87+
{"-o", "none"},
88+
{"-p", "0"},
89+
{"--bind-address", "localhost"},
90+
{"--directory", "/some/path"},
91+
{"--output", "none"},
92+
{"--port", "0"}
93+
// doesn't fail for -h option
94+
};
95+
}
96+
97+
@Test(dataProvider = "tooManyOptionArgs")
98+
public void testTooManyOptionArgs(String opt, String arg) throws Throwable {
99+
out.println("\n--- testTooManyOptionArgs, opt=\"%s\" ".formatted(opt));
100+
simpleserver(JWEBSERVER, opt, arg, arg)
101+
.shouldNotHaveExitValue(0)
102+
.shouldContain("Error: unknown option: " + arg);
103+
}
104+
105+
@DataProvider
106+
public Object[][] noArg() {
107+
return new Object[][] {
108+
{"-b", """
109+
-b, --bind-address - Address to bind to. Default: %s (loopback).
110+
For all interfaces use "-b 0.0.0.0" or "-b ::".""".formatted(LOOPBACK_ADDR)},
111+
{"-d", "-d, --directory - Directory to serve. Default: current directory."},
112+
{"-o", "-o, --output - Output format. none|info|verbose. Default: info."},
113+
{"-p", "-p, --port - Port to listen on. Default: 8000."},
114+
{"--bind-address", """
115+
-b, --bind-address - Address to bind to. Default: %s (loopback).
116+
For all interfaces use "-b 0.0.0.0" or "-b ::".""".formatted(LOOPBACK_ADDR)},
117+
{"--directory", "-d, --directory - Directory to serve. Default: current directory."},
118+
{"--output", "-o, --output - Output format. none|info|verbose. Default: info."},
119+
{"--port", "-p, --port - Port to listen on. Default: 8000."}
120+
// doesn't fail for -h option
121+
};
122+
}
123+
124+
@Test(dataProvider = "noArg")
125+
public void testNoArg(String opt, String msg) throws Throwable {
126+
out.println("\n--- testNoArg, opt=\"%s\" ".formatted(opt));
127+
simpleserver(JWEBSERVER, opt)
128+
.shouldNotHaveExitValue(0)
129+
.shouldContain("Error: no value given for " + opt)
130+
.shouldContain(msg);
131+
}
132+
133+
@DataProvider
134+
public Object[][] invalidValue() {
135+
return new Object[][] {
136+
{"-b", "[127.0.0.1]"},
137+
{"-b", "badhost"},
138+
{"--bind-address", "192.168.1.220..."},
139+
140+
{"-o", "bad-output-level"},
141+
{"--output", "bad-output-level"},
142+
143+
{"-p", "+-"},
144+
{"--port", "+-"}
145+
};
146+
}
147+
148+
@Test(dataProvider = "invalidValue")
149+
public void testInvalidValue(String opt, String val) throws Throwable {
150+
out.println("\n--- testInvalidValue, opt=\"%s\" ".formatted(opt));
151+
simpleserver(JWEBSERVER, opt, val)
152+
.shouldNotHaveExitValue(0)
153+
.shouldContain("Error: invalid value given for " + opt + ": " + val);
154+
}
155+
156+
@DataProvider
157+
public Object[][] portOptions() { return new Object[][] {{"-p"}, {"--port"}}; }
158+
159+
@Test(dataProvider = "portOptions")
160+
public void testPortOutOfRange(String opt) throws Throwable {
161+
out.println("\n--- testPortOutOfRange, opt=\"%s\" ".formatted(opt));
162+
simpleserver(JWEBSERVER, opt, "65536") // range 0 to 65535
163+
.shouldNotHaveExitValue(0)
164+
.shouldContain("Error: server config failed: " + "port out of range:65536");
165+
}
166+
167+
@DataProvider
168+
public Object[][] directoryOptions() { return new Object[][] {{"-d"}, {"--directory"}}; }
169+
170+
@Test(dataProvider = "directoryOptions")
171+
public void testRootNotAbsolute(String opt) throws Throwable {
172+
out.println("\n--- testRootNotAbsolute, opt=\"%s\" ".formatted(opt));
173+
var root = Path.of(".");
174+
assertFalse(root.isAbsolute());
175+
simpleserver(JWEBSERVER, opt, root.toString())
176+
.shouldNotHaveExitValue(0)
177+
.shouldContain("Error: server config failed: " + "Path is not absolute:");
178+
}
179+
180+
@Test(dataProvider = "directoryOptions")
181+
public void testRootNotADirectory(String opt) throws Throwable {
182+
out.println("\n--- testRootNotADirectory, opt=\"%s\" ".formatted(opt));
183+
var file = TEST_FILE.toString();
184+
assertFalse(Files.isDirectory(TEST_FILE));
185+
simpleserver(JWEBSERVER, opt, file)
186+
.shouldNotHaveExitValue(0)
187+
.shouldContain("Error: server config failed: " + "Path is not a directory: " + file);
188+
}
189+
190+
@Test(dataProvider = "directoryOptions")
191+
public void testRootDoesNotExist(String opt) throws Throwable {
192+
out.println("\n--- testRootDoesNotExist, opt=\"%s\" ".formatted(opt));
193+
Path root = TEST_DIR.resolve("not/existent/dir");
194+
assertFalse(Files.exists(root));
195+
simpleserver(JWEBSERVER, opt, root.toString())
196+
.shouldNotHaveExitValue(0)
197+
.shouldContain("Error: server config failed: " + "Path does not exist: " + root.toString());
198+
}
199+
200+
@Test(dataProvider = "directoryOptions")
201+
public void testRootNotReadable(String opt) throws Throwable {
202+
out.println("\n--- testRootNotReadable, opt=\"%s\" ".formatted(opt));
203+
if (Platform.isWindows()) {
204+
// Not applicable to Windows. Reason: cannot revoke an owner's read
205+
// access to a directory that was created by that owner
206+
throw new SkipException("cannot run on Windows");
207+
}
208+
Path root = Files.createDirectories(TEST_DIR.resolve("not/readable/dir"));
209+
try {
210+
root.toFile().setReadable(false, false);
211+
assertFalse(Files.isReadable(root));
212+
simpleserver(JWEBSERVER, opt, root.toString())
213+
.shouldNotHaveExitValue(0)
214+
.shouldContain("Error: server config failed: " + "Path is not readable: " + root.toString());
215+
} finally {
216+
root.toFile().setReadable(true, false);
217+
}
218+
}
219+
220+
@AfterTest
221+
public void teardown() throws IOException {
222+
if (Files.exists(TEST_DIR)) {
223+
FileUtils.deleteFileTreeWithRetry(TEST_DIR);
224+
}
225+
}
226+
227+
// --- infra ---
228+
229+
static String getJwebserver(Path image) {
230+
boolean isWindows = System.getProperty("os.name").startsWith("Windows");
231+
Path jwebserver = image.resolve("bin").resolve(isWindows ? "jwebserver.exe" : "jwebserver");
232+
if (Files.notExists(jwebserver))
233+
throw new RuntimeException(jwebserver + " not found");
234+
return jwebserver.toAbsolutePath().toString();
235+
}
236+
237+
static OutputAnalyzer simpleserver(String... args) throws Throwable {
238+
var pb = new ProcessBuilder(args)
239+
.directory(TEST_DIR.toFile());
240+
var outputAnalyser = ProcessTools.executeCommand(pb)
241+
.outputTo(System.out)
242+
.errorTo(System.out);
243+
return outputAnalyser;
244+
}
245+
}

‎test/jdk/com/sun/net/httpserver/simpleserver/jwebserver/CommandLinePortNotSpecifiedTest.java

+154
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
/*
2+
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
/*
25+
* @test
26+
* @bug 8276848
27+
* @summary Tests the jwebserver tool with port not specified
28+
* @modules jdk.httpserver
29+
* @library /test/lib
30+
* @run testng/othervm/manual CommandLinePortNotSpecifiedTest
31+
*/
32+
33+
import java.io.IOException;
34+
import java.net.InetAddress;
35+
import java.nio.file.Files;
36+
import java.nio.file.Path;
37+
import java.util.concurrent.TimeUnit;
38+
import jdk.test.lib.Platform;
39+
import jdk.test.lib.process.OutputAnalyzer;
40+
import jdk.test.lib.process.ProcessTools;
41+
import jdk.test.lib.util.FileUtils;
42+
import org.testng.annotations.AfterTest;
43+
import org.testng.annotations.BeforeTest;
44+
import org.testng.annotations.Test;
45+
import static java.lang.System.out;
46+
47+
public class CommandLinePortNotSpecifiedTest {
48+
49+
static final Path JAVA_HOME = Path.of(System.getProperty("java.home"));
50+
static final String JWEBSERVER = getJwebserver(JAVA_HOME);
51+
static final Path CWD = Path.of(".").toAbsolutePath().normalize();
52+
static final Path TEST_DIR = CWD.resolve("CommandLinePortNotSpecifiedTest");
53+
static final Path TEST_FILE = TEST_DIR.resolve("file.txt");
54+
static final String TEST_DIR_STR = TEST_DIR.toString();
55+
static final String LOOPBACK_ADDR = InetAddress.getLoopbackAddress().getHostAddress();
56+
57+
@BeforeTest
58+
public void setup() throws IOException {
59+
if (Files.exists(TEST_DIR)) {
60+
FileUtils.deleteFileTreeWithRetry(TEST_DIR);
61+
}
62+
Files.createDirectories(TEST_DIR);
63+
Files.createFile(TEST_FILE);
64+
}
65+
66+
static final int SIGTERM = 15;
67+
static final int NORMAL_EXIT_CODE = normalExitCode();
68+
69+
static int normalExitCode() {
70+
if (Platform.isWindows()) {
71+
return 1; // expected process destroy exit code
72+
} else {
73+
// signal terminated exit code on Unix is 128 + signal value
74+
return 128 + SIGTERM;
75+
}
76+
}
77+
78+
/**
79+
* This is a manual test to confirm the command-line tool starts successfully
80+
* in the case where the port is not specified. In this case the server uses
81+
* the default port 8000. The test is manual to avoid a BindException in the
82+
* unlikely but not impossible case that the port is already in use.
83+
*/
84+
@Test
85+
public void testPortNotSpecified() throws Throwable {
86+
out.println("\n--- testPortNotSpecified");
87+
simpleserver(JWEBSERVER)
88+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
89+
.shouldContain("Binding to loopback by default. For all interfaces use \"-b 0.0.0.0\" or \"-b ::\".")
90+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on " + LOOPBACK_ADDR + " port")
91+
.shouldContain("URL http://" + LOOPBACK_ADDR);
92+
}
93+
94+
@AfterTest
95+
public void teardown() throws IOException {
96+
if (Files.exists(TEST_DIR)) {
97+
FileUtils.deleteFileTreeWithRetry(TEST_DIR);
98+
}
99+
}
100+
101+
// --- infra ---
102+
103+
static String getJwebserver(Path image) {
104+
boolean isWindows = System.getProperty("os.name").startsWith("Windows");
105+
Path jwebserver = image.resolve("bin").resolve(isWindows ? "jwebserver.exe" : "jwebserver");
106+
if (Files.notExists(jwebserver))
107+
throw new RuntimeException(jwebserver + " not found");
108+
return jwebserver.toAbsolutePath().toString();
109+
}
110+
111+
static final String REGULAR_STARTUP_LINE1_STRING = "Serving";
112+
static final String REGULAR_STARTUP_LINE2_STRING = "URL http://";
113+
114+
static final String OPTIONS_TEXT = """
115+
Options:
116+
-b, --bind-address - Address to bind to. Default: %s (loopback).
117+
For all interfaces use "-b 0.0.0.0" or "-b ::".
118+
-d, --directory - Directory to serve. Default: current directory.
119+
-o, --output - Output format. none|info|verbose. Default: info.
120+
-p, --port - Port to listen on. Default: 8000.
121+
-h, -?, --help - Prints this help message and exits.
122+
-version, --version - Prints version information and exits.
123+
To stop the server, press Ctrl + C.""".formatted(LOOPBACK_ADDR);
124+
125+
// The stdout/stderr output line to wait for when starting the simpleserver
126+
enum WaitForLine {
127+
REGULAR_STARTUP_LINE (REGULAR_STARTUP_LINE2_STRING) ,
128+
HELP_STARTUP_LINE (OPTIONS_TEXT.lines().reduce((first, second) -> second).orElseThrow());
129+
130+
final String value;
131+
WaitForLine(String value) { this.value = value; }
132+
}
133+
134+
static OutputAnalyzer simpleserver(String... args) throws Throwable {
135+
return simpleserver(WaitForLine.REGULAR_STARTUP_LINE, true, args);
136+
}
137+
138+
static OutputAnalyzer simpleserver(WaitForLine waitForLine, boolean destroy, String... args) throws Throwable {
139+
StringBuffer sb = new StringBuffer(); // stdout & stderr
140+
// start the process and await the waitForLine before returning
141+
var p = ProcessTools.startProcess("simpleserver",
142+
new ProcessBuilder(args).directory(TEST_DIR.toFile()),
143+
line -> sb.append(line + "\n"),
144+
line -> line.startsWith(waitForLine.value),
145+
30, // suitably high default timeout, not expected to timeout
146+
TimeUnit.SECONDS);
147+
if (destroy) {
148+
p.destroy(); // SIGTERM on Unix
149+
}
150+
int ec = p.waitFor();
151+
var outputAnalyser = new OutputAnalyzer(sb.toString(), "", ec);
152+
return outputAnalyser;
153+
}
154+
}

‎test/jdk/com/sun/net/httpserver/simpleserver/jwebserver/CommandLinePositiveTest.java

+257
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,257 @@
1+
/*
2+
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
3+
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4+
*
5+
* This code is free software; you can redistribute it and/or modify it
6+
* under the terms of the GNU General Public License version 2 only, as
7+
* published by the Free Software Foundation.
8+
*
9+
* This code is distributed in the hope that it will be useful, but WITHOUT
10+
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11+
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12+
* version 2 for more details (a copy is included in the LICENSE file that
13+
* accompanied this code).
14+
*
15+
* You should have received a copy of the GNU General Public License version
16+
* 2 along with this work; if not, write to the Free Software Foundation,
17+
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*
19+
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20+
* or visit www.oracle.com if you need additional information or have any
21+
* questions.
22+
*/
23+
24+
/*
25+
* @test
26+
* @summary Positive tests for the jwebserver command-line tool
27+
* @library /test/lib
28+
* @modules jdk.httpserver
29+
* @run testng/othervm CommandLinePositiveTest
30+
*/
31+
32+
import java.io.IOException;
33+
import java.net.InetAddress;
34+
import java.nio.file.Files;
35+
import java.nio.file.Path;
36+
import java.util.concurrent.TimeUnit;
37+
import jdk.test.lib.Platform;
38+
import jdk.test.lib.process.OutputAnalyzer;
39+
import jdk.test.lib.process.ProcessTools;
40+
import jdk.test.lib.util.FileUtils;
41+
import org.testng.annotations.AfterTest;
42+
import org.testng.annotations.BeforeTest;
43+
import org.testng.annotations.DataProvider;
44+
import org.testng.annotations.Test;
45+
import static java.lang.System.out;
46+
47+
public class CommandLinePositiveTest {
48+
49+
static final String JAVA_VERSION = System.getProperty("java.version");
50+
static final Path JAVA_HOME = Path.of(System.getProperty("java.home"));
51+
static final String JWEBSERVER = getJwebserver(JAVA_HOME);
52+
static final Path CWD = Path.of(".").toAbsolutePath().normalize();
53+
static final Path TEST_DIR = CWD.resolve("CommandLinePositiveTest");
54+
static final Path TEST_FILE = TEST_DIR.resolve("file.txt");
55+
static final String TEST_DIR_STR = TEST_DIR.toString();
56+
static final String LOOPBACK_ADDR = InetAddress.getLoopbackAddress().getHostAddress();
57+
58+
@BeforeTest
59+
public void setup() throws IOException {
60+
if (Files.exists(TEST_DIR)) {
61+
FileUtils.deleteFileTreeWithRetry(TEST_DIR);
62+
}
63+
Files.createDirectories(TEST_DIR);
64+
Files.createFile(TEST_FILE);
65+
}
66+
67+
static final int SIGTERM = 15;
68+
static final int NORMAL_EXIT_CODE = normalExitCode();
69+
70+
static int normalExitCode() {
71+
if (Platform.isWindows()) {
72+
return 1; // expected process destroy exit code
73+
} else {
74+
// signal terminated exit code on Unix is 128 + signal value
75+
return 128 + SIGTERM;
76+
}
77+
}
78+
79+
@DataProvider
80+
public Object[][] directoryOptions() { return new Object[][] {{"-d"}, {"--directory"}}; }
81+
82+
@Test(dataProvider = "directoryOptions")
83+
public void testDirectory(String opt) throws Throwable {
84+
out.println("\n--- testDirectory, opt=\"%s\" ".formatted(opt));
85+
simpleserver(JWEBSERVER, "-p", "0", opt, TEST_DIR_STR)
86+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
87+
.shouldContain("Binding to loopback by default. For all interfaces use \"-b 0.0.0.0\" or \"-b ::\".")
88+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on " + LOOPBACK_ADDR + " port")
89+
.shouldContain("URL http://" + LOOPBACK_ADDR);
90+
}
91+
92+
@DataProvider
93+
public Object[][] portOptions() { return new Object[][] {{"-p"}, {"--port"}}; }
94+
95+
@Test(dataProvider = "portOptions")
96+
public void testPort(String opt) throws Throwable {
97+
out.println("\n--- testPort, opt=\"%s\" ".formatted(opt));
98+
simpleserver(JWEBSERVER, opt, "0")
99+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
100+
.shouldContain("Binding to loopback by default. For all interfaces use \"-b 0.0.0.0\" or \"-b ::\".")
101+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on " + LOOPBACK_ADDR + " port")
102+
.shouldContain("URL http://" + LOOPBACK_ADDR);
103+
}
104+
105+
@DataProvider
106+
public Object[][] helpOptions() { return new Object[][] {{"-h"}, {"-?"}, {"--help"}}; }
107+
108+
static final String USAGE_TEXT = """
109+
Usage: jwebserver [-b bind address] [-p port] [-d directory]
110+
[-o none|info|verbose] [-h to show options]
111+
[-version to show version information]""";
112+
113+
static final String OPTIONS_TEXT = """
114+
Options:
115+
-b, --bind-address - Address to bind to. Default: %s (loopback).
116+
For all interfaces use "-b 0.0.0.0" or "-b ::".
117+
-d, --directory - Directory to serve. Default: current directory.
118+
-o, --output - Output format. none|info|verbose. Default: info.
119+
-p, --port - Port to listen on. Default: 8000.
120+
-h, -?, --help - Prints this help message and exits.
121+
-version, --version - Prints version information and exits.
122+
To stop the server, press Ctrl + C.""".formatted(LOOPBACK_ADDR);
123+
124+
@Test(dataProvider = "helpOptions")
125+
public void testHelp(String opt) throws Throwable {
126+
out.println("\n--- testHelp, opt=\"%s\" ".formatted(opt));
127+
simpleserver(WaitForLine.HELP_STARTUP_LINE,
128+
false, // do not explicitly destroy the process
129+
JWEBSERVER, opt)
130+
.shouldHaveExitValue(0)
131+
.shouldContain(USAGE_TEXT)
132+
.shouldContain(OPTIONS_TEXT);
133+
}
134+
135+
@DataProvider
136+
public Object[][] versionOptions() { return new Object[][] {{"-version"}, {"--version"}}; }
137+
138+
@Test(dataProvider = "versionOptions")
139+
public void testVersion(String opt) throws Throwable {
140+
out.println("\n--- testVersion, opt=\"%s\" ".formatted(opt));
141+
simpleserver(WaitForLine.VERSION_STARTUP_LINE,
142+
false, // do not explicitly destroy the process
143+
JWEBSERVER, opt)
144+
.shouldHaveExitValue(0);
145+
}
146+
147+
@DataProvider
148+
public Object[][] bindOptions() { return new Object[][] {{"-b"}, {"--bind-address"}}; }
149+
150+
@Test(dataProvider = "bindOptions")
151+
public void testBindAllInterfaces(String opt) throws Throwable {
152+
out.println("\n--- testBindAllInterfaces, opt=\"%s\" ".formatted(opt));
153+
simpleserver(JWEBSERVER, "-p", "0", opt, "0.0.0.0")
154+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
155+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on 0.0.0.0 (all interfaces) port")
156+
.shouldContain("URL http://" + InetAddress.getLocalHost().getHostAddress());
157+
simpleserver(JWEBSERVER, opt, "::0")
158+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
159+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on 0.0.0.0 (all interfaces) port")
160+
.shouldContain("URL http://" + InetAddress.getLocalHost().getHostAddress());
161+
}
162+
163+
@Test(dataProvider = "bindOptions")
164+
public void testLastOneWinsBindAddress(String opt) throws Throwable {
165+
out.println("\n--- testLastOneWinsBindAddress, opt=\"%s\" ".formatted(opt));
166+
simpleserver(JWEBSERVER, "-p", "0", opt, "123.4.5.6", opt, LOOPBACK_ADDR)
167+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
168+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on " + LOOPBACK_ADDR + " port")
169+
.shouldContain("URL http://" + LOOPBACK_ADDR);
170+
171+
}
172+
173+
@Test(dataProvider = "directoryOptions")
174+
public void testLastOneWinsDirectory(String opt) throws Throwable {
175+
out.println("\n--- testLastOneWinsDirectory, opt=\"%s\" ".formatted(opt));
176+
simpleserver(JWEBSERVER, "-p", "0", opt, TEST_DIR_STR, opt, TEST_DIR_STR)
177+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
178+
.shouldContain("Binding to loopback by default. For all interfaces use \"-b 0.0.0.0\" or \"-b ::\".")
179+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on " + LOOPBACK_ADDR + " port")
180+
.shouldContain("URL http://" + LOOPBACK_ADDR);
181+
}
182+
183+
@DataProvider
184+
public Object[][] outputOptions() { return new Object[][] {{"-o"}, {"--output"}}; }
185+
186+
@Test(dataProvider = "outputOptions")
187+
public void testLastOneWinsOutput(String opt) throws Throwable {
188+
out.println("\n--- testLastOneWinsOutput, opt=\"%s\" ".formatted(opt));
189+
simpleserver(JWEBSERVER, "-p", "0", opt, "none", opt, "verbose")
190+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
191+
.shouldContain("Binding to loopback by default. For all interfaces use \"-b 0.0.0.0\" or \"-b ::\".")
192+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on " + LOOPBACK_ADDR + " port")
193+
.shouldContain("URL http://" + LOOPBACK_ADDR);
194+
}
195+
196+
@Test(dataProvider = "portOptions")
197+
public void testLastOneWinsPort(String opt) throws Throwable {
198+
out.println("\n--- testLastOneWinsPort, opt=\"%s\" ".formatted(opt));
199+
simpleserver(JWEBSERVER, opt, "-999", opt, "0")
200+
.shouldHaveExitValue(NORMAL_EXIT_CODE)
201+
.shouldContain("Binding to loopback by default. For all interfaces use \"-b 0.0.0.0\" or \"-b ::\".")
202+
.shouldContain("Serving " + TEST_DIR_STR + " and subdirectories on " + LOOPBACK_ADDR + " port")
203+
.shouldContain("URL http://" + LOOPBACK_ADDR);
204+
}
205+
206+
@AfterTest
207+
public void teardown() throws IOException {
208+
if (Files.exists(TEST_DIR)) {
209+
FileUtils.deleteFileTreeWithRetry(TEST_DIR);
210+
}
211+
}
212+
213+
// --- infra ---
214+
215+
static String getJwebserver(Path image) {
216+
boolean isWindows = System.getProperty("os.name").startsWith("Windows");
217+
Path jwebserver = image.resolve("bin").resolve(isWindows ? "jwebserver.exe" : "jwebserver");
218+
if (Files.notExists(jwebserver))
219+
throw new RuntimeException(jwebserver + " not found");
220+
return jwebserver.toAbsolutePath().toString();
221+
}
222+
223+
static final String REGULAR_STARTUP_LINE1_STRING = "Serving";
224+
static final String REGULAR_STARTUP_LINE2_STRING = "URL http://";
225+
static final String VERSION_STARTUP_LINE_STRING = "jwebserver " + JAVA_VERSION;
226+
227+
// The stdout/stderr output line to wait for when starting the simpleserver
228+
enum WaitForLine {
229+
REGULAR_STARTUP_LINE (REGULAR_STARTUP_LINE2_STRING) ,
230+
HELP_STARTUP_LINE (OPTIONS_TEXT.lines().reduce((first, second) -> second).orElseThrow()),
231+
VERSION_STARTUP_LINE (VERSION_STARTUP_LINE_STRING);
232+
233+
final String value;
234+
WaitForLine(String value) { this.value = value; }
235+
}
236+
237+
static OutputAnalyzer simpleserver(String... args) throws Throwable {
238+
return simpleserver(WaitForLine.REGULAR_STARTUP_LINE, true, args);
239+
}
240+
241+
static OutputAnalyzer simpleserver(WaitForLine waitForLine, boolean destroy, String... args) throws Throwable {
242+
StringBuffer sb = new StringBuffer(); // stdout & stderr
243+
// start the process and await the waitForLine before returning
244+
var p = ProcessTools.startProcess("simpleserver",
245+
new ProcessBuilder(args).directory(TEST_DIR.toFile()),
246+
line -> sb.append(line + "\n"),
247+
line -> line.startsWith(waitForLine.value),
248+
30, // suitably high default timeout, not expected to timeout
249+
TimeUnit.SECONDS);
250+
if (destroy) {
251+
p.destroy(); // SIGTERM on Unix
252+
}
253+
int ec = p.waitFor();
254+
var outputAnalyser = new OutputAnalyzer(sb.toString(), "", ec);
255+
return outputAnalyser;
256+
}
257+
}

‎test/jdk/tools/launcher/HelpFlagsTest.java

+1
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ private static class ToolHelpSpec {
151151
new ToolHelpSpec("rmiregistry", 0, 0, 0, 0, 0, 0, 1), // none, prints help message anyways.
152152
new ToolHelpSpec("serialver", 0, 0, 0, 0, 0, 0, 1), // none, prints help message anyways.
153153
new ToolHelpSpec("jpackage", 0, 1, 1, 0, 0, 1, 1), // -h, --help,
154+
new ToolHelpSpec("jwebserver", 1, 1, 1, 0, 0, 1, 1), // -?, -h, --help
154155
};
155156

156157
// Returns corresponding object from jdkTools array.

‎test/jdk/tools/launcher/VersionCheck.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ public class VersionCheck extends TestHelper {
6161
"jmc.ini",
6262
"jweblauncher",
6363
"jpackage",
64-
"ssvagent"
64+
"ssvagent",
65+
"jwebserver"
6566
};
6667

6768
// tools that do not accept -version

0 commit comments

Comments
 (0)
Please sign in to comment.