S - subject class type.M - message type.public class ProtoSubject<S extends ProtoSubject<S,M>,M extends com.google.protobuf.Message> extends LiteProtoSubject<S,M> implements ProtoFluentAssertion
ProtoTruth.assertThat(actual).isEqualTo(expected) performs the same assertion as
Truth.assertThat(actual).isEqualTo(expected), but with a better failure message. By
default, the assertions are strict with respect to repeated field order, missing fields, etc.
This behavior can be changed with the configuration methods on this subject, e.g. ProtoTruth.assertThat(actual).ignoringRepeatedFieldOrder().isEqualTo(expected).
Floating-point fields are compared using exact equality, which is probably not what you want if the values are the results of some arithmetic. Support for approximate equality may be added in a later version.
Equality tests, and other methods, may yield slightly different behavior for versions 2 and 3 of Protocol Buffers. If testing protos of multiple versions, make sure you understand the behaviors of default and unknown fields so you don't under or over test.
LiteProtoSubject.Factory<S extends LiteProtoSubject<S,M>,M extends com.google.protobuf.MessageLite>| Modifier | Constructor and Description |
|---|---|
protected |
ProtoSubject(FailureMetadata failureMetadata,
M message) |
| Modifier and Type | Method and Description |
|---|---|
ProtoFluentAssertion |
comparingExpectedFieldsOnly()
Limits the comparison of Protocol buffers to the fields set in the expected proto(s).
|
void |
hasAllRequiredFields()
Checks whether the subject has all required fields set.
|
ProtoFluentAssertion |
ignoringExtraRepeatedFieldElements()
Specifies that, for all repeated and map fields, any elements in the 'actual' proto which are
not found in the 'expected' proto are ignored, with the exception of fields in the expected
proto which are empty.
|
ProtoFluentAssertion |
ignoringFieldAbsence()
Specifies that the 'has' bit of individual fields should be ignored when comparing for
equality.
|
ProtoFluentAssertion |
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. |
ProtoFluentAssertion |
ignoringFieldDescriptors(Iterable<com.google.protobuf.Descriptors.FieldDescriptor> fieldDescriptors)
Excludes all message fields matching the given
Descriptors.FieldDescriptors from the comparison. |
ProtoFluentAssertion |
ignoringFields(int firstFieldNumber,
int... rest)
Excludes the top-level message fields with the given tag numbers from the comparison.
|
ProtoFluentAssertion |
ignoringFields(Iterable<Integer> fieldNumbers)
Excludes the top-level message fields with the given tag numbers from the comparison.
|
ProtoFluentAssertion |
ignoringFieldScope(FieldScope fieldScope)
Excludes all specific field paths under the argument
FieldScope from the comparison. |
ProtoFluentAssertion |
ignoringRepeatedFieldOrder()
Specifies that the ordering of repeated fields, at all levels, should be ignored when comparing
for equality.
|
void |
isEqualTo(Object expected)
Checks whether the MessageLite is equivalent to the argument, using the standard equals()
implementation.
|
void |
isNotEqualTo(Object expected)
Fails if the subject is equal to the given object.
|
ProtoFluentAssertion |
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.
|
ProtoFluentAssertion |
usingDoubleTolerance(double tolerance)
Compares double fields as equal if they are both finite and their absolute difference is less
than or equal to
tolerance. |
ProtoFluentAssertion |
usingFloatTolerance(float tolerance)
Compares float fields as equal if they are both finite and their absolute difference is less
than or equal to
tolerance. |
ProtoFluentAssertion |
withPartialScope(FieldScope fieldScope)
Limits the comparison of Protocol buffers to the defined
FieldScope. |
actualCustomStringRepresentation, isEqualTo, isEqualToDefaultInstance, isNotEqualTo, isNotEqualToDefaultInstance, serializedSizeactual, actualAsString, check, check, equals, fail, fail, fail, failComparing, failComparing, failWithActual, failWithActual, failWithBadResults, failWithCustomSubject, failWithoutActual, failWithoutActual, failWithoutSubject, failWithRawMessage, failWithRawMessageAndCause, getSubject, hashCode, ignoreCheck, internalCustomName, isAnyOf, isIn, isInstanceOf, isNoneOf, isNotIn, isNotInstanceOf, isNotNull, isNotSameAs, isNull, isSameAs, named, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitequals, hashCodeprotected ProtoSubject(FailureMetadata failureMetadata, @NullableDecl M message)
public ProtoFluentAssertion ignoringFieldAbsence()
ProtoFluentAssertionFor 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.
ignoringFieldAbsence in interface ProtoFluentAssertionpublic ProtoFluentAssertion ignoringRepeatedFieldOrder()
ProtoFluentAssertionThis setting applies to all repeated fields recursively, but it does not ignore structure.
For example, with ProtoFluentAssertion.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.
ignoringRepeatedFieldOrder in interface ProtoFluentAssertionpublic ProtoFluentAssertion ignoringExtraRepeatedFieldElements()
ProtoFluentAssertionProtoFluentAssertion.comparingExpectedFieldsOnly().
This rule is applied independently from ProtoFluentAssertion.ignoringRepeatedFieldOrder(). If ignoring
repeated field order AND extra repeated field elements, all that is tested is that the expected
elements comprise a subset of the actual elements. If not ignoring repeated field order, but
still ignoring extra repeated field elements, the actual elements must contain a subsequence
that matches the expected elements for the test to pass. (The subsequence rule does not apply
to Map fields, which are always compared by key.)
ignoringExtraRepeatedFieldElements in interface ProtoFluentAssertionpublic ProtoFluentAssertion usingDoubleTolerance(double tolerance)
ProtoFluentAssertiontolerance.usingDoubleTolerance in interface ProtoFluentAssertiontolerance - A finite, non-negative tolerance.public ProtoFluentAssertion usingFloatTolerance(float tolerance)
ProtoFluentAssertiontolerance.usingFloatTolerance in interface ProtoFluentAssertiontolerance - A finite, non-negative tolerance.public ProtoFluentAssertion comparingExpectedFieldsOnly()
ProtoFluentAssertionThe "expected proto(s)" are those passed to the void method at the end of the ProtoFluentAssertion call-chain: For example, ProtoFluentAssertion.isEqualTo(Object), or ProtoFluentAssertion.isNotEqualTo(Object).
Fields not set in the expected proto(s) are ignored. In particular, proto3 fields which have their default values are ignored, as these are indistinguishable from unset fields. If you want to assert that a proto3 message has certain fields with default values, you cannot use this method.
comparingExpectedFieldsOnly in interface ProtoFluentAssertionpublic ProtoFluentAssertion withPartialScope(FieldScope fieldScope)
ProtoFluentAssertionFieldScope.
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.
withPartialScope in interface ProtoFluentAssertionpublic ProtoFluentAssertion ignoringFields(int firstFieldNumber, int... rest)
ProtoFluentAssertionThis 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.
ignoringFields in interface ProtoFluentAssertionpublic ProtoFluentAssertion ignoringFields(Iterable<Integer> fieldNumbers)
ProtoFluentAssertionThis 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.
ignoringFields in interface ProtoFluentAssertionpublic ProtoFluentAssertion ignoringFieldDescriptors(com.google.protobuf.Descriptors.FieldDescriptor firstFieldDescriptor, com.google.protobuf.Descriptors.FieldDescriptor... rest)
ProtoFluentAssertionDescriptors.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.
ignoringFieldDescriptors in interface ProtoFluentAssertionpublic ProtoFluentAssertion ignoringFieldDescriptors(Iterable<com.google.protobuf.Descriptors.FieldDescriptor> fieldDescriptors)
ProtoFluentAssertionDescriptors.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.
ignoringFieldDescriptors in interface ProtoFluentAssertionpublic ProtoFluentAssertion ignoringFieldScope(FieldScope fieldScope)
ProtoFluentAssertionFieldScope 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.
ignoringFieldScope in interface ProtoFluentAssertionpublic ProtoFluentAssertion reportingMismatchesOnly()
ProtoFluentAssertionThis a purely cosmetic setting, and it has no effect on the behavior of the test.
reportingMismatchesOnly in interface ProtoFluentAssertionpublic void isEqualTo(@NullableDecl
Object expected)
LiteProtoSubjectisEqualTo in interface ProtoFluentAssertionisEqualTo in class LiteProtoSubject<S extends ProtoSubject<S,M>,M extends com.google.protobuf.Message>public void isNotEqualTo(@NullableDecl
Object expected)
SubjectSubject.isEqualTo(java.lang.Object) method.isNotEqualTo in interface ProtoFluentAssertionisNotEqualTo in class LiteProtoSubject<S extends ProtoSubject<S,M>,M extends com.google.protobuf.Message>public void hasAllRequiredFields()
LiteProtoSubjectbuild(), which itself fails if required fields aren't set.hasAllRequiredFields in class LiteProtoSubject<S extends ProtoSubject<S,M>,M extends com.google.protobuf.Message>Copyright © 2018. All rights reserved.