-
Notifications
You must be signed in to change notification settings - Fork 230
/
Base16InputStreamTest.java
407 lines (363 loc) · 16.4 KB
/
Base16InputStreamTest.java
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.codec.binary;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import org.junit.jupiter.api.Test;
/**
*/
public class Base16InputStreamTest {
/**
* Decodes to {202, 254, 186, 190, 255, 255}
*/
private static final String ENCODED_B16 = "CAFEBABEFFFF";
private static final String STRING_FIXTURE = "Hello World";
/**
* Tests skipping past the end of a stream.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testAvailable() throws IOException {
final InputStream ins = new ByteArrayInputStream(StringUtils.getBytesIso8859_1(ENCODED_B16));
try (final Base16InputStream b16Stream = new Base16InputStream(ins)) {
assertEquals(1, b16Stream.available());
assertEquals(6, b16Stream.skip(10));
// End of stream reached
assertEquals(0, b16Stream.available());
assertEquals(-1, b16Stream.read());
assertEquals(-1, b16Stream.read());
assertEquals(0, b16Stream.available());
}
}
/**
* Tests the Base16InputStream implementation against empty input.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testBase16EmptyInputStream() throws IOException {
final byte[] emptyEncoded = {};
final byte[] emptyDecoded = {};
testByteByByte(emptyEncoded, emptyDecoded);
testByChunk(emptyEncoded, emptyDecoded);
}
/**
* Tests the Base16InputStream implementation.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testBase16InputStreamByChunk() throws IOException {
// Hello World test.
byte[] encoded = StringUtils.getBytesUtf8("48656C6C6F20576F726C64");
byte[] decoded = StringUtils.getBytesUtf8(STRING_FIXTURE);
testByChunk(encoded, decoded);
// Single Byte test.
encoded = StringUtils.getBytesUtf8("41");
decoded = new byte[] { (byte) 0x41 };
testByChunk(encoded, decoded);
// OpenSSL interop test.
encoded = StringUtils.getBytesUtf8(Base16TestData.ENCODED_UTF8_UPPERCASE);
decoded = BaseNTestData.DECODED;
testByChunk(encoded, decoded);
// test random data of sizes 0 through 150
final BaseNCodec codec = new Base16(true);
for (int i = 0; i <= 150; i++) {
final byte[][] randomData = BaseNTestData.randomData(codec, i);
encoded = randomData[1];
decoded = randomData[0];
testByChunk(encoded, decoded, true);
}
}
/**
* Tests the Base16InputStream implementation.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testBase16InputStreamByteByByte() throws IOException {
// Hello World test.
byte[] encoded = StringUtils.getBytesUtf8("48656C6C6F20576F726C64");
byte[] decoded = StringUtils.getBytesUtf8(STRING_FIXTURE);
testByteByByte(encoded, decoded);
// Single Byte test.
encoded = StringUtils.getBytesUtf8("41");
decoded = new byte[] { (byte) 0x41 };
testByteByByte(encoded, decoded);
// OpenSSL interop test.
encoded = StringUtils.getBytesUtf8(Base16TestData.ENCODED_UTF8_UPPERCASE);
decoded = BaseNTestData.DECODED;
testByteByByte(encoded, decoded);
// test random data of sizes 0 through 150
final BaseNCodec codec = new Base16(true);
for (int i = 0; i <= 150; i++) {
final byte[][] randomData = BaseNTestData.randomData(codec, i);
encoded = randomData[1];
decoded = randomData[0];
testByteByByte(encoded, decoded, true);
}
}
/**
* Tests method does three tests on the supplied data: 1. encoded ---[DECODE]--> decoded 2. decoded ---[ENCODE]--> encoded 3. decoded
* ---[WRAP-WRAP-WRAP-etc...] --> decoded
* <p/>
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the Base16InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded Base16 encoded data
* @param decoded the data from above, but decoded
* @throws IOException Usually signifies a bug in the Base16 commons-codec implementation.
*/
private void testByChunk(final byte[] encoded, final byte[] decoded) throws IOException {
testByChunk(encoded, decoded, false);
}
/**
* Tests method does three tests on the supplied data: 1. encoded ---[DECODE]--> decoded 2. decoded ---[ENCODE]--> encoded 3. decoded
* ---[WRAP-WRAP-WRAP-etc...] --> decoded
* <p/>
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the Base16InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded Base16 encoded data
* @param decoded the data from above, but decoded
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet
* @throws IOException Usually signifies a bug in the Base16 commons-codec implementation.
*/
private void testByChunk(final byte[] encoded, final byte[] decoded, final boolean lowerCase) throws IOException {
// Start with encode.
try (final InputStream in = new Base16InputStream(new ByteArrayInputStream(decoded), true, lowerCase)) {
final byte[] output = BaseNTestData.streamToBytes(in);
assertEquals(-1, in.read(), "EOF");
assertEquals(-1, in.read(), "Still EOF");
assertArrayEquals(encoded, output, "Streaming Base16 encode");
}
// Now let's try to decode.
try (final InputStream in = new Base16InputStream(new ByteArrayInputStream(encoded), false, lowerCase)) {
final byte[] output = BaseNTestData.streamToBytes(in);
assertEquals(-1, in.read(), "EOF");
assertEquals(-1, in.read(), "Still EOF");
assertArrayEquals(decoded, output, "Streaming Base16 decode");
}
// wrap encoder with decoder
try (final InputStream in = new ByteArrayInputStream(decoded);
final InputStream inEncode = new Base16InputStream(in, true, lowerCase);
final InputStream inDecode = new Base16InputStream(inEncode, false, lowerCase)) {
final byte[] output = BaseNTestData.streamToBytes(inDecode);
assertEquals(-1, inDecode.read(), "EOF");
assertEquals(-1, inDecode.read(), "Still EOF");
assertArrayEquals(decoded, output, "Streaming Base16 wrap-wrap!");
}
}
/**
* Tests method does three tests on the supplied data: 1. encoded ---[DECODE]--> decoded 2. decoded ---[ENCODE]--> encoded 3. decoded
* ---[WRAP-WRAP-WRAP-etc...] --> decoded
* <p/>
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the Base16InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded Base16 encoded data
* @param decoded the data from above, but decoded
* @throws IOException Usually signifies a bug in the Base16 commons-codec implementation.
*/
private void testByteByByte(final byte[] encoded, final byte[] decoded) throws IOException {
testByteByByte(encoded, decoded, false);
}
/**
* Tests method does three tests on the supplied data: 1. encoded ---[DECODE]--> decoded 2. decoded ---[ENCODE]--> encoded 3. decoded
* ---[WRAP-WRAP-WRAP-etc...] --> decoded
* <p/>
* By "[WRAP-WRAP-WRAP-etc...]" we mean situation where the Base16InputStream wraps itself in encode and decode mode over and over again.
*
* @param encoded Base16 encoded data
* @param decoded the data from above, but decoded
* @param lowerCase if {@code true} then use a lower-case Base16 alphabet
* @throws IOException Usually signifies a bug in the Base16 commons-codec implementation.
*/
private void testByteByByte(final byte[] encoded, final byte[] decoded, final boolean lowerCase) throws IOException {
// Start with encode.
try (final InputStream in = new Base16InputStream(new ByteArrayInputStream(decoded), true, lowerCase)) {
final byte[] output = new byte[encoded.length];
for (int i = 0; i < output.length; i++) {
output[i] = (byte) in.read();
}
assertEquals(-1, in.read(), "EOF");
assertEquals(-1, in.read(), "Still EOF");
assertArrayEquals(encoded, output, "Streaming Base16 encode");
}
// Now let's try to decode.
try (final InputStream in = new Base16InputStream(new ByteArrayInputStream(encoded), false, lowerCase)) {
final byte[] output = new byte[decoded.length];
for (int i = 0; i < output.length; i++) {
output[i] = (byte) in.read();
}
assertEquals(-1, in.read(), "EOF");
assertEquals(-1, in.read(), "Still EOF");
assertArrayEquals(decoded, output, "Streaming Base16 decode");
}
// wrap encoder with decoder
try (final InputStream in = new ByteArrayInputStream(decoded);
final InputStream inEncode = new Base16InputStream(in, true, lowerCase);
final InputStream inDecode = new Base16InputStream(inEncode, false, lowerCase)) {
final byte[] output = new byte[decoded.length];
for (int i = 0; i < output.length; i++) {
output[i] = (byte) inDecode.read();
}
assertEquals(-1, inDecode.read(), "EOF");
assertEquals(-1, inDecode.read(), "Still EOF");
assertArrayEquals(decoded, output, "Streaming Base16 wrap-wrap!");
}
}
/**
* Tests markSupported.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testMarkSupported() throws IOException {
final byte[] decoded = StringUtils.getBytesUtf8(STRING_FIXTURE);
final ByteArrayInputStream bin = new ByteArrayInputStream(decoded);
try (final Base16InputStream in = new Base16InputStream(bin, true)) {
// Always returns false for now.
assertFalse(in.markSupported(), "Base16InputStream.markSupported() is false");
}
}
/**
* Tests read returning 0
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testRead0() throws IOException {
final byte[] decoded = StringUtils.getBytesUtf8(STRING_FIXTURE);
final byte[] buf = new byte[1024];
int bytesRead = 0;
final ByteArrayInputStream bin = new ByteArrayInputStream(decoded);
try (final Base16InputStream in = new Base16InputStream(bin, true)) {
bytesRead = in.read(buf, 0, 0);
assertEquals(0, bytesRead, "Base16InputStream.read(buf, 0, 0) returns 0");
}
}
/**
* Tests read with null.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testReadNull() throws IOException {
final byte[] decoded = StringUtils.getBytesUtf8(STRING_FIXTURE);
final ByteArrayInputStream bin = new ByteArrayInputStream(decoded);
try (final Base16InputStream in = new Base16InputStream(bin, true)) {
assertThrows(NullPointerException.class, () -> in.read(null, 0, 0), "Base16InputStream.read(null, 0, 0)");
}
}
/**
* Tests read throwing IndexOutOfBoundsException
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testReadOutOfBounds() throws IOException {
final byte[] decoded = StringUtils.getBytesUtf8(STRING_FIXTURE);
final byte[] buf = new byte[1024];
final ByteArrayInputStream bin = new ByteArrayInputStream(decoded);
try (final Base16InputStream in = new Base16InputStream(bin, true)) {
assertThrows(IndexOutOfBoundsException.class, () -> in.read(buf, -1, 0), "Base16InputStream.read(buf, -1, 0)");
assertThrows(IndexOutOfBoundsException.class, () -> in.read(buf, 0, -1), "Base16InputStream.read(buf, 0, -1)");
assertThrows(IndexOutOfBoundsException.class, () -> in.read(buf, buf.length + 1, 0), "Base16InputStream.read(buf, buf.length + 1, 0)");
assertThrows(IndexOutOfBoundsException.class, () -> in.read(buf, buf.length - 1, 2), "Base16InputStream.read(buf, buf.length - 1, 2)");
}
}
/**
* Tests skipping number of characters larger than the internal buffer.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testSkipBig() throws IOException {
final InputStream ins = new ByteArrayInputStream(StringUtils.getBytesIso8859_1(ENCODED_B16));
try (final Base16InputStream b16Stream = new Base16InputStream(ins)) {
assertEquals(6, b16Stream.skip(Integer.MAX_VALUE));
// End of stream reached
assertEquals(-1, b16Stream.read());
assertEquals(-1, b16Stream.read());
}
}
/**
* Tests skipping as a noop
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testSkipNone() throws IOException {
final InputStream ins = new ByteArrayInputStream(StringUtils.getBytesIso8859_1(ENCODED_B16));
try (final Base16InputStream b16Stream = new Base16InputStream(ins)) {
final byte[] actualBytes = new byte[6];
assertEquals(0, b16Stream.skip(0));
b16Stream.read(actualBytes, 0, actualBytes.length);
assertArrayEquals(actualBytes, new byte[] { (byte) 202, (byte) 254, (byte) 186, (byte) 190, (byte) 255, (byte) 255 });
// End of stream reached
assertEquals(-1, b16Stream.read());
}
}
/**
* Tests skipping past the end of a stream.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testSkipPastEnd() throws IOException {
final InputStream ins = new ByteArrayInputStream(StringUtils.getBytesIso8859_1(ENCODED_B16));
try (final Base16InputStream b16Stream = new Base16InputStream(ins)) {
// due to CODEC-130, skip now skips correctly decoded characters rather than encoded
assertEquals(6, b16Stream.skip(10));
// End of stream reached
assertEquals(-1, b16Stream.read());
assertEquals(-1, b16Stream.read());
}
}
/**
* Tests skipping to the end of a stream.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testSkipToEnd() throws IOException {
final InputStream ins = new ByteArrayInputStream(StringUtils.getBytesIso8859_1(ENCODED_B16));
try (final Base16InputStream b16Stream = new Base16InputStream(ins)) {
// due to CODEC-130, skip now skips correctly decoded characters rather than encoded
assertEquals(6, b16Stream.skip(6));
// End of stream reached
assertEquals(-1, b16Stream.read());
assertEquals(-1, b16Stream.read());
}
}
/**
* Tests if negative arguments to skip are handled correctly.
*
* @throws IOException for some failure scenarios.
*/
@Test
public void testSkipWrongArgument() throws IOException {
final InputStream ins = new ByteArrayInputStream(StringUtils.getBytesIso8859_1(ENCODED_B16));
try (final Base16InputStream b16Stream = new Base16InputStream(ins)) {
assertThrows(IllegalArgumentException.class, () -> b16Stream.skip(-10));
}
}
}