Allow code_style.py to work from a git hook
#9233
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When running a git hook, git sets certain environment variables (such as GIT_INDEX_FILE) which force git to look at the main repository, overriding other options. This trips up code_style.py whenever it tries to run a git command on the framework submodule. Fix this by explicitly clearing git-related environment-variables before running git commands on the framework. This is recommended by git's documentation[1]: > Environment variables, such as GIT_DIR, GIT_WORK_TREE, etc., are > exported so that Git commands run by the hook can correctly locate > the repository. If your hook needs to invoke Git commands in a > foreign repository or in a different working tree of the same > repository, then it should clear these environment variables so > they do not interfere with Git operations at the foreign location. [1] https://git-scm.com/docs/githooks Signed-off-by: David Horstmann <[email protected]>
davidhorstmann-arm
added
needs-review
gilles-peskine-arm
requested changes
Jun 6, 2024
scripts/code_style.py
Outdated
Comment on lines
88
to
90
| git_env_vars = git_env_vars.split() | ||
| # Remove the vars from the environment | ||
| for var in git_env_vars: |
There was a problem hiding this comment.
Changing the type of a variable mid-function is confusing both to readers and to mypy.
Suggested change
| git_env_vars = git_env_vars.split() | |
| # Remove the vars from the environment | |
| for var in git_env_vars: | |
| # Remove the vars from the environment | |
| for var in git_env_vars.split(): |
gilles-peskine-arm
added
needs-work
needs-backports
|
No need for a changelog entry. This only affects contributors, not users. |
Signed-off-by: David Horstmann <[email protected]>
4 tasks
davidhorstmann-arm
changed the title
code_style.py to work from a git hook
davidhorstmann-arm
removed
the
needs-backports
| # (i.e. prevent us from performing commands on the framework repo). | ||
| # Create an environment without these variables for running commands on the | ||
| # framework repo. | ||
| framework_env = os.environ.copy() |
There was a problem hiding this comment.
Just a comment that we may want to do that in check_files.py as well. Not necessarily in this PR though.
| # Remove the vars from the environment | ||
| for var in git_env_vars.split(): | ||
| framework_env.pop(var, None) | ||
|
|
||
| output = subprocess.check_output(["git", "-C", "framework", "ls-files"] |
There was a problem hiding this comment.
I think the solution here is actually on the wrong track, although it's an improvement so I won't block it. When this script is called with --since, it looks for the given revision name in the submodule. Reported as Mbed-TLS/mbedtls-framework#24. I suspect the right solution would be to never call git -C framework and instead rely on --recurse-submodules throughout.
There was a problem hiding this comment.
Using --recurse-submodules comes with some issues as well: see 7661aa0 commit message.
valeriosetti
approved these changes
Jun 7, 2024
davidhorstmann-arm
added
approved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When running a git hook, git sets certain environment variables (such as
GIT_INDEX_FILE) which force git to look at the main repository, overriding other options. This trips up code_style.py whenever it tries to run a git command on the framework submodule.Fix this by explicitly clearing git-related environment-variables before running git commands on the framework. This is recommended by git's documentation:
PR checklist
Please tick as appropriate and edit the reasons (e.g.: "backport: not needed because this is a new feature")
code_style.pyto work from a git hook #9234