.. title:: OptionalFtraceTestBundle lisa.tests.base.OptionalFtraceTestBundle ======================================== .. autoclass:: lisa.tests.base::OptionalFtraceTestBundle :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Classes .. list-table:: :align: left * - :class:`~lisa.tests.base.TestBundleBase.__class__` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase.__class__ Metaclass of :class:`TestBundleBase`. .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~lisa.utils.Serializable.ATTRIBUTES_SERIALIZATION` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Attributes to be treated specially during serialization. * - :attr:`~lisa.utils.Serializable.DEFAULT_SERIALIZATION_FMT` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Default format used when serializing objects. * - :attr:`~lisa.tests.base.OptionalFtraceTestBundle.FTRACE_CONF` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.OptionalFtraceTestBundle * - :attr:`~lisa.tests.base.FtraceTestBundleBase.TRACE_PATH` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.FtraceTestBundleBase Path to the ``trace-cmd`` trace.dat file in the result directory. * - :attr:`~lisa.tests.base.TestBundleBase.VERIFY_SERIALIZATION` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase When True, this enforces a serialization/deserialization step in :meth:`from_target`. * - :attr:`~lisa.utils.Serializable.YAML_ENCODING` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Encoding used for YAML files. * - :attr:`~lisa.tests.base.OptionalFtraceTestBundle.ftrace_conf` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.OptionalFtraceTestBundle .. rubric:: Properties .. list-table:: :align: left * - :attr:`~lisa.tests.base.TestBundleBase._children_test_bundles` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Convenience short-hand for ``self.get_logger()``. * - :attr:`~lisa.tests.base.FtraceTestBundleBase.trace` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.FtraceTestBundleBase The :class:`~lisa.trace.Trace` for the collected trace.dat file. * - :attr:`~lisa.tests.base.FtraceTestBundleBase.trace_path` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.FtraceTestBundleBase Path to the ``trace-cmd report`` trace.dat file. .. rubric:: Methods .. list-table:: :align: left * - :meth:`~lisa.utils.Serializable.__copy__` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Regular shallow copy operation, without dropping any attributes. * - :meth:`~lisa.utils.Serializable.__getstate__` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Filter the instance's attributes upon serialization. * - :meth:`~lisa.utils.Serializable.__setstate__` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable * - :meth:`~lisa.tests.base.TestBundleBase._from_target` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase * - :meth:`~lisa.tests.base.TestBundleBase._get_filepath` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase * - :meth:`~lisa.tests.base.TestBundleBase.add_undecided_filter` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase Turn any method returning a :class:`ResultBundleBase` into a decorator that can be used as a test method filter. * - :meth:`~lisa.tests.base.TestBundleBase.can_create_from_target` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase :returns: Whether the given target can be used to create an instance of this class :rtype: bool. * - :meth:`~lisa.tests.base.TestBundleBase.check_from_target` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase Check whether the given target can be used to create an instance of this class. * - :meth:`~lisa.tests.base.TestBundleBase.from_dir` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase Wrapper around :meth:`lisa.utils.Serializable.from_path`. * - :meth:`~lisa.utils.Serializable.from_path` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Deserialize an object from a file. * - :meth:`~lisa.tests.base.TestBundleBase.from_target` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase Factory method to create a bundle using a live target. * - :meth:`~lisa.utils.Loggable.get_logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Provides a :class:`logging.Logger` named after ``cls``. * - :meth:`~lisa.tests.base.TestBundleBase.get_tags` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase Dictionary of tags and tag values. * - :meth:`~lisa.tests.base.FtraceTestBundleBase.get_trace` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.FtraceTestBundleBase :returns: a :class:`lisa.trace.Trace` collected in the standard location. * - :meth:`~lisa.utils.Loggable.log_locals` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Debugging aid: log the local variables of the calling function. * - :meth:`~lisa.tests.base.TestBundleBase.to_dir` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.TestBundleBase See :meth:`lisa.utils.Serializable.to_path`. * - :meth:`~lisa.utils.Serializable.to_path` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Serialize the object to a file. * - :meth:`~lisa.utils.Serializable.to_yaml` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Serializable Return a YAML string with the serialized object. Classes ------- .. autoclass:: lisa.tests.base::OptionalFtraceTestBundle.__class__ Attributes ---------- .. autoattribute:: lisa.tests.base::OptionalFtraceTestBundle.ATTRIBUTES_SERIALIZATION .. autoattribute:: lisa.tests.base::OptionalFtraceTestBundle.DEFAULT_SERIALIZATION_FMT .. autoattribute:: lisa.tests.base::OptionalFtraceTestBundle.FTRACE_CONF .. autoattribute:: lisa.tests.base::OptionalFtraceTestBundle.TRACE_PATH .. autoattribute:: lisa.tests.base::OptionalFtraceTestBundle.VERIFY_SERIALIZATION .. autoattribute:: lisa.tests.base::OptionalFtraceTestBundle.YAML_ENCODING .. autoattribute:: lisa.tests.base::OptionalFtraceTestBundle.ftrace_conf Properties ---------- .. autoproperty:: lisa.tests.base::OptionalFtraceTestBundle._children_test_bundles .. autoproperty:: lisa.tests.base::OptionalFtraceTestBundle.logger .. autoproperty:: lisa.tests.base::OptionalFtraceTestBundle.trace .. autoproperty:: lisa.tests.base::OptionalFtraceTestBundle.trace_path Methods ------- .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.__copy__ .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.__getstate__ .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.__setstate__ .. automethod:: lisa.tests.base::OptionalFtraceTestBundle._from_target .. automethod:: lisa.tests.base::OptionalFtraceTestBundle._get_filepath .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.add_undecided_filter .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.can_create_from_target .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.check_from_target .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.from_dir .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.from_path .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.from_target .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.get_logger .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.get_tags .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.get_trace .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.log_locals .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.to_dir .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.to_path .. automethod:: lisa.tests.base::OptionalFtraceTestBundle.to_yaml