:py:mod:`buildtest.utils.tools`
===============================

.. py:module:: buildtest.utils.tools


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


Functions
~~~~~~~~~

.. autoapisummary::

   buildtest.utils.tools.deep_get
   buildtest.utils.tools.checkColor
   buildtest.utils.tools.check_binaries
   buildtest.utils.tools.check_container_runtime



Attributes
~~~~~~~~~~

.. autoapisummary::

   buildtest.utils.tools.logger


.. py:data:: logger

   

.. py:function:: deep_get(dictionary, *keys)


.. py:function:: checkColor(colorArg)

   Checks the provided colorArg against the compatible colors from Rich.Color


.. py:function:: check_binaries(binaries, custom_dirs=None)

   Check if binaries exist in $PATH and any additional directories specified by custom_dirs. The return is a dictionary
   containing the binary name and full path to binary.

   :param binaries: list of binaries to check for existence in $PATH
   :type binaries: list
   :param custom_dirs: list of custom directories to check for binaries. Defaults to None.
   :type custom_dirs: list, optional

   :returns: dictionary containing binary name and full path to binary
   :rtype: dict


.. py:function:: check_container_runtime(platform, configuration)

   Check if container runtime exists in $PATH and any additional directories specified by
   custom_dirs. The return is a dictionary

   :param platform: platform to check for container runtime
   :type platform: str
   :param configuration: configuration dictionary
   :type configuration: dict