opendev/gerrit
Code Issues Proposed changes

Move SerializedClassSubject to a more common location

Browse Source 
Previously, SerializedClassSubject was only used for CacheSerializer
tests. With the addition of ProtoConverters, we need exactly the same
test helpers again. To reduce code duplication and avoid strange
dependencies, move the Truth subject to a more common package.

Change-Id: Iafdc5fc5efcb1a7ee4a9335eeac3b5fdd5f443c0
This commit is contained in:
Alice Kober-Sotzek
2018-12-10 13:41:40 +01:00
parent 0d394bc9aa
commit 2b12b57072
20 changed files with 55 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
java/com/google/gerrit/server/cache/testing/BUILD vendored
View File

@@ -5,10 +5,6 @@ java_library(
srcs = glob(["*.java"]),
visibility = ["//visibility:public"],
deps = [
"//java/com/google/gerrit/server/cache/serialize",
"//lib:guava",
"//lib:protobuf",
"//lib/commons:lang3",
"//lib/truth",
],
)

110
java/com/google/gerrit/server/cache/testing/SerializedClassSubject.java vendored
View File

@@ -1,110 +0,0 @@
// Copyright (C) 2018 The Android Open Source Project
//
// 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.gerrit.server.cache.testing;
import static com.google.common.collect.ImmutableMap.toImmutableMap;
import static com.google.common.truth.Truth.assertAbout;
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth.assertWithMessage;
import com.google.common.truth.FailureMetadata;
import com.google.common.truth.Subject;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Type;
import java.util.Arrays;
import java.util.Map;
import org.apache.commons.lang3.reflect.FieldUtils;
/**
* Subject about classes that are serialized into persistent caches.
*
* <p>Hand-written {@link com.google.gerrit.server.cache.serialize.CacheSerializer CacheSerializer}
* implementations depend on the exact representation of the data stored in a class, so it is
* important to verify any assumptions about the structure of the serialized classes. This class
* contains assertions about serialized classes, and should be used for every class that has a
* custom serializer implementation.
*
* <p>Changing fields of a serialized class (or abstract methods, in the case of {@code @AutoValue}
* classes) will likely require changes to the serializer implementation, and may require bumping
* the {@link com.google.gerrit.server.cache.PersistentCacheBinding#version(int) version} in the
* cache binding, in case the representation has changed in such a way that old serialized data
* becomes unreadable.
*
* <p>Changes to a serialized class such as adding or removing fields generally requires a change to
* the hand-written serializer. Usually, serializer implementations should be written in such a way
* that new fields are considered optional, and won't require bumping the version.
*/
public class SerializedClassSubject extends Subject<SerializedClassSubject, Class<?>> {
public static SerializedClassSubject assertThatSerializedClass(Class<?> actual) {
// This formulation fails in Eclipse 4.7.3a with "The type
// SerializedClassSubject does not define SerializedClassSubject() that is
// applicable here", due to
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=534694 or a similar bug:
// return assertAbout(SerializedClassSubject::new).that(actual);
Subject.Factory<SerializedClassSubject, Class<?>> factory =
(m, a) -> new SerializedClassSubject(m, a);
return assertAbout(factory).that(actual);
}
private SerializedClassSubject(FailureMetadata metadata, Class<?> actual) {
super(metadata, actual);
}
public void isAbstract() {
isNotNull();
assertWithMessage("expected class %s to be abstract", actual().getName())
.that(Modifier.isAbstract(actual().getModifiers()))
.isTrue();
}
public void isConcrete() {
isNotNull();
assertWithMessage("expected class %s to be concrete", actual().getName())
.that(!Modifier.isAbstract(actual().getModifiers()))
.isTrue();
}
public void hasFields(Map<String, Type> expectedFields) {
isConcrete();
assertThat(
FieldUtils.getAllFieldsList(actual())
.stream()
.filter(f -> !Modifier.isStatic(f.getModifiers()))
.collect(toImmutableMap(Field::getName, Field::getGenericType)))
.containsExactlyEntriesIn(expectedFields);
}
public void hasAutoValueMethods(Map<String, Type> expectedMethods) {
// Would be nice if we could check clazz is an @AutoValue, but the retention is not RUNTIME.
isAbstract();
assertThat(
Arrays.stream(actual().getDeclaredMethods())
.filter(m -> !Modifier.isStatic(m.getModifiers()))
.filter(m -> Modifier.isAbstract(m.getModifiers()))
.filter(m -> m.getParameters().length == 0)
.collect(toImmutableMap(Method::getName, Method::getGenericReturnType)))
.named("no-argument abstract methods on %s", actual().getName())
.isEqualTo(expectedMethods);
}
public void extendsClass(Type superclassType) {
isNotNull();
assertThat(actual().getGenericSuperclass())
.named("superclass of %s", actual().getName())
.isEqualTo(superclassType);
}
}