Package com.google.common.truth

Truth is a library for performing assertions in tests:

 assertThat(notificationText).contains("testuser@google.com");
 

Truth is owned and maintained by the Guava team. It is used in the majority of the tests in Google’s own codebase.

For more information, see our introduction and other docs.

Interface Summary

Interface	Description
Correspondence.BinaryPredicate<A,E>	A functional interface for a binary predicate, to be used to test whether a pair of objects of types A and E satisfy some condition.
Correspondence.DiffFormatter<A,E>	A functional interface to be used format the diff between a pair of objects of types A and E.
CustomSubjectBuilder.Factory<CustomSubjectBuilderT extends CustomSubjectBuilder>	In a fluent assertion chain, the argument to the "custom" overload of about, the method that specifies what kind of Subject to create.
ErrorWithFacts	Supertype of Truth's AssertionError subclasses that are created from a list of Fact instances.
ExpectFailure.SimpleSubjectBuilderCallback<S extends Subject,A>	A "functional interface" for expectFailureAbout() to invoke and capture failures.
ExpectFailure.StandardSubjectBuilderCallback	A "functional interface" for expectFailure() to invoke and capture failures.
FailureStrategy	Defines what to do when a check fails.
IterableSubject.PairwiseChecker
MapSubject.ValueTester<A,E>
Ordered	Returned by calls like IterableSubject.containsExactly(java.lang.Object...), Ordered lets the caller additionally check that the expected elements were present in the order they were passed to the previous calls.
Platform.JUnitTestRule	Wrapping interface of TestRule to be used within truth.
Subject.Factory<SubjectT extends Subject,ActualT>	In a fluent assertion chain, the argument to the common overload of about, the method that specifies what kind of Subject to create.

Class Summary

