mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 15:01:18 +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>
618 lines
16 KiB
Python
618 lines
16 KiB
Python
# IMPORTATION STANDARD
|
|
import os
|
|
|
|
# IMPORTATION THIRDPARTY
|
|
import pandas as pd
|
|
import pytest
|
|
import yfinance
|
|
|
|
# IMPORTATION INTERNAL
|
|
from openbb_terminal.core.session.current_user import (
|
|
PreferencesModel,
|
|
copy_user,
|
|
)
|
|
from openbb_terminal.stocks.insider import insider_controller
|
|
|
|
# pylint: disable=E1101
|
|
# pylint: disable=W0603
|
|
# pylint: disable=E1111
|
|
|
|
EMPTY_DF = pd.DataFrame()
|
|
DF_STOCK = pd.DataFrame.from_dict(
|
|
data={
|
|
pd.Timestamp("2020-11-30 00:00:00"): {
|
|
"Open": 75.69999694824219,
|
|
"High": 76.08999633789062,
|
|
"Low": 75.41999816894531,
|
|
"Close": 75.75,
|
|
"Adj Close": 71.90919494628906,
|
|
"Volume": 5539100,
|
|
"date_id": 1,
|
|
"OC_High": 75.75,
|
|
"OC_Low": 75.69999694824219,
|
|
},
|
|
pd.Timestamp("2020-12-01 00:00:00"): {
|
|
"Open": 76.0199966430664,
|
|
"High": 77.12999725341797,
|
|
"Low": 75.69000244140625,
|
|
"Close": 77.02999877929688,
|
|
"Adj Close": 73.1242904663086,
|
|
"Volume": 6791700,
|
|
"date_id": 2,
|
|
"OC_High": 77.02999877929688,
|
|
"OC_Low": 76.0199966430664,
|
|
},
|
|
},
|
|
orient="index",
|
|
)
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def vcr_config():
|
|
return {
|
|
"filter_headers": [("User-Agent", None)],
|
|
"filter_query_parameters": [
|
|
("period1", "1598220000"),
|
|
("period2", "1635980400"),
|
|
],
|
|
}
|
|
|
|
|
|
@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):
|
|
mocker.patch(
|
|
target=(
|
|
"openbb_terminal.stocks.insider.insider_controller."
|
|
"InsiderController.switch"
|
|
),
|
|
return_value=["quit"],
|
|
)
|
|
stock = pd.DataFrame()
|
|
result_menu = insider_controller.InsiderController(
|
|
ticker="TSLA",
|
|
start="2021-10-25",
|
|
interval="1440min",
|
|
stock=stock,
|
|
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",
|
|
)
|
|
|
|
stock = pd.DataFrame()
|
|
result_menu = insider_controller.InsiderController(
|
|
ticker="TSLA",
|
|
start="2021-10-25",
|
|
interval="1440min",
|
|
stock=stock,
|
|
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):
|
|
# 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.insider.insider_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.insider.insider_controller."
|
|
"InsiderController.switch"
|
|
),
|
|
new=mock_switch,
|
|
)
|
|
|
|
stock = pd.DataFrame()
|
|
result_menu = insider_controller.InsiderController(
|
|
ticker="TSLA",
|
|
start="2021-10-25",
|
|
interval="1440min",
|
|
stock=stock,
|
|
queue=None,
|
|
).menu()
|
|
|
|
assert result_menu == ["help"]
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.record_stdout
|
|
def test_print_help():
|
|
controller = insider_controller.InsiderController(
|
|
ticker="",
|
|
start="",
|
|
interval="",
|
|
stock=pd.DataFrame(),
|
|
)
|
|
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", "ins"]),
|
|
],
|
|
)
|
|
def test_switch(an_input, expected_queue):
|
|
controller = insider_controller.InsiderController(
|
|
ticker="",
|
|
start="",
|
|
interval="",
|
|
stock=pd.DataFrame(),
|
|
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 = insider_controller.InsiderController(
|
|
ticker="",
|
|
start="",
|
|
interval="",
|
|
stock=pd.DataFrame(),
|
|
)
|
|
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",
|
|
],
|
|
),
|
|
("call_exit", ["help"], ["quit", "quit", "quit", "help"]),
|
|
("call_home", [], ["quit", "quit"]),
|
|
("call_help", [], []),
|
|
("call_quit", [], ["quit"]),
|
|
("call_quit", ["help"], ["quit", "help"]),
|
|
(
|
|
"call_reset",
|
|
[],
|
|
["quit", "quit", "reset", "stocks", "ins"],
|
|
),
|
|
(
|
|
"call_reset",
|
|
["help"],
|
|
["quit", "quit", "reset", "stocks", "ins", "help"],
|
|
),
|
|
],
|
|
)
|
|
def test_call_func_expect_queue(expected_queue, queue, func):
|
|
controller = insider_controller.InsiderController(
|
|
ticker="",
|
|
start="",
|
|
interval="",
|
|
stock=pd.DataFrame(),
|
|
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_view",
|
|
["whales"],
|
|
"",
|
|
[],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_set",
|
|
["whales"],
|
|
"",
|
|
[],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_filter",
|
|
["1", "--urls", "--export=csv"],
|
|
"openinsider_view.print_insider_filter",
|
|
[],
|
|
dict(
|
|
preset="whales",
|
|
symbol="",
|
|
limit=1,
|
|
links=True,
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_lcb",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["lcb", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_stats",
|
|
["1", "--urls", "--export=csv"],
|
|
"openinsider_view.print_insider_filter",
|
|
[],
|
|
dict(
|
|
preset="",
|
|
symbol="MOCK_TICKER",
|
|
limit=1,
|
|
links=True,
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_lpsb",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["lpsb", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_lit",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["lit", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_lip",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["lip", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_blip",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["blip", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_blop",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["blop", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_blcp",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["blcp", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_lis",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["lis", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_blis",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["blis", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_blos",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["blos", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_blcs",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["blcs", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_topt",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["topt", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_toppw",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["toppw", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_toppm",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["toppm", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_tipt",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["tipt", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_tippw",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["tippw", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_tippm",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["tippm", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_tist",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["tist", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_tispw",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["tispw", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_tispm",
|
|
["1", "--export=csv"],
|
|
"openinsider_view.print_insider_data",
|
|
["tispm", 1, "csv"],
|
|
dict(),
|
|
),
|
|
(
|
|
"call_act",
|
|
["5", "--raw", "--export=csv"],
|
|
"businessinsider_view.insider_activity",
|
|
[],
|
|
dict(
|
|
data=EMPTY_DF,
|
|
symbol="MOCK_TICKER",
|
|
start_date="MOCK_DATE",
|
|
interval="MOCK_INTERVAL",
|
|
limit=5,
|
|
raw=True,
|
|
export="csv",
|
|
sheet_name=None,
|
|
),
|
|
),
|
|
(
|
|
"call_lins",
|
|
["5", "--export=csv"],
|
|
"finviz_view.last_insider_activity",
|
|
[],
|
|
dict(symbol="MOCK_TICKER", limit=5, export="csv", sheet_name=None),
|
|
),
|
|
],
|
|
)
|
|
def test_call_func(
|
|
tested_func, mocked_func, other_args, called_args, called_kwargs, mocker
|
|
):
|
|
path_controller = "openbb_terminal.stocks.insider.insider_controller"
|
|
|
|
if mocked_func:
|
|
mock = mocker.Mock()
|
|
mocker.patch(
|
|
target=f"{path_controller}.{mocked_func}",
|
|
new=mock,
|
|
)
|
|
|
|
EMPTY_DF.drop(EMPTY_DF.index, inplace=True)
|
|
controller = insider_controller.InsiderController(
|
|
ticker="MOCK_TICKER",
|
|
start="MOCK_DATE",
|
|
interval="MOCK_INTERVAL",
|
|
stock=EMPTY_DF,
|
|
)
|
|
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:
|
|
EMPTY_DF.drop(EMPTY_DF.index, inplace=True)
|
|
controller = insider_controller.InsiderController(
|
|
ticker="MOCK_TICKER",
|
|
start="MOCK_DATE",
|
|
interval="MOCK_INTERVAL",
|
|
stock=EMPTY_DF,
|
|
)
|
|
getattr(controller, tested_func)(other_args)
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.parametrize(
|
|
"func",
|
|
[
|
|
"call_act",
|
|
"call_lins",
|
|
],
|
|
)
|
|
def test_call_func_no_parser(func, mocker):
|
|
mocker.patch(
|
|
"openbb_terminal.stocks.insider.insider_controller.InsiderController.parse_known_args_and_warn",
|
|
return_value=None,
|
|
)
|
|
controller = insider_controller.InsiderController(
|
|
ticker="MOCK_TICKER",
|
|
start="2021-10-25",
|
|
interval="1440min",
|
|
stock=pd.DataFrame(),
|
|
)
|
|
|
|
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")
|
|
@pytest.mark.record_stdout
|
|
@pytest.mark.parametrize(
|
|
"func",
|
|
["call_act", "call_lins"],
|
|
)
|
|
def test_call_func_empty_ticker(func):
|
|
controller = insider_controller.InsiderController(
|
|
ticker=None,
|
|
start="2021-10-25",
|
|
interval="1440min",
|
|
stock=pd.DataFrame(),
|
|
)
|
|
getattr(controller, func)(other_args=list())
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.parametrize(
|
|
"ticker, expected",
|
|
[
|
|
(None, []),
|
|
("MOCK_TICKER", ["stocks", "load MOCK_TICKER", "ins"]),
|
|
],
|
|
)
|
|
def test_custom_reset(expected, ticker):
|
|
controller = insider_controller.InsiderController(
|
|
ticker=None,
|
|
start="2021-10-25",
|
|
interval="1440min",
|
|
stock=pd.DataFrame(),
|
|
)
|
|
controller.ticker = ticker
|
|
|
|
result = controller.custom_reset()
|
|
|
|
assert result == expected
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
@pytest.mark.record_stdout
|
|
@pytest.mark.parametrize(
|
|
"func",
|
|
["call_stats", "call_act", "call_lins"],
|
|
)
|
|
def test_call_func_no_stock(func):
|
|
controller = insider_controller.InsiderController(
|
|
ticker=None,
|
|
start="2021-10-25",
|
|
interval="1440min",
|
|
stock=pd.DataFrame(),
|
|
)
|
|
getattr(controller, func)(other_args=list())
|
|
|
|
|
|
@pytest.mark.vcr(record_mode="none")
|
|
def test_call_load(mocker):
|
|
# MOCK LOAD
|
|
yf_download = yfinance.download
|
|
|
|
def mock_yf_download(*args, **kwargs):
|
|
kwargs["threads"] = False
|
|
return yf_download(*args, **kwargs)
|
|
|
|
mocker.patch("yfinance.download", side_effect=mock_yf_download)
|
|
controller = insider_controller.InsiderController(
|
|
ticker=None,
|
|
start="2021-10-25",
|
|
interval="1440min",
|
|
stock=pd.DataFrame(),
|
|
)
|
|
|
|
other_args = [
|
|
"TSLA",
|
|
"--start=2021-12-17",
|
|
"--end=2021-12-18",
|
|
"--source=YahooFinance",
|
|
]
|
|
controller.call_load(other_args=other_args)
|