googleapis / googleapis/google-cloud-python

google-auth: Local developer mTLS environment leaks into unit tests, causing mock failures

Ouverte Adaptée aux débutants
#17,283 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
type: bug
Langage dominant
Python
Étoiles
5.4k
Forks
1.8k
Merge moyen
2 j 23 h
PR mergées (30 j)
123

Description

### Determine this is the right repository

- [x] I determined this is the correct repository in which to report this bug.

### Summary of the issue

When running unit tests locally on developer machines that have context-aware access or enterprise mTLS configured (such as Google-managed corporate MacBooks), several tests fail unexpectedly.

This happens because the test suite's global configuration (`tests/conftest.py`) does not sanitize the environment. Global environment variables (like `GOOGLE_API_CERTIFICATE_CONFIG` or `GOOGLE_API_USE_CLIENT_CERTIFICATE`) and default configuration files (like `~/.config/gcloud/certificate_config.json`) leak directly into the `pytest` session.

Any test that does not explicitly mock `_mtls_helper.check_use_client_cert()` or clear these environment variables will transition to using mTLS hostnames (e.g. expecting `iamcredentials.googleapis.com` but getting `iamcredentials.mtls.googleapis.com`). Since the mock networks in the tests are configured with standard endpoints, the requests fail to match the mock setups, causing transport exceptions and test failures.

### Proposed fix
Introduce a function-scoped, autouse fixture in `tests/conftest.py` to establish a clean, hermetic environment for every unit test. Using pytest's standard `monkeypatch` fixture ensures all local environmental variables and mocks are automatically cleaned up and restored back to the developer's original workstation state after each test executes. This can be accomplished by something like:

```python
# tests/conftest.py
@pytest.fixture(autouse=True)
def clean_mtls_environment(monkeypatch):
from google.auth.transport import _mtls_helper

# Pop all mTLS-related environment variables
for var in [
"GOOGLE_API_USE_CLIENT_CERTIFICATE",
"GOOGLE_API_CERTIFICATE_CONFIG",
"CLOUDSDK_CONTEXT_AWARE_USE_CLIENT_CERTIFICATE",
"CLOUDSDK_CONTEXT_AWARE_CERTIFICATE_CONFIG_FILE_PATH",
]:
monkeypatch.delenv(var, raising=False)

# Mock check_use_client_cert to return False by default
monkeypatch.setattr(_mtls_helper, "check_use_client_cert", lambda: False)
```

This way tests specifically designed to verify mTLS behaviors can easily override the global mock locally by re-patching the method in their own bodies (which runs after the global autouse setup):
```python
def test_mtls_behavior(monkeypatch):
from google.auth.transport import _mtls_helper
monkeypatch.setattr(_mtls_helper, "check_use_client_cert", lambda: True)
# Test runs with mTLS enabled cleanly
```

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez dans tests/conftest.py et examinez les fixtures pytest existantes ainsi que les tests liés à mTLS. Exécutez la suite de tests unitaires avec des variables d’environnement mTLS locales ou une configuration de certificats présente, puis vérifiez que les tests ordinaires utilisent des endpoints standard tandis que les tests qui activent explicitement mTLS continuent de réussir. C’est terminé lorsque l’environnement est isolé pour chaque test et restauré ensuite.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
testing-qa
Type d'issue
Bug
Difficulté
2/5
Temps estimé
1-3 heures
Activité
Calme
Clarté
Clairement spécifiée
Accessibilité débutants
76/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.