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
|
// 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 org.junit.Assert.fail;
import com.google.common.base.Preconditions;
import com.google.common.base.Stopwatch;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.skyframe.serialization.DeserializationContext;
import com.google.devtools.build.lib.skyframe.serialization.ObjectCodec;
import com.google.devtools.build.lib.skyframe.serialization.SerializationException;
import com.google.protobuf.CodedInputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.logging.Level;
import java.util.logging.Logger;
/** Utility for testing {@link ObjectCodec} instances. */
public class ObjectCodecTester<T> {
private static final Logger logger = Logger.getLogger(SerializerTester.class.getName());
/** Interface for testing successful deserialization of an object. */
@FunctionalInterface
public interface VerificationFunction<T> {
/**
* Verify whether or not the original object was sufficiently serialized/deserialized. Typically
* this will be some sort of assertion.
*
* @throws Exception on verification failure
*/
void verifyDeserialized(T original, T deserialized) throws Exception;
}
/**
* Create an {@link ObjectCodecTester.Builder} for the supplied instance. See
* {@link ObjectCodecTester.Builder} for details.
*/
public static <T> ObjectCodecTester.Builder<T> newBuilder(ObjectCodec<T> toTest) {
return new ObjectCodecTester.Builder<>(toTest);
}
private final ObjectCodec<T> underTest;
private final ImmutableList<T> subjects;
private final boolean skipBadDataTest;
private final VerificationFunction<T> verificationFunction;
private ObjectCodecTester(
ObjectCodec<T> underTest,
ImmutableList<T> subjects,
boolean skipBadDataTest,
VerificationFunction<T> verificationFunction) {
this.underTest = underTest;
Preconditions.checkState(!subjects.isEmpty(), "No subjects provided");
this.subjects = subjects;
this.skipBadDataTest = skipBadDataTest;
this.verificationFunction = verificationFunction;
}
private void runTests() throws Exception {
testSerializeDeserialize();
testStableSerialization();
if (!skipBadDataTest) {
testDeserializeJunkData();
}
}
/** Runs serialization/deserialization tests. */
void testSerializeDeserialize() throws Exception {
Stopwatch timer = Stopwatch.createStarted();
int totalBytes = 0;
for (T subject : subjects) {
byte[] serialized = toBytes(subject);
totalBytes += serialized.length;
T deserialized = fromBytes(serialized);
verificationFunction.verifyDeserialized(subject, deserialized);
}
logger.log(
Level.INFO,
underTest.getEncodedClass().getSimpleName()
+ " total serialized bytes = "
+ totalBytes
+ ", "
+ timer);
}
/** Runs serialized bytes stability tests. */
void testStableSerialization() throws Exception {
for (T subject : subjects) {
byte[] serialized = toBytes(subject);
T deserialized = fromBytes(serialized);
byte[] reserialized = toBytes(deserialized);
assertThat(reserialized).isEqualTo(serialized);
}
}
/** Runs junk-data recognition tests. */
void testDeserializeJunkData() {
try {
underTest.deserialize(
DeserializationContext.create(),
CodedInputStream.newInstance("junk".getBytes(StandardCharsets.UTF_8)));
fail("Expected exception");
} catch (SerializationException | IOException e) {
// Expected.
}
}
private T fromBytes(byte[] bytes) throws SerializationException, IOException {
return TestUtils.fromBytes(underTest, bytes);
}
private byte[] toBytes(T subject) throws IOException, SerializationException {
return TestUtils.toBytes(underTest, subject);
}
/** Builder for {@link ObjectCodecTester}. */
public static class Builder<T> {
private final ObjectCodec<T> underTest;
private final ImmutableList.Builder<T> subjectsBuilder = ImmutableList.builder();
private boolean skipBadDataTest = false;
private VerificationFunction<T> verificationFunction =
(original, deserialized) -> assertThat(deserialized).isEqualTo(original);
private Builder(ObjectCodec<T> underTest) {
this.underTest = underTest;
}
/** Add subjects to be tested for serialization/deserialization. */
@SafeVarargs
public final Builder<T> addSubjects(@SuppressWarnings("unchecked") T... subjects) {
return addSubjects(ImmutableList.copyOf(subjects));
}
/** Add subjects to be tested for serialization/deserialization. */
public Builder<T> addSubjects(ImmutableList<T> subjects) {
subjectsBuilder.addAll(subjects);
return this;
}
/**
* Skip tests that check for the ability to detect bad data. This may be useful for simpler
* codecs which don't do any error verification.
*/
public Builder<T> skipBadDataTest() {
this.skipBadDataTest = true;
return this;
}
/**
* Sets {@link ObjectCodecTester.VerificationFunction} for verifying deserialization. Default
* is simple equality assertion, a custom version may be provided for more, or less, detailed
* checks.
*/
public Builder<T> verificationFunction(VerificationFunction<T> verificationFunction) {
this.verificationFunction = Preconditions.checkNotNull(verificationFunction);
return this;
}
/** Captures the state of this builder and run all associated tests. */
public void buildAndRunTests() throws Exception {
build().runTests();
}
/**
* Creates a new {@link ObjectCodecTester} from this builder. Exposed to allow running tests
* individually.
*/
ObjectCodecTester<T> build() {
return new ObjectCodecTester<>(
underTest,
subjectsBuilder.build(),
skipBadDataTest,
verificationFunction);
}
}
}
|
