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
|
// Copyright 2014 The Bazel Authors. All rights reserved.
//
// Licensed 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 com.google.devtools.build.lib.util;
import static com.google.common.truth.Truth.assertThat;
import com.google.devtools.build.lib.testutil.Scratch;
import com.google.devtools.build.lib.vfs.Path;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/**
* Unit tests for the {@link PersistentMap}.
*/
@RunWith(JUnit4.class)
public class PersistentMapTest {
public static class PersistentStringMap extends PersistentMap<String, String> {
boolean updateJournal = true;
boolean keepJournal = false;
public PersistentStringMap(Map<String, String> map, Path mapFile,
Path journalFile) throws IOException {
super(0x0, map, mapFile, journalFile);
load();
}
@Override
protected String readKey(DataInputStream in) throws IOException {
return in.readUTF();
}
@Override
protected String readValue(DataInputStream in) throws IOException {
return in.readUTF();
}
@Override
protected void writeKey(String key, DataOutputStream out)
throws IOException {
out.writeUTF(key);
}
@Override
protected void writeValue(String value, DataOutputStream out)
throws IOException {
out.writeUTF(value);
}
@Override
protected boolean updateJournal() {
return updateJournal;
}
@Override
protected boolean keepJournal() {
return keepJournal;
}
}
private Scratch scratch = new Scratch();
private PersistentStringMap map;
private Path mapFile;
private Path journalFile;
@Before
public final void createFiles() throws Exception {
mapFile = scratch.resolve("/tmp/map.txt");
journalFile = scratch.resolve("/tmp/journal.txt");
createMap();
}
private void createMap() throws Exception {
Map<String, String> map = new HashMap<>();
this.map = new PersistentStringMap(map, mapFile, journalFile);
}
@Test
public void map() throws Exception {
createMap();
map.put("foo", "bar");
map.put("baz", "bang");
assertThat(map).containsEntry("foo", "bar");
assertThat(map).containsEntry("baz", "bang");
assertThat(map).hasSize(2);
long size = map.save();
assertThat(size).isEqualTo(mapFile.getFileSize());
assertThat(map).containsEntry("foo", "bar");
assertThat(map).containsEntry("baz", "bang");
assertThat(map).hasSize(2);
createMap(); // create a new map
assertThat(map).containsEntry("foo", "bar");
assertThat(map).containsEntry("baz", "bang");
assertThat(map).hasSize(2);
}
@Test
public void remove() throws Exception {
createMap();
map.put("foo", "bar");
map.put("baz", "bang");
long size = map.save();
assertThat(size).isEqualTo(mapFile.getFileSize());
assertThat(journalFile.exists()).isFalse();
map.remove("foo");
assertThat(map).hasSize(1);
assertThat(journalFile.exists()).isTrue();
createMap(); // create a new map
assertThat(map).hasSize(1);
}
@Test
public void clear() throws Exception {
createMap();
map.put("foo", "bar");
map.put("baz", "bang");
map.save();
assertThat(mapFile.exists()).isTrue();
assertThat(journalFile.exists()).isFalse();
map.clear();
assertThat(map).isEmpty();
assertThat(mapFile.exists()).isTrue();
assertThat(journalFile.exists()).isFalse();
createMap(); // create a new map
assertThat(map).isEmpty();
}
@Test
public void noUpdateJournal() throws Exception {
createMap();
map.put("foo", "bar");
map.put("baz", "bang");
map.save();
assertThat(journalFile.exists()).isFalse();
// prevent updating the journal
map.updateJournal = false;
// remove an entry
map.remove("foo");
assertThat(map).hasSize(1);
// no journal file written
assertThat(journalFile.exists()).isFalse();
createMap(); // create a new map
// both entries are still in the map on disk
assertThat(map).hasSize(2);
}
@Test
public void keepJournal() throws Exception {
createMap();
map.put("foo", "bar");
map.put("baz", "bang");
map.save();
assertThat(journalFile.exists()).isFalse();
// Keep the journal through the save.
map.updateJournal = false;
map.keepJournal = true;
// remove an entry
map.remove("foo");
assertThat(map).hasSize(1);
// no journal file written
assertThat(journalFile.exists()).isFalse();
long size = map.save();
assertThat(map).hasSize(1);
// The journal must be serialzed on save(), even if !updateJournal.
assertThat(journalFile.exists()).isTrue();
assertThat(size).isEqualTo(journalFile.getFileSize() + mapFile.getFileSize());
map.load();
assertThat(map).hasSize(1);
assertThat(journalFile.exists()).isTrue();
createMap(); // create a new map
assertThat(map).hasSize(1);
map.keepJournal = false;
map.save();
assertThat(map).hasSize(1);
assertThat(journalFile.exists()).isFalse();
}
@Test
public void keepJournalWithMultipleSaves() throws Exception {
createMap();
map.put("foo", "bar");
map.put("baz", "bang");
map.save();
map.updateJournal = false;
map.keepJournal = true;
map.remove("foo");
assertThat(map).hasSize(1);
map.save();
map.remove("baz");
map.save();
assertThat(map).isEmpty();
// Ensure recreating the map loads the correct state.
createMap();
assertThat(map).isEmpty();
assertThat(journalFile.exists()).isFalse();
}
@Test
public void multipleJournalUpdates() throws Exception {
createMap();
map.put("foo", "bar");
map.save();
assertThat(journalFile.exists()).isFalse();
// add an entry
map.put("baz", "bang");
assertThat(map).hasSize(2);
// journal file written
assertThat(journalFile.exists()).isTrue();
createMap(); // create a new map
// both entries are still in the map on disk
assertThat(map).hasSize(2);
// add another entry
map.put("baz2", "bang2");
assertThat(map).hasSize(3);
// journal file written
assertThat(journalFile.exists()).isTrue();
createMap(); // create a new map
// all three entries are still in the map on disk
assertThat(map).hasSize(3);
}
}
|