.. title:: OptionalDmesgTestBundle lisa.tests.base.OptionalDmesgTestBundle ======================================= .. autoclass:: lisa.tests.base::OptionalDmesgTestBundle :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.tests.base.DmesgTestBundleBase.CANNED_DMESG_IGNORED_PATTERNS` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.DmesgTestBundleBase Mapping of canned patterns to avoid repetition while defining :attr:`lisa.tests.base.DmesgTestBundleBase.DMESG_IGNORED_PATTERNS` in subclasses. * - :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.DmesgTestBundleBase.DMESG_IGNORED_PATTERNS` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.DmesgTestBundleBase List of patterns to ignore in addition to the ones passed to :meth:`~lisa.tests.base.DmesgTestBundle.test_dmesg`. * - :attr:`~lisa.tests.base.DmesgTestBundleBase.DMESG_PATH` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.DmesgTestBundleBase Path to the dmesg log 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. .. 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.tests.base.DmesgTestBundleBase.dmesg_entries` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.DmesgTestBundleBase List of parsed dmesg output entries :class:`devlib.collector.dmesg.KernelLogEntry`. * - :attr:`~lisa.tests.base.DmesgTestBundleBase.dmesg_path` :sup:`inherited` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.DmesgTestBundleBase Path to the dmesg output log file. * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Convenience short-hand for ``self.get_logger()``. .. rubric:: Methods .. list-table:: :align: left * - :meth:`~lisa.tests.base.OptionalDmesgTestBundle.test_dmesg` - .. withrefctx:: :module: lisa.tests.base :class: lisa.tests.base.OptionalDmesgTestBundle Basic test on kernel dmesg output. * - :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.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::OptionalDmesgTestBundle.__class__ Attributes ---------- .. autoattribute:: lisa.tests.base::OptionalDmesgTestBundle.ATTRIBUTES_SERIALIZATION .. autoattribute:: lisa.tests.base::OptionalDmesgTestBundle.CANNED_DMESG_IGNORED_PATTERNS .. autoattribute:: lisa.tests.base::OptionalDmesgTestBundle.DEFAULT_SERIALIZATION_FMT .. autoattribute:: lisa.tests.base::OptionalDmesgTestBundle.DMESG_IGNORED_PATTERNS .. autoattribute:: lisa.tests.base::OptionalDmesgTestBundle.DMESG_PATH .. autoattribute:: lisa.tests.base::OptionalDmesgTestBundle.VERIFY_SERIALIZATION .. autoattribute:: lisa.tests.base::OptionalDmesgTestBundle.YAML_ENCODING Properties ---------- .. autoproperty:: lisa.tests.base::OptionalDmesgTestBundle._children_test_bundles .. autoproperty:: lisa.tests.base::OptionalDmesgTestBundle.dmesg_entries .. autoproperty:: lisa.tests.base::OptionalDmesgTestBundle.dmesg_path .. autoproperty:: lisa.tests.base::OptionalDmesgTestBundle.logger Methods ------- .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.test_dmesg .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.__copy__ .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.__getstate__ .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.__setstate__ .. automethod:: lisa.tests.base::OptionalDmesgTestBundle._from_target .. automethod:: lisa.tests.base::OptionalDmesgTestBundle._get_filepath .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.add_undecided_filter .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.can_create_from_target .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.check_from_target .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.from_dir .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.from_path .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.from_target .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.get_logger .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.get_tags .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.log_locals .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.to_dir .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.to_path .. automethod:: lisa.tests.base::OptionalDmesgTestBundle.to_yaml