Files
OpenBB/tests/openbb_terminal/session/test_hub_model.py
montezdesousa 825b8955df Set guest by default and put authentication behind environment variable (#4197)
* small bug

* small bug on routines list

* guest as default

* limit logout to users2

* simpler this way

* add logout

* move logout to account & add env var

* put authentication under env var

* fix tests

* remove login

* remove openbb vars on login

* ruff

* revert .toml

* Delete Icon

* Update .env

* fix sdk guest not loading keys

* ruff

* remove press enter & --login

* ruff

* move env load

* load env

* move dot env loading to terminal.py

* fix user sdk login mixing .env with user

* now it works

* fix reset

* fix tests

* ruff

* Login on the SDK using the OpenBB Personal Access Token (#4206)

* openbb key on keys menu

* adding sdk endpoints

* adding login via token to the sdk

* base url

* rename to personal access token

* added docstrings and examples

* openbb is special

* removing extra break line

* making keys working with the personal access token

* resolve conflicting tests

* Revert "resolve conflicting tests"

This reverts commit 2fca2c0ec3.

* using custom requests

* tests

* tests

* tests

* using process_session_response instead

* rewriting some tests

* Fix sdk guest not loading keys (#4207)

* fix sdk guest not loading keys

* ruff

* remove comment

* tests

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>

* test record mode vcr none

* remove yes from tests yml

* specify modules to reload

* try disable check api

* UPdate spec file

* Small stocks bug

* avoid reloading in test mode

* will this work?

* skip session tests

* try with env var as well

* mock sdk reload

* pylint

* bump poetry on python 3.8

* adapt to python 3.8

* adapt to python 3.8 remaining tests

* Tests : update cassettes

* Fix linting

* Makes login conditions simpler

* Tests : txt

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
2023-02-14 09:56:03 +00:00

712 lines
25 KiB
Python

from unittest.mock import MagicMock, patch
import pytest
import requests
from openbb_terminal.session import hub_model
TEST_RESPONSE = {
"access_token": "test_token",
"token_type": "bearer",
"uuid": "test_uuid",
}
TEST_EMAIL_PASSWORD = [
(
"test_email",
"test_pass",
),
]
TEST_HEADER_TOKEN = [
("Bearer test_token", "test_token"),
]
@pytest.mark.parametrize("email, password", TEST_EMAIL_PASSWORD)
def test_create_session_success(email, password):
with patch("requests.post") as mock_post:
mock_post.return_value.json.return_value = TEST_RESPONSE
response = hub_model.create_session(email, password)
assert response.json() == TEST_RESPONSE
mock_post.assert_called_once_with(
url=hub_model.BASE_URL + "login",
json={"email": email, "password": password, "remember": True},
timeout=hub_model.TIMEOUT,
)
@pytest.mark.parametrize("email, password", TEST_EMAIL_PASSWORD)
def test_create_session_connection_error(email, password):
with patch("requests.post") as mock_post:
mock_post.side_effect = requests.exceptions.ConnectionError
response = hub_model.create_session(email, password)
assert response is None
@pytest.mark.parametrize("email, password", TEST_EMAIL_PASSWORD)
def test_create_session_timeout(email, password):
with patch("requests.post") as mock_post:
mock_post.side_effect = requests.exceptions.Timeout
response = hub_model.create_session(email, password)
assert response is None
@pytest.mark.parametrize("email, password", TEST_EMAIL_PASSWORD)
def test_create_session_exception(email, password):
with patch("requests.post") as mock_post:
mock_post.side_effect = Exception
response = hub_model.create_session(email, password)
assert response is None
@pytest.mark.parametrize("token", [("test_token")])
def test_create_session_from_token_success(token):
with patch("requests.post") as mock_post:
mock_post.return_value.json.return_value = TEST_RESPONSE
response = hub_model.create_session_from_token(token)
assert response.json() == TEST_RESPONSE
mock_post.assert_called_once_with(
url=hub_model.BASE_URL + "sdk/login",
json={"token": token},
timeout=hub_model.TIMEOUT,
)
@pytest.mark.parametrize("token", [("test_token")])
def test_create_session_from_token_connection_error(token):
with patch("requests.post") as mock_post:
mock_post.side_effect = requests.exceptions.ConnectionError
response = hub_model.create_session_from_token(token)
assert response is None
@pytest.mark.parametrize("token", [("test_token")])
def test_create_session_from_token_timeout(token):
with patch("requests.post") as mock_post:
mock_post.side_effect = requests.exceptions.Timeout
response = hub_model.create_session_from_token(token)
assert response is None
@pytest.mark.parametrize("token", [("test_token")])
def test_create_session_from_token_exception(token):
with patch("requests.post") as mock_post:
mock_post.side_effect = Exception
response = hub_model.create_session_from_token(token)
assert response is None
@pytest.mark.parametrize("auth_header, token", TEST_HEADER_TOKEN)
def test_delete_session_success(auth_header, token):
with patch("requests.post") as mock_post:
mock_post.return_value.status_code = 200
response = hub_model.delete_session(auth_header, token)
assert response.status_code == 200
mock_post.assert_called_once_with(
url=hub_model.BASE_URL + "logout",
headers={"Authorization": "Bearer test_token"},
json={"token": "test_token"},
timeout=hub_model.TIMEOUT,
)
@pytest.mark.parametrize("auth_header, token", TEST_HEADER_TOKEN)
def test_delete_session_connection_error(auth_header, token):
with patch("requests.post") as mock_post:
mock_post.side_effect = requests.exceptions.ConnectionError
response = hub_model.delete_session(auth_header, token)
assert response is None
@pytest.mark.parametrize("auth_header, token", TEST_HEADER_TOKEN)
def test_delete_session_timeout(auth_header, token):
with patch("requests.post") as mock_post:
mock_post.side_effect = requests.exceptions.Timeout
response = hub_model.delete_session(auth_header, token)
assert response is None
@pytest.mark.parametrize("auth_header, token", TEST_HEADER_TOKEN)
def test_delete_session_exception(auth_header, token):
with patch("requests.post") as mock_post:
mock_post.side_effect = Exception
response = hub_model.delete_session(auth_header, token)
assert response is None
def test_process_session_response_success():
response = requests.Response()
response.status_code = 200
response.json = lambda: {
"access_token": "test_token",
"token_type": "bearer",
"uuid": "test_uuid",
}
login = hub_model.process_session_response(response)
assert login == {
"access_token": "test_token",
"token_type": "bearer",
"uuid": "test_uuid",
}
def test_process_session_response_401():
response = requests.Response()
response.status_code = 401
login = hub_model.process_session_response(response)
assert not login
assert isinstance(login, dict)
def test_process_session_response_403():
response = requests.Response()
response.status_code = 403
login = hub_model.process_session_response(response)
assert not login
assert isinstance(login, dict)
def test_process_session_response_fail():
response = requests.Response()
response.status_code = 400
login = hub_model.process_session_response(response)
assert not login
assert isinstance(login, dict)
def test_get_session_success():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 200
mock_response.json.return_value = {"session": "info"}
with patch(
"openbb_terminal.session.hub_model.create_session", return_value=mock_response
) as create_session_mock:
result = hub_model.get_session("email", "password")
assert result == {"session": "info"}
create_session_mock.assert_called_once_with("email", "password")
def test_get_session_401():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 401
with patch(
"openbb_terminal.session.hub_model.create_session", return_value=mock_response
) as create_session_mock:
result = hub_model.get_session("email", "password")
assert result == {}
create_session_mock.assert_called_once_with("email", "password")
def test_get_session_403():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 403
with patch(
"openbb_terminal.session.hub_model.create_session", return_value=mock_response
) as create_session_mock:
result = hub_model.get_session("email", "password")
assert result == {}
create_session_mock.assert_called_once_with("email", "password")
def test_get_session_failed_to_request():
with patch(
"openbb_terminal.session.hub_model.create_session", return_value=None
) as create_session_mock:
result = hub_model.get_session("email", "password")
assert result == {}
create_session_mock.assert_called_once_with("email", "password")
def test_get_session_from_token():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 200
mock_response.json.return_value = {"session": "info"}
with patch(
"openbb_terminal.session.hub_model.create_session_from_token",
return_value=mock_response,
) as create_session_mock:
result = hub_model.get_session_from_token("token")
assert result == {"session": "info"}
create_session_mock.assert_called_once_with("token")
def test_get_session_from_token_401():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 401
with patch(
"openbb_terminal.session.hub_model.create_session_from_token",
return_value=mock_response,
) as create_session_mock:
result = hub_model.get_session_from_token("token")
assert result == {}
create_session_mock.assert_called_once_with("token")
def test_get_session_from_token_403():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 403
with patch(
"openbb_terminal.session.hub_model.create_session_from_token",
return_value=mock_response,
) as create_session_mock:
result = hub_model.get_session_from_token("token")
assert result == {}
create_session_mock.assert_called_once_with("token")
def test_get_session_from_token_failed_to_request():
with patch(
"openbb_terminal.session.hub_model.create_session_from_token",
return_value=None,
) as create_session_mock:
result = hub_model.get_session_from_token("token")
assert result == {}
create_session_mock.assert_called_once_with("token")
@pytest.mark.parametrize("token_type, access_token", [("TokenType", "AccessToken")])
def test_fetch_user_configs_success(token_type, access_token):
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 200
mock_response.json.return_value = {"configs": "info"}
with patch(
"openbb_terminal.session.hub_model.requests.get", return_value=mock_response
) as requests_get_mock:
session = {"token_type": token_type, "access_token": access_token}
result = hub_model.fetch_user_configs(session)
assert result == mock_response
requests_get_mock.assert_called_once()
_, kwargs = requests_get_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {
"Authorization": f"{token_type.title()} {access_token}"
}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_fetch_user_configs_failure():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 404
with patch("requests.get", return_value=mock_response) as get_mock:
session = {"token_type": "Bearer", "access_token": "abc123"}
result = hub_model.fetch_user_configs(session)
assert isinstance(result, requests.Response)
get_mock.assert_called_once_with(
url=hub_model.BASE_URL + "terminal/user",
headers={"Authorization": "Bearer abc123"},
timeout=hub_model.TIMEOUT,
)
def test_fetch_user_configs_connection_error():
with patch(
"requests.get", side_effect=requests.exceptions.ConnectionError
) as get_mock:
session = {"token_type": "Bearer", "access_token": "abc123"}
result = hub_model.fetch_user_configs(session)
assert result is None
get_mock.assert_called_once_with(
url=hub_model.BASE_URL + "terminal/user",
headers={"Authorization": "Bearer abc123"},
timeout=hub_model.TIMEOUT,
)
def test_fetch_user_configs_timeout():
with patch("requests.get", side_effect=requests.exceptions.Timeout) as get_mock:
session = {"token_type": "Bearer", "access_token": "abc123"}
result = hub_model.fetch_user_configs(session)
assert result is None
get_mock.assert_called_once_with(
url=hub_model.BASE_URL + "terminal/user",
headers={"Authorization": "Bearer abc123"},
timeout=hub_model.TIMEOUT,
)
def test_fetch_user_configs_exception():
with patch("requests.get", side_effect=Exception) as get_mock:
session = {"token_type": "Bearer", "access_token": "abc123"}
result = hub_model.fetch_user_configs(session)
assert result is None
get_mock.assert_called_once_with(
url=hub_model.BASE_URL + "terminal/user",
headers={"Authorization": "Bearer abc123"},
timeout=hub_model.TIMEOUT,
)
@pytest.mark.parametrize(
"key, value, type_, auth_header",
[
("key", "value", "keys", "auth_header"),
("key", "value", "settings", "auth_header"),
],
)
def test_patch_user_configs_success(key, value, type_, auth_header):
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 200
with patch(
"openbb_terminal.session.hub_model.requests.patch", return_value=mock_response
) as requests_patch_mock:
result = hub_model.patch_user_configs(key, value, type_, auth_header)
assert result.status_code == mock_response.status_code
requests_patch_mock.assert_called_once()
_, kwargs = requests_patch_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": f"{auth_header}"}
assert kwargs["json"] == {"key": f"features_{type_}.{key}", "value": value}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_patch_user_configs_failure():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 400
with patch(
"openbb_terminal.session.hub_model.requests.patch", return_value=mock_response
) as requests_patch_mock:
result = hub_model.patch_user_configs("key", "value", "keys", "auth_header")
assert result.status_code == mock_response.status_code
requests_patch_mock.assert_called_once()
_, kwargs = requests_patch_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"key": "features_keys.key", "value": "value"}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_patch_user_configs_connection_error():
with patch(
"openbb_terminal.session.hub_model.requests.patch"
) as requests_patch_mock:
requests_patch_mock.side_effect = requests.exceptions.ConnectionError()
result = hub_model.patch_user_configs("key", "value", "keys", "auth_header")
assert result is None
requests_patch_mock.assert_called_once()
_, kwargs = requests_patch_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"key": "features_keys.key", "value": "value"}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_patch_user_configs_timeout():
with patch(
"openbb_terminal.session.hub_model.requests.patch"
) as requests_patch_mock:
requests_patch_mock.side_effect = requests.exceptions.Timeout()
result = hub_model.patch_user_configs("key", "value", "keys", "auth_header")
assert result is None
requests_patch_mock.assert_called_once()
_, kwargs = requests_patch_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"key": "features_keys.key", "value": "value"}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_patch_user_configs_exception():
with patch(
"openbb_terminal.session.hub_model.requests.patch"
) as requests_patch_mock:
requests_patch_mock.side_effect = Exception()
result = hub_model.patch_user_configs("key", "value", "keys", "auth_header")
assert result is None
requests_patch_mock.assert_called_once()
_, kwargs = requests_patch_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"key": "features_keys.key", "value": "value"}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_clear_user_configs_success():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 200
with patch(
"openbb_terminal.session.hub_model.requests.put", return_value=mock_response
) as requests_put_mock:
result = hub_model.clear_user_configs("auth_header")
assert result.status_code == mock_response.status_code
requests_put_mock.assert_called_once()
_, kwargs = requests_put_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"features_keys": {}, "features_settings": {}}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_clear_user_configs_failure():
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = 400
with patch(
"openbb_terminal.session.hub_model.requests.put", return_value=mock_response
) as requests_put_mock:
result = hub_model.clear_user_configs("auth_header")
assert result.status_code == mock_response.status_code
requests_put_mock.assert_called_once()
_, kwargs = requests_put_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"features_keys": {}, "features_settings": {}}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_clear_user_configs_timeout():
with patch(
"openbb_terminal.session.hub_model.requests.put",
side_effect=requests.exceptions.Timeout,
) as requests_put_mock:
result = hub_model.clear_user_configs("auth_header")
assert result is None
requests_put_mock.assert_called_once()
_, kwargs = requests_put_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"features_keys": {}, "features_settings": {}}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_clear_user_configs_connection_error():
with patch("openbb_terminal.session.hub_model.requests.put") as requests_put_mock:
requests_put_mock.side_effect = requests.exceptions.ConnectionError()
result = hub_model.clear_user_configs("auth_header")
assert result is None
requests_put_mock.assert_called_once()
_, kwargs = requests_put_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"features_keys": {}, "features_settings": {}}
assert kwargs["timeout"] == hub_model.TIMEOUT
def test_clear_user_configs_exception():
with patch(
"openbb_terminal.session.hub_model.requests.put", side_effect=Exception
) as requests_put_mock:
result = hub_model.clear_user_configs("auth_header")
assert result is None
requests_put_mock.assert_called_once()
_, kwargs = requests_put_mock.call_args
assert kwargs["url"] == hub_model.BASE_URL + "terminal/user"
assert kwargs["headers"] == {"Authorization": "auth_header"}
assert kwargs["json"] == {"features_keys": {}, "features_settings": {}}
assert kwargs["timeout"] == hub_model.TIMEOUT
@pytest.mark.parametrize(
"auth_header, name, description, routine, override, base_url, timeout, status_code",
[
("auth_header", "name", "description", "routine", True, "base_url", 10, 200),
("auth_header", "name", "description", "routine", False, "base_url", 10, 400),
],
)
def test_upload_routine(
auth_header, name, description, routine, override, base_url, timeout, status_code
):
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = status_code
with patch(
"openbb_terminal.session.hub_model.requests.post", return_value=mock_response
) as requests_get_mock:
result = hub_model.upload_routine(
auth_header=auth_header,
name=name,
description=description,
routine=routine,
override=override,
base_url=base_url,
timeout=timeout,
)
assert result.status_code == mock_response.status_code
requests_get_mock.assert_called_once()
_, kwargs = requests_get_mock.call_args
assert kwargs["url"] == base_url + "terminal/script"
assert kwargs["headers"] == {"Authorization": auth_header}
assert kwargs["timeout"] == timeout
@pytest.mark.parametrize(
"side_effect",
[
requests.exceptions.ConnectionError,
requests.exceptions.Timeout,
Exception,
],
)
def test_upload_routine_error(side_effect):
with patch(
"openbb_terminal.session.hub_model.requests.post",
side_effect=side_effect,
):
result = hub_model.upload_routine("auth_header", "name", "routine")
assert result is None
@pytest.mark.parametrize(
"auth_header, name, base_url, timeout, status_code",
[
("auth_header", "name", "base_url", 10, 200),
("other_header", "other name", "other_url", 10, 400),
],
)
def test_download_routine(auth_header, name, base_url, timeout, status_code):
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = status_code
with patch(
"openbb_terminal.session.hub_model.requests.get", return_value=mock_response
) as requests_get_mock:
result = hub_model.download_routine(
auth_header=auth_header, name=name, base_url=base_url, timeout=timeout
)
assert result.status_code == mock_response.status_code
requests_get_mock.assert_called_once()
_, kwargs = requests_get_mock.call_args
assert kwargs["url"] == base_url + f"terminal/script/{name}"
assert kwargs["headers"] == {"Authorization": auth_header}
assert kwargs["timeout"] == timeout
@pytest.mark.parametrize(
"side_effect",
[
requests.exceptions.ConnectionError,
requests.exceptions.Timeout,
Exception,
],
)
def test_download_routine_error(side_effect):
with patch(
"openbb_terminal.session.hub_model.requests.get",
side_effect=side_effect,
):
result = hub_model.download_routine("auth_header", "name", "routine")
assert result is None
@pytest.mark.parametrize(
"auth_header, name, base_url, timeout, status_code",
[
("auth_header", "name", "base_url", 10, 200),
("other_header", "other name", "other_url", 10, 400),
],
)
def test_delete_routine(auth_header, name, base_url, timeout, status_code):
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = status_code
with patch(
"openbb_terminal.session.hub_model.requests.delete", return_value=mock_response
) as requests_get_mock:
result = hub_model.delete_routine(
auth_header=auth_header, name=name, base_url=base_url, timeout=timeout
)
assert result.status_code == mock_response.status_code
requests_get_mock.assert_called_once()
_, kwargs = requests_get_mock.call_args
assert kwargs["url"] == base_url + f"terminal/script/{name}"
assert kwargs["headers"] == {"Authorization": auth_header}
assert kwargs["timeout"] == timeout
@pytest.mark.parametrize(
"side_effect",
[
requests.exceptions.ConnectionError,
requests.exceptions.Timeout,
Exception,
],
)
def test_delete_routine_error(side_effect):
with patch(
"openbb_terminal.session.hub_model.requests.delete",
side_effect=side_effect,
):
result = hub_model.delete_routine("auth_header", "name")
assert result is None
@pytest.mark.parametrize(
"auth_header, page, size, base_url, timeout, status_code",
[
("auth_header", 1, 10, "base_url", 10, 200),
("other_header", 2, 20, "other_url", 10, 400),
],
)
def test_list_routines(auth_header, page, size, base_url, timeout, status_code):
mock_response = MagicMock(spec=requests.Response)
mock_response.status_code = status_code
with patch(
"openbb_terminal.session.hub_model.requests.get", return_value=mock_response
) as requests_get_mock:
result = hub_model.list_routines(
auth_header=auth_header,
page=page,
size=size,
base_url=base_url,
timeout=timeout,
)
assert result.status_code == mock_response.status_code
requests_get_mock.assert_called_once()
_, kwargs = requests_get_mock.call_args
assert (
kwargs["url"]
== base_url
+ f"terminal/script?fields=name%2Cdescription&page={page}&size={size}"
)
assert kwargs["headers"] == {"Authorization": auth_header}
assert kwargs["timeout"] == timeout
@pytest.mark.parametrize(
"side_effect",
[
requests.exceptions.ConnectionError,
requests.exceptions.Timeout,
Exception,
],
)
def test_list_routines_error(side_effect):
with patch(
"openbb_terminal.session.hub_model.requests.get",
side_effect=side_effect,
):
result = hub_model.list_routines(auth_header="Bearer 123", page=1, size=10)
assert result is None