Fixes #5773: guard against user's ~/.gitconfig setting init.templateDir
#5774
Conversation
If the user has a ~/.gitconfig file where init.templateDir is set, then some of the tests in bash_scripts_test.py may fail because the settings may cause the commands in the script to produce output that doesn't match expectations. The changes here pass an explicit argument to `git init` commands to override anything the user may have set in their ~/.gitconfig file.
mhucka
changed the title
~/.gitconfig setting init.templateDir~/.gitconfig setting init.templateDir
dev_tools/bash_scripts_test.py
Outdated
| mkdir empty-templates | ||
| git init --template=empty-templates --quiet --initial-branch master |
There was a problem hiding this comment.
Can you try if inserting
export GIT_CONFIG_GLOBAL=/dev/null
export GIT_CONFIG_SYSTEM=/dev/null
at the start of the cmd would fix the issue as well?
This should make git run with its defaults, regardless of system and user configuration files.
There was a problem hiding this comment.
Tested this, and you're right, it works too. This is a better solution because it will prevent other possible user settings from interfering, not just the one for template dir. I'll edit the PR.
This solves the problem in a different way, using the solution suggested by @pavoljuhas in comments on the PR. The new approach uses environment variables GIT_CONFIG_SYSTEM and GIT_CONFIG_GLOBAL to override per-user configuration in ~/.gitconfig. This is a better solution because it makes git completely ignore the user's configuration, rather than only addressing the single template dir problem of my original solution.
dev_tools/bash_scripts_test.py
Outdated
| 'export GIT_CONFIG_GLOBAL=/dev/null\n' | ||
| 'export GIT_CONFIG_SYSTEM=/dev/null\n' |
There was a problem hiding this comment.
This can be removed, because the setup argument for the run() function above
is inserted after the exports on lines 60-61.
There was a problem hiding this comment.
Ah, foo. I didn't notice how run was being used. Serves me right for trying to do things too quickly. Thanks for noticing and explaining that.
Turns out doing the settings of GIT_CONFIG_GLOBAL and GIT_CONFIG_SYSTEM around line 322-323 is unnecessary because the function `run()` is being applied here too, and we've already added the settings on online 60-61.
|
One of the CI checks failed, but as far as I can tell, it's due to some timeout. Unfortunately, I don't seem to have the privileges to re-run the test (presumably due to team membership/github permissions—which is understandable and I'm not asking for a change there) so can't cause it to retry. |
|
I just updated the branch which should rerun the CI checks again. |
pavoljuhas
added
the
automerge
CirqBot
added
the
front_of_queue_automerge
CirqBot
removed
automerge
…nit.templateDir` (quantumlib#5774) This is a fix for issue quantumlib#5773. The approach involves passing an explicit `--template` parameter to the `git init` commands in `dev_tools/bash_scripts_test.py`. This will override any settings that the user happens to have for `init.templateDir` in their `~/.gitconfig` file.
This is a fix for issue #5773. The approach involves passing an explicit
--templateparameter to thegit initcommands indev_tools/bash_scripts_test.py. This will override any settings that the user happens to have forinit.templateDirin their~/.gitconfigfile.