==
UI
==

:mod:`pytest-houdini` contains a number of useful fixtures for mocking UI related modules for testing.

mock_hdefereval
---------------

The :func:`~pytest_houdini.fixtures.ui.mock_hdefereval` fixture mocks the :mod:`hdefereval` module. If you need to test code which uses this module you'll
want to use this fixture as importing the module in non-graphical Houdini (hython) will result in an :exc:`ImportError` due
to the UI not being available.

.. code-block::

    def my_func():
        print("I'm deferred!")

    def run_my_func_deferred():
        hdefereval.executeDeferred(my_func)

    def test_run_my_func_deferred(mock_hdefereval):
        run_my_func_deferred()

        mock_hdefereval.executeDeferred.assert_called_with(my_func)

        import hdefereval
        assert hdefereval == mock_hdefereval


mock_hou_qt
-----------

The :func:`~pytest_houdini.fixtures.ui.mock_hou_qt` fixture mocks the :mod:`hou.qt` module which does not exist in non-graphical Houdini.

The temporary :mod:`hou.qt` object is removed after the test is completed.

.. code-block::

    def get_icon(icon_name):
        return hou.qt.Icon(icon_name)

    def test_get_icon(mock_hou_qt):
        icon = get_icon("SOP_box")

        assert icon == mock_hou_qt.Icon.return_value
        assert hou.qt == mock_hou_qt

mock_hou_ui
-----------

The :func:`~pytest_houdini.fixtures.ui.mock_hou_ui` fixture mocks the :mod:`hou.ui` module which does not exist in non-graphical Houdini.

The temporary :mod:`hou.ui` object is removed after the test is completed.

.. code-block::

    def output_message(message):
        hou.ui.displayMessage(message)
        hou.ui.setStatusMessage(message)

    def test_output_message(mock_hou_ui):
        output_message("This is a message")

        mock_hou_ui.displayMessage.assert_called()
        mock_hou_ui.setStatusMessage.assert_called()

        assert hou.ui == mock_hou_ui

set_ui_available
----------------

The :func:`~pytest_houdini.fixtures.ui.set_ui_available` fixture forces the :func:`hou.isUIAvailable()` function to return True. It does **NOT**
handle any mocking of :mod:`hou.ui`, however.

.. code-block:: python

    @pytest.mark.usefixtures("set_ui_available")
    def test_ui_available():
        assert hou.isUIAvailable()