mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 14:02:06 +00:00
475ebb5acd
* 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>
606 lines
17 KiB
Python
606 lines
17 KiB
Python
# IMPORTATION STANDARD
|
|
|
|
import os
|
|
|
|
# IMPORTATION THIRDPARTY
|
|
import pandas as pd
|
|
import pytest
|
|
|
|
# IMPORTATION INTERNAL
|
|
from openbb_terminal.core.session.current_user import (
|
|
PreferencesModel,
|
|
copy_user,
|
|
)
|
|
from openbb_terminal.stocks.comparison_analysis import ca_controller
|
|
|
|
# pylint: disable=E1101
|
|
# pylint: disable=W0603
|
|
|
|
DF_EMPTY = pd.DataFrame()
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.parametrize(
|
|
"queue, expected",
|
|
[
|
|
(["historical", "help"], ["help"]),
|
|
(["q", ".."], [".."]),
|
|
],
|
|
)
|
|
def test_menu_with_queue(expected, mocker, queue):
|
|
mocker.patch(
|
|
target=(
|
|
"openbb_terminal.stocks.comparison_analysis.ca_controller."
|
|
"ComparisonAnalysisController.switch"
|
|
),
|
|
return_value=["quit"],
|
|
)
|
|
result_menu = ca_controller.ComparisonAnalysisController(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
queue=queue,
|
|
).menu()
|
|
|
|
assert result_menu == expected
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
def test_menu_without_queue_completion(mocker):
|
|
# 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
|
|
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.stocks.comparison_analysis.ca_controller.session",
|
|
)
|
|
mocker.patch(
|
|
target="openbb_terminal.stocks.comparison_analysis.ca_controller.session.prompt",
|
|
return_value="quit",
|
|
)
|
|
|
|
result_menu = ca_controller.ComparisonAnalysisController(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
queue=None,
|
|
).menu()
|
|
|
|
assert result_menu == ["help"]
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.parametrize(
|
|
"mock_input",
|
|
["quit", " quit", "quit mock"],
|
|
)
|
|
def test_menu_without_queue_sys_exit(mock_input, mocker):
|
|
# 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="openbb_terminal.stocks.comparison_analysis.ca_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=(
|
|
"openbb_terminal.stocks.comparison_analysis.ca_controller."
|
|
"ComparisonAnalysisController.switch"
|
|
),
|
|
new=mock_switch,
|
|
)
|
|
|
|
result_menu = ca_controller.ComparisonAnalysisController(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
queue=None,
|
|
).menu()
|
|
|
|
assert result_menu == ["help"]
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.record_stdout
|
|
def test_print_help():
|
|
controller = ca_controller.ComparisonAnalysisController()
|
|
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", "quit", "reset", "stocks", "ca"]),
|
|
],
|
|
)
|
|
def test_switch(an_input, expected_queue):
|
|
controller = ca_controller.ComparisonAnalysisController()
|
|
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 = ca_controller.ComparisonAnalysisController()
|
|
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",
|
|
"quit",
|
|
"quit",
|
|
],
|
|
),
|
|
("call_exit", ["help"], ["quit", "quit", "quit", "quit", "help"]),
|
|
("call_home", [], ["quit", "quit"]),
|
|
("call_help", [], []),
|
|
("call_quit", [], ["quit"]),
|
|
("call_quit", ["help"], ["quit", "help"]),
|
|
(
|
|
"call_reset",
|
|
[],
|
|
["quit", "quit", "reset", "stocks", "ca", "set MOCK_SIMILAR"],
|
|
),
|
|
(
|
|
"call_reset",
|
|
["help"],
|
|
["quit", "quit", "reset", "stocks", "ca", "set MOCK_SIMILAR", "help"],
|
|
),
|
|
],
|
|
)
|
|
def test_call_func_expect_queue(expected_queue, queue, func):
|
|
controller = ca_controller.ComparisonAnalysisController(
|
|
similar=["MOCK_SIMILAR"],
|
|
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, mocked_func, other_args, called_with",
|
|
[
|
|
(
|
|
"call_set",
|
|
None,
|
|
[
|
|
"--similar=MOCK_TICKER_1,MOCK_TICKER_2",
|
|
],
|
|
None,
|
|
),
|
|
(
|
|
"call_add",
|
|
None,
|
|
[
|
|
"--similar=MOCK_TICKER_1,MOCK_TICKER_2",
|
|
],
|
|
None,
|
|
),
|
|
(
|
|
"call_rmv",
|
|
None,
|
|
[
|
|
"--similar=MOCK_TICKER_1,MOCK_TICKER_2",
|
|
],
|
|
None,
|
|
),
|
|
(
|
|
"call_historical",
|
|
"yahoo_finance_view.display_historical",
|
|
[
|
|
"--type=h",
|
|
"--no-scale",
|
|
"--start=2020-12-01",
|
|
"--end=2022-12-11",
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
start_date="2020-12-01",
|
|
end_date="2022-12-11",
|
|
candle_type="h",
|
|
normalize=False,
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_hcorr",
|
|
"yahoo_finance_view.display_correlation",
|
|
[
|
|
"--type=h",
|
|
"--start=2020-12-01",
|
|
"--end=2022-12-11",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
start_date="2020-12-01",
|
|
end_date="2022-12-11",
|
|
candle_type="h",
|
|
export="",
|
|
sheet_name=None,
|
|
display_full_matrix=False,
|
|
raw=False,
|
|
),
|
|
),
|
|
(
|
|
"call_volume",
|
|
"yahoo_finance_view.display_volume",
|
|
[
|
|
"--start=2020-12-01",
|
|
"--end=2022-12-11",
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
start_date="2020-12-01",
|
|
end_date="2022-12-11",
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_income",
|
|
"marketwatch_view.display_income_comparison",
|
|
[
|
|
"--quarter",
|
|
"--timeframe=MOCK_TIMEFRAME",
|
|
],
|
|
dict(
|
|
symbols=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
timeframe="MOCK_TIMEFRAME",
|
|
quarter=True,
|
|
export="",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_balance",
|
|
"marketwatch_view.display_balance_comparison",
|
|
[
|
|
"--quarter",
|
|
"--timeframe=MOCK_TIMEFRAME",
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
symbols=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
timeframe="MOCK_TIMEFRAME",
|
|
quarter=True,
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_cashflow",
|
|
"marketwatch_view.display_cashflow_comparison",
|
|
[
|
|
"--quarter",
|
|
"--timeframe=MOCK_TIMEFRAME",
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
symbols=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
timeframe="MOCK_TIMEFRAME",
|
|
quarter=True,
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_sentiment",
|
|
"finbrain_view.display_sentiment_compare",
|
|
[
|
|
"--raw",
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
raw=True,
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_scorr",
|
|
"finbrain_view.display_sentiment_correlation",
|
|
[
|
|
"--raw",
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
raw=True,
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_overview",
|
|
"finviz_compare_view.screener",
|
|
[
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
data_type="overview",
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_valuation",
|
|
"finviz_compare_view.screener",
|
|
[
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
data_type="valuation",
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_financial",
|
|
"finviz_compare_view.screener",
|
|
[
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
data_type="financial",
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_ownership",
|
|
"finviz_compare_view.screener",
|
|
[
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
data_type="ownership",
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_performance",
|
|
"finviz_compare_view.screener",
|
|
[
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
data_type="performance",
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_technical",
|
|
"finviz_compare_view.screener",
|
|
[
|
|
"--export=csv",
|
|
],
|
|
dict(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
data_type="technical",
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
],
|
|
)
|
|
def test_call_func(tested_func, mocked_func, other_args, called_with, mocker):
|
|
if mocked_func:
|
|
mock = mocker.Mock()
|
|
mocker.patch(
|
|
"openbb_terminal.stocks.comparison_analysis." + mocked_func,
|
|
new=mock,
|
|
)
|
|
|
|
controller = ca_controller.ComparisonAnalysisController(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
)
|
|
getattr(controller, tested_func)(other_args=other_args)
|
|
|
|
if isinstance(called_with, dict):
|
|
mock.assert_called_once_with(**called_with)
|
|
elif isinstance(called_with, list):
|
|
mock.assert_called_once_with(*called_with)
|
|
else:
|
|
mock.assert_called_once()
|
|
else:
|
|
controller = ca_controller.ComparisonAnalysisController(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
)
|
|
getattr(controller, tested_func)(other_args=other_args)
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.parametrize(
|
|
"func",
|
|
[
|
|
"call_ticker",
|
|
"call_get",
|
|
"call_set",
|
|
"call_add",
|
|
"call_rmv",
|
|
"call_historical",
|
|
"call_hcorr",
|
|
"call_volume",
|
|
"call_income",
|
|
"call_balance",
|
|
"call_cashflow",
|
|
"call_sentiment",
|
|
"call_scorr",
|
|
"call_overview",
|
|
"call_valuation",
|
|
"call_financial",
|
|
"call_ownership",
|
|
"call_performance",
|
|
"call_technical",
|
|
"call_tsne",
|
|
],
|
|
)
|
|
def test_call_func_no_parser(func, mocker):
|
|
mocker.patch(
|
|
"openbb_terminal.stocks.comparison_analysis.ca_controller.ComparisonAnalysisController.parse_known_args_and_warn",
|
|
return_value=None,
|
|
)
|
|
controller = ca_controller.ComparisonAnalysisController(
|
|
similar=["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"]
|
|
)
|
|
|
|
func_result = getattr(controller, func)(other_args=list())
|
|
assert func_result is None
|
|
assert controller.queue == []
|
|
controller.parse_known_args_and_warn.assert_called_once()
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
def test_call_ticker(mocker):
|
|
similar = ["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"]
|
|
mock = mocker.Mock(return_value=pd.DataFrame())
|
|
target = "yfinance.download"
|
|
mocker.patch(target=target, new=mock)
|
|
|
|
controller = ca_controller.ComparisonAnalysisController(similar=similar)
|
|
controller.call_ticker(other_args=["MOCK_TICKER"])
|
|
mock.assert_called_once_with("MOCK_TICKER", progress=False)
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.parametrize(
|
|
"tested_func, mocked_func, other_args",
|
|
[
|
|
(
|
|
"call_get",
|
|
"finviz_compare_model.get_similar_companies",
|
|
["--nocountry", "--source=Finviz"],
|
|
),
|
|
(
|
|
"call_get",
|
|
"polygon_model.get_similar_companies",
|
|
["--us_only", "--source=Polygon"],
|
|
),
|
|
(
|
|
"call_get",
|
|
"finnhub_model.get_similar_companies",
|
|
["--source=Finnhub"],
|
|
),
|
|
],
|
|
)
|
|
def test_func_calling_get_similar_companies(
|
|
tested_func, mocked_func, other_args, mocker
|
|
):
|
|
similar = ["MOCK_SIMILAR_" + str(i) for i in range(11)]
|
|
mock = mocker.Mock(return_value=similar)
|
|
target = "openbb_terminal.stocks.comparison_analysis." + mocked_func
|
|
mocker.patch(target=target, new=mock)
|
|
|
|
controller = ca_controller.ComparisonAnalysisController(similar=["MOCK_SIMILAR"])
|
|
getattr(controller, tested_func)(other_args=other_args)
|
|
mock.assert_called_once()
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
def test_call_tsne(mocker):
|
|
similar = ["MOCK_SIMILAR"]
|
|
mock = mocker.Mock(return_value=pd.DataFrame())
|
|
target = "openbb_terminal.stocks.comparison_analysis.yahoo_finance_model.get_sp500_comps_tsne"
|
|
mocker.patch(target=target, new=mock)
|
|
|
|
controller = ca_controller.ComparisonAnalysisController(similar=similar)
|
|
controller.call_tsne(
|
|
other_args=[
|
|
"--learnrate=100",
|
|
"--limit=5",
|
|
"--no_plot",
|
|
]
|
|
)
|
|
mock.assert_called_once_with(
|
|
symbol="MOCK_SIMILAR",
|
|
lr=100,
|
|
)
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.parametrize(
|
|
"similar, expected",
|
|
[
|
|
(None, []),
|
|
(
|
|
["MOCK_SIMILAR_1", "MOCK_SIMILAR_2"],
|
|
["stocks", "ca", "set MOCK_SIMILAR_1,MOCK_SIMILAR_2"],
|
|
),
|
|
],
|
|
)
|
|
def test_custom_reset(expected, similar):
|
|
controller = ca_controller.ComparisonAnalysisController(
|
|
similar=None,
|
|
queue=None,
|
|
)
|
|
controller.similar = similar
|
|
|
|
result = controller.custom_reset()
|
|
|
|
assert result == expected
|