Approval is an open source assertion/verification library to aid unit testing. FastApproval makes it even more fun.
This fork of @nicolavp/approval aims at maintaining the library for future releases of Java.
To include FastApproval in your project, follow the JitPack button above.
There are many sources from which you can learn about approval testing(just google it) but basically the process is the following:
- you already have a working implementation of the thing you want to test
- you run it and get the result the first time
- the result will be shown to you in your preferred tool(this can be configured)
- you either approve the result in which case it is recored(saved) and the test pass or you disapprove it in which case the test fails
- the recorded result is then used on further test runs to make sure that there are no regressions in your code(i.e. you broke something and the result is not the same).
- Of course sometimes you want to change the way something behaves so if the result is not the same we will prompt you with difference between the new result and the last recorded again in your preferred tool.
Want to learn more? See our latest documentation.
The current project is using ideas from ApprovalTests but should provide a more up to date java feel to it.
There are currently no dependencies for the project.
FastApproval is built with Maven and GitHub Actions. In order to release a new version, mvn release:prepare release:clean is enough (no deployment, as binaries are created on-the-fly with JitPack).
You can just file an issue, write a bug report or create a pull request with a patch :)
Documentation is never enough. Wanna write some of it and see how it looks? It is super easy - just install sphinx-autobuild and run:
sphinx-autobuild -b html doc/source doc/build/html
from the root directory of the project