Skip to content

Surface keyring failures instead of silently dropping the token #71195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rjgoyln wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −2
Open

Surface keyring failures instead of silently dropping the token #71195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions airflow-ctl/src/airflowctl/api/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,9 +244,10 @@ def save(self, skip_keyring: bool = False):
"Use `airflowctl auth login --skip-keyring ...` to dismiss this error."
) from e
except TypeError as e:
# This happens when the token is None, which is not allowed by keyring
if self.api_token is None and self.client_kind == ClientKind.CLI:
# keyring rejects a None password; any other TypeError is a real backend failure
if self.api_token is None:
raise AirflowCtlCredentialNotFoundException("No API token found. Please login first.") from e
raise

def load(self) -> Credentials:
"""Load the credentials from keyring and URL from disk file."""
Expand Down
19 changes: 19 additions & 0 deletions airflow-ctl/tests/airflow_ctl/api/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,25 @@ def test_save_no_keyring(self, mock_keyring):
with pytest.raises(AirflowCtlKeyringException, match="Keyring backend is not available"):
Credentials(client_kind=cli_client).save()

@pytest.mark.parametrize("client_kind", [ClientKind.AUTH, ClientKind.NO_AUTH, None])
@patch.dict(os.environ, {"AIRFLOW_CLI_ENVIRONMENT": "TEST_SAVE_NO_TOKEN"})
@patch("airflowctl.api.client.keyring")
def test_save_without_token_raises_for_non_cli_client_kinds(self, mock_keyring, client_kind):
mock_keyring.set_password.side_effect = TypeError("password must be a string")

with pytest.raises(AirflowCtlCredentialNotFoundException, match="No API token found"):
Credentials(api_url="http://localhost:8080", client_kind=client_kind).save()

@patch.dict(os.environ, {"AIRFLOW_CLI_ENVIRONMENT": "TEST_SAVE_TYPE_ERROR"})
@patch("airflowctl.api.client.keyring")
def test_save_reraises_type_error_unrelated_to_missing_token(self, mock_keyring):
mock_keyring.set_password.side_effect = TypeError("keyring backend blew up")

with pytest.raises(TypeError, match="keyring backend blew up"):
Credentials(
api_url="http://localhost:8080", api_token="TEST_TOKEN", client_kind=ClientKind.CLI
).save()

@patch.dict(os.environ, {"AIRFLOW_CLI_ENVIRONMENT": "TEST_SAVE_SKIP_KEYRING"})
@patch("airflowctl.api.client.keyring")
def test_save_no_keyring_backend_skip_keyring(self, mock_keyring):
Expand Down