Skip to content

Commit

Permalink
#9910 - add combinations test
Browse files Browse the repository at this point in the history 
Signed-off-by: Ludovic Orban <[email protected]>
  • Loading branch information
@lorban
lorban committed Jul 4, 2023
1 parent dbe9a25 commit be8d4c6
Showing 1 changed file with 191 additions and 0 deletions.
191 changes: 191 additions & 0 deletions ...-servlet/src/test/java/org/eclipse/jetty/ee10/servlet/DefaultServletCombinationsTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//

package org.eclipse.jetty.ee10.servlet;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.stream.Stream;

import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.eclipse.jetty.http.HttpHeader;
import org.eclipse.jetty.http.HttpStatus;
import org.eclipse.jetty.http.HttpTester;
import org.eclipse.jetty.server.HttpConfiguration;
import org.eclipse.jetty.server.LocalConnector;
import org.eclipse.jetty.server.ResourceService;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.toolchain.test.FS;
import org.eclipse.jetty.toolchain.test.jupiter.WorkDir;
import org.eclipse.jetty.toolchain.test.jupiter.WorkDirExtension;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.MethodSource;

import static java.nio.charset.StandardCharsets.UTF_8;
import static org.eclipse.jetty.server.ResourceService.WelcomeMode.REDIRECT;
import static org.eclipse.jetty.server.ResourceService.WelcomeMode.REHANDLE;
import static org.eclipse.jetty.server.ResourceService.WelcomeMode.SERVE;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;

