com.google.common.truth.extensions.proto

Interface IterableOfProtosFluentAssertion<M extends com.google.protobuf.Message>

public interface IterableOfProtosFluentAssertion<M extends com.google.protobuf.Message>

Fluent API to perform detailed, customizable comparison of iterables of protocol buffers. The same comparison rules are applied to all pairs of protocol buffers which get compared.

Methods may be chained in any order, but the chain should terminate with a method that doesn't return an IterableOfProtosFluentAssertion, such as containsExactly(M...), or containsAnyIn(java.lang.Iterable<? extends M>).

The state of a IterableOfProtosFluentAssertion object after each method is called is left undefined. Users should not retain references to IterableOfProtosFluentAssertion instances.

Method Summary

Methods

Modifier and Type	Method and Description
void	contains(M expected) Attests that the subject contains at least one element that corresponds to the given expected element.
Ordered	containsAllIn(Iterable<? extends M> expected) Attests that the subject contains elements that corresponds to all of the expected elements, i.e.
Ordered	containsAllOf(M first, M second, M... rest) Attests that the subject contains elements that corresponds to all of the expected elements, i.e.
void	containsAnyIn(Iterable<? extends M> expected) Attests that the subject contains at least one element that corresponds to at least one of the expected elements.
void	containsAnyOf(M first, M second, M... rest) Attests that the subject contains at least one element that corresponds to at least one of the expected elements.
Ordered	containsExactly(M... expected) Attests that subject contains exactly elements that correspond to the expected elements, i.e.
Ordered	containsExactlyElementsIn(Iterable<? extends M> expected) Attests that subject contains exactly elements that correspond to the expected elements, i.e.
void	containsNoneIn(Iterable<? extends M> excluded) Attests that the subject contains no elements that correspond to any of the given elements.
void	containsNoneOf(M firstExcluded, M secondExcluded, M... restOfExcluded) Attests that the subject contains no elements that correspond to any of the given elements.
void	doesNotContain(M excluded) Attests that none of the actual elements correspond to the given element.
boolean	equals(Object o) Deprecated. Do not call equals() on a IterableOfProtosFluentAssertion.
int	hashCode() Deprecated. IterableOfProtosFluentAssertion does not support hashCode().
IterableOfProtosFluentAssertion<M>	ignoringFieldAbsence() Specifies that the 'has' bit of individual fields should be ignored when comparing for equality.
IterableOfProtosFluentAssertion<M>	ignoringFieldDescriptors(com.google.protobuf.Descriptors.FieldDescriptor firstFieldDescriptor, com.google.protobuf.Descriptors.FieldDescriptor... rest) Excludes all message fields matching the given Descriptors.FieldDescriptors from the comparison.
IterableOfProtosFluentAssertion<M>	ignoringFields(int firstFieldNumber, int... rest) Excludes the top-level message fields with the given tag numbers from the comparison.
IterableOfProtosFluentAssertion<M>	ignoringFieldScope(FieldScope fieldScope) Excludes all specific field paths under the argument FieldScope from the comparison.
IterableOfProtosFluentAssertion<M>	ignoringRepeatedFieldOrder() Specifies that the ordering of repeated fields, at all levels, should be ignored when comparing for equality.
IterableOfProtosFluentAssertion<M>	reportingMismatchesOnly() If set, in the event of a comparison failure, the error message printed will list only those specific fields that did not match between the actual and expected values.
IterableOfProtosFluentAssertion<M>	withPartialScope(FieldScope fieldScope) Limits the comparison of Protocol buffers to the defined FieldScope.

Method Detail

ignoringFieldAbsence

IterableOfProtosFluentAssertion<M> ignoringFieldAbsence()

Specifies that the 'has' bit of individual fields should be ignored when comparing for equality.

For version 2 Protocol Buffers, this setting determines whether two protos with the same value for a primitive field compare equal if one explicitly sets the value, and the other merely implicitly uses the schema-defined default. This setting also determines whether unknown fields should be considered in the comparison. By ignoringFieldAbsence(), unknown fields are ignored, and value-equal fields as specified above are considered equal.

For version 3 Protocol Buffers, this setting has no effect. Primitive fields set to their default value are indistinguishable from unset fields in proto 3. Proto 3 also eliminates unknown fields, so this setting has no effect there either.

ignoringRepeatedFieldOrder

IterableOfProtosFluentAssertion<M> ignoringRepeatedFieldOrder()

Specifies that the ordering of repeated fields, at all levels, should be ignored when comparing for equality.

This setting applies to all repeated fields recursively, but it does not ignore structure. For example, with ignoringRepeatedFieldOrder(), a repeated int32 field bar, set inside a repeated message field foo, the following protos will all compare equal:

message1: {
   foo: {
     bar: 1
     bar: 2
   }
   foo: {
     bar: 3
     bar: 4
   }
 }

 message2: {
   foo: {
     bar: 2
     bar: 1
   }
   foo: {
     bar: 4
     bar: 3
   }
 }

 message3: {
   foo: {
     bar: 4
     bar: 3
   }
   foo: {
     bar: 2
     bar: 1
   }
 }
 

However, the following message will compare equal to none of these:

message4: {
   foo: {
     bar: 1
     bar: 3
   }
   foo: {
     bar: 2
     bar: 4
   }
 }
 

This setting does not apply to map fields, for which field order is always ignored. The serialization order of map fields is undefined, and it may change from runtime to runtime.

withPartialScope

IterableOfProtosFluentAssertion<M> withPartialScope(FieldScope fieldScope)

