chore(deps): Update truth to v1.4.0 #96
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
1.1.5
->1.4.0
1.1.5
->1.4.0
Release Notes
google/truth (com.google.truth.extensions:truth-java8-extension)
v1.4.0
: 1.4.0In this release, our assertions on Java 8 types continue to move from the
Truth8
class to the mainTruth
class. This change should not break compatibility for any supported JDK or Android version, even users who test under old versions of Android without API desugaring. Additionally, we will never break binary compatibility, though some users will have to make changes to their source code in order for it to compile against newer versions.This release is likely to lead to more build failures than 1.3.0 did. However, those failures should be straightforward to fix.
Example build failure
Simplest upgrade strategy (if you can update all your code atomically in the same commit as the Truth upgrade)
In the same commit:
import static com.google.common.truth.Truth8.assertThat;
withimport static com.google.common.truth.Truth.assertThat;
.import com.google.common.truth.Truth8.assertThat
withimport com.google.common.truth.Truth.assertThat
.import com.google.common.truth.Truth8;
withimport com.google.common.truth.Truth;
.Truth8
with references toTruth
.Truth8.assertThat(optional).isPresent()
withTruth.assertThat(optional).isPresent()
.If you're feeling lucky, you can try this one-liner for the code updates:
After that process, it is possible that you'll still see build errors from ambiguous usages of
assertThat
static imports. If so, you can find a workaround in the section about overload ambiguity in the release notes for 1.3.0. Alternatively, you can wait to upgrade until after a future Truth release, which will eliminate the ambiguity by changing the signatures of someTruth.assertThat
overloads.Incremental upgrade strategy
If you have a very large repo or you have other reasons to prefer to upgrade incrementally, you can use the approach that we used inside Google. Roughly, that approach was:
Truth8.assertThat
, change them to avoid static import.assertThat(optional).isPresent()
withTruth8.assertThat(optional).isPresent()
.Truth8
with references toTruth
(including restoring static imports if desired), as discussed in section about the simple upgrade strategy above.Optional additional changes
assertWithMessage(...).about(intStreams()).that(...)
,expect.about(optionalLongs()).that(...)
, or similar, you can remove your call toabout
. This change will never be necessary; it is just a simplification.streams
andoptionals
, whereas 1.4.0 solves it for the otherTruth8
types.For help
Please feel welcome to open an issue to report problems or request help.
Changelog
Truth8.assertThat
overloads to the mainTruth
class. (9be8e77
,1f81827
)that
overloads to make it possible to write type-specific assertions when using the remaining Java 8 types. (7c65fc6
)v1.3.0
: 1.3.0In this release, our assertions on Java 8 types begin to move from the
truth-java8-extensions
artifact and theTruth8
class to the maintruth
artifact and theTruth
class. This change should not break compatibility for anyone, even users who test under old versions of Android without API desugaring. Additionally, we will never break binary compatibility, though some users will have to make changes to their source code in order for it to compile against newer versions.This change will be routine for most users, but we're providing as much information as we can for any users who do encounter problems.
We will post fuller instructions for migration later on, once we've learned more from our internal migration efforts. For now, you may find that you need to make one kind of change, and you may elect to make others. (If we missed anything, please open an issue to report problems or request help.)
The change you might need to make:
Truth.assertThat
, we cause some code to fail to compile because of an overload ambiguity. This is rare, but it can happen if you static import bothTruth.assertThat
and some otherassertThat
method that includes overloads forOptional
orStream
. (It does not happen forTruth8.assertThat
, though, except with the Eclipse compiler. Nor it does necessarily happen for otherassertThat(Stream)
andassertThat(Optional)
methods.) If this happens to you, you'll need to remove one of the static imports, changing the corresponding call sites from "assertThat
" to "FooSubject.assertThat
."Truth.assertThat
overloads. Once we make those further changes, you may be able to simultaneously replace all your imports ofTruth8.assertThat
with imports ofTruth.assertThat
as you upgrade to the new version, likely without introducing overload ambiguities.The changes you might elect to make:
If you use
Truth8.assertThat(Stream)
orTruth8.assertThat(Optional)
, you can migrate to the new overloads inTruth
. If you static importTruth8.assertThat
, you can usually make this change simply by replacing that static import with a static import ofTruth.assertThat
—or, if you already have an import ofTruth.assertThat
, by just removing the import ofTruth8.assertThat
. (If you additionally use less common assertion methods, likeassertThat(OptionalInt)
, you'll want to use both imports for now. Later, we'll moveassertThat(OptionalInt)
and friends, too.) We recommend making this change now, since your calls toTruth8.assertThat
will fail to compile against some future version of Truth, unless you plan to wait to update your Truth dependency until we've made all our changes for Java 8 types.If you use
assertWithMessage(...).about(streams()).that(...)
,expect.about(optionals()).that(...)
, or similar, you can remove your call toabout
. This change will never be necessary; it is just a simplification.If you depend on
truth-java8-extension
, you may remove it. All its classes are now part of the maintruth
artifact. This change, too, is not necessary; it is just a simplification. (OK, if your build system has a concept of strict deps, there is a chance that you'll need to add deps ontruth
to replace your deps ontruth-java8-extension
.)Finally, the changelog for this release:
StreamSubject
avoid collecting theStream
until necessary, and made itsisEqualTo
andisNotEqualTo
methods no longer always throw. (f8ecaec
)assertThat
overloads forOptional
andStream
to the mainTruth
class. (37fd8be
)that
overloads to make it possible to write type-specific assertions when usingexpect.that(optional)
andexpect.that(stream)
. (ca7e8f4
)truth-java8-extension
classes into the maintruth
artifact. There is no longer any need to depend ontruth-java8-extension
, which is now empty. (We've also removed theTruth8
GWT module.) (eb0426e
)Again, if you have any problems, please let us know.
v1.2.0
: 1.2.0Any
messages. This fix may cause tests to fail, since ProtoTruth will now check whether the message contents match. If so, you may need to change the values that your tests expect, or there may be a bug in the code under test that had been hidden by the Truth bug. Sorry for the trouble. (8bd3ef6
)isWithin().of()
support toIntegerSubject
andLongSubject
. (6464cb5
,0e99a27
)Configuration
📅 Schedule: Branch creation - "after 5pm on the 2nd day of the month" (UTC), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about these updates again.
This PR has been generated by Mend Renovate. View repository job log here.