Releases: google/truth
v1.4.4
1.4.3
Known Issue for at least some builds targeting Java 8, fixed in 1.4.4: "unknown enum constant ElementType.MODULE": #1320. As far as we know, this is only a warning, so it should cause practical problems only if you use -Werror
or you perform reflection on @NullMarked
under a Java 8 runtime.
- Added more nullness information to our APIs (in the form of JSpecify annotations). This could lead to additional warnings (or even errors) for users of Kotlin and other nullness checkers. Please report any problems. (ee680cb)
- Deprecated
Subject.Factory
methods for Java 8 types. We won't remove them, but you can simplify your code by migrating off them: Just replaceassertAbout(foos()).that(foo)
withassertThat(foo)
(orabout(foos()).that(foo)
withthat(foo)
). (59e7a50)
1.4.2
This release is the final step of copying all our methods from Truth8
to Truth
. If you have not already migrated your usages from Truth8
to Truth
, you may see build errors:
OptionalSubjectTest.java:39: error: reference to assertThat is ambiguous
assertThat(Optional.of("foo")).isPresent();
^
both method assertThat(@org.checkerframework.checker.nullness.qual.Nullable Optional<?>) in Truth8 and method assertThat(@org.checkerframework.checker.nullness.qual.Nullable Optional<?>) in Truth match
In most cases, you can migrate your whole project mechanically: git grep -l Truth8 | xargs perl -pi -e 's/\bTruth8\b/Truth/g;'
. (You can make that change before upgrading to Truth 1.4.2 or as part of the same commit.)
If you instead need to migrate your project incrementally (for example, because it is very large), you may want to upgrade your version of Truth incrementally, too, following our instructions for 1.3.0 and 1.4.0.
For help
Please feel welcome to open an issue to report problems or request help.
Changelog
- Removed temporary type parameters from
Truth.assertThat(Stream)
andTruth.assertThat(Optional)
. This can create build errors, which you can fix by replacing all your references toTruth8
with references toTruth
. (45782bd)
1.4.1
This release deprecates Truth8
.
All its methods have become available on the main Truth
class. In most cases, you can migrate your whole project mechanically: git grep -l Truth8 | xargs perl -pi -e 's/\bTruth8\b/Truth/g;'
While we do not plan to delete Truth8
, we recommend migrating off it, at least if you static import assertThat
: If you do not migrate, such static imports will become ambiguous in Truth 1.4.2, breaking your build.
1.4.0
In this release, our assertions on Java 8 types continue to move from the Truth8
class to the main Truth
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
Foo.java:152: error: reference to assertThat is ambiguous
assertThat(repo.findFileWithName("foo")).isNull();
^
both method assertThat(@org.checkerframework.checker.nullness.qual.Nullable Path) in Truth8 and method assertThat(@org.checkerframework.checker.nullness.qual.Nullable Path) in Truth match
Simplest upgrade strategy (if you can update all your code atomically in the same commit as the Truth upgrade)
In the same commit:
- Upgrade Truth to 1.4.0.
- Replace
import static com.google.common.truth.Truth8.assertThat;
withimport static com.google.common.truth.Truth.assertThat;
.- If you use Kotlin, replace
import com.google.common.truth.Truth8.assertThat
withimport com.google.common.truth.Truth.assertThat
.
- If you use Kotlin, replace
- Replace
import com.google.common.truth.Truth8;
withimport com.google.common.truth.Truth;
.- again, similarly for Kotlin if needed
- Optionally replace remaining references to
Truth8
with references toTruth
.- For example, replace
Truth8.assertThat(optional).isPresent()
withTruth.assertThat(optional).isPresent()
.
- For example, replace
If you're feeling lucky, you can try this one-liner for the code updates:
git grep -l Truth8 | xargs perl -pi -e 's/import static com.google.common.truth.Truth8.assertThat;/import static com.google.common.truth.Truth.assertThat;/g; s/import com.google.common.truth.Truth8.assertThat/import com.google.common.truth.Truth.assertThat/g; s/import com.google.common.truth.Truth8/import com.google.common.truth.Truth/g; s/\bTruth8[.]/Truth./g;'
In most cases, that can be further simplified to:
git grep -l Truth8 | xargs perl -pi -e 's/\bTruth8\b/Truth/g;'
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 some Truth.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:
- Make the optional changes discussed in the release notes for 1.3.0.
- For any remaining calls to
Truth8.assertThat
, change them to avoid static import.- That is, replace
assertThat(optional).isPresent()
withTruth8.assertThat(optional).isPresent()
.
- That is, replace
- Upgrade Truth to 1.4.0.
- Optionally replace references to
Truth8
with references toTruth
(including restoring static imports if desired), as discussed in section about the simple upgrade strategy above.
Optional additional changes
- If you use
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.- This is similar to a previous optional change from 1.3.0, except that 1.3.0 solved this problem for
streams
andoptionals
, whereas 1.4.0 solves it for the otherTruth8
types.
- This is similar to a previous optional change from 1.3.0, except that 1.3.0 solved this problem for
For help
Please feel welcome to open an issue to report problems or request help.
Changelog
1.3.0
In this release, our assertions on Java 8 types begin to move from the truth-java8-extensions
artifact and the Truth8
class to the main truth
artifact and the Truth
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 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:
- By adding new overloads of
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
."- Alternatively, you may choose to wait until we make further changes to the new
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.
- Alternatively, you may choose to wait until we make further changes to the new
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:
- Made
StreamSubject
avoid collecting theStream
until necessary, and made itsisEqualTo
andisNotEqualTo
methods no longer always throw. (f8ecaec) - Added
assertThat
overloads forOptional
andStream
to the mainTruth
class. (37fd8be) - Added
that
overloads to make it possible to write type-specific assertions when usingexpect.that(optional)
andexpect.that(stream)
. (ca7e8f4) - Moved the
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.
1.2.0
- Fixed a bug that caused ProtoTruth to ignore the contents of unpacked
Any
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) - Added
isWithin().of()
support toIntegerSubject
andLongSubject
. (6464cb5, 0e99a27)
1.1.5
- Updated Truth to depend on Guava 32.0.1. The previous Guava version, 32.0.0, contained a bug under Windows, which did not affect Truth's functionality but could cause problems for people who use Guava's I/O functionality in their codebase. Affected users can already manually update their Guava dependency to 32.0.1, but if they don't depend directly on Guava, they may find it easier to upgrade to this new Truth release instead.
- Fixed
IterableOfProtosSubject
to produce a proper failure message instead of NPE when the actual value isnull
.
1.1.4
- Updated Truth to build with
-source 8 -target 8
. This means that it no longer runs under Java 7 VMs. It continues to run under Android, even old versions, for all apps that have enabled support for Java 8 language features. (db5db24) - Updated Truth to depend on Guava 32.0.0. That release contains changes related to CVEs. Neither of the CVEs relates to any methods that are used by Truth, so this version bump is just about eliminating any warnings related to the old version and helping tools like Maven to select the newest version of Guava. (f8d4dbb, 99b1df8)
- Added support for
value of: method()
toexpect.that
, matching the existing support forassertThat
. (bd8efd0) - Enhanced
IterableSubject.containsAtLeastElementsIn().inOrder()
to print an extra line that shows only the expected elements in their actual order. (9da7dd1) - Annotated Truth for nullness. (2151add)