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
|
// Copyright 2017 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.skyframe.serialization.testutils;
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth.assert_;
import com.google.common.base.Preconditions;
import com.google.common.base.Stopwatch;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.skyframe.serialization.AutoRegistry;
import com.google.devtools.build.lib.skyframe.serialization.ObjectCodec;
import com.google.devtools.build.lib.skyframe.serialization.ObjectCodecRegistry;
import com.google.devtools.build.lib.skyframe.serialization.ObjectCodecs;
import com.google.devtools.build.lib.skyframe.serialization.SerializationException;
import com.google.protobuf.ByteString;
import com.google.protobuf.InvalidProtocolBufferException;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Random;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Utility for testing serialization of given subjects.
*
* <p>Differs from {@link ObjectCodecTester} in that this uses the context to perform serialization
* deserialization instead of a specific codec.
*/
public class SerializationTester {
public static final int DEFAULT_JUNK_INPUTS = 20;
public static final int JUNK_LENGTH_UPPER_BOUND = 20;
private static final Logger logger = Logger.getLogger(SerializationTester.class.getName());
/** Interface for testing successful deserialization of an object. */
@FunctionalInterface
public interface VerificationFunction<T> {
/**
* Verifies that the original object was sufficiently serialized/deserialized.
*
* <p><i>Must</i> throw an exception on failure.
*/
void verifyDeserialized(T original, T deserialized) throws Exception;
}
private final ImmutableList<Object> subjects;
private final ImmutableMap.Builder<Class<?>, Object> dependenciesBuilder;
private final ArrayList<ObjectCodec<?>> additionalCodecs = new ArrayList<>();
private boolean memoize;
private ObjectCodecs objectCodecs;
@SuppressWarnings("rawtypes")
private VerificationFunction verificationFunction =
(original, deserialized) -> assertThat(deserialized).isEqualTo(original);
private int repetitions = 1;
public SerializationTester(Object... subjects) {
this(ImmutableList.copyOf(subjects));
}
public SerializationTester(ImmutableList<Object> subjects) {
Preconditions.checkArgument(!subjects.isEmpty());
this.subjects = subjects;
this.dependenciesBuilder = ImmutableMap.builder();
}
public <D> SerializationTester addDependency(Class<? super D> type, D dependency) {
dependenciesBuilder.put(type, dependency);
return this;
}
public SerializationTester addCodec(ObjectCodec<?> codec) {
additionalCodecs.add(codec);
return this;
}
public SerializationTester makeMemoizing() {
this.memoize = true;
return this;
}
public SerializationTester setObjectCodecs(ObjectCodecs objectCodecs) {
this.objectCodecs = objectCodecs;
return this;
}
@SuppressWarnings("rawtypes")
public <T> SerializationTester setVerificationFunction(
VerificationFunction<T> verificationFunction) {
this.verificationFunction = verificationFunction;
return this;
}
/** Sets the number of times to repeat serialization and deserialization. */
public SerializationTester setRepetitions(int repetitions) {
this.repetitions = repetitions;
return this;
}
public void runTests() throws Exception {
ObjectCodecs codecs = this.objectCodecs == null ? createObjectCodecs() : this.objectCodecs;
testSerializeDeserialize(codecs);
testStableSerialization(codecs);
testDeserializeJunkData(codecs);
}
private ObjectCodecs createObjectCodecs() {
ObjectCodecRegistry registry = AutoRegistry.get();
ImmutableMap<Class<?>, Object> dependencies = dependenciesBuilder.build();
ObjectCodecRegistry.Builder registryBuilder = registry.getBuilder();
for (Object val : dependencies.values()) {
registryBuilder.addReferenceConstant(val);
}
for (ObjectCodec<?> codec : additionalCodecs) {
registryBuilder.add(codec);
}
return new ObjectCodecs(registryBuilder.build(), dependencies);
}
private ByteString serialize(Object subject, ObjectCodecs codecs)
throws SerializationException, IOException {
if (memoize) {
return codecs.serializeMemoized(subject);
} else {
return codecs.serialize(subject);
}
}
private Object deserialize(ByteString serialized, ObjectCodecs codecs)
throws SerializationException, IOException {
if (memoize) {
return codecs.deserializeMemoized(serialized);
} else {
return codecs.deserialize(serialized);
}
}
/** Runs serialization/deserialization tests. */
@SuppressWarnings("unchecked")
private void testSerializeDeserialize(ObjectCodecs codecs) throws Exception {
Stopwatch timer = Stopwatch.createStarted();
int totalBytes = 0;
for (int i = 0; i < repetitions; ++i) {
for (Object subject : subjects) {
ByteString serialized = serialize(subject, codecs);
totalBytes += serialized.size();
Object deserialized = deserialize(serialized, codecs);
verificationFunction.verifyDeserialized(subject, deserialized);
}
}
logger.log(
Level.INFO,
subjects.get(0).getClass().getSimpleName()
+ " total serialized bytes = "
+ totalBytes
+ ", "
+ timer);
}
/** Runs serialized bytes stability tests. */
private void testStableSerialization(ObjectCodecs codecs)
throws SerializationException, IOException {
for (Object subject : subjects) {
ByteString serialized = serialize(subject, codecs);
Object deserialized = deserialize(serialized, codecs);
ByteString reserialized = serialize(deserialized, codecs);
assertThat(reserialized).isEqualTo(serialized);
}
}
/** Runs junk-data recognition tests. */
private void testDeserializeJunkData(ObjectCodecs codecs) throws IOException {
Random rng = new Random(0);
for (int i = 0; i < DEFAULT_JUNK_INPUTS; ++i) {
byte[] junkData = new byte[rng.nextInt(JUNK_LENGTH_UPPER_BOUND)];
rng.nextBytes(junkData);
try {
deserialize(ByteString.copyFrom(junkData), codecs);
// OK. Junk string was coincidentally parsed.
} catch (SerializationException | InvalidProtocolBufferException e) {
// OK. Deserialization of junk failed.
return;
}
}
assert_().fail("all junk was parsed successfully");
}
}
|
