.. title:: base

lisa.tests.base
===============


.. toctree::
   :hidden:

   DmesgTestBundle <lisa.tests.base.DmesgTestBundle>
   DmesgTestBundleBase <lisa.tests.base.DmesgTestBundleBase>
   DmesgTestConf <lisa.tests.base.DmesgTestConf>
   FtraceTestBundle <lisa.tests.base.FtraceTestBundle>
   FtraceTestBundleBase <lisa.tests.base.FtraceTestBundleBase>
   OptionalDmesgTestBundle <lisa.tests.base.OptionalDmesgTestBundle>
   OptionalFtraceTestBundle <lisa.tests.base.OptionalFtraceTestBundle>
   RTATestBundle <lisa.tests.base.RTATestBundle>
   Result <lisa.tests.base.Result>
   TestBundle <lisa.tests.base.TestBundle>
   TestBundleBase <lisa.tests.base.TestBundleBase>
   TestBundleMeta <lisa.tests.base.TestBundleMeta>
   TestConfBase <lisa.tests.base.TestConfBase>
   TestMetric <lisa.tests.base.TestMetric>
   AggregatedResultBundle <lisa.tests.base.AggregatedResultBundle>
   ResultBundle <lisa.tests.base.ResultBundle>
   ResultBundleBase <lisa.tests.base.ResultBundleBase>

.. module:: lisa.tests.base


.. withrefctx::
   :module: lisa.tests.base


   
   .. automodule:: lisa.tests.base
       :no-index:
       :no-members:
       :no-inherited-members:
       :no-undoc-members:
       :no-private-members:
       :no-special-members:
   


.. rubric:: Classes

.. list-table::
   :align: left

   * - :class:`~lisa.tests.base.DmesgTestBundle`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.DmesgTestBundle
      
      
         Dummy subclass of :class:`DmesgTestBundleBase` to be inherited from to override :class:`OptionalDmesgTestBundle` in the inheritance tree.
   * - :class:`~lisa.tests.base.DmesgTestBundleBase`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.DmesgTestBundleBase
      
      
         Abstract Base Class for TestBundles based on dmesg output.
   * - :class:`~lisa.tests.base.DmesgTestConf`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.DmesgTestConf
      
      
         Configuration class for :meth:`lisa.tests.base.DmesgTestBundle.test_dmesg`.
   * - :class:`~lisa.tests.base.FtraceTestBundle`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.FtraceTestBundle
      
      
         Dummy subclass of :class:`FtraceTestBundleBase` to be inherited from to override :class:`OptionalFtraceTestBundle` in the inheritance tree.
   * - :class:`~lisa.tests.base.FtraceTestBundleBase`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.FtraceTestBundleBase
      
      
         Base class for test bundles needing ftrace traces.
   * - :class:`~lisa.tests.base.OptionalDmesgTestBundle`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.OptionalDmesgTestBundle
      
      
         .. warning:: Arbitrary code can be executed while loading an instance from a YAML or Pickle file. To include untrusted data in YAML, use the !untrusted tag along with a string.
   * - :class:`~lisa.tests.base.OptionalFtraceTestBundle`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.OptionalFtraceTestBundle
      
      
         .. warning:: Arbitrary code can be executed while loading an instance from a YAML or Pickle file. To include untrusted data in YAML, use the !untrusted tag along with a string.
   * - :class:`~lisa.tests.base.RTATestBundle`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.RTATestBundle
      
      
         Abstract Base Class for :class:`lisa.wlgen.rta.RTA`-powered TestBundles.
   * - :class:`~lisa.tests.base.Result`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.Result
      
      
         A classification of a test result.
   * - :class:`~lisa.tests.base.TestBundle`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.TestBundle
      
      
         Dummy class used as a base class for all tests.
   * - :class:`~lisa.tests.base.TestBundleBase`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.TestBundleBase
      
      
         A LISA test bundle.
   * - :class:`~lisa.tests.base.TestBundleMeta`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.TestBundleMeta
      
      
         Metaclass of :class:`TestBundleBase`.
   * - :class:`~lisa.tests.base.TestConfBase`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.TestConfBase
      
      
         Base class for test configurations.
   * - :class:`~lisa.tests.base.TestMetric`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.TestMetric
      
      
         A storage class for metrics used by tests.


.. rubric:: Exceptions

.. list-table::
   :align: left

   * - :class:`~lisa.tests.base.AggregatedResultBundle`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.AggregatedResultBundle
      
      
         Aggregates many :class:`ResultBundle` into one.
   * - :class:`~lisa.tests.base.ResultBundle`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.ResultBundle
      
      
         Bundle for storing test results.
   * - :class:`~lisa.tests.base.ResultBundleBase`
     -
      
      .. withrefctx::
         :module: lisa.tests.base
         :class: lisa.tests.base.ResultBundleBase
      
      
         Base class for all result bundles.