:py:mod:`buildtest.executors.local`
===================================

.. py:module:: buildtest.executors.local

.. autoapi-nested-parse::

   This module implements the LocalExecutor class responsible for submitting
   jobs to localhost. This class is called in class BuildExecutor
   when initializing the executors.



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

Classes
~~~~~~~

.. autoapisummary::

   buildtest.executors.local.LocalExecutor




.. py:class:: LocalExecutor(name, settings, site_configs, timeout=None, account=None, maxpendtime=None)


   Bases: :py:obj:`buildtest.executors.base.BaseExecutor`

   The LocalExecutor class is responsible for running tests locally for
   bash, sh, csh and python shell. The LocalExecutor runs the tests and gathers
   the output and error results and writes to file.

   Initiate a base executor, meaning we provide a name (also held
   by the BuildExecutor base that holds it) and the loaded dictionary
   of config opts to parse.

   :param name: name of executor
   :type name: str
   :param setting: setting for a given executor defined in configuration file
   :type setting: dict
   :param site_configs: Instance of SiteConfiguration class
   :type site_configs: buildtest.config.SiteConfiguration
   :param timeout: Test timeout in number of seconds
   :type timeout: str, optional
   :param maxpendtime: Maximum Pending Time until job is cancelled. The default is 1 day (86400s)
   :type maxpendtime: int, optional
   :param account: Account to use for job submission
   :type account: str, optional
   :param maxpendtime: Maximum Pending Time until job is cancelled. The default is 1 day (86400s)
   :type maxpendtime: int, optional

   .. py:attribute:: type
      :value: 'local'

      

   .. py:method:: run(builder)

      This method is responsible for running test for LocalExecutor which
      runs test locally. We keep track of metadata in ``builder.metadata``
      that keeps track of run result. The output and error file
      are written to filesystem.

      :param builder: An instance object of BuilderBase type
      :type builder: buildtest.buildsystem.base.BuilderBase