Files
OpenBB/cli/tests/test_controllers_base_platform_controller.py
Igor Radovanovic a116d9bbf2 [Feature] - OpenBB Platform CLI Unit tests (#6397)
* Unit test batch 1

* CLI controller

* Test batch 3

* Test batch 4

* Test batch 5

* clean some workflows and setup actions

* test

* rename wfs

* rename

* update action

* Skip

* fix cli tests

---------

Co-authored-by: Henrique Joaquim <henriquecjoaquim@gmail.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
2024-05-14 15:38:06 +00:00

71 lines
2.2 KiB
Python

"""Test the BasePlatformController."""
from unittest.mock import MagicMock, patch
import pytest
from openbb_cli.controllers.base_platform_controller import PlatformController, Session
# pylint: disable=redefined-outer-name, protected-access, unused-argument, unused-variable
@pytest.fixture
def mock_session():
"""Mock session fixture."""
with patch(
"openbb_cli.controllers.base_platform_controller.session",
MagicMock(spec=Session),
) as mock:
yield mock
def test_initialization_with_valid_params(mock_session):
"""Test the initialization of the BasePlatformController."""
translators = {"dummy_translator": MagicMock()}
controller = PlatformController(
name="test", parent_path=["parent"], translators=translators
)
assert controller._name == "test"
assert controller.translators == translators
def test_initialization_without_required_params():
"""Test the initialization of the BasePlatformController without required params."""
with pytest.raises(ValueError):
PlatformController(name="test", parent_path=["parent"])
def test_command_generation(mock_session):
"""Test the command generation method."""
translator = MagicMock()
translators = {"test_command": translator}
controller = PlatformController(
name="test", parent_path=["parent"], translators=translators
)
# Check if command function is correctly linked
assert "test_command" in controller.translators
def test_print_help(mock_session):
"""Test the print help method."""
translators = {"test_command": MagicMock()}
controller = PlatformController(
name="test", parent_path=["parent"], translators=translators
)
with patch(
"openbb_cli.controllers.base_platform_controller.MenuText"
) as mock_menu_text:
controller.print_help()
mock_menu_text.assert_called_once_with("/parent/test/")
def test_sub_controller_generation(mock_session):
"""Test the sub controller generation method."""
translators = {"test_menu_item": MagicMock()}
controller = PlatformController(
name="test", parent_path=["parent"], translators=translators
)
assert "test_menu_item" in controller.translators