:py:mod:`buildtest.main`
========================

.. py:module:: buildtest.main

.. autoapi-nested-parse::

   Entry point for buildtest



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


Functions
~~~~~~~~~

.. autoapisummary::

   buildtest.main.main
   buildtest.main.setup
   buildtest.main.handle_log_viewing
   buildtest.main.handle_build_command
   buildtest.main.handle_buildspec_command
   buildtest.main.handle_inspect_command
   buildtest.main.handle_cdash_command



.. py:function:: main()

   Entry point to buildtest.


.. py:function:: setup(args)

   This function sets up the environment for buildtest.
   This function initializes logging, configuration, and system object.
   This function returns a tuple of system, configuration, buildtest_editor, and report_file.
   This function is called at the beginning of main() function.

   :param args: An argparse namespace object containing command line arguments
   :type args: argparse.Namespace

   :returns: A tuple of system, configuration, buildtest_editor, and report_file
   :rtype: Tuple


.. py:function:: handle_log_viewing(args)

   This function handles the viewing of the log file. If the user specifies --view-log or --print-log, this function will display the log file content and return True.
   If the log file is not present, this function will raise an exception. If the user does not specify --view-log or --print-log, this function will return False.

   :param args: An argparse namespace object containing command line arguments
   :type args: argparse.Namespace

   :returns: Return True if user specifies --view-log or --print-log and implements logic, otherwise return False
   :rtype: bool


.. py:function:: handle_build_command(args, configuration, report_file)


.. py:function:: handle_buildspec_command(args, configuration, report_file, buildtest_editor)


.. py:function:: handle_inspect_command(args, configuration, report_file)


.. py:function:: handle_cdash_command(args, configuration, report_file)