Skip to content

Commit

Permalink
Issue #12697 - improve testing for FormAuthenticatorTest
Browse files Browse the repository at this point in the history 
Signed-off-by: Lachlan Roberts <[email protected]>
  • Loading branch information
@lachlan-roberts
lachlan-roberts committed Jan 10, 2025
1 parent 7f31cb4 commit cf504e5
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 10 deletions.
35 changes: 30 additions & 5 deletions ...-servlet/src/test/java/org/eclipse/jetty/ee10/servlet/security/FormAuthenticatorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.eclipse.jetty.ee10.servlet.ErrorPageErrorHandler;
import org.eclipse.jetty.ee10.servlet.ServletContextHandler;
import org.eclipse.jetty.security.Constraint;
import org.eclipse.jetty.security.EmptyLoginService;
Expand All @@ -28,25 +29,28 @@
import org.eclipse.jetty.server.LocalConnector;
import org.eclipse.jetty.server.Server;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.startsWith;

public class FormAuthenticatorTest
{
private Server _server;
private LocalConnector _connector;

@BeforeEach
public void configureServer() throws Exception
public void configureServer(FormAuthenticator authenticator) throws Exception
{
_server = new Server();
_connector = new LocalConnector(_server);
_server.addConnector(_connector);

ServletContextHandler contextHandler = new ServletContextHandler("/ctx", ServletContextHandler.SESSIONS);
ErrorPageErrorHandler errorPageErrorHandler = new ErrorPageErrorHandler();
errorPageErrorHandler.addErrorPage(403, "/servletErrorPage");
contextHandler.setErrorHandler(errorPageErrorHandler);

_server.setHandler(contextHandler);
contextHandler.addServlet(new AuthenticationTestServlet(), "/");

Expand All @@ -56,7 +60,7 @@ public void configureServer() throws Exception
securityHandler.put("/any/*", Constraint.ANY_USER);
securityHandler.put("/known/*", Constraint.KNOWN_ROLE);
securityHandler.put("/admin/*", Constraint.from("admin"));
securityHandler.setAuthenticator(new FormAuthenticator("/login", "/error", true));
securityHandler.setAuthenticator(authenticator);

_server.start();
}
Expand All @@ -76,16 +80,19 @@ protected void service(HttpServletRequest req, HttpServletResponse resp) throws
@AfterEach
public void stopServer() throws Exception
{
if (_server.isRunning())
if (_server != null && _server.isRunning())
{
_server.stop();
_server.join();
_server = null;
_connector = null;
}
}

@Test
public void testLoginDispatch() throws Exception
{
configureServer(new FormAuthenticator("/login", null, true));
String response = _connector.getResponse("GET /ctx/admin/user HTTP/1.0\r\nHost:host:8888\r\n\r\n");
assertThat(response, containsString("HTTP/1.1 200 OK"));
assertThat(response, containsString("dispatcherType: REQUEST"));
Expand All @@ -96,9 +103,27 @@ public void testLoginDispatch() throws Exception
@Test
public void testErrorDispatch() throws Exception
{
// With dispatch enabled it does a AuthenticationState.serveAs to the error page with REQUEST dispatch type.
configureServer(new FormAuthenticator("/login", "/error", true));
String response = _connector.getResponse("GET /ctx/j_security_check?j_username=user&j_password=wrong HTTP/1.0\r\nHost:host:8888\r\n\r\n");
assertThat(response, containsString("dispatcherType: REQUEST"));
assertThat(response, containsString("contextPath: /ctx"));
assertThat(response, containsString("servletPath: /error"));
stopServer();

// With no dispatch it should do a redirect to the error page.
configureServer(new FormAuthenticator("/login", "/error", false));
response = _connector.getResponse("GET /ctx/j_security_check?j_username=user&j_password=wrong HTTP/1.0\r\nHost:host:8888\r\n\r\n");
assertThat(response, startsWith("HTTP/1.1 302 Found"));
assertThat(response, containsString("Location: /ctx/error"));
stopServer();

// With no FormAuthenticator error page, it will do an error dispatch to the servlet error page for that code.
configureServer(new FormAuthenticator("/login", null, true));
response = _connector.getResponse("GET /ctx/j_security_check?j_username=user&j_password=wrong HTTP/1.0\r\nHost:host:8888\r\n\r\n");
assertThat(response, containsString("dispatcherType: ERROR"));
assertThat(response, containsString("contextPath: /ctx"));
assertThat(response, containsString("servletPath: /servletErrorPage"));
stopServer();
}
}
35 changes: 30 additions & 5 deletions ...-servlet/src/test/java/org/eclipse/jetty/ee11/servlet/security/FormAuthenticatorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.eclipse.jetty.ee11.servlet.ErrorPageErrorHandler;
import org.eclipse.jetty.ee11.servlet.ServletContextHandler;
import org.eclipse.jetty.security.Constraint;
import org.eclipse.jetty.security.EmptyLoginService;
Expand All @@ -28,25 +29,28 @@
import org.eclipse.jetty.server.LocalConnector;
import org.eclipse.jetty.server.Server;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.startsWith;

public class FormAuthenticatorTest
{
private Server _server;
private LocalConnector _connector;

@BeforeEach
public void configureServer() throws Exception
public void configureServer(FormAuthenticator authenticator) throws Exception
{
_server = new Server();
_connector = new LocalConnector(_server);
_server.addConnector(_connector);

ServletContextHandler contextHandler = new ServletContextHandler("/ctx", ServletContextHandler.SESSIONS);
ErrorPageErrorHandler errorPageErrorHandler = new ErrorPageErrorHandler();
errorPageErrorHandler.addErrorPage(403, "/servletErrorPage");
contextHandler.setErrorHandler(errorPageErrorHandler);

_server.setHandler(contextHandler);
contextHandler.addServlet(new AuthenticationTestServlet(), "/");

Expand All @@ -56,7 +60,7 @@ public void configureServer() throws Exception
securityHandler.put("/any/*", Constraint.ANY_USER);
securityHandler.put("/known/*", Constraint.KNOWN_ROLE);
securityHandler.put("/admin/*", Constraint.from("admin"));
securityHandler.setAuthenticator(new FormAuthenticator("/login", "/error", true));
securityHandler.setAuthenticator(authenticator);

_server.start();
}
Expand All @@ -76,16 +80,19 @@ protected void service(HttpServletRequest req, HttpServletResponse resp) throws
@AfterEach
public void stopServer() throws Exception
{
if (_server.isRunning())
if (_server != null && _server.isRunning())
{
_server.stop();
_server.join();
_server = null;
_connector = null;
}
}

@Test
public void testLoginDispatch() throws Exception
{
configureServer(new FormAuthenticator("/login", null, true));
String response = _connector.getResponse("GET /ctx/admin/user HTTP/1.0\r\nHost:host:8888\r\n\r\n");
assertThat(response, containsString("HTTP/1.1 200 OK"));
assertThat(response, containsString("dispatcherType: REQUEST"));
Expand All @@ -96,9 +103,27 @@ public void testLoginDispatch() throws Exception
@Test
public void testErrorDispatch() throws Exception
{
// With dispatch enabled it does a AuthenticationState.serveAs to the error page with REQUEST dispatch type.
configureServer(new FormAuthenticator("/login", "/error", true));
String response = _connector.getResponse("GET /ctx/j_security_check?j_username=user&j_password=wrong HTTP/1.0\r\nHost:host:8888\r\n\r\n");
assertThat(response, containsString("dispatcherType: REQUEST"));
assertThat(response, containsString("contextPath: /ctx"));
assertThat(response, containsString("servletPath: /error"));
stopServer();

// With no dispatch it should do a redirect to the error page.
configureServer(new FormAuthenticator("/login", "/error", false));
response = _connector.getResponse("GET /ctx/j_security_check?j_username=user&j_password=wrong HTTP/1.0\r\nHost:host:8888\r\n\r\n");
assertThat(response, startsWith("HTTP/1.1 302 Found"));
assertThat(response, containsString("Location: /ctx/error"));
stopServer();

// With no FormAuthenticator error page, it will do an error dispatch to the servlet error page for that code.
configureServer(new FormAuthenticator("/login", null, true));
response = _connector.getResponse("GET /ctx/j_security_check?j_username=user&j_password=wrong HTTP/1.0\r\nHost:host:8888\r\n\r\n");
assertThat(response, containsString("dispatcherType: ERROR"));
assertThat(response, containsString("contextPath: /ctx"));
assertThat(response, containsString("servletPath: /servletErrorPage"));
stopServer();
}
}

0 comments on commit cf504e5

Please sign in to comment.