fix: replace \r\n with \n on windows

[zepatrik]

Depending on how you setup git on windows, it might convert between line separators. For Github actions it seems to be the case that \n is replaced by \r\n, as we have a constant failure here: https://github.com/ory/x/runs/3937200972 but the content is identical when copied and compared via diff.
In contrast, a run with this fix as a replacement succeeds: https://github.com/ory/x/runs/3937395472

[bradleyjkemp]

Interesting issue! I've definitely not seen anyone else report this before.

I don't think this is particularly a bug in cupaloy nor can it safely be fixed within the library—say if someone is trying to snapshot test something which outputs \r\n characters?

What I think you're running into is this problem: actions/checkout#135
By running

git config --system core.autocrlf false
git config --system core.eol lf

before checkout, git won't re-write your snapshot files and so the tests should pass

Alternatively I think you can set only your snapshot files to remain un-modified using a .gitattributes file: https://docs.github.com/en/get-started/getting-started-with-git/configuring-git-to-handle-line-endings#per-repository-settings

Could you try and see if one of those fixes the problem?

[zepatrik]

True, that should fix it. Test run: https://github.com/ory/x/pull/412/checks?check_run_id=3952501267

[zepatrik]

I will add a section to the README in case that fixes the problem.

[zepatrik]

So yeah, setting the git config fixed it. I added a short debug help section to the readme.

[bradleyjkemp]

Amazing thanks for adding that 🙂 just one tiny comment: it looks like you linked the same GitHub Actions issue twice?

[zepatrik]

Ah, wanted to link this PR 😅 fixed it

[bradleyjkemp]

Thanks @zepatrik ❤️