Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

assertThat(boolean) is harmful - violates fluent API principles #614

Closed
clehene opened this issue Jul 25, 2019 · 6 comments
Closed

assertThat(boolean) is harmful - violates fluent API principles #614

clehene opened this issue Jul 25, 2019 · 6 comments

Comments

@clehene
Copy link

clehene commented Jul 25, 2019

This was raised before by @cpovirk #48 and IMO the suggestion that error prone would catch it is irrelevant since truth doesn't require error prone.

Truth is a fluent API so the "contract" is that grammatically correct things would work as expected: "assert that something is true" is correct, yet Truth requires a double boolean check.

This looks natural:

assertThat(e.getStatus().getCode() == Status.ALREADY_EXISTS.getCode());

It's also consistent with how Guava preconditions work, however it's wrong and will always pass.

The correct (boolean) version is not fluent

assertThat(e.getStatus().getCode() == Status.ALREADY_EXISTS.getCode()).isTrue();

// and yes, it should be

assertThat(e.getStatus().getCode()).isEqualTo(Status.ALREADY_EXISTS.getCode());

Worse it's terribly difficult to spot and that's a sign of a bad API.

@jbduncan
Copy link

@clehene I'm not a Googler or on the Truth team, but I'm unclear on what you mean by assertThat(e.getStatus().getCode()).isEqualTo(Status.ALREADY_EXISTS.getCode()); not being fluent.

Would you mind clarifying? 🤔

@jbduncan
Copy link

I agree with you that the first example is more natural, but IIUC, the reason why Truth (and AssertJ) adopt the less intuitive approach over the more natural one is because these assertion libraries have very limited access to code e.getStatus().getCode() == Status.ALREADY_EXISTS.getCode(), and thus they can't provide a more helpful message than expected: <true> but was: <false> (taken from JUnit 5's assertTrue).

Thus I think you're asking for something that's very difficult to achieve in Java, but I could be wrong about this, and I'd love to be corrected. :)

@clehene
Copy link
Author

clehene commented Jul 25, 2019

@jbduncan that is fluent, the first one (assertThat(e.getStatus().getCode() == Status.ALREADY_EXISTS.getCode()).isTrue()) is not fluent.
I was stating that normally it should be assert(something).isEqualsTo(expected) (which is fluent and works) rather than (assert(a == b)) but still ..

I should have had two code snippets there rather than a single one with a comment in it to make it clear what I wanted to say, sorry.

@jbduncan
Copy link

@clehene Oh oops, sorry, my mistake! Thanks for clarifying what you meant. 👍

@jbduncan
Copy link

...for some reason I hadn't seen the .isTrue() at the end of your first example, so sorry for missing that!

@cpovirk
Copy link
Member

cpovirk commented Jul 25, 2019

This is quite possibly the biggest footgun in the Truth API. We once batted around some crazy ideas to try to catch it at runtime, but we couldn't find anything that seemed like an improvement. At this point, we're committed to the existing API. We might want to recommend Error Prone or similar static analysis somewhere prominent.

copybara-service bot pushed a commit that referenced this issue Sep 16, 2024
Bumps the github-actions group with 1 update: [actions/setup-java](https://github.com/actions/setup-java).

Updates `actions/setup-java` from 4.2.2 to 4.3.0
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a href="https://github.com/actions/setup-java/releases">actions/setup-java's releases</a>.</em></p>
<blockquote>
<h2>v4.3.0</h2>
<p>What's Changed</p>
<ul>
<li>Add support for SapMachine JDK/JRE by <a href="https://github.com/Shegox"><code>@​Shegox</code></a> in <a href="https://redirect.github.com/actions/setup-java/issues/614">#614</a></li>
</ul>
<pre lang="yaml"><code>steps:
 - name: Checkout
   uses: actions/checkout@v4
 - name: Setup-java
   uses: actions/setup-java@v4
   with:
     distribution: ‘sapmachine’
     java-version: ’21’
</code></pre>
<p>Bug fixes :</p>
<ul>
<li>
<pre><code>Fix typos on Corretto by @johnshajiang in [#666](actions/setup-java#666)
</code></pre>
</li>
<li>
<pre><code>IBM Semeru Enhancement on arm64 by @mahabaleshwars in [#677](actions/setup-java#677)
</code></pre>
</li>
<li>
<pre><code>Resolve Basic Validation Check Failures by @aparnajyothi-y
 in [#682](actions/setup-java#682)
</code></pre>
</li>
</ul>
<p>New Contributors :</p>
<ul>
<li>
<pre><code>@johnshajiang made their first contribution in [#666](actions/setup-java#666)
</code></pre>
</li>
<li>
<pre><code>@Shegox made their first contribution in [#614](actions/setup-java#614)
</code></pre>
</li>
</ul>
<p><strong>Full Changelog</strong>: <a href="https://github.com/actions/setup-java/compare/v4...v4.3.0">https://github.com/actions/setup-java/compare/v4...v4.3.0</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/actions/setup-java/commit/2dfa2011c5b2a0f1489bf9e433881c92c1631f88"><code>2dfa201</code></a> basic validation failure fix (<a href="https://redirect.github.com/actions/setup-java/issues/682">#682</a>)</li>
<li><a href="https://github.com/actions/setup-java/commit/7467385c615a13cecd14d5768e738332968d0792"><code>7467385</code></a> feat: add support for SapMachine JDK/JRE (<a href="https://redirect.github.com/actions/setup-java/issues/614">#614</a>)</li>
<li><a href="https://github.com/actions/setup-java/commit/8e04ddff28554375a9a1096c888a2ef2c9803cd7"><code>8e04ddf</code></a> Update Error Messages and Fix Architecture Detection for IBM Semeru (<a href="https://redirect.github.com/actions/setup-java/issues/677">#677</a>)</li>
<li><a href="https://github.com/actions/setup-java/commit/67fbd726daaf08212a7b021c1c4d117f94a81dd3"><code>67fbd72</code></a> Fix typos on Corretto (<a href="https://redirect.github.com/actions/setup-java/issues/665">#665</a>) (<a href="https://redirect.github.com/actions/setup-java/issues/666">#666</a>)</li>
<li>See full diff in <a href="https://github.com/actions/setup-java/compare/6a0805fcefea3d4657a47ac4c165951e33482018...2dfa2011c5b2a0f1489bf9e433881c92c1631f88">compare view</a></li>
</ul>
</details>
<br />

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/setup-java&package-manager=github_actions&previous-version=4.2.2&new-version=4.3.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore <dependency name> major version` will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
- `@dependabot ignore <dependency name> minor version` will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
- `@dependabot ignore <dependency name>` will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
- `@dependabot unignore <dependency name>` will remove all of the ignore conditions of the specified dependency
- `@dependabot unignore <dependency name> <ignore condition>` will remove the ignore condition of the specified dependency and ignore conditions

</details>

Fixes #1334

COPYBARA_INTEGRATE_REVIEW=#1334 from google:dependabot/github_actions/github-actions-bc3bba8501 d5bda3e
PiperOrigin-RevId: 675184114
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants