Files
OpenBB/tests/openbb_terminal/session/test_sdk_session.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

201 lines
5.4 KiB
Python

# IMPORTATION STANDARD
# IMPORTATION THIRDPARTY
from unittest.mock import patch
import pytest
# IMPORTATION INTERNAL
from openbb_terminal.session import sdk_session
from openbb_terminal.session.session_model import LoginStatus
from openbb_terminal.session.user import User
TEST_SESSION = {
"access_token": "test_token",
"token_type": "bearer",
"uuid": "test_uuid",
}
@pytest.mark.parametrize(
"email, password, token, save",
[
(
"test_email",
"test_pass",
"test_token",
True,
),
],
)
def test_get_session_exception(email: str, password: str, token: str, save: bool):
path = "openbb_terminal.session.sdk_session."
with patch(path + "session_model.create_session") as mock_create_session:
with patch(
path + "session_model.create_session_from_token"
) as mock_create_session_from_token:
mock_create_session.return_value = {}
mock_create_session_from_token.return_value = {}
with pytest.raises(Exception):
sdk_session.get_session(
email=email, password=password, token=token, save=save
)
mock_create_session.assert_called_once_with(email, password, save)
mock_create_session_from_token.assert_called_once_with(token, save)
@pytest.mark.parametrize(
"email, password, token, save",
[
(
"test_email",
"test_pass",
"test_token",
True,
),
],
)
def test_get_session(email: str, password: str, token: str, save: bool):
path = "openbb_terminal.session.sdk_session."
with patch(path + "session_model.create_session") as mock_create_session:
mock_create_session.return_value = TEST_SESSION
sdk_session.get_session(email=email, password=password, token=token, save=save)
mock_create_session.assert_called_once_with(email, password, save)
@pytest.mark.parametrize(
"email, password, token, save",
[
(
"test_email",
"test_pass",
"test_token",
True,
),
],
)
def test_get_session_from_token(email: str, password: str, token: str, save: bool):
path = "openbb_terminal.session.sdk_session."
with patch(
path + "session_model.create_session_from_token"
) as mock_create_session_from_token:
mock_create_session_from_token.return_value = TEST_SESSION
sdk_session.get_session(email=email, password=password, token=token, save=save)
mock_create_session_from_token.assert_called_once_with(token, save)
@pytest.mark.parametrize(
"email, password, token, keep_session, has_session, status",
[
(
"test_email",
"test_pass",
"test_token",
True,
False,
LoginStatus.SUCCESS,
),
(
"test_email",
"test_pass",
"test_token",
True,
True,
LoginStatus.SUCCESS,
),
(
"test_email",
"test_pass",
"test_token",
True,
False,
LoginStatus.FAILED,
),
(
"test_email",
"test_pass",
"test_token",
True,
False,
LoginStatus.NO_RESPONSE,
),
],
)
def test_login(
mocker,
email: str,
password: str,
token: str,
keep_session: bool,
has_session: bool,
status: LoginStatus,
):
path = "openbb_terminal.session.sdk_session."
mock_login = mocker.patch(path + "session_model.login")
mock_local_get_session = mocker.patch(path + "Local.get_session")
mock_hub_get_session = mocker.patch(path + "get_session")
if has_session:
mock_local_get_session.return_value = TEST_SESSION
else:
mock_local_get_session.return_value = None
mock_hub_get_session.return_value = TEST_SESSION
mock_login.return_value = status
if status in [LoginStatus.FAILED, LoginStatus.NO_RESPONSE]:
with pytest.raises(Exception):
sdk_session.login(
email=email,
password=password,
token=token,
keep_session=keep_session,
)
else:
sdk_session.login(
email=email, password=password, token=token, keep_session=keep_session
)
mock_local_get_session.assert_called_once()
if has_session:
mock_hub_get_session.assert_not_called()
else:
mock_hub_get_session.assert_called_once_with(
email, password, token, keep_session
)
mock_login.assert_called_once_with(TEST_SESSION)
def test_logout():
User.load_user_info(TEST_SESSION, "test@email.com")
path = "openbb_terminal.session.sdk_session."
with (patch(path + "session_model.logout") as mock_logout,):
sdk_session.logout()
mock_logout.assert_called_once_with(
auth_header=User.get_auth_header(),
token=User.get_token(),
guest=User.is_guest(),
)
@pytest.mark.record_stdout
def test_whoami_guest():
sdk_session.whoami()
@pytest.mark.record_stdout
def test_whoami():
User.load_user_info(
{
"token_type": "MOCK_TOKEN_TYPE",
"access_token": "MOCK_ACCESS_TOKEN",
"uuid": "MOCK_UUID",
},
email="MOCK_EMAIL",
)
sdk_session.whoami()