aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/test/java/com/yahoo/fs4/test/PacketTestCase.java
blob: 151d192c25bd538c30b517119396d11f46e67cbc (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.fs4.test;

import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;

import com.yahoo.fs4.*;
import com.yahoo.search.Query;
import org.junit.Ignore;
import org.junit.Test;

import static junit.framework.Assert.assertEquals;
import static junit.framework.TestCase.*;
import static org.junit.Assume.assumeTrue;

/**
 * Tests the Packet class.  Specifically made this unit test suite
 * for checking that queries that are too large for the buffer
 * are handled gracefully.
 *
 * @author  <a href="mailto:borud@yahoo-inc.com">Bjorn Borud</a>
 */
public class PacketTestCase {

    /**
     * Make sure we don't get false negatives for reasonably sized
     * buffers
     */
    @Test
    public void testSmallQueryOK () {
        Query query = new Query("/?query=foo");
        assertNotNull(query);

        QueryPacket queryPacket = QueryPacket.create(query);
        assertNotNull(queryPacket);

        ByteBuffer buffer = ByteBuffer.allocate(1024);
        int position = buffer.position();

        try {
            queryPacket.encode(buffer, 0);
        }
        catch (BufferTooSmallException e) {
            fail();
        }

        // make sure state of buffer HAS changed and is according
        // to contract
        assertTrue(position != buffer.position());
        assertTrue(buffer.position() == buffer.limit());
    }

    /**
     * Make a query that is too large and then try to encode it
     * into a small ByteBuffer
     */
    @Test
    public void testLargeQueryFail () {
        StringBuilder queryBuffer = new StringBuilder(4008);
        queryBuffer.append("/?query=");
        for (int i=0; i < 1000; i++) {
            queryBuffer.append("the%20");
        }
        Query query = new Query(queryBuffer.toString());
        assertNotNull(query);

        QueryPacket queryPacket = QueryPacket.create(query);
        assertNotNull(queryPacket);

        ByteBuffer buffer = ByteBuffer.allocate(100);
        int position = buffer.position();
        int limit    = buffer.limit();
        try {
            queryPacket.encode(buffer, 0);
            fail();
        }
        catch (BufferTooSmallException e) {
            // success if exception is thrown
        }

        // make sure state of buffer is unchanged
        assertEquals(position, buffer.position());
        assertEquals(limit, buffer.limit());
    }

    @Test
    public void requireThatPacketsCanTurnOnCompression() throws BufferTooSmallException {
        QueryPacket queryPacket = QueryPacket.create(new Query("/?query=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"));
        ByteBuffer buffer = ByteBuffer.allocate(1024);
        int channel = 32;

        queryPacket.encode(buffer, channel);
        buffer.flip();
        assertEquals(86, buffer.getInt());  // size
        assertEquals(0xda, buffer.getInt());  // code
        assertEquals(channel, buffer.getInt());

        queryPacket.setCompressionLimit(88);
        buffer.clear();
        queryPacket.encode(buffer, channel);
        buffer.flip();
        assertEquals(86, buffer.getInt());  // size
        assertEquals(0xda, buffer.getInt());  // code

        queryPacket.setCompressionLimit(84);
        buffer.clear();
        queryPacket.encode(buffer, channel);
        buffer.flip();
        assertEquals(57, buffer.getInt());  // size
        assertEquals(0x060000da, buffer.getInt());  // code
        assertEquals(channel, buffer.getInt());
    }

    @Test
    public void requireThatUncompressablePacketsArentCompressed() throws BufferTooSmallException {
        QueryPacket queryPacket = QueryPacket.create(new Query("/?query=aaaaaaaaaaaaaaa"));
        ByteBuffer buffer = ByteBuffer.allocate(1024);
        int channel = 32;

        queryPacket.setCompressionLimit(10);
        buffer.clear();
        queryPacket.encode(buffer, channel);
        buffer.flip();
        assertEquals(56, buffer.getInt());  // size
        assertEquals(0xda, buffer.getInt());  // code
        assertEquals(channel, buffer.getInt());
    }

    class MyPacket extends Packet {
        private String bodyString = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
        private int myCode = 1234;

        @Override
        public int getCode() {
            return myCode;
        }

        @Override
        protected void encodeBody(ByteBuffer buffer) {
            buffer.put(bodyString.getBytes(StandardCharsets.UTF_8));
        }

        @Override
        public void codeDecodedHook(int code) {
            assertEquals(myCode, code);
        }

        @Override
        public void decodeBody(ByteBuffer buffer) {
            byte[] bytes = new byte[bodyString.length()];
            buffer.get(bytes);
            assertEquals(bodyString, new String(bytes));
        }
    }

    @Test
    public void requireThatCompressedPacketsCanBeDecompressed() throws BufferTooSmallException {

        MyPacket packet = new MyPacket();
        packet.setCompressionLimit(10);
        ByteBuffer buffer = ByteBuffer.allocate(1024);
        int channel = 32;
        packet.encode(buffer, channel);

        buffer.flip();
        new MyPacket().decode(buffer);
    }

    @Test
    public void requireThatCompressedByteBufferMayContainExtraData() throws BufferTooSmallException {

        MyPacket packet = new MyPacket();
        packet.setCompressionLimit(10);
        ByteBuffer buffer = ByteBuffer.allocate(1024);
        buffer.putLong(0xdeadbeefL);
        int channel = 32;
        packet.encode(buffer, channel);
        buffer.limit(buffer.limit() + 8);
        buffer.putLong(0xdeadbeefL);

        buffer.flip();
        assertEquals(0xdeadbeefL, buffer.getLong());  // read initial content.
        new MyPacket().decode(buffer);
        assertEquals(0xdeadbeefL, buffer.getLong());  // read final content.
    }

    class MyBasicPacket extends BasicPacket {
        private String bodyString = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa";
        private int myCode = 1234;

        @Override
        public int getCode() {
            return myCode;
        }

        @Override
        protected void encodeBody(ByteBuffer buffer) {
            buffer.put(bodyString.getBytes(StandardCharsets.UTF_8));
        }

        @Override
        public void codeDecodedHook(int code) {
            assertEquals(myCode, code);
        }

        @Override
        public void decodeBody(ByteBuffer buffer) {
            byte[] bytes = new byte[bodyString.length()];
            buffer.get(bytes);
            assertEquals(bodyString, new String(bytes));
        }
    }

    @Test
    public void requireThatCompressedBasicPacketsCanBeDecompressed() throws BufferTooSmallException {

        MyBasicPacket packet = new MyBasicPacket();
        packet.setCompressionLimit(10);
        ByteBuffer buffer = ByteBuffer.allocate(1024);
        packet.encode(buffer);

        buffer.flip();
        new MyBasicPacket().decode(buffer);
    }
}