@ExtendWith(WorkDirExtension.class)
public class DefaultServletCombinationsTest
{
public WorkDir workDir;

public Path docRoot;
private Server server;
private LocalConnector connector;
private ServletContextHandler context;

@BeforeEach
public void init() throws Exception
{
docRoot = workDir.getEmptyPathDir().resolve("docroot");
FS.ensureDirExists(docRoot);
Path subdirPath = docRoot.resolve("subdir");
FS.ensureDirExists(subdirPath);
Files.writeString(docRoot.resolve("index.html"), "Static index.html at root", UTF_8);
Files.writeString(docRoot.resolve("foo.welcome"), "Static foo.welcome at root", UTF_8);
Files.writeString(subdirPath.resolve("index.html"), "Static index.html at subdir", UTF_8);
Files.writeString(subdirPath.resolve("foo.welcome"), "Static foo.welcome at subdir", UTF_8);

server = new Server();

connector = new LocalConnector(server);
connector.getConnectionFactory(HttpConfiguration.ConnectionFactory.class).getHttpConfiguration().setSendServerVersion(false);

context = new ServletContextHandler();
context.setBaseResourceAsPath(docRoot);
context.setContextPath("/");
context.setWelcomeFiles(new String[]{"index.html", "index.welcome"});

ServletHolder welcomeExtHolder = context.addServlet(WelcomeServlet.class, "*.welcome");
welcomeExtHolder.setInitParameter("mapping", "welcome extension");
}

private void startServer(boolean pathInfoOnly, ResourceService.WelcomeMode welcomeMode) throws Exception
{
ServletHolder defaultHolder = context.addServlet(DefaultServlet.class, "/");
defaultHolder.setInitParameter("pathInfoOnly", String.valueOf(pathInfoOnly));

server.setHandler(context);
server.addConnector(connector);

server.start();
((DefaultServlet)defaultHolder.getServlet()).getResourceService().setWelcomeMode(welcomeMode);
}

@AfterEach
public void destroy() throws Exception
{
server.stop();
server.join();
}

public static class WelcomeServlet extends HttpServlet
{
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException
{
resp.setStatus(200);
String mapping = getInitParameter("mapping");
resp.getWriter().print("Servlet at " + mapping);
}
}

record Data(boolean pathInfoOnly, ResourceService.WelcomeMode welcomeMode, String requestPath, int expectedStatus, String expected)
{
}

public static Stream<Data> data()
{
return Stream.of(
new Data(false, SERVE, "/", HttpStatus.OK_200, "Static index.html at root"),
new Data(false, REDIRECT, "/", HttpStatus.FOUND_302, "http://local/index.html"),
new Data(false, REHANDLE, "/", HttpStatus.OK_200, "Static index.html at root"),
new Data(true, SERVE, "/", HttpStatus.FOUND_302, "http://local/index.html/"),
new Data(true, REDIRECT, "/", HttpStatus.FOUND_302, "http://local/index.html"),
new Data(true, REHANDLE, "/", HttpStatus.FOUND_302, "http://local/index.html/"),

new Data(false, SERVE, "/index.html", HttpStatus.OK_200, "Static index.html at root"),
new Data(false, REDIRECT, "/index.html", HttpStatus.OK_200, "Static index.html at root"),
new Data(false, REHANDLE, "/index.html", HttpStatus.OK_200, "Static index.html at root"),
new Data(true, SERVE, "/index.html", HttpStatus.FOUND_302, "http://local/index.html/"),
new Data(true, REDIRECT, "/index.html", HttpStatus.FOUND_302, "http://local/index.html/"),
new Data(true, REHANDLE, "/index.html", HttpStatus.FOUND_302, "http://local/index.html/"),

new Data(false, SERVE, "/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(false, REDIRECT, "/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(false, REHANDLE, "/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, SERVE, "/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, REDIRECT, "/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, REHANDLE, "/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),

new Data(false, SERVE, "/subdir/", HttpStatus.OK_200, "Static index.html at subdir"),
new Data(false, REDIRECT, "/subdir/", HttpStatus.FOUND_302, "http://local/subdir/index.html"),
new Data(false, REHANDLE, "/subdir/", HttpStatus.OK_200, "Static index.html at subdir"),
new Data(true, SERVE, "/subdir/", HttpStatus.FOUND_302, "http://local/subdir/index.html/"),
new Data(true, REDIRECT, "/subdir/", HttpStatus.FOUND_302, "http://local/subdir/subdir/index.html"),
new Data(true, REHANDLE, "/subdir/", HttpStatus.FOUND_302, "http://local/subdir/index.html/"),

new Data(false, SERVE, "/subdir/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(false, REDIRECT, "/subdir/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(false, REHANDLE, "/subdir/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, SERVE, "/subdir/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, REDIRECT, "/subdir/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, REHANDLE, "/subdir/foo.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),

new Data(false, SERVE, "/nothing/index.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(false, REDIRECT, "/nothing/index.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(false, REHANDLE, "/nothing/index.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, SERVE, "/nothing/index.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, REDIRECT, "/nothing/index.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),
new Data(true, REHANDLE, "/nothing/index.welcome", HttpStatus.OK_200, "Servlet at welcome extension"),

new Data(false, SERVE, "/nothing/", HttpStatus.NOT_FOUND_404, null),
new Data(false, REDIRECT, "/nothing/", HttpStatus.NOT_FOUND_404, null),
new Data(false, REHANDLE, "/nothing/", HttpStatus.NOT_FOUND_404, null),
new Data(true, SERVE, "/nothing/", HttpStatus.FOUND_302, "http://local/nothing/index.html/"),
new Data(true, REDIRECT, "/nothing/", HttpStatus.FOUND_302, "http://local/nothing/nothing/index.html"),
new Data(true, REHANDLE, "/nothing/", HttpStatus.FOUND_302, "http://local/nothing/index.html/")
);
}

@ParameterizedTest
@MethodSource("data")
public void testCombinations(Data data) throws Exception
{
startServer(data.pathInfoOnly(), data.welcomeMode());
String rawResponse = connector.getResponse(String.format("""
GET %s HTTP/1.1\r
Host: local\r
Connection: close\r
\r
""", data.requestPath()));
HttpTester.Response response = HttpTester.parseResponse(rawResponse);
int status = response.getStatus();
assertThat(response.toString(), status, is(data.expectedStatus()));
if (status > 299 && status < 400)
assertThat(response.get(HttpHeader.LOCATION), is(data.expected));
else if (data.expected != null)
assertThat(response.getContent(), is(data.expected));
}
}

0 comments on commit be8d4c6

Please sign in to comment.