Pytest tests cannot load global config that definitely exists even though real use of the library can
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- git, python
- Ambito
- testing-qa
Direzione di ricerca
Inizia con test/test_config.py e i percorsi Config.get_global_config e Config.get_system_config mostrati in pygit2/config.py. Riproduci i test ignorati con pytest e confronta la visibilità dei relativi file di configurazione e i messaggi di errore con gli esempi interattivi in Python. Il lavoro è concluso quando i test non riportano più silenziosamente in modo errato file di configurazione esistenti, oppure documentano e segnalano chiaramente la limitazione dell’ambiente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
While working on and writing tests for #1466, I discovered that Config.get_global_config raised an IOError in my test. Confused as to why that didn't break other tests, I searched for use of this in the tests and found this:
def test_global_config() -> None:
try:
assert Config.get_global_config() is not None
except IOError:
# There is no user config
pass
def test_system_config() -> None:
try:
assert Config.get_system_config() is not None
except IOError:
# There is no system config
pass
I changed these tests to this so that these situations result in an official "skip" with information about why it was skipped, instead of just silently fake-passing:
def test_global_config() -> None:
try:
assert Config.get_global_config() is not None
except IOError as e:
settings = Settings()
pytest.skip(f'Unavailable for testing with home dir = {settings.homedir}: {e}')
def test_system_config() -> None:
try:
assert Config.get_system_config() is not None
except IOError as e:
pytest.skip(f'Unavailable for testing: {e}')
But the resulting pytest output puzzled me:
test/test_config.py::test_global_config SKIPPED (Unavailable for testing with home dir = /Users/nicholas: the global file '.gitconfig' doesn't exist:)
test/test_config.py::test_system_config SKIPPED (Unavailable for testing: the system file 'gitconfig' doesn't exist:)
The first reason it puzzled me is that /Users/nicholas/.gitconfig definitely exists:
$ ls -al /Users/nicholas/.gitconfig
-rw-r--r-- 1 nicholas staff 366 Apr 9 17:39 /Users/nicholas/.gitconfig
The second reason it puzzled me is that I don't encounter this error if I simply use the library in a Python shell prompt:
>>> c = pygit2.Config.get_global_config()
>>> c["push.gpgSign"]
'if-asked'
Now, it's correct that my system config file does not exist:
>>> pygit2.Config.get_system_config()
Traceback (most recent call last):
File "<python-input-8>", line 1, in <module>
pygit2.Config.get_system_config()
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^
File "/Users/nicholas/Development/OSS/libgit2/pygit2/.venv/lib/python3.14/site-packages/pygit2/config.py", line 309, in get_system_config
check_error(err)
~~~~^^^^^
File "/Users/nicholas/Development/OSS/libgit2/pygit2/.venv/lib/python3.14/site-packages/pygit2/config.py", line 300, in _from_found_config
File "/Users/nicholas/Development/OSS/libgit2/pygit2/.venv/lib/python3.14/site-packages/pygit2/errors.py", line 56, in check_error
raise IOError(message)
OSError: the system file 'gitconfig' doesn't exist: No such file or directory
But note that that error message is slightly different from the skip message of the test: "No such file or directory" is missing in the skip message. Weird?
If I now manually create /etc/gitconfig:
>>> c = pygit2.Config.get_system_config()
>>> c["bogus.foo"]
'bar'
But, low and behold, that test, also, still skips with the same partial message about not finding the system config file.
So, these two functions do work ... just not in tests. I've been unable to figure out why. My best guess is that mypy is somehow sandboxed so that it can't read these files? But that's just a wild guess. I can't confirm it.
- Lingua principale
- Python
- Stelle
- 1.7k
- Fork
- 408
- Merge medio
- 2g 57m
- PR unite (30g)
- 7
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di libgit2/pygit2
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 45/100
-
merge_bases not wrapped Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100
Tutte le issue di libgit2/pygit2
Issue simili
-
documentation help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 90/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 90/100
simonw/sqlite-utils#872 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100