Merge pull request #1120 from GitGuardian/specific-apitoken-error-message

fix: update error messages to specify "Invalid GitGuardian API key"

Author: mathieubellon

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.",

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"
 

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, [])