|
| 1 | +import json |
| 2 | +import pprint |
| 3 | +import threading |
| 4 | +import time as ttime |
| 5 | + |
| 6 | +import pytest |
| 7 | +from bluesky_queueserver.manager.tests.common import re_manager, re_manager_cmd # noqa F401 |
| 8 | +from websockets.sync.client import connect |
| 9 | + |
| 10 | +from .conftest import fastapi_server_fs # noqa: F401 |
| 11 | +from .conftest import ( |
| 12 | + SERVER_ADDRESS, |
| 13 | + SERVER_PORT, |
| 14 | + request_to_json, |
| 15 | + setup_server_with_config_file, |
| 16 | + wait_for_environment_to_be_closed, |
| 17 | + wait_for_environment_to_be_created, |
| 18 | +) |
| 19 | + |
| 20 | +config_toy_test = """ |
| 21 | +authentication: |
| 22 | + allow_anonymous_access: True |
| 23 | + providers: |
| 24 | + - provider: toy |
| 25 | + authenticator: bluesky_httpserver.authenticators:DictionaryAuthenticator |
| 26 | + args: |
| 27 | + users_to_passwords: |
| 28 | + bob: bob_password |
| 29 | + alice: alice_password |
| 30 | + cara: cara_password |
| 31 | + tom: tom_password |
| 32 | +api_access: |
| 33 | + policy: bluesky_httpserver.authorization:DictionaryAPIAccessControl |
| 34 | + args: |
| 35 | + users: |
| 36 | + bob: |
| 37 | + roles: |
| 38 | + - admin |
| 39 | + - expert |
| 40 | + alice: |
| 41 | + roles: advanced |
| 42 | + tom: |
| 43 | + roles: user |
| 44 | +""" |
| 45 | + |
| 46 | + |
| 47 | +class _ReceiveSystemInfoSocket(threading.Thread): |
| 48 | + """ |
| 49 | + Catch streaming console output by connecting to /console_output/ws socket and |
| 50 | + save messages to the buffer. |
| 51 | + """ |
| 52 | + |
| 53 | + def __init__(self, *, endpoint, api_key=None, token=None, **kwargs): |
| 54 | + super().__init__(**kwargs) |
| 55 | + self.received_data_buffer = [] |
| 56 | + self._exit = False |
| 57 | + self._api_key = api_key |
| 58 | + self._token = token |
| 59 | + self._endpoint = endpoint |
| 60 | + |
| 61 | + def run(self): |
| 62 | + websocket_uri = f"ws://{SERVER_ADDRESS}:{SERVER_PORT}/api{self._endpoint}" |
| 63 | + if self._token is not None: |
| 64 | + additional_headers = {"Authorization": f"Bearer {self._token}"} |
| 65 | + elif self._api_key is not None: |
| 66 | + additional_headers = {"Authorization": f"ApiKey {self._api_key}"} |
| 67 | + else: |
| 68 | + additional_headers = {} |
| 69 | + |
| 70 | + try: |
| 71 | + with connect(websocket_uri, additional_headers=additional_headers) as websocket: |
| 72 | + while not self._exit: |
| 73 | + try: |
| 74 | + msg_json = websocket.recv(timeout=0.1, decode=False) |
| 75 | + try: |
| 76 | + msg = json.loads(msg_json) |
| 77 | + self.received_data_buffer.append(msg) |
| 78 | + except json.JSONDecodeError: |
| 79 | + pass |
| 80 | + except TimeoutError: |
| 81 | + pass |
| 82 | + except Exception as ex: |
| 83 | + print(f"Failed to connect to server: {ex}") |
| 84 | + |
| 85 | + def stop(self): |
| 86 | + """ |
| 87 | + Call this method to stop the thread. Then send a request to the server so that some output |
| 88 | + is printed in ``stdout``. |
| 89 | + """ |
| 90 | + self._exit = True |
| 91 | + |
| 92 | + def __del__(self): |
| 93 | + self.stop() |
| 94 | + |
| 95 | + |
| 96 | +# fmt: off |
| 97 | +@pytest.mark.parametrize("ws_auth_type", ["apikey", "apikey_invalid", "none"]) |
| 98 | +# fmt: on |
| 99 | +def test_websocket_auth_01( |
| 100 | + tmpdir, |
| 101 | + monkeypatch, |
| 102 | + re_manager_cmd, # noqa: F811 |
| 103 | + fastapi_server_fs, # noqa: F811 |
| 104 | + ws_auth_type, |
| 105 | +): |
| 106 | + """ |
| 107 | + Test authentication for websockets. The test is run only on ``/status/ws`` websocket. |
| 108 | + The other websockets are expected to use the same authentication scheme. |
| 109 | + """ |
| 110 | + |
| 111 | + # Start RE Manager |
| 112 | + params = ["--zmq-publish-console", "ON"] |
| 113 | + re_manager_cmd(params) |
| 114 | + |
| 115 | + setup_server_with_config_file(config_file_str=config_toy_test, tmpdir=tmpdir, monkeypatch=monkeypatch) |
| 116 | + fastapi_server_fs() |
| 117 | + |
| 118 | + resp1 = request_to_json("post", "/auth/provider/toy/token", login=("bob", "bob_password")) |
| 119 | + assert "access_token" in pprint.pformat(resp1) |
| 120 | + token = resp1["access_token"] |
| 121 | + |
| 122 | + resp3 = request_to_json( |
| 123 | + "post", "/auth/apikey", json={"expires_in": 900, "note": "API key for testing"}, token=token |
| 124 | + ) |
| 125 | + assert "secret" in resp3, pprint.pformat(resp3) |
| 126 | + assert "note" in resp3, pprint.pformat(resp3) |
| 127 | + assert resp3["note"] == "API key for testing" |
| 128 | + assert resp3["scopes"] == ["inherit"] |
| 129 | + api_key = resp3["secret"] |
| 130 | + |
| 131 | + endpoint = "/status/ws" |
| 132 | + if ws_auth_type == "none": |
| 133 | + ws_params = {} |
| 134 | + elif ws_auth_type == "apikey": |
| 135 | + ws_params = {"api_key": api_key} |
| 136 | + elif ws_auth_type == "apikey_invalid": |
| 137 | + ws_params = {"api_key": "InvalidApiKey"} |
| 138 | + # elif ws_auth_type == "token": |
| 139 | + # ws_params = {"token": token} |
| 140 | + # elif ws_auth_type == "token_invalid": |
| 141 | + # ws_params = {"token": "InvalidToken"} |
| 142 | + else: |
| 143 | + assert False, f"Unknown authentication type: {ws_auth_type!r}" |
| 144 | + |
| 145 | + rsc = _ReceiveSystemInfoSocket(endpoint=endpoint, **ws_params) |
| 146 | + rsc.start() |
| 147 | + ttime.sleep(1) # Wait until the client connects to the socket |
| 148 | + |
| 149 | + resp1 = request_to_json("post", "/environment/open", api_key=api_key) |
| 150 | + assert resp1["success"] is True, pprint.pformat(resp1) |
| 151 | + |
| 152 | + assert wait_for_environment_to_be_created(timeout=10, api_key=api_key) |
| 153 | + |
| 154 | + resp2b = request_to_json("post", "/environment/close", api_key=api_key) |
| 155 | + assert resp2b["success"] is True, pprint.pformat(resp2b) |
| 156 | + |
| 157 | + assert wait_for_environment_to_be_closed(timeout=10, api_key=api_key) |
| 158 | + |
| 159 | + # Wait until capture is complete |
| 160 | + ttime.sleep(2) |
| 161 | + rsc.stop() |
| 162 | + rsc.join() |
| 163 | + |
| 164 | + buffer = rsc.received_data_buffer |
| 165 | + if ws_auth_type in ("none", "apikey_invalid", "token_invalid"): |
| 166 | + assert len(buffer) == 0 |
| 167 | + elif ws_auth_type in ("apikey", "token"): |
| 168 | + assert len(buffer) > 0 |
| 169 | + for msg in buffer: |
| 170 | + assert "time" in msg, msg |
| 171 | + assert isinstance(msg["time"], float), msg |
| 172 | + assert "msg" in msg |
| 173 | + assert isinstance(msg["msg"], dict) |
| 174 | + else: |
| 175 | + assert False, f"Unknown authentication type: {ws_auth_type!r}" |
0 commit comments