Set Git configuration to default during tests ~~Disable GPG signing tags during tests~~

[Durbatuluk1701]

When running the tests on a clean main branch, I ran into some issues related to lightweight git tag commands. In particular, because I have tag.gpgSign set globally, it always expects a message and breaks the tests.

For example:

dune/test/blackbox-tests/test-cases/pkg/opam-repository-download.t

Line 161 in 8692870

$ git tag 1.0

Would try to open my git.config.core.editor and break the rest of the test:

+|  Vim: Warning: Output is not to a terminal
+|  Vim: Warning: Input is not from a terminal
<pkg/mock-opam-repository/.git/TAG_EDITMSG" 5L, 81B  1                                                                               2 #
+|    3 # Write a message for tag:
+|    4 #   1.0
+|    5 # Lines starting with '#' will be ignored.
+|  ~                                                                               Vim: Error reading input, exiting...
+|  Vim: Finished.
+|   with the editor 'vim'.
+|  Please supply the message using either -m or -F option.
+|  [1]

---

Not sure if this is a problem that I should just be solving locally, but the change is relatively minimal so I thought I'd open this and at least it can be documented for those who might encounter it in the future.

[Alizter]

I think your fix is fine, but perhaps a better fix would be to disable the global config in git locally. We want the tests to act the same irregardless of a users global configuration. Something like:

export GIT_CONFIG_GLOBAL=""

might be enough.

[Leonidas-from-XIV]

Thanks for the report @Durbatuluk1701.

I agree with @Alizter's assessment; we should probably make sure that the git used in the tests acts in general as default as possible because there might be other things that the user might have configured that break the tests.

[Durbatuluk1701]

Thank you for the feedback, definitely a much better approach.

I did some extra research and it revealed the GIT_CONFIG_SYSTEM variable that I made a fix for as well (I confirmed it could cause local issues as well). Further, it appears the idiomatic suggestion is /dev/null and it will be translated by mingw to NUL for windows.

[Alizter]

FTR we don't currently run the test on Windows (mingw) but this may change in the future. It is of course the job of the maintainers in the future to consider such changes.

Thank you for the patch!

[Alizter]

@Durbatuluk1701 Just to quickly check, does this resolve the issue you were having with the test on your end, we won't be able to see it in the CI.

[Durbatuluk1701]

@Durbatuluk1701 Just to quickly check, does this resolve the issue you were having with the test on your end, we won't be able to see it in the CI.

Yes it does, thank you!