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

Fix dead links to files in readme #324

Merged
merged 1 commit into from
Dec 3, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ before rerunning the procedure above.

To test some of the output of the powerful trident CLI functions, poseidon-hs features a golden test mechanism:

The output of a number of CLI function calls implemented in [`test/Poseidon/GoldenTestsRunCommands.hs`](test/Poseidon/GoldenTestsRunCommands.hs) is stored in a static file storage ([`test/testDat/poseidonHSGoldenTestData`](test/testDat/poseidonHSGoldenTestData)), together with relevant checksums for these files in [`test/testDat/poseidonHSGoldenTestCheckSumFile.txt`](test/testDat/poseidonHSGoldenTestCheckSumFile.txt).
The output of a number of CLI function calls implemented in [`test/PoseidonGoldenTests/GoldenTestsRunCommands.hs`](test/PoseidonGoldenTests/GoldenTestsRunCommands.hs) is stored in a static file storage ([`test/PoseidonGoldenTests/GoldenTestData`](test/PoseidonGoldenTests/GoldenTestData)), together with relevant checksums for these files in [`test/PoseidonGoldenTests/GoldenTestCheckSumFile.txt`](test/PoseidonGoldenTests/GoldenTestCheckSumFile.txt).

`stack test` then runs -- among other things -- the code in `/test/testDat/poseidonHSGoldenTestData` again and stores the result in a dynamic, temporary directory. It then validates the output by comparing the new and temporary checksums with the old and git-logged checksums in said file `poseidonHSGoldenTestCheckSumFile.txt`. Any deviation between these two sets of checksums will cause the test to fail. The test output in this case will therefore only print the name of the operation or the output file that changed, not what exactly changed within this file.

Expand Down
Loading