commit 594086ed8f67eb284f02527bd4e417e1c4845f81
author Patrick Meiring <meiring@google.com> Tue Aug 08 03:19:30 2023
committer LUCI CQ <infra-scoped@luci-project-accounts.iam.gserviceaccount.com> Tue Aug 08 03:19:30 2023
tree 6faba56c836775aefd0a2404c7fd08ac6f12db5a
parent c4e0e2259dbd26a459b74b603d2de178b2b5731f

[common] Improve ShouldResembleProto to handle protos in structs.

A number of cases have arisen where tests want to compare
vanilla go structs with one or more nested proto messages. For
example, structs representing rows in Spanner with protocol buffer
fields.

Neither Goconvey's ShouldResemble or its replacement that
handles proto messages (ShouldResembleProto) can do equality
comparisons on these, leading to ad-hoc workarounds in tests or
direct calls into gocmp which are generally unsatisfactory from
a readability perspective.

Rather than implement a third ShouldResembleXXX method, this CL
modifies the comparison in the existing ShouldResembleProto method
to allow protos nested in other ways. The gocmp-comparison is
stricter than the existing ShouldResembleProto test as it verifies the
type of the enclosing slice (if any), so some tests must be updated.

Some CV tests were using ShouldResembleProto on go structs
with datastore keys and protos inside them, the old
ShouldResembleProto was performing no meaningful comparison in this
case due to a bug. Rather than delete this test, datastore key
equality was updated slightly to allow the test to pass.

BUG=None
TEST=SPANNER_EMULATOR=1 INTEGRATION_TESTS=1 go test
go.chromium.org/luci/...

Change-Id: I9424e58e0b1f693e9bebb3774996466bfce25f73
Reviewed-on: https://chromium-review.googlesource.com/c/infra/luci/luci-go/+/4749987
Reviewed-by: Robbie Iannucci <iannucci@chromium.org>
Commit-Queue: Patrick Meiring <meiring@google.com>
Reviewed-by: Tuan Nguyen <nqmtuan@google.com>