Class	Description
AbstractArraySubject	A common supertype for Array subjects, abstracting some common display and error infrastructure.
ActualValueInference	Given the stack frame of a failing assertion, tries to describe what the user passed to assertThat.
ActualValueInference.DescribedEntry	An entry that contains a description of how it was created.
ActualValueInference.FrameInfo	A value class to represent a frame.
ActualValueInference.InferenceClassVisitor
ActualValueInference.InferenceMethodVisitor
ActualValueInference.InferredType	This is the type used for type inference.
ActualValueInference.Invocation	A method invocation.
ActualValueInference.Invocation.Builder
ActualValueInference.OpaqueEntry	An entry that we know nothing about except for its type.
ActualValueInference.StackEntry	An entry on the stack (or the local-variable table) with a type and sometimes a description of how the value was produced or, as a special case, whether the value is a Truth subject.
ActualValueInference.SubjectEntry	An entry for a Subject (or a similar object derived with a Subject, like Ordered).
AutoValue_ActualValueInference_DescribedEntry
AutoValue_ActualValueInference_FrameInfo
AutoValue_ActualValueInference_InferredType
AutoValue_ActualValueInference_Invocation
AutoValue_ActualValueInference_Invocation.Builder
AutoValue_ActualValueInference_OpaqueEntry
AutoValue_ActualValueInference_SubjectEntry
BigDecimalSubject	Propositions for BigDecimal typed subjects.
BooleanSubject	Propositions for boolean subjects.
ClassSubject	Propositions for Class subjects.
ComparableSubject<T extends java.lang.Comparable>	Propositions for Comparable typed subjects.
Correspondence<A,E>	Determines whether an instance of type A corresponds in some way to an instance of type E for the purposes of a test assertion.
Correspondence.ExceptionStore	Helper object to store exceptions encountered while executing a Correspondence method.
Correspondence.FormattingDiffs<A,E>
Correspondence.FromBinaryPredicate<A,E>
Correspondence.StoredException
Correspondence.TolerantNumericEquality
Correspondence.Transforming<A,E>
CustomSubjectBuilder	In a fluent assertion chain, exposes one or more "custom" that methods, which accept a value under test and return a Subject.
DoubleSubject	Propositions for Double subjects.
DoubleSubject.TolerantDoubleComparison	A partially specified check about an approximate relationship to a double subject using a tolerance.
Expect	A TestRule that batches up all failures encountered during a test, and reports them all together at the end (similar to ErrorCollector).
Expect.ExpectationGatherer
ExpectFailure	A utility for testing that assertions against a custom Subject fail when they should, plus a utility to assert about parts of the resulting failure messages.
Fact	A string key-value pair in a failure message, such as "expected: abc" or "but was: xyz."
Facts	Helper class that wraps a collection of Fact instances to make them easier to build.
FailureMetadata	An opaque, immutable object containing state from the previous calls in the fluent assertion chain.
FailureMetadata.Step	The data from a call to either (a) a Subject constructor or (b) Subject.check().
FloatSubject	Propositions for Float subjects.
FloatSubject.TolerantFloatComparison	A partially specified check about an approximate relationship to a float subject using a tolerance.
GraphMatching	Helper routines related to graph matchings.
GraphMatching.HopcroftKarp<U,V>	Helper which implements the Hopcroft–Karp algorithm.
GuavaOptionalSubject	Propositions for Guava Optional subjects.
IntegerSubject	Propositions for Integer subjects.
IntStreamSubject	Propositions for IntStream subjects.
IterableSubject	Propositions for Iterable subjects.
IterableSubject.UsingCorrespondence<A,E>	A partially specified check in which the actual elements (normally the elements of the Iterable under test) are compared to expected elements using a Correspondence.
LazyMessage
LongStreamSubject	Propositions for LongStream subjects.
LongSubject	Propositions for long subjects.
MapSubject	Propositions for Map subjects.
MapSubject.MapDifference<K,A,E>
MapSubject.TypedToStringWrapper
MapSubject.ValueDifference<A,E>
MathUtil	Math utilities to be shared by numeric subjects.
MultimapSubject	Propositions for Multimap subjects.
MultimapSubject.EntryCorrespondence<K,A,E>
MultimapSubject.IterableEntries
MultisetSubject	Propositions for Multiset subjects.
ObjectArraySubject<T>	A Subject for Object[] and more generically T[].
OptionalDoubleSubject	Propositions for Java 8 OptionalDouble subjects.
OptionalIntSubject	Propositions for Java 8 OptionalInt subjects.
OptionalLongSubject	Propositions for Java 8 OptionalLong subjects.
OptionalSubject	Propositions for Java 8 Optional subjects.
PathSubject	Assertions for Path instances.
Platform	Extracted routines that need to be swapped in for GWT, to allow for minimal deltas between the GWT and non-GWT version.
PrimitiveBooleanArraySubject	A Subject for boolean[].
PrimitiveByteArraySubject	A Subject for byte[].
PrimitiveCharArraySubject	A Subject for char[].
PrimitiveDoubleArraySubject	A Subject for double[].
PrimitiveDoubleArraySubject.DoubleArrayAsIterable	A partially specified check for doing assertions on the array similar to the assertions supported for Iterable subjects, in which the elements of the array under test are compared to expected elements using either exact or tolerant double equality: see PrimitiveDoubleArraySubject.usingExactEquality() and PrimitiveDoubleArraySubject.usingTolerance(double).
PrimitiveFloatArraySubject	A Subject for float[].
PrimitiveFloatArraySubject.FloatArrayAsIterable	A partially specified check for doing assertions on the array similar to the assertions supported for Iterable subjects, in which the elements of the array under test are compared to expected elements using either exact or tolerant float equality: see PrimitiveFloatArraySubject.usingExactEquality() and PrimitiveFloatArraySubject.usingTolerance(double).
PrimitiveIntArraySubject	A Subject for int[].
PrimitiveLongArraySubject	A Subject for long[].
PrimitiveShortArraySubject	A Subject for short[].
SimpleSubjectBuilder<SubjectT extends Subject,ActualT>	In a fluent assertion chain, exposes the most common that method, which accepts a value under test and returns a Subject.
StackTraceCleaner	Utility that cleans stack traces to remove noise from common frameworks.
StackTraceCleaner.StackTraceElementWrapper	Wrapper around a StackTraceElement for calculating and holding the metadata used to clean the stack trace.
StandardSubjectBuilder	In a fluent assertion chain, an object with which you can do any of the following: Set an optional message with StandardSubjectBuilder.withMessage(java.lang.String).
StreamSubject	Propositions for Stream subjects.
StringSubject	Propositions for string subjects.
Subject	An object that lets you perform checks on the value under test.
Subject.ComparisonResult	The result of comparing two objects for equality.
SubjectUtils	Utility methods used in Subject implementors.
SubjectUtils.DuplicateGroupedAndTyped	Missing or unexpected values from a collection assertion, with equal objects grouped together and, in some cases, type information added.
SubjectUtils.NonHashingMultiset<E>
TableSubject	Propositions for Table subjects.
ThrowableSubject	Propositions for Throwable subjects.
Truth	The primary entry point for Truth, a library for fluent test assertions.
Truth8	The primary entry point for assertions about Java 8 types.
TruthFailureSubject	Subject for AssertionError objects thrown by Truth.
TruthJUnit	Provides a way to use Truth to perform JUnit "assumptions." An assumption is a check that, if false, aborts (skips) the test.

Enum Summary

Enum	Description
Expect.TestPhase
FailureMetadata.OldAndNewValuesAreSimilar	Whether the value of the original subject and the value of the derived subject are "similar enough" that we don't need to display both.
IterableSubject.ElementFactGrouping	Whether to output each missing/unexpected item as its own Fact or to group all those items together into a single Fact.
StackTraceCleaner.StackFrameType	Enum of the package or class-name based categories of stack frames that might be removed or collapsed by the cleaner.
Subject.EqualityCheck

Exception Summary

Exception	Description
Platform	Extracted routines that need to be swapped in for GWT, to allow for minimal deltas between the GWT and non-GWT version.
TruthJUnit.ThrowableAssumptionViolatedException

Error Summary

Error	Description
AssertionErrorWithFacts	An AssertionError composed of structured Fact instances and other string messages.
ComparisonFailureWithFacts	An AssertionError (usually a JUnit ComparisonFailure, but not under GWT) composed of structured Fact instances and other string messages.
Platform.PlatformComparisonFailure
Truth.SimpleAssertionError	An AssertionError that (a) always supports a cause, even under old versions of Android and (b) omits "java.lang.AssertionError:" from the beginning of its toString() representation.

Annotation Types Summary

Annotation Type	Description
ActualValueInference.Nullable