Fix get_versioned_files() failing when GIT_INDEX_FILE is set #123
Conversation
Instead of running `git ls-files` in each git submodule, run
$ git ls-file --recurse-submodules
from the git root directory and list all files under version control
in one go.
This fixes a bug when check-manifest would fail with
['git', 'ls-files', '-z'] failed (status 128):
fatal: .git/index: index file open failed: Not a directory
when run from a pre-commit hook. When running from a pre-commit hook,
git sets `GIT_INDEX_FILE=.git/index`, which should be interpreted
relative to the git root directory. When changing directories into a
submodule directory (say `./submodule/`) and running `git ls-files`
there, git expects to find a git index file at `./submodule/.git/index`,
which fails since `./submodule/.git` is a regular file in a submodule.
The easy solution is to just pass `--recurse-submodules` when listing
files under version control and remove all logic listing submodules
files one-by-one.
A test is added that sets `GIT_INDEX_FILE=.git/index` and checks that
tests dealing with submodules still pass. This simulates the "running
from git-hook" setting
|
(BTW thank you very much for the very comprehensive bug analysis and the PR fixing it while simultaneously simplifying the code!) |
This is not needed anymore since b8f814f.
|
You're welcome :) I had been scratching my head why I'll push an addition to the changelog later; if you are happy with the changes I could squash and rebase then. |
|
Well, this is weird: https://travis-ci.org/github/mgedmin/check-manifest/jobs/728972962 I'd be interested to know how I was able to trigger that without changing any code. Has to be the worst timing ever. |
|
I've retried the pypy job and it passed! |
|
BTW I released check-manifest 0.43 with this fix yesterday. |
This reverts commit cc7c176. Fixes #153: a `.gitmodules` might exist in a subdirectory, so it's not sufficient to check for it at the project root. Also, Git versions that don't support --recurse-submodules are even further in the past now, so I'm hoping it's fine to ignore them. Note that this removes a fix for #123.
Instead of running
git ls-filesin each git submodule, runfrom the git root directory and list all files under version control in one go.
This fixes a bug when check-manifest would fail with
when run from a pre-commit hook. When running from a pre-commit hook, git sets
GIT_INDEX_FILE=.git/index, which should be interpreted relative to the git root directory. When changing directories into a submodule directory (say./submodule/) and runninggit ls-filesthere, git expects to find a git index file at./submodule/.git/index, which fails since./submodule/.gitis a regular file in a submodule.The easy solution is to just pass
--recurse-submoduleswhen listing files under version control and remove all logic listing submodules files one-by-one.A test is added that sets
GIT_INDEX_FILE=.git/indexand checks that tests dealing with submodules still pass. This simulates the "running from git-hook" settingFixes #122.