com.google.common.truth.extensions.proto.ProtoTruth Maven / Gradle / Ivy
Show all versions of truth-proto-extension Show documentation
/*
* Copyright (c) 2016 Google, Inc.
*
* 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.common.truth.extensions.proto;
import static com.google.common.truth.Truth.assertAbout;
import com.google.common.collect.Multimap;
import com.google.common.truth.CustomSubjectBuilder;
import com.google.common.truth.IterableSubject;
import com.google.common.truth.MapSubject;
import com.google.common.truth.MultimapSubject;
import com.google.common.truth.StandardSubjectBuilder;
import com.google.protobuf.Message;
import com.google.protobuf.MessageLite;
import java.util.Map;
import org.jspecify.annotations.Nullable;
/**
* A set of static methods to begin a Truth assertion chain for protocol buffers.
*
* Note: Usage of different failure strategies such as assume and expect should
* rely on {@link StandardSubjectBuilder#about(CustomSubjectBuilder.Factory)} to begin a chain with
* those alternative behaviors.
*/
public final class ProtoTruth {
/**
* Returns a {@link CustomSubjectBuilder.Factory}, akin to a {@link
* com.google.common.truth.Subject.Factory}, which can be used to assert on multiple types of
* Protos and collections containing them.
*/
public static CustomSubjectBuilder.Factory protos() {
return ProtoSubjectBuilder.factory();
}
/** Assert on a single {@link MessageLite} instance. */
public static LiteProtoSubject assertThat(@Nullable MessageLite messageLite) {
return assertAbout(protos()).that(messageLite);
}
/** Assert on a single {@link Message} instance. */
public static ProtoSubject assertThat(@Nullable Message message) {
return assertAbout(protos()).that(message);
}
/**
* Assert on a sequence of {@link Message}s.
*
* This allows for the equality configurations on {@link ProtoSubject} to be applied to all
* comparison tests available on {@link IterableSubject.UsingCorrespondence}.
*/
// Note: We must specify M explicitly here. The presence of the type parameter makes this method
// signature distinct from Truth.assertThat(Iterable), and allows users to import both static
// methods without conflict. If this method instead accepted Iterable, this
// would result in method ambiguity errors.
// See http://stackoverflow.com/a/8467804 for a more thorough explanation.
public static IterableOfProtosSubject assertThat(
@Nullable Iterable messages) {
return assertAbout(protos()).that(messages);
}
/**
* Assert on a map with {@link Message} values.
*
* This allows for the equality configurations on {@link ProtoSubject} to be applied to all
* comparison tests available on {@link MapSubject.UsingCorrespondence}.
*/
public static MapWithProtoValuesSubject assertThat(
@Nullable Map map) {
return assertAbout(protos()).that(map);
}
/**
* Assert on a {@link Multimap} with {@link Message} values.
*
* This allows for the equality configurations on {@link ProtoSubject} to be applied to all
* comparison tests available on {@link MultimapSubject.UsingCorrespondence}.
*/
public static MultimapWithProtoValuesSubject assertThat(
@Nullable Multimap multimap) {
return assertAbout(protos()).that(multimap);
}
private ProtoTruth() {}
}