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
|
/*
* 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.zookeeper.common;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Writer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import org.apache.zookeeper.ZKTestCase;
import org.apache.zookeeper.common.AtomicFileWritingIdiom.OutputStreamStatement;
import org.apache.zookeeper.common.AtomicFileWritingIdiom.WriterStatement;
import org.junit.jupiter.api.Test;
public class AtomicFileWritingIdiomTest extends ZKTestCase {
@Test
public void testOutputStreamSuccess(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
assertEquals("before", getContent(target));
new AtomicFileWritingIdiom(target, new OutputStreamStatement() {
@Override
public void write(OutputStream os) throws IOException {
os.write("after".getBytes(StandardCharsets.US_ASCII));
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
}
});
assertFalse(tmp.exists(), "tmp file should have been deleted");
// content changed
assertEquals("after", getContent(target));
}
@Test
public void testWriterSuccess(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
assertEquals("before", getContent(target));
new AtomicFileWritingIdiom(target, new WriterStatement() {
@Override
public void write(Writer os) throws IOException {
os.write("after");
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
}
});
assertFalse(tmp.exists(), "tmp file should have been deleted");
// content changed
assertEquals("after", getContent(target));
}
@Test
public void testOutputStreamFailure(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
assertEquals("before", getContent(target));
boolean exception = false;
try {
new AtomicFileWritingIdiom(target, new OutputStreamStatement() {
@Override
public void write(OutputStream os) throws IOException {
os.write("after".getBytes(StandardCharsets.US_ASCII));
os.flush();
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
throw new RuntimeException();
}
});
} catch (RuntimeException ex) {
exception = true;
}
assertFalse(tmp.exists(), "tmp file should have been deleted");
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
}
@Test
public void testWriterFailure(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
assertEquals("before", getContent(target));
boolean exception = false;
try {
new AtomicFileWritingIdiom(target, new WriterStatement() {
@Override
public void write(Writer os) throws IOException {
os.write("after");
os.flush();
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
throw new RuntimeException();
}
});
} catch (RuntimeException ex) {
exception = true;
}
assertFalse(tmp.exists(), "tmp file should have been deleted");
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
}
@Test
public void testOutputStreamFailureIOException(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
assertEquals("before", getContent(target));
boolean exception = false;
try {
new AtomicFileWritingIdiom(target, new OutputStreamStatement() {
@Override
public void write(OutputStream os) throws IOException {
os.write("after".getBytes(StandardCharsets.US_ASCII));
os.flush();
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
throw new IOException();
}
});
} catch (IOException ex) {
exception = true;
}
assertFalse(tmp.exists(), "tmp file should have been deleted");
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
}
@Test
public void testWriterFailureIOException(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
assertEquals("before", getContent(target));
boolean exception = false;
try {
new AtomicFileWritingIdiom(target, new WriterStatement() {
@Override
public void write(Writer os) throws IOException {
os.write("after");
os.flush();
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
throw new IOException();
}
});
} catch (IOException ex) {
exception = true;
}
assertFalse(tmp.exists(), "tmp file should have been deleted");
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
}
@Test
public void testOutputStreamFailureError(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
assertEquals("before", getContent(target));
boolean exception = false;
try {
new AtomicFileWritingIdiom(target, new OutputStreamStatement() {
@Override
public void write(OutputStream os) throws IOException {
os.write("after".getBytes(StandardCharsets.US_ASCII));
os.flush();
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
throw new Error();
}
});
} catch (Error ex) {
exception = true;
}
assertFalse(tmp.exists(), "tmp file should have been deleted");
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
}
@Test
public void testWriterFailureError(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
createFile(target, "before");
assertEquals("before", getContent(target));
boolean exception = false;
try {
new AtomicFileWritingIdiom(target, new WriterStatement() {
@Override
public void write(Writer os) throws IOException {
os.write("after");
os.flush();
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
throw new Error();
}
});
} catch (Error ex) {
exception = true;
}
assertFalse(tmp.exists(), "tmp file should have been deleted");
assertTrue(exception, "should have raised an exception");
// content preserved
assertEquals("before", getContent(target));
}
// ************** target file does not exist
@Test
public void testOutputStreamSuccessNE(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
target.delete();
assertFalse(target.exists(), "file should not exist");
new AtomicFileWritingIdiom(target, new OutputStreamStatement() {
@Override
public void write(OutputStream os) throws IOException {
os.write("after".getBytes(StandardCharsets.US_ASCII));
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
}
});
// content changed
assertEquals("after", getContent(target));
}
@Test
public void testWriterSuccessNE(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
target.delete();
assertFalse(target.exists(), "file should not exist");
new AtomicFileWritingIdiom(target, new WriterStatement() {
@Override
public void write(Writer os) throws IOException {
os.write("after");
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
}
});
assertFalse(tmp.exists(), "tmp file should have been deleted");
// content changed
assertEquals("after", getContent(target));
}
@Test
public void testOutputStreamFailureNE(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
target.delete();
assertFalse(target.exists(), "file should not exist");
boolean exception = false;
try {
new AtomicFileWritingIdiom(target, new OutputStreamStatement() {
@Override
public void write(OutputStream os) throws IOException {
os.write("after".getBytes(StandardCharsets.US_ASCII));
os.flush();
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
throw new RuntimeException();
}
});
} catch (RuntimeException ex) {
exception = true;
}
assertFalse(tmp.exists(), "tmp file should have been deleted");
assertTrue(exception, "should have raised an exception");
// file should not exist
assertFalse(target.exists(), "file should not exist");
}
@Test
public void testWriterFailureNE(File tmpdir) throws IOException {
File target = new File(tmpdir, "target.txt");
final File tmp = new File(tmpdir, "target.txt.tmp");
target.delete();
assertFalse(target.exists(), "file should not exist");
boolean exception = false;
try {
new AtomicFileWritingIdiom(target, new WriterStatement() {
@Override
public void write(Writer os) throws IOException {
os.write("after");
os.flush();
assertTrue(tmp.exists(), "implementation of AtomicFileOutputStream has changed, update the test");
throw new RuntimeException();
}
});
} catch (RuntimeException ex) {
exception = true;
}
assertFalse(tmp.exists(), "tmp file should have been deleted");
assertTrue(exception, "should have raised an exception");
// file should not exist
assertFalse(target.exists(), "file should not exist");
}
private String getContent(File file, Charset encoding) throws IOException {
StringBuilder result = new StringBuilder();
FileInputStream fis = new FileInputStream(file);
byte[] b = new byte[20];
int nb;
while ((nb = fis.read(b)) != -1) {
result.append(new String(b, 0, nb, encoding));
}
fis.close();
return result.toString();
}
private String getContent(File file) throws IOException {
return getContent(file, StandardCharsets.US_ASCII);
}
private void createFile(File file, String content) throws IOException {
FileOutputStream fos = new FileOutputStream(file);
fos.write(content.getBytes(StandardCharsets.US_ASCII));
fos.close();
}
}
|
