aboutsummaryrefslogtreecommitdiffstats
path: root/jdisc_http_service/src/test/java/com/yahoo/jdisc/http/server/jetty/AccessLogRequestLogTest.java
blob: 580533be4c34745d06a8c0e80b44dca163070a6e (plain) (blame)
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
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc.http.server.jetty;

import com.yahoo.container.logging.AccessLog;
import com.yahoo.container.logging.AccessLogEntry;
import org.eclipse.jetty.http.MetaData;
import org.eclipse.jetty.server.HttpChannel;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.server.Response;
import org.junit.Test;

import java.util.Optional;

import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.not;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

/**
 * @author Oyvind Bakksjo
 * @author bjorncs
 */
public class AccessLogRequestLogTest {
    @Test
    public void requireThatQueryWithUnquotedSpecialCharactersIsHandled() {
        final AccessLogEntry accessLogEntry = new AccessLogEntry();
        final Request jettyRequest = createRequestMock(accessLogEntry);
        when(jettyRequest.getRequestURI()).thenReturn("/search/");
        when(jettyRequest.getQueryString()).thenReturn("query=year:>2010");

        new AccessLogRequestLog(mock(AccessLog.class)).log(jettyRequest, createResponseMock());

        assertThat(accessLogEntry.getRawPath(), is(not(nullValue())));
        assertTrue(accessLogEntry.getRawQuery().isPresent());
    }

    @Test
    public void requireThatDoubleQuotingIsNotPerformed() {
        final AccessLogEntry accessLogEntry = new AccessLogEntry();
        final Request jettyRequest = createRequestMock(accessLogEntry);
        final String path = "/search/";
        when(jettyRequest.getRequestURI()).thenReturn(path);
        final String query = "query=year%252010+%3B&customParameter=something";
        when(jettyRequest.getQueryString()).thenReturn(query);

        new AccessLogRequestLog(mock(AccessLog.class)).log(jettyRequest, createResponseMock());

        assertThat(accessLogEntry.getRawPath(), is(path));
        assertThat(accessLogEntry.getRawQuery().get(), is(query));

    }

    @Test
    public void raw_path_and_query_are_set_from_request() {
        AccessLogEntry accessLogEntry = new AccessLogEntry();
        Request jettyRequest = createRequestMock(accessLogEntry);
        String rawPath = "//search/";
        when(jettyRequest.getRequestURI()).thenReturn(rawPath);
        String rawQuery = "q=%%2";
        when(jettyRequest.getQueryString()).thenReturn(rawQuery);

        new AccessLogRequestLog(mock(AccessLog.class)).log(jettyRequest, createResponseMock());
        assertThat(accessLogEntry.getRawPath(), is(rawPath));
        Optional<String> actualRawQuery = accessLogEntry.getRawQuery();
        assertThat(actualRawQuery.isPresent(), is(true));
        assertThat(actualRawQuery.get(), is(rawQuery));
    }

    @Test
    public void verify_x_forwarded_for_precedence () {
        AccessLogEntry accessLogEntry = new AccessLogEntry();
        Request jettyRequest = createRequestMock(accessLogEntry);
        when(jettyRequest.getRequestURI()).thenReturn("//search/");
        when(jettyRequest.getQueryString()).thenReturn("q=%%2");
        when(jettyRequest.getHeader("x-forwarded-for")).thenReturn("1.2.3.4");
        when(jettyRequest.getHeader("y-ra")).thenReturn("2.3.4.5");

        new AccessLogRequestLog(mock(AccessLog.class)).log(jettyRequest, createResponseMock());
        assertThat(accessLogEntry.getRemoteAddress(), is("1.2.3.4"));
    }

    @Test
    public void verify_x_forwarded_port_precedence () {
        AccessLogEntry accessLogEntry = new AccessLogEntry();
        Request jettyRequest = createRequestMock(accessLogEntry);
        when(jettyRequest.getRequestURI()).thenReturn("//search/");
        when(jettyRequest.getQueryString()).thenReturn("q=%%2");
        when(jettyRequest.getHeader("X-Forwarded-Port")).thenReturn("80");
        when(jettyRequest.getHeader("y-rp")).thenReturn("8080");

        new AccessLogRequestLog(mock(AccessLog.class)).log(jettyRequest, createResponseMock());
        assertThat(accessLogEntry.getRemotePort(), is(80));
    }

    private static Request createRequestMock(AccessLogEntry entry) {
        Request request = mock(Request.class);
        when(request.getAttribute(JDiscHttpServlet.ATTRIBUTE_NAME_ACCESS_LOG_ENTRY)).thenReturn(entry);
        return request;
    }

    private Response createResponseMock() {
        Response response = mock(Response.class);
        when(response.getHttpChannel()).thenReturn(mock(HttpChannel.class));
        when(response.getCommittedMetaData()).thenReturn(mock(MetaData.Response.class));
        return response;
    }
}