summaryrefslogtreecommitdiffstats
path: root/cli/tests/test_controllers_settings_controller.py
blob: 7540b3bea4f666f3aa13e0bf72b2ce9f3c71e582 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
"""Test the SettingsController class."""

from unittest.mock import MagicMock, patch

import pytest
from openbb_cli.controllers.settings_controller import SettingsController

# pylint: disable=redefined-outer-name, unused-argument


@pytest.fixture
def mock_session():
    with patch("openbb_cli.controllers.settings_controller.session") as mock:
        mock.settings.USE_INTERACTIVE_DF = False
        mock.settings.ALLOWED_NUMBER_OF_ROWS = 20
        mock.settings.TIMEZONE = "UTC"

        mock.settings.set_item = MagicMock()

        yield mock


def test_call_interactive(mock_session):
    controller = SettingsController()
    controller.call_interactive(None)
    mock_session.settings.set_item.assert_called_once_with("USE_INTERACTIVE_DF", True)


@pytest.mark.parametrize(
    "input_rows, expected",
    [
        (10, 10),
        (15, 15),
    ],
)
def test_call_n_rows(input_rows, expected, mock_session):
    controller = SettingsController()
    args = ["--rows", str(input_rows)]
    controller.call_n_rows(args)
    mock_session.settings.set_item.assert_called_with(
        "ALLOWED_NUMBER_OF_ROWS", expected
    )


def test_call_n_rows_no_args_provided(mock_session):
    controller = SettingsController()
    controller.call_n_rows([])
    mock_session.console.print.assert_called_with("Current number of rows: 20")


@pytest.mark.parametrize(
    "timezone, valid",
    [
        ("UTC", True),
        ("Mars/Phobos", False),
    ],
)
def test_call_timezone(timezone, valid, mock_session):
    with patch(
        "openbb_cli.controllers.settings_controller.is_timezone_valid",
        return_value=valid,
    ):
        controller = SettingsController()
        args = ["--timezone", timezone]
        controller.call_timezone(args)
        if valid:
            mock_session.settings.set_item.assert_called_with("TIMEZONE", timezone)
        else:
            mock_session.settings.set_item.assert_not_called()


def test_call_console_style(mock_session):
    controller = SettingsController()
    args = ["--style", "dark"]
    controller.call_console_style(args)
    mock_session.console.print.assert_called()


def test_call_console_style_no_args(mock_session):
    mock_session.settings.RICH_STYLE = "default"
    controller = SettingsController()
    controller.call_console_style([])
    mock_session.console.print.assert_called_with("Current console style: default")


def test_call_flair(mock_session):
    controller = SettingsController()
    args = ["--flair", "rocket"]
    controller.call_flair(args)


def test_call_flair_no_args(mock_session):
    mock_session.settings.FLAIR = "star"
    controller = SettingsController()
    controller.call_flair([])
    mock_session.console.print.assert_called_with("Current flair: star")


def test_call_obbject_display(mock_session):
    controller = SettingsController()
    args = ["--number", "5"]
    controller.call_obbject_display(args)
    mock_session.settings.set_item.assert_called_once_with(
        "N_TO_DISPLAY_OBBJECT_REGISTRY", 5
    )


def test_call_obbject_display_no_args(mock_session):
    mock_session.settings.N_TO_DISPLAY_OBBJECT_REGISTRY = 10
    controller = SettingsController()
    controller.call_obbject_display([])
    mock_session.console.print.assert_called_with(
        "Current number of results to display from the OBBject registry: 10"
    )


@pytest.mark.parametrize(
    "args, expected",
    [
        (["--rows", "50"], 50),
        (["--rows", "100"], 100),
        ([], 20),
    ],
)
def test_call_n_rows_v2(args, expected, mock_session):
    mock_session.settings.ALLOWED_NUMBER_OF_ROWS = 20
    controller = SettingsController()
    controller.call_n_rows(args)
    if args:
        mock_session.settings.set_item.assert_called_with(
            "ALLOWED_NUMBER_OF_ROWS", expected
        )
    else:
        mock_session.console.print.assert_called_with("Current number of rows: 20")