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

Bump com.approvaltests:approvaltests from 18.7.1 to 22.0.0 #25

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Oct 13, 2023

Bumps com.approvaltests:approvaltests from 18.7.1 to 22.0.0.

Release notes

Sourced from com.approvaltests:approvaltests's releases.

Remove deprecated api

Minor breaking changes

Issue #376 made javax.mail optional Removed deprecated api in JupiterApprovals Moved TestUtils.displayEmail to EmailOpener.displayEmail

Easy reordering of JSON for consistent approvals

The Problem:

JSON does not define an order to the fields.
This can make approving JSON inconsistent as ApprovalTests requires consistent results.

The Solution:

JsonApprovals.verifyJson(json) now has an overload:
JsonApprovals.verifyJson(json, reorderJson: true)
which will alphabetically sort the JSON in the result. By default it still does not reorder the JSON.

Extras

You can call the reordering directly with
JsonUtils.reorderFields(json)
This fixes #422

Improvements for IntelliJ reporters when using Jetbrains Toolbox

On Mac, when using Jetbrains Toolbox, we now should detect your IntelliJ installation and launch the idea diff viewer.

Fixes to KDiff3

Added KDiff3 Linux reporter. Minor breaking changes KDiff3Reporter has been moved to KDiff3MacReporter, KDiff3WindowsReporter as appropriate. We also created a generic KDiff3 reporter that will work on all three systems. Closes issue #412

Removal of EnvironmentAwareReporter

This is a breaking change.

When you call Reporter.report(received, approved) it now returns if it was successful. This makes the java architecture more consistent with other implementations and allows us to determine when something should have worked but it didn't.

It should not affect you unless you've written a custom implementation of ApprovalFailureReporter.

Information on why and how to upgrade can be found here.

Exceptions and Help messages on duplicate verify() calls.

ApprovalTests only wants one call to verify() per test. There are ways to go around this but if you call verify where it would want the exact same file name twice, it will now throw an exception. This will make it easier for people to not be confused as most other testing frameworks allow you to put multiple assertions in the same test.

Backwards compatibility

There are some situations where you want to check that two different processes produce the same result.

... (truncated)

Commits
  • 0cb7624 . e Add javax.mail to approvaltests-tests
  • 59f9eab a reformat code
  • 14cc240 . t Corrected test that was using deprecated api
  • 9286f5c ! F Separating Email opener and removing deprecated function
  • fc5d790 d updated markdown snippets
  • 265a484 ! F Added reorder field option to JsonApprovals.verifyJson
  • 3636eba ! F JsonUtils.reorderFields
  • c61f422 a reformat code
  • 37e24b7 F - Extend list of known text file extensions
  • 813522a v 21.1.0
  • Additional commits viewable in compare view

Dependabot compatibility score

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 commands and options

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 this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [com.approvaltests:approvaltests](https://github.com/approvals/ApprovalTests.Java) from 18.7.1 to 22.0.0.
- [Release notes](https://github.com/approvals/ApprovalTests.Java/releases)
- [Commits](approvals/ApprovalTests.Java@18.7.1...22.0.0)

---
updated-dependencies:
- dependency-name: com.approvaltests:approvaltests
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file java Pull requests that update Java code labels Oct 13, 2023
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Oct 17, 2023

Superseded by #26.

@dependabot dependabot bot closed this Oct 17, 2023
@dependabot dependabot bot deleted the dependabot/maven/com.approvaltests-approvaltests-22.0.0 branch October 17, 2023 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file java Pull requests that update Java code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants