From 3e399fc753cc4fcc3f2176bed1745a61ad38d1a4 Mon Sep 17 00:00:00 2001 From: Mathieu Bellon Date: Wed, 13 Aug 2025 17:43:43 +0200 Subject: [PATCH] fix: update error messages to specify 'Invalid GitGuardian API key' --- ggshield/core/client.py | 2 +- tests/unit/cmd/auth/test_login.py | 4 +++- tests/unit/verticals/secret/test_secret_scanner.py | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/ggshield/core/client.py b/ggshield/core/client.py index e9931864fe..e884e8ed85 100644 --- a/ggshield/core/client.py +++ b/ggshield/core/client.py @@ -108,7 +108,7 @@ def check_client_api_key(client: GGClient, required_scopes: set[TokenScope]) -> # None means success pass elif response.status_code == 401: - raise APIKeyCheckError(client.base_uri, "Invalid API key.") + raise APIKeyCheckError(client.base_uri, "Invalid GitGuardian API key.") elif response.status_code == 404: raise UnexpectedError( "The server returned a 404 error. Check your instance URL settings.", diff --git a/tests/unit/cmd/auth/test_login.py b/tests/unit/cmd/auth/test_login.py index 53851aeb14..1fbb38a8ff 100644 --- a/tests/unit/cmd/auth/test_login.py +++ b/tests/unit/cmd/auth/test_login.py @@ -54,7 +54,9 @@ } ) -INVALID_TOKEN_RESPONSE = create_json_response({"detail": "Invalid API key."}, 401) +INVALID_TOKEN_RESPONSE = create_json_response( + {"detail": "Invalid GitGuardian API key."}, 401 +) METADATA_ENDPOINT = "/v1/metadata" diff --git a/tests/unit/verticals/secret/test_secret_scanner.py b/tests/unit/verticals/secret/test_secret_scanner.py index a676d7aca0..b6efd352e7 100644 --- a/tests/unit/verticals/secret/test_secret_scanner.py +++ b/tests/unit/verticals/secret/test_secret_scanner.py @@ -170,7 +170,7 @@ def test_scanner_skips_unscannable_files(client, fs, cache, unscannable_type: st def test_handle_scan_error_api_key(): - detail = Detail("Invalid API key.") + detail = Detail("Invalid GitGuardian API key.") detail.status_code = 401 with pytest.raises(click.UsageError): handle_scan_chunk_error(detail, [])