search

nix-community / home-manager

Manage a user environment using Nix [maintainer=@rycee]
https://nix-community.github.io/home-manager/
MIT License
7.05k stars 1.82k forks source link

add golden test tooling to help update tests #5483

Open teto opened 5 months ago

teto commented 5 months ago

I was preparing a PR that updates the test and now I wonder how people update the tests because I find it tedious. Either you copy the generated result back into the folder or you edit the snapshot right into the tree. If the tests change a lot, it can become tedious.

What we do is called "snapshot testing" or "golden testing". There are some tools to help with that for instance you are presented with a diff and can choose the generated file as the new reference snapshot.

For a personal project I was quite happy with: https://github.com/ReplicaTest/REPLica More recently in the nix area, there is https://github.com/nix-community/namaka but I wonder if it fits our scenario.

stale[bot] commented 1 month ago

Thank you for your contribution! I marked this issue as stale due to inactivity. Please be considerate of people watching this issue and receiving notifications before commenting 'I have this issue too'. We welcome additional information that will help resolve this issue. Please read the relevant sections below before commenting.

If you are the original author of the issue

* If this is resolved, please consider closing it so that the maintainers know not to focus on this. * If this might still be an issue, but you are not interested in promoting its resolution, please consider closing it while encouraging others to take over and reopen an issue if they care enough. * If you know how to solve the issue, please consider submitting a Pull Request that addresses this issue.

If you are not the original author of the issue

* If you are also experiencing this issue, please add details of your situation to help with the debugging process. * If you know how to solve the issue, please consider submitting a Pull Request that addresses this issue.

Memorandum on closing issues

Don't be afraid to manually close an issue, even if it holds valuable information. Closed issues stay in the system for people to search, read, cross-reference, or even reopen – nothing is lost! Closing obsolete issues is an important way to help maintainers focus their time and effort.