inet.test.smoke
===============

.. py:module:: inet.test.smoke

.. autoapi-nested-parse::

   This module provides functionality for smoke testing of multiple simulations.

   The main function is :py:func:`run_smoke_tests`. It allows running multiple smoke tests matching the
   provided filter criteria. Smoke tests check if simulations run without crashing and terminate properly.



Classes
-------

.. toctree::
   :hidden:

   /python-api/inet/test/smoke/SmokeTestTask

.. autoapisummary::

   inet.test.smoke.SmokeTestTask


Functions
---------

.. autoapisummary::

   inet.test.smoke.get_smoke_test_tasks
   inet.test.smoke.run_smoke_tests


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

.. py:function:: get_smoke_test_tasks(cpu_time_limit='1s', run_number=0, **kwargs)

   Returns multiple smoke test tasks matching the provided filter criteria. The returned tasks can be run by calling
   the :py:meth:`run <inet.common.task.MultipleTasks.run>` method.

   :param kwargs: The filter criteria parameters are inherited from the :py:meth:`get_simulation_tasks <inet.simulation.task.get_simulation_tasks>` method.
   :type kwargs: dict

   Returns (:py:class:`MultipleSimulationTestTasks <inet.test.simulation.MultipleSimulationTestTasks>`):
       an object that contains a list of :py:class:`SimulationTestTask <inet.test.simulation.SimulationTestTask>` objects matching the provided filter criteria.
       The result can be run (and re-run) without providing additional parameters.


.. py:function:: run_smoke_tests(**kwargs)

   Runs one or more smoke tests that match the provided filter criteria.

   :param kwargs: The filter criteria parameters are inherited from the :py:func:`get_smoke_test_tasks` function.
   :type kwargs: dict

   Returns (:py:class:`MultipleTestTaskResults <inet.test.task.MultipleTestTaskResults>`):
       an object that contains a list of :py:class:`SimulationTestTaskResult <inet.test.simulation.SimulationTestTaskResult>` objects. Each object describes the result of running one test task.