Skip to content

Add a logout method to blueapi client #1611

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
noemifrisina wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −0
Open

Add a logout method to blueapi client #1611

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
11 changes: 11 additions & 0 deletions src/blueapi/client/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -774,6 +774,17 @@ def login(self, token_path: Path | None = None):
else:
print("Server is not configured to use authentication!")

def logout(self, token_path: Path | None = None):
try:
auth: SessionManager = SessionManager.from_cache(token_path)
auth.logout()
except FileNotFoundError:
print("Logged out")
except ValueError as e:
print(f"Invalid login token: {e}")
except Exception as e:
print(f"Failed to logout from blueapi with error: {e}")


class PlanFailedError(Exception):
def __init__(self, typ: str, message: str):
Expand Down
16 changes: 16 additions & 0 deletions tests/unit_tests/client/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1000,3 +1000,19 @@ def test_client_login_no_oidc(
client.login()

mock_session_manager.assert_not_called()


@patch("blueapi.client.client.SessionManager")
def test_client_logout(mock_session_manager: Mock, client: BlueapiClient):
client.logout()

mock_session_manager.from_cache.assert_called_once()
mock_session_manager.from_cache.return_value.logout.assert_called_once()


@patch("blueapi.client.client.SessionManager")
def test_client_logout_invalid_token(mock_session_manager: Mock, client: BlueapiClient):
mock_session_manager.from_cache.side_effect = ValueError("No token")

client.logout()
mock_session_manager.from_cache.return_value.logout.assert_not_called()
Loading