Files
OpenBB/tests/openbb_terminal/fixedincome/test_fixedincome_controller.py
montezdesousa 475ebb5acd [WIP] Migrate user, feature flags and configurations to dataclass (#4309)
* implement user and change is guest

* replace User methods

* move remaining functions to user

* fix bug

* portfolio test

* fix tests

* fix tests

* uncomment skip

* ruff

* start credentials model implementation

* change deault structure

* refacto quandl

* change default struct and file names

* bug

* start using global user

* add comments

* move update flair

* change cfg references in keys model

* reddit & fmp

* refactore additional keys

* remaing config keys

* remove unsude imports and fix hub keys

* ruff

* fix line too long

* unblock unittests

* fix keys model tests

* remove os patch

* fix account controller tests

* fix account controller tests

* fix account model

* account fixed

* fix user tests

* User Model

* User Model

* User Model

* Move session folder

* User Model : grouping the models

* User Model : fix bugs

* Config Plot + bug fix

* User Model : Refactoring plots

* Feature flags

* Remove dup

* clean comments a fix some vars

* fix feature flags controller

* refactor obbff from settings controller

* refactor a bunch of obbff variables

* fix bug blocking terminal

* fix integration tests

* refactor controllers with obbff

* refactor remaining ffs

* remove comments

* log not started

* mispelled variable

* set current user on local model

* User Model : moving files + updating

* User Preferences

* User : Refactor is_guest function + bug fix

* User : refactor is_guest function

* Fix conftest.py

* remove lost obbffs

* typo on fileoverwrite

* Plot config: move variables and start plot dpi

* User : tests

* refactor plot dpi references

* remove plot dpi imports

* refactor some config terminal leftover

* /account/sync : fix bug

* remove configs reload

* start path refactor

* installation paths vs user paths

* remove cfg_plot

* Tests : User Refactoring

* user prefix only for preferences

* user prefix only for preferences

* move user paths

* remove comment

* update apply remote configs

* fix tz not updating

* save some copys

* small fix

* create interface for credentials and preferences

* wrong docstrings fixed

* ruff core

* fix some pref setting

* login is better

* ruff

* ruff

* remove Literal

* add small comment

* Tests : User Refactoring

* Credentials Model : add DataBento

* Fix helper_funcs

* Fixing code

* Tests : fixing

* User Model : freezing the models

* Fixed Income + Databento

* Tests : fixing keys

* black

* ruff

* Tests : user model

* Tests : user model

* Fix linting

* Fix linting

* Linting

* Linting

* Fixing code and tests

* Fix tests

* mypy

* SDK

* Clean ruff cache

* Fix syntax issue

* Update fred_view

* Black

* Linting

* Update code

* Update tests

* Linting

* Linting

* Tests

* Black

* Linting

* Linting

* Mock os.listdir to avoid looking for file that doesnt exist

* Mock options paths

* lint

* Tests : fix

* Code : update

* Tests + Linting

* Tests

* Ruff

* Code : update

* Tests

* Code : update

* Fix workflow

* Code : update

---------

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: luqazino@gmail.com <luqazino@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
2023-03-05 00:37:19 +01:00

608 lines
16 KiB
Python

# IMPORTATION STANDARD
import os
from datetime import datetime
import pytest
# IMPORTATION INTERNAL
from openbb_terminal.core.session.current_user import (
PreferencesModel,
copy_user,
)
from openbb_terminal.fixedincome import fixedincome_controller
MOCK_START = datetime.strptime("2022-01-01", "%Y-%m-%d")
MOCK_END = datetime.strptime("2022-01-31", "%Y-%m-%d")
@pytest.mark.vcr(record_mode="none")
@pytest.mark.parametrize(
"queue, expected",
[
(["load", "help"], ["help"]),
(["quit", "help"], ["help"]),
],
)
def test_menu_with_queue(expected, mocker, queue):
path_controller = "openbb_terminal.fixedincome.fixedincome_controller"
# MOCK SWITCH
mocker.patch(
target=f"{path_controller}.FixedIncomeController.switch",
return_value=["quit"],
)
result_menu = fixedincome_controller.FixedIncomeController(queue=queue).menu()
assert result_menu == expected
@pytest.mark.vcr(record_mode="none")
def test_menu_without_queue_completion(mocker):
path_controller = "openbb_terminal.fixedincome.fixedincome_controller"
# ENABLE AUTO-COMPLETION : HELPER_FUNCS.MENU
preferences = PreferencesModel(USE_PROMPT_TOOLKIT=True)
mock_current_user = copy_user(preferences=preferences)
mocker.patch(
target="openbb_terminal.core.session.current_user.__current_user",
new=mock_current_user,
)
mocker.patch(
target="openbb_terminal.parent_classes.session",
)
mocker.patch(
target="openbb_terminal.parent_classes.session.prompt",
return_value="quit",
)
# DISABLE AUTO-COMPLETION : CONTROLLER.COMPLETER
mocker.patch(
target=f"{path_controller}.session",
)
mocker.patch(
target=f"{path_controller}.session.prompt",
return_value="quit",
)
result_menu = fixedincome_controller.FixedIncomeController(queue=None).menu()
assert result_menu == ["help"]
@pytest.mark.vcr(record_mode="none")
@pytest.mark.parametrize(
"mock_input",
["help", "homee help", "home help", "mock"],
)
def test_menu_without_queue_sys_exit(mock_input, mocker):
path_controller = "openbb_terminal.fixedincome.fixedincome_controller"
# DISABLE AUTO-COMPLETION
preferences = PreferencesModel(USE_PROMPT_TOOLKIT=True)
mock_current_user = copy_user(preferences=preferences)
mocker.patch(
target="openbb_terminal.core.session.current_user.__current_user",
new=mock_current_user,
)
mocker.patch(
target=f"{path_controller}.session",
return_value=None,
)
# MOCK USER INPUT
mocker.patch("builtins.input", return_value=mock_input)
# MOCK SWITCH
class SystemExitSideEffect:
def __init__(self):
self.first_call = True
def __call__(self, *args, **kwargs):
if self.first_call:
self.first_call = False
raise SystemExit()
return ["quit"]
mock_switch = mocker.Mock(side_effect=SystemExitSideEffect())
mocker.patch(
target=f"{path_controller}.FixedIncomeController.switch",
new=mock_switch,
)
result_menu = fixedincome_controller.FixedIncomeController(queue=None).menu()
assert result_menu == ["help"]
@pytest.mark.vcr(record_mode="none")
@pytest.mark.record_stdout
def test_print_help():
controller = fixedincome_controller.FixedIncomeController(queue=None)
controller.print_help()
@pytest.mark.vcr(record_mode="none")
@pytest.mark.parametrize(
"an_input, expected_queue",
[
("", []),
("/help", ["home", "help"]),
("help/help", ["help", "help"]),
("q", ["quit"]),
("h", []),
(
"r",
[
"quit",
"reset",
"fixedincome",
],
),
],
)
def test_switch(an_input, expected_queue):
controller = fixedincome_controller.FixedIncomeController(queue=None)
queue = controller.switch(an_input=an_input)
assert queue == expected_queue
@pytest.mark.vcr(record_mode="none")
def test_call_cls(mocker):
mocker.patch("os.system")
controller = fixedincome_controller.FixedIncomeController(queue=None)
controller.call_cls([])
assert controller.queue == []
os.system.assert_called_once_with("cls||clear")
@pytest.mark.vcr(record_mode="none")
@pytest.mark.parametrize(
"func, queue, expected_queue",
[
(
"call_exit",
[],
["quit", "quit"],
),
("call_exit", ["help"], ["quit", "quit", "help"]),
("call_home", [], ["quit"]),
("call_help", [], []),
("call_quit", [], ["quit"]),
("call_quit", ["help"], ["quit", "help"]),
(
"call_reset",
[],
[
"quit",
"reset",
"fixedincome",
],
),
(
"call_reset",
["help"],
[
"quit",
"reset",
"fixedincome",
"help",
],
),
],
)
def test_call_func_expect_queue(expected_queue, func, queue):
controller = fixedincome_controller.FixedIncomeController(queue=queue)
result = getattr(controller, func)([])
assert result is None
assert controller.queue == expected_queue
@pytest.mark.vcr(record_mode="none")
@pytest.mark.parametrize(
"tested_func, other_args, mocked_func, called_args, called_kwargs",
[
(
"call_estr",
[
"-p=total_volume",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"fred_view.plot_estr",
[],
dict(
parameter="total_volume",
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_estr",
[
"--source=ECB",
"-p=total_volume",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"ecb_view.plot_estr",
[],
dict(
parameter="total_volume",
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_sofr",
[
"-p=180_day_average",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"fred_view.plot_sofr",
[],
dict(
parameter="180_day_average",
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_sonia",
[
"-p=index",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"fred_view.plot_sonia",
[],
dict(
parameter="index",
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_ameribor",
[
"-p=2_year_term_structure",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"fred_view.plot_ameribor",
[],
dict(
parameter="2_year_term_structure",
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_fed",
[
"-p=monthly",
"--overnight",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"fred_view.plot_fed",
[],
dict(
parameter="monthly",
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
overnight=True,
quantiles=False,
target=False,
raw=False,
),
),
(
"call_iorb",
[
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"fred_view.plot_iorb",
[],
dict(
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_dwpcr",
[
"-p=annual",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"fred_view.plot_dwpcr",
[],
dict(
parameter="annual",
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_ecb",
[
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"fred_view.plot_ecb",
[],
dict(
interest_type=None,
raw=False,
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_treasury",
[
"--short=united_kingdom",
"--long=united_states,canada",
"--forecast",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
],
"oecd_view.plot_treasuries",
[],
dict(
forecast=True,
raw=False,
long_term=["united_states", "canada"],
short_term=["united_kingdom"],
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
),
),
(
"call_usrates",
[
"-m=7_year",
"-p=tips",
"--forecast",
"-s=2022-01-01",
"-e=2022-01-31",
"--export=csv",
"--raw",
],
"fred_view.plot_usrates",
[],
dict(
parameter="tips",
maturity="7_year",
start_date=MOCK_START,
end_date=MOCK_END,
export="csv",
sheet_name=None,
raw=True,
),
),
(
"call_ycrv",
["-d=2022-01-01", "--raw"],
"fred_view.display_yield_curve",
[],
dict(
date="2022-01-01",
inflation_adjusted=False,
export="",
sheet_name=None,
raw=True,
),
),
(
"call_ecbycrv",
["-d=2022-01-01", "--raw", "-p=spot_rate"],
"ecb_view.display_ecb_yield_curve",
[],
dict(
date="2022-01-01",
yield_type="spot_rate",
export="",
detailed=False,
any_rating=False,
sheet_name=None,
raw=True,
),
),
(
"call_tmc",
[
"-s=2022-01-01",
"-e=2022-01-31",
],
"fred_view.plot_tmc",
[],
dict(
parameter="3_month",
start_date=MOCK_START,
end_date=MOCK_END,
sheet_name=None,
export="",
),
),
(
"call_ffrmc",
[
"-s=2022-01-01",
"-e=2022-01-31",
],
"fred_view.plot_ffrmc",
[],
dict(
parameter="10_year",
start_date=MOCK_START,
end_date=MOCK_END,
sheet_name=None,
export="",
),
),
(
"call_tbffr",
[
"-s=2022-01-01",
"-e=2022-01-31",
],
"fred_view.plot_tbffr",
[],
dict(
parameter="3_month",
start_date=MOCK_START,
end_date=MOCK_END,
sheet_name=None,
export="",
),
),
(
"call_icebofa",
[
"-t=yield",
"-a=us",
"-g=aaa",
"-s=2022-01-01",
"-e=2022-01-31",
],
"fred_view.plot_icebofa",
[],
dict(
data_type="yield",
category="all",
grade="aaa",
area="us",
raw=False,
options=False,
description=False,
start_date=MOCK_START,
end_date=MOCK_END,
sheet_name=None,
export="",
),
),
(
"call_moody",
[
"-t=aaa",
"--spread=fed_funds",
"-s=2022-01-01",
"-e=2022-01-31",
],
"fred_view.plot_moody",
[],
dict(
data_type="aaa",
spread="fed_funds",
raw=False,
start_date=MOCK_START,
end_date=MOCK_END,
sheet_name=None,
export="",
),
),
(
"call_cp",
[
"-m=overnight",
"-c=non_financial",
"-s=2022-01-01",
"-e=2022-01-31",
],
"fred_view.plot_cp",
[],
dict(
maturity="overnight",
category="non_financial",
grade="aa",
description=False,
raw=False,
options=False,
start_date=MOCK_START,
end_date=MOCK_END,
sheet_name=None,
export="",
),
),
(
"call_spot",
[
"-s=2022-01-01",
"-e=2022-01-31",
],
"fred_view.plot_spot",
[],
dict(
maturity=["10y"],
category=["spot_rate"],
description=False,
raw=False,
start_date=MOCK_START,
end_date=MOCK_END,
sheet_name=None,
export="",
),
),
],
)
def test_call_cmd(
tested_func, mocked_func, other_args, called_args, called_kwargs, mocker
):
path_controller = "openbb_terminal.fixedincome.fixedincome_controller"
if mocked_func:
mock = mocker.Mock()
mocker.patch(
target=f"{path_controller}.{mocked_func}",
new=mock,
)
controller = fixedincome_controller.FixedIncomeController(queue=None)
getattr(controller, tested_func)(other_args)
if called_args or called_kwargs:
mock.assert_called_once_with(*called_args, **called_kwargs)
else:
mock.assert_called_once()
else:
controller = fixedincome_controller.FixedIncomeController(queue=None)
getattr(controller, tested_func)(other_args)