tests.conftest
==============

.. py:module:: tests.conftest


Attributes
----------

.. autoapisummary::

   tests.conftest.logger


Functions
---------

.. autoapisummary::

   tests.conftest.pytest_configure
   tests.conftest.cfg
   tests.conftest.auto_platform_config_data
   tests.conftest.platform_bundle
   tests.conftest.platform_driver
   tests.conftest.session_manager
   tests.conftest.platform_name
   tests.conftest.platform_base_obj
   tests.conftest.pytest_addoption


Module Contents
---------------

.. py:data:: logger

.. py:function:: pytest_configure(config)

   Configure pytest logging and conditionally load target plugins.

   :param config: Pytest configuration object.
   :returns: None.


.. py:function:: cfg(pytestconfig)

   Load the YAML configuration once per test session.

   :param pytestconfig: Pytest configuration object.
   :returns: Parsed :class:`Config` instance.


.. py:function:: auto_platform_config_data(pytestconfig, cfg)

   Resolve and return the selected platform dictionary from the YAML config.

   :param pytestconfig: Pytest configuration object.
   :param cfg: Parsed configuration object.
   :returns: Platform configuration dictionary.


.. py:function:: platform_bundle(pytestconfig, cfg, auto_platform_config_data)

   Build the platform bundle once from the config.

   :param pytestconfig: Pytest configuration object.
   :param cfg: Parsed configuration object.
   :param auto_platform_config_data: Platform configuration dictionary.
   :returns: Yields an initialized :class:`DriverBundle`.


.. py:function:: platform_driver(platform_bundle)

   Provide the platform driver object for tests.

   :param platform_bundle: Initialized driver bundle.
   :returns: Driver instance from the bundle.


.. py:function:: session_manager(platform_bundle)

   Provide the session/console manager for tests.

   :param platform_bundle: Initialized driver bundle.
   :returns: Session manager object.


.. py:function:: platform_name(platform_base_obj, cfg)

   Normalize the selected platform name to a canonical short name.

   :param platform_base_obj: Initialized :class:`AutoTestPlatformBase`.
   :param cfg: Parsed configuration object.
   :returns: Canonical name like ``'aspne'``.


.. py:function:: platform_base_obj(session_manager, auto_platform_config_data, pytestconfig)

   Construct the base platform helper object once per session.

   :param session_manager: Session/console manager instance.
   :param auto_platform_config_data: Platform configuration dictionary.
   :param pytestconfig: Pytest configuration object.
   :returns: Initialized :class:`AutoTestPlatformBase` instance.


.. py:function:: pytest_addoption(parser)

   Register custom CLI options used by the test framework.

   :param parser: Pytest argument parser.
   :returns: None.