Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Issue 113 - CustomRequestLog 

added test methods for all format codes

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan Roberts 2018-11-08 18:07:53 +01:00
parent 3ce7016a35
commit 0d8369c5c1
2 changed files with 490 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
jetty-server/src/main/java/org/eclipse/jetty/server/CustomRequestLog.java
View File

@ -293,7 +293,7 @@ public class CustomRequestLog extends AbstractLifeCycle implements RequestLog
private transient PathMappings<String> _ignorePathMap;
private boolean _preferProxiedForAddress;
private transient DateCache _logDateCache;
private String _logDateFormat = "dd/MMM/yyyy:HH:mm:ss Z";
private String _logDateFormat = "dd/MMM/yyyy:HH:mm:ss ZZZ";
private Locale _logLocale = Locale.getDefault();
private String _logTimeZone = "GMT";
@ -305,9 +305,13 @@ public class CustomRequestLog extends AbstractLifeCycle implements RequestLog
{
_logHandle = getLogHandle(formatString);
}
catch (Throwable t)
catch (NoSuchMethodException e)
{
throw new IllegalStateException(t);
throw new IllegalStateException(e);
}
catch (IllegalAccessException e)
{
throw new IllegalStateException(e);
}
}
@ -555,7 +559,7 @@ public class CustomRequestLog extends AbstractLifeCycle implements RequestLog
}
private MethodHandle getLogHandle(String formatString) throws Throwable
private MethodHandle getLogHandle(String formatString) throws NoSuchMethodException, IllegalAccessException
{
MethodHandle append = MethodHandles.lookup().findStatic(CustomRequestLog.class, "append", methodType(Void.TYPE, String.class, StringBuilder.class));
MethodHandle logHandle = dropArguments(dropArguments(append.bindTo("\n"), 1, Request.class), 2, Response.class);
@ -629,7 +633,7 @@ public class CustomRequestLog extends AbstractLifeCycle implements RequestLog
}
}
private MethodHandle updateLogHandle(MethodHandle logHandle, MethodHandle append, String code, String arg, List<String> modifiers, boolean negated) throws Throwable
private MethodHandle updateLogHandle(MethodHandle logHandle, MethodHandle append, String code, String arg, List<String> modifiers, boolean negated) throws NoSuchMethodException, IllegalAccessException
{
MethodType logType = methodType(Void.TYPE, StringBuilder.class, Request.class, Response.class);
MethodType logTypeArg = methodType(Void.TYPE, String.class, StringBuilder.class, Request.class, Response.class);
@ -822,7 +826,7 @@ public class CustomRequestLog extends AbstractLifeCycle implements RequestLog
case "s":
{
String method = "logUrlRequestPath";
String method = "logResponseStatus";
specificHandle = MethodHandles.lookup().findStatic(CustomRequestLog.class, method, logType);
break;
}
@ -878,7 +882,7 @@ public class CustomRequestLog extends AbstractLifeCycle implements RequestLog
case "U":
{
String method = "logResponseStatus";
String method = "logUrlRequestPath";
specificHandle = MethodHandles.lookup().findStatic(CustomRequestLog.class, method, logType);
break;
}
@ -1082,8 +1086,8 @@ public class CustomRequestLog extends AbstractLifeCycle implements RequestLog
public static void logRequestFirstLine(StringBuilder b, Request request, Response response)
{
//todo implement
append(b, "?");
//todo is there a better way to do this
append(b, request.getMethod() + " " + request.getOriginalURI() + " " + request.getProtocol());
}
public static void logRequestHandler(StringBuilder b, Request request, Response response)
@ -1116,6 +1120,7 @@ public class CustomRequestLog extends AbstractLifeCycle implements RequestLog
public static void logLatencySeconds(StringBuilder b, Request request, Response response)
{
//todo should this give decimal places
long latency = System.currentTimeMillis() - request.getTimeStamp();
b.append(TimeUnit.MILLISECONDS.toSeconds(latency));
}

484
jetty-server/src/test/java/org/eclipse/jetty/server/handler/CustomRequestLogTest.java
View File

@ -22,6 +22,7 @@ import java.io.IOException;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.TimeUnit;
import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@ -35,7 +36,9 @@ 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.is;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.fail;
public class CustomRequestLogTest
{
@ -68,16 +71,462 @@ public class CustomRequestLogTest
}
@Test
public void testQuery() throws Exception
{
testHandlerServerStart("clientIP: %a");
_connector.getResponse("GET /foo?name=value HTTP/1.0\n\n");
@Test
public void testModifier() throws Exception
{
testHandlerServerStart("%s: %!404,301{Referer}i");
_connector.getResponse("GET /error404 HTTP/1.0\nReferer: testReferer\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log,containsString("GET /foo?name=value"));
assertThat(log,containsString(" 200 "));
assertThat(log, is("404: -\n"));
_connector.getResponse("GET /error301 HTTP/1.0\nReferer: testReferer\n\n");
log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("301: -\n"));
_connector.getResponse("GET /success HTTP/1.0\nReferer: testReferer\n\n");
log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("200: testReferer\n"));
}
@Test
public void testInvalidArguments() throws Exception
{
fail();
}
@Test
public void testDoublePercent() throws Exception
{
testHandlerServerStart("%%a");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("%a\n"));
}
@Test
public void testLogClientIP() throws Exception
{
testHandlerServerStart("ClientIP: %a");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogConnectionIP() throws Exception
{
testHandlerServerStart("ConnectionIP: %{c}a");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogLocalIP() throws Exception
{
testHandlerServerStart("LocalIP: %A");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogResponseSize() throws Exception
{
testHandlerServerStart("ResponseSize: %B");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("ResponseSize: 0\n"));
_connector.getResponse("GET / HTTP/1.0\nEcho: hello world\n\n");
log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("ResponseSize: 11\n"));
}
@Test
public void testLogResponseSizeCLF() throws Exception
{
testHandlerServerStart("ResponseSize: %b");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("ResponseSize: -\n"));
_connector.getResponse("GET / HTTP/1.0\nEcho: hello world\n\n");
log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("ResponseSize: 11\n"));
}
@Test
public void testLogRequestCookie() throws Exception
{
testHandlerServerStart("RequestCookies: %{cookieName}C, %{cookie2}C, %{cookie3}C");
_connector.getResponse("GET / HTTP/1.0\nCookie: cookieName=cookieValue; cookie2=value2\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("RequestCookies: cookieValue, value2, -\n"));
}
@Test
public void testLogEnvironmentVar() throws Exception
{
testHandlerServerStart("EnvironmentVar: %{JAVA_HOME}e");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("EnvironmentVar: " + System.getenv("JAVA_HOME") + "\n"));
}
@Test
public void testLogFilename() throws Exception
{
testHandlerServerStart("Filename: %f");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogRemoteHostName() throws Exception
{
testHandlerServerStart("RemoteHostName: %h");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogRequestProtocol() throws Exception
{
testHandlerServerStart("RequestProtocol: %H");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("Protocol: HTTP/1.0\n"));
}
@Test
public void testLogRequestHeader() throws Exception
{
testHandlerServerStart("RequestHeader: %{Header1}i, %{Header2}i, %{Header3}i");
_connector.getResponse("GET / HTTP/1.0\nHeader1: value1\nHeader2: value2\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("RequestHeader: value1, value2, -\n"));
}
@Test
public void testLogKeepAliveRequests() throws Exception
{
testHandlerServerStart("KeepAliveRequests: %k");
_connector.getResponse("GET / HTTP/1.0\n\n");
_connector.getResponse("GET / HTTP/1.0\n\n");
_connector.getResponse("GET / HTTP/1.0\n\n");
_log.entries.poll(5,TimeUnit.SECONDS);
_log.entries.poll(5,TimeUnit.SECONDS);
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogRequestMethod() throws Exception
{
testHandlerServerStart("RequestMethod: %m");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("RequestMethod: GET\n"));
}
@Test
public void testLogResponseHeader() throws Exception
{
testHandlerServerStart("ResponseHeader: %{Header1}o, %{Header2}o, %{Header3}o");
_connector.getResponse("GET /responseHeaders HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("ResponseHeader: value1, value2, -\n"));
}
@Test
public void testLogCanonicalPort() throws Exception
{
testHandlerServerStart("CanonicalPort: %p, %{canonical}p");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogLocalPort() throws Exception
{
testHandlerServerStart("LocalPort: %{local}p");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogRemotePort() throws Exception
{
testHandlerServerStart("RemotePort: %{remote}p");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogUnknownPort() throws Exception
{
assertThrows(IllegalArgumentException.class, ()->
{
testHandlerServerStart("%{unknown}p");
});
}
@Test
public void testLogQueryString() throws Exception
{
testHandlerServerStart("QueryString: %q");
_connector.getResponse("GET /path?queryString HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("QueryString: queryString\n"));
}
@Test
public void testLogRequestFirstLine() throws Exception
{
testHandlerServerStart("RequestFirstLin: %r");
_connector.getResponse("GET /path?query HTTP/1.0\nHeader: null\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("RequestFirstLin: GET /path?query HTTP/1.0\n"));
}
@Test
public void testLogRequestHandler() throws Exception
{
testHandlerServerStart("RequestHandler: %R");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogResponseStatus() throws Exception
{
testHandlerServerStart("LogResponseStatus: %s");
_connector.getResponse("GET /error404 HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("LogResponseStatus: 404\n"));
_connector.getResponse("GET /error301 HTTP/1.0\n\n");
log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("LogResponseStatus: 301\n"));
_connector.getResponse("GET / HTTP/1.0\n\n");
log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("LogResponseStatus: 200\n"));
}
@Test
public void testLogRequestTime() throws Exception
{
testHandlerServerStart("RequestTime: %t");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogRequestTimeCustomFormats() throws Exception
{
/*
The time, in the form given by format, which should be in an extended strftime(3) format (potentially localized).
If the format starts with begin: (default) the time is taken at the beginning of the request processing.
If it starts with end: it is the time when the log entry gets written, close to the end of the request processing.
In addition to the formats supported by strftime(3), the following format tokens are supported:
sec number of seconds since the Epoch
msec number of milliseconds since the Epoch
usec number of microseconds since the Epoch
msec_frac millisecond fraction
usec_frac microsecond fraction
These tokens can not be combined with each other or strftime(3) formatting in the same format string.
You can use multiple %{format}t tokens instead.
*/
testHandlerServerStart("RequestTime: %{}t");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogLatencyMicroseconds() throws Exception
{
testHandlerServerStart("LatencyMicroseconds: %{us}Tus");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogLatencyMilliseconds() throws Exception
{
testHandlerServerStart("LatencyMilliseconds: %{ms}Tms");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogLatencySeconds() throws Exception
{
testHandlerServerStart("LatencySeconds: %{s}Ts");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogRequestAuthentication() throws Exception
{
testHandlerServerStart("RequestAuthentication: %u");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogUrlRequestPath() throws Exception
{
testHandlerServerStart("UrlRequestPath: %U");
_connector.getResponse("GET /path?query HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
assertThat(log, is("UrlRequestPath: /path\n"));
}
@Test
public void testLogServerName() throws Exception
{
testHandlerServerStart("ServerName: %v");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogConnectionStatus() throws Exception
{
testHandlerServerStart("ConnectionStatus: %X");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogBytesReceived() throws Exception
{
testHandlerServerStart("BytesReceived: %I");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogBytesSent() throws Exception
{
testHandlerServerStart("BytesSent: %I");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogBytesTransferred() throws Exception
{
testHandlerServerStart("BytesTransferred: %I");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogRequestTrailerLines() throws Exception
{
testHandlerServerStart("RequestTrailerLines: %{2}ti");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@Test
public void testLogResponseTrailerLines() throws Exception
{
testHandlerServerStart("RequestTrailerLines: %{2}to");
_connector.getResponse("GET / HTTP/1.0\n\n");
String log = _log.entries.poll(5,TimeUnit.SECONDS);
fail(log);
}
@ -116,6 +565,25 @@ public class CustomRequestLogTest
@Override
public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
{
if (request.getRequestURI().contains("error404"))
{
response.setStatus(404);
}
else if (request.getRequestURI().contains("error301"))
{
response.setStatus(301);
}
else if (request.getHeader("echo") != null)
{
ServletOutputStream outputStream = response.getOutputStream();
outputStream.print(request.getHeader("echo"));
}
else if (request.getRequestURI().contains("responseHeaders"))
{
response.addHeader("Header1", "value1");
response.addHeader("Header2", "value2");
}
baseRequest.setHandled(true);
}
}