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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.logging;
import com.yahoo.test.ManualClock;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.Duration;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Base64;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
public class SpoolerTest {
private static final ManualClock clock = new ManualClock();
@TempDir
Path tempDir;
@Test
public void testSpoolingLogger() throws IOException {
Path spoolDir = tempDir.resolve("spool");
Spooler spooler = createSpooler(spoolDir, 1);
TestLogger logger = new TestLogger(spooler);
assertTrue(sendEntry(logger, "Yo entry"));
assertTrue(sendEntry(logger, "Yo entry 2"));
Path readyPath = spooler.readyPath();
Path readyFile1 = readyPath.resolve(spooler.fileNameBase.get() + "-0");
waitUntilFileExists(readyFile1);
Path readyFile2 = readyPath.resolve(spooler.fileNameBase.get() + "-1");
waitUntilFileExists(readyFile2);
// Check content after being moved to ready path
assertContent(readyFile1, "Yo entry");
assertContent(readyFile2, "Yo entry 2");
// Process files (read, transport files)
logger.manualRun();
assertEquals(2, logger.entriesSent());
// No files in processing or ready, 2 files in successes
assertProcessedFiles(spooler, 0);
assertReadyFiles(spooler, 0);
assertSuccessFiles(spooler, 2);
assertFailureFiles(spooler, 0);
assertTrue(spooler.failures().isEmpty(), spooler.failures().toString());
}
@Test
public void testSpoolingLoggerCleanup() throws IOException {
Path spoolDir = tempDir.resolve("spool");
Spooler spooler = createSpooler(spoolDir, 1, false, 5);
TestLogger logger = new TestLogger(spooler);
assertTrue(sendEntry(logger, "Yo entry"));
Path readyPath = spooler.readyPath();
Path readyFile1 = readyPath.resolve(spooler.fileNameBase.get() + "-0");
waitUntilFileExists(readyFile1);
// Check content after being moved to ready path
assertContent(readyFile1, "Yo entry");
// Process files (read, transport files)
logger.manualRun();
assertEquals(1, logger.entriesSent());
// No files in processing or ready or successes
assertProcessedFiles(spooler, 0);
assertReadyFiles(spooler, 0);
assertSuccessFiles(spooler, 0);
assertFailureFiles(spooler, 0);
assertTrue(spooler.failures().isEmpty(), spooler.failures().toString());
}
@Test
public void testSpoolingManyEntriesPerFile() throws IOException {
Path spoolDir = tempDir.resolve("spool");
Spooler spooler = createSpooler(spoolDir, 2);
TestLogger logger = new TestLogger(spooler);
assertTrue(sendEntry(logger, "Yo entry"));
assertTrue(sendEntry(logger, "Yo entry 2"));
Path readyPath = spooler.readyPath();
Path readyFile1 = readyPath.resolve(spooler.fileNameBase.get() + "-0");
waitUntilFileExists(readyFile1);
// Check content after being moved to ready path
assertContent(readyFile1, "Yo entry");
// Process files (read, transport files)
logger.manualRun();
assertEquals(2, logger.entriesSent());
// No files in processing or ready, 1 file in successes
assertProcessedFiles(spooler, 0);
assertReadyFiles(spooler, 0);
assertSuccessFiles(spooler, 1);
assertFailureFiles(spooler, 0);
// Write 1 entry and advance time, so that file will be processed even if
// maxEntriesPerFile is 2 and there is only 1 entry in file
assertTrue(sendEntry(logger, "Yo entry 3"));
clock.advance(Duration.ofMinutes(1));
logger.manualRun();
assertEquals(3, logger.entriesSent());
assertSuccessFiles(spooler, 2);
}
private void assertProcessedFiles(Spooler spooler, int expected) throws IOException {
assertEquals(expected, spooler.listFilesInPath(spooler.processingPath()).size());
}
private void assertReadyFiles(Spooler spooler, int expected) throws IOException {
assertEquals(expected, spooler.listFilesInPath(spooler.readyPath()).size());
}
private void assertSuccessFiles(Spooler spooler, int expected) throws IOException {
assertEquals(expected, spooler.listFilesInPath(spooler.successesPath()).size());
}
private void assertFailureFiles(Spooler spooler, int expected) throws IOException {
assertEquals(expected, spooler.listFilesInPath(spooler.failuresPath()).size());
}
@Test
public void failingToTransportIsRetried() throws IOException {
Path spoolDir = tempDir.resolve("spool");
Spooler spooler = createSpooler(spoolDir, 1, true, 2);
FailingToTransportNthEntryLogger logger = new FailingToTransportNthEntryLogger(spooler, 2);
assertTrue(sendEntry(logger, "Yo entry"));
logger.manualRun(); // Success for first message
assertEquals(1, spooler.listFilesInPath(spooler.successesPath()).size());
assertTrue(sendEntry(logger, "Yo entry 2"));
logger.manualRun(); // Failure for second message, so still just 1 file in successes path
assertEquals(1, spooler.listFilesInPath(spooler.successesPath()).size());
assertEquals(0, spooler.listFilesInPath(spooler.failuresPath()).size());
logger.manualRun(); // Success when retrying second message, so 2 files in successes path
assertEquals(2, spooler.listFilesInPath(spooler.successesPath()).size());
}
@Test
public void failingToTransportGivesUpAfterNTries() throws IOException {
Path spoolDir = tempDir.resolve("spool");
Spooler spooler = createSpooler(spoolDir, 1, true, 2);
FailingToTransportAfterNEntriesLogger logger = new FailingToTransportAfterNEntriesLogger(spooler, 2);
assertTrue(sendEntry(logger, "Yo entry"));
assertEquals(1, spooler.listFilesInPath(spooler.readyPath()).size());
logger.manualRun(); // Success for first message
assertEquals(1, spooler.listFilesInPath(spooler.successesPath()).size());
assertEquals(0, spooler.listFilesInPath(spooler.failuresPath()).size());
assertTrue(sendEntry(logger, "Yo entry 2"));
assertEquals(1, spooler.listFilesInPath(spooler.readyPath()).size());
logger.manualRun(); // Failure for second message, so still just 1 file in successes path
assertEquals(1, spooler.listFilesInPath(spooler.successesPath()).size());
assertEquals(0, spooler.listFilesInPath(spooler.failuresPath()).size());
logger.manualRun(); // Fails again, but should be retried
assertEquals(1, spooler.listFilesInPath(spooler.readyPath()).size());
assertEquals(1, spooler.listFilesInPath(spooler.successesPath()).size());
assertEquals(0, spooler.listFilesInPath(spooler.failuresPath()).size());
logger.manualRun(); // Fails again, should be moved to failures path
assertEquals(0, spooler.listFilesInPath(spooler.readyPath()).size());
assertEquals(1, spooler.listFilesInPath(spooler.successesPath()).size());
assertEquals(1, spooler.listFilesInPath(spooler.failuresPath()).size());
}
@Test
public void noSuccessFiles() throws IOException {
Path spoolDir = tempDir.resolve("spool");
boolean keepSuccessFiles = false;
Spooler spooler = createSpooler(spoolDir, 1, keepSuccessFiles, 2);
FailingToTransportNthEntryLogger logger = new FailingToTransportNthEntryLogger(spooler, 2);
assertTrue(sendEntry(logger, "Yo entry"));
logger.manualRun(); // Success for first message
assertEquals(0, spooler.listFilesInPath(spooler.successesPath()).size());
}
private boolean sendEntry(Logger logger, String x) {
return logger.newEntry()
.blob(x.getBytes())
.send();
}
private void waitUntilFileExists(Path path) {
Instant end = Instant.now().plus(Duration.ofSeconds(1));
while (!path.toFile().exists() && Instant.now().isBefore(end)) {
try {
Thread.sleep(10);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
assertTrue(path.toFile().exists(), path.toFile() + " does not exits");
}
private void assertContent(Path file, String expectedContent) throws IOException {
String content = Files.readString(file);
assertTrue(content.contains(Base64.getEncoder().encodeToString(expectedContent.getBytes())));
}
private static Spooler createSpooler(Path spoolDir, int maxEntriesPerFile) {
return new Spooler(spoolDir, maxEntriesPerFile, clock, true, 1000);
}
private static Spooler createSpooler(Path spoolDir, int maxEntriesPerFile, boolean keepSuccessFiles, int maxFailures) {
return new Spooler(spoolDir, maxEntriesPerFile, clock, keepSuccessFiles, maxFailures);
}
private static class TestLogger extends AbstractSpoolingLogger {
private final List<LoggerEntry> entriesSent = new ArrayList<>();
public TestLogger(Spooler spooler) {
super(spooler);
}
@Override
public boolean transport(LoggerEntry entry) {
entriesSent.add(entry);
return true;
}
@Override
public void run() {} // do nothing, call manualRun() to do something
@Override
public boolean send(LoggerEntry entry) {
spooler.write(entry);
return true;
}
public void manualRun() {
super.run();
}
int entriesSent() {
return entriesSent.size();
}
}
private static class FailingToTransportNthEntryLogger extends AbstractSpoolingLogger {
private int transportCount = 0;
private final int entriesToFail;
public FailingToTransportNthEntryLogger(Spooler spooler, int entriesToFail) {
super(spooler);
this.entriesToFail = entriesToFail;
}
@Override
public boolean send(LoggerEntry entry) {
spooler.write(entry);
return true;
}
@Override
public boolean transport(LoggerEntry entry) {
transportCount++;
return transportCount != entriesToFail;
}
@Override
public void run() {} // do nothing, call manualRun() to do something
public void manualRun() {
super.run();
}
}
private static class FailingToTransportAfterNEntriesLogger extends AbstractSpoolingLogger {
private int transportCount = 0;
private final int entriesToFailAfter;
public FailingToTransportAfterNEntriesLogger(Spooler spooler, int entriesToFailAfter) {
super(spooler);
this.entriesToFailAfter = entriesToFailAfter;
}
@Override
public boolean send(LoggerEntry entry) {
spooler.write(entry);
return true;
}
@Override
public boolean transport(LoggerEntry entry) {
transportCount++;
return transportCount < entriesToFailAfter;
}
@Override
public void run() {} // do nothing, call manualRun() to do something
public void manualRun() {
super.run();
}
}
}
|