Limits the comparison of Protocol buffers to the defined FieldScope.

This method is additive and has well-defined ordering semantics. If the invoking ProtoFluentAssertion is already scoped to a FieldScope X, and this method is invoked with FieldScope Y, the resultant ProtoFluentAssertion is constrained to the intersection of FieldScopes X and Y.

By default, ProtoFluentAssertion is constrained to FieldScopes.all(), that is, no fields are excluded from comparison.

ignoringFields

IterableOfProtosFluentAssertion<M> ignoringFields(int firstFieldNumber,
                                                int... rest)

Excludes the top-level message fields with the given tag numbers from the comparison.

This method adds on any previous FieldScope related settings, overriding previous changes to ensure the specified fields are ignored recursively. All sub-fields of these field numbers are ignored, and all sub-messages of type M will also have these field numbers ignored.

If an invalid field number is supplied, the terminal comparison operation will throw a runtime exception.

ignoringFieldDescriptors

IterableOfProtosFluentAssertion<M> ignoringFieldDescriptors(com.google.protobuf.Descriptors.FieldDescriptor firstFieldDescriptor,
                                                          com.google.protobuf.Descriptors.FieldDescriptor... rest)

Excludes all message fields matching the given Descriptors.FieldDescriptors from the comparison.

This method adds on any previous FieldScope related settings, overriding previous changes to ensure the specified fields are ignored recursively. All sub-fields of these field descriptors are ignored, no matter where they occur in the tree.

If a field descriptor which does not, or cannot occur in the proto structure is supplied, it is silently ignored.

ignoringFieldScope

IterableOfProtosFluentAssertion<M> ignoringFieldScope(FieldScope fieldScope)

Excludes all specific field paths under the argument FieldScope from the comparison.

This method is additive and has well-defined ordering semantics. If the invoking ProtoFluentAssertion is already scoped to a FieldScope X, and this method is invoked with FieldScope Y, the resultant ProtoFluentAssertion is constrained to the subtraction of X - Y.

By default, ProtoFluentAssertion is constrained to FieldScopes.all(), that is, no fields are excluded from comparison.

reportingMismatchesOnly

IterableOfProtosFluentAssertion<M> reportingMismatchesOnly()

If set, in the event of a comparison failure, the error message printed will list only those specific fields that did not match between the actual and expected values. Useful for very large protocol buffers.

This a purely cosmetic setting, and it has no effect on the behavior of the test.

contains

void contains(@Nullable
            M expected)

Attests that the subject contains at least one element that corresponds to the given expected element.

doesNotContain

void doesNotContain(@Nullable
                  M excluded)

Attests that none of the actual elements correspond to the given element.

containsExactly

Ordered containsExactly(@Nullable
                      M... expected)

Attests that subject contains exactly elements that correspond to the expected elements, i.e. that there is a 1:1 mapping between the actual elements and the expected elements where each pair of elements correspond.

To also test that the contents appear in the given order, make a call to inOrder() on the object returned by this method.

containsExactlyElementsIn

Ordered containsExactlyElementsIn(Iterable<? extends M> expected)

Attests that subject contains exactly elements that correspond to the expected elements, i.e. that there is a 1:1 mapping between the actual elements and the expected elements where each pair of elements correspond.

To also test that the contents appear in the given order, make a call to inOrder() on the object returned by this method.

containsAllOf

Ordered containsAllOf(@Nullable
                    M first,
                    @Nullable
                    M second,
                    @Nullable
                    M... rest)

Attests that the subject contains elements that corresponds to all of the expected elements, i.e. that there is a 1:1 mapping between any subset of the actual elements and the expected elements where each pair of elements correspond.

To also test that the contents appear in the given order, make a call to inOrder() on the object returned by this method. The elements must appear in the given order within the subject, but they are not required to be consecutive.

containsAllIn

Ordered containsAllIn(Iterable<? extends M> expected)

Attests that the subject contains elements that corresponds to all of the expected elements, i.e. that there is a 1:1 mapping between any subset of the actual elements and the expected elements where each pair of elements correspond.

To also test that the contents appear in the given order, make a call to inOrder() on the object returned by this method. The elements must appear in the given order within the subject, but they are not required to be consecutive.

containsAnyOf

void containsAnyOf(@Nullable
                 M first,
                 @Nullable
                 M second,
                 @Nullable
                 M... rest)

Attests that the subject contains at least one element that corresponds to at least one of the expected elements.

containsAnyIn

void containsAnyIn(Iterable<? extends M> expected)

Attests that the subject contains at least one element that corresponds to at least one of the expected elements.

containsNoneOf

void containsNoneOf(@Nullable
                  M firstExcluded,
                  @Nullable
                  M secondExcluded,
                  @Nullable
                  M... restOfExcluded)

Attests that the subject contains no elements that correspond to any of the given elements. (Duplicates are irrelevant to this test, which fails if any of the subject elements correspond to any of the given elements.)

containsNoneIn

void containsNoneIn(Iterable<? extends M> excluded)

Attests that the subject contains no elements that correspond to any of the given elements. (Duplicates are irrelevant to this test, which fails if any of the subject elements correspond to any of the given elements.)

equals

@Deprecated
boolean equals(Object o)

Deprecated. Do not call equals() on a IterableOfProtosFluentAssertion.

Overrides:

equals in class Object

See Also:

Subject.equals(Object)

hashCode

@Deprecated
int hashCode()

Deprecated. IterableOfProtosFluentAssertion does not support hashCode().

Overrides:

hashCode in class Object

See Also:

Subject.hashCode()