lisa.tests.base.DmesgTestBundle#

class lisa.tests.base.DmesgTestBundle(res_dir, plat_info)[source]#

Bases: DmesgTestBundleBase

Dummy subclass of DmesgTestBundleBase to be inherited from to override OptionalDmesgTestBundle in the inheritance tree.

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

Note

As a subclass of lisa.tests.base.TestBundleBase, this class is considered as “application” and its API is therefore more subject to change than other parts of lisa.

Classes

__class__ inherited

Metaclass of TestBundleBase.

Attributes

ATTRIBUTES_SERIALIZATION inherited

Attributes to be treated specially during serialization.

CANNED_DMESG_IGNORED_PATTERNS inherited

Mapping of canned patterns to avoid repetition while defining lisa.tests.base.DmesgTestBundleBase.DMESG_IGNORED_PATTERNS in subclasses.

DEFAULT_SERIALIZATION_FMT inherited

Default format used when serializing objects.

DMESG_IGNORED_PATTERNS inherited

List of patterns to ignore in addition to the ones passed to test_dmesg().

DMESG_PATH inherited

Path to the dmesg log in the result directory.

VERIFY_SERIALIZATION inherited

When True, this enforces a serialization/deserialization step in from_target().

YAML_ENCODING inherited

Encoding used for YAML files.

Properties

_children_test_bundles inherited

dmesg_entries inherited

List of parsed dmesg output entries devlib.collector.dmesg.KernelLogEntry.

dmesg_path inherited

Path to the dmesg output log file.

logger inherited

Convenience short-hand for self.get_logger().

Methods

test_dmesg()

Basic test on kernel dmesg output.

__copy__() inherited

Regular shallow copy operation, without dropping any attributes.

__getstate__() inherited

Filter the instance’s attributes upon serialization.

__setstate__() inherited

_from_target() inherited

_get_filepath() inherited

add_undecided_filter() inherited

Turn any method returning a ResultBundleBase into a decorator that can be used as a test method filter.

can_create_from_target() inherited
returns:

Whether the given target can be used to create an instance of this class :rtype: bool.

check_from_target() inherited

Check whether the given target can be used to create an instance of this class.

from_dir() inherited

Wrapper around lisa.utils.Serializable.from_path().

from_path() inherited

Deserialize an object from a file.

from_target() inherited

Factory method to create a bundle using a live target.

get_logger() inherited

Provides a logging.Logger named after cls.

get_tags() inherited

Dictionary of tags and tag values.

log_locals() inherited

Debugging aid: log the local variables of the calling function.

to_dir() inherited

See lisa.utils.Serializable.to_path().

to_path() inherited

Serialize the object to a file.

to_yaml() inherited

Return a YAML string with the serialized object.

Classes#

DmesgTestBundle.__class__#

alias of TestBundleMeta

Attributes#

DmesgTestBundle.ATTRIBUTES_SERIALIZATION = {'allowed': [], 'ignored': [], 'placeholders': {}}#

Inherited attribute, see lisa.utils.Serializable.ATTRIBUTES_SERIALIZATION

Attributes to be treated specially during serialization.

DmesgTestBundle.CANNED_DMESG_IGNORED_PATTERNS = {'EAS-schedutil': 'Disabling EAS, schedutil is mandatory', 'executable-stack': 'started with executable stack'}#

Inherited attribute, see lisa.tests.base.DmesgTestBundleBase.CANNED_DMESG_IGNORED_PATTERNS

Mapping of canned patterns to avoid repetition while defining lisa.tests.base.DmesgTestBundleBase.DMESG_IGNORED_PATTERNS in subclasses.

DmesgTestBundle.DEFAULT_SERIALIZATION_FMT = 'yaml'#

Inherited attribute, see lisa.utils.Serializable.DEFAULT_SERIALIZATION_FMT

Default format used when serializing objects.

DmesgTestBundle.DMESG_IGNORED_PATTERNS = ['started with executable stack']#

Inherited attribute, see lisa.tests.base.DmesgTestBundleBase.DMESG_IGNORED_PATTERNS

List of patterns to ignore in addition to the ones passed to test_dmesg().

DmesgTestBundle.DMESG_PATH = 'dmesg.log'#

Inherited attribute, see lisa.tests.base.DmesgTestBundleBase.DMESG_PATH

Path to the dmesg log in the result directory.

DmesgTestBundle.VERIFY_SERIALIZATION = True#

Inherited attribute, see lisa.tests.base.TestBundleBase.VERIFY_SERIALIZATION

When True, this enforces a serialization/deserialization step in from_target().

DmesgTestBundle.YAML_ENCODING = 'utf-8'#

Inherited attribute, see lisa.utils.Serializable.YAML_ENCODING

Encoding used for YAML files.

Properties#

property DmesgTestBundle._children_test_bundles#

Inherited property, see lisa.tests.base.TestBundleBase._children_test_bundles

property DmesgTestBundle.dmesg_entries#

Inherited property, see lisa.tests.base.DmesgTestBundleBase.dmesg_entries

List of parsed dmesg output entries devlib.collector.dmesg.KernelLogEntry.

property DmesgTestBundle.dmesg_path#

Inherited property, see lisa.tests.base.DmesgTestBundleBase.dmesg_path

Path to the dmesg output log file.

property DmesgTestBundle.logger#

Inherited property, see lisa.utils.Loggable.logger

Convenience short-hand for self.get_logger().

Methods#

DmesgTestBundle.test_dmesg(level='warn', facility=None, ignored_patterns: IgnoredPatterns = None) → ResultBundle#

Basic test on kernel dmesg output.

Parameters:

  • level (str) – Any dmesg entr with a level more critical than (and including) that will make the test fail.

  • facility (str or None) – Only select entries emitted by the given dmesg facility like kern. Note that not all versions of dmesg are able to print it, so specifying it may lead to no entry being inspected at all. If None, the facility is ignored.

  • ignored_patterns (list or None) – List of regexes to ignore some messages. The pattern list is combined with DMESG_IGNORED_PATTERNS class attribute.

DmesgTestBundle.__copy__()#

Inherited method, see lisa.utils.Serializable.__copy__()

Regular shallow copy operation, without dropping any attributes.

DmesgTestBundle.__getstate__()#

Inherited method, see lisa.utils.Serializable.__getstate__()

Filter the instance’s attributes upon serialization.

DmesgTestBundle.__setstate__(dct)#

Inherited method, see lisa.utils.Serializable.__setstate__()

abstract classmethod DmesgTestBundle._from_target(target, *, res_dir)#

Inherited method, see lisa.tests.base.TestBundleBase._from_target()

classmethod DmesgTestBundle._get_filepath(res_dir)#

Inherited method, see lisa.tests.base.TestBundleBase._get_filepath()

DmesgTestBundle.add_undecided_filter()#

Inherited method, see lisa.tests.base.TestBundleBase.add_undecided_filter()

Turn any method returning a ResultBundleBase into a decorator that can be used as a test method filter.

classmethod DmesgTestBundle.can_create_from_target(target)#

Inherited method, see lisa.tests.base.TestBundleBase.can_create_from_target()

Returns:

Whether the given target can be used to create an instance of this class :rtype: bool.

classmethod DmesgTestBundle.check_from_target(target)#

Inherited method, see lisa.tests.base.TestBundleBase.check_from_target()

Check whether the given target can be used to create an instance of this class.

classmethod DmesgTestBundle.from_dir(res_dir, update_res_dir=True)#

Inherited method, see lisa.tests.base.TestBundleBase.from_dir()

Wrapper around lisa.utils.Serializable.from_path().

classmethod DmesgTestBundle.from_path(filepath, fmt=None)#

Inherited method, see lisa.utils.Serializable.from_path()

Deserialize an object from a file.

classmethod DmesgTestBundle.from_target(target: Target, *, res_dir: ArtifactPath = None, **kwargs)#

Inherited method, see lisa.tests.base.TestBundleBase.from_target()

Factory method to create a bundle using a live target.

classmethod DmesgTestBundle.get_logger(suffix=None)#

Inherited method, see lisa.utils.Loggable.get_logger()

Provides a logging.Logger named after cls.

DmesgTestBundle.get_tags()#

Inherited method, see lisa.tests.base.TestBundleBase.get_tags()

Dictionary of tags and tag values.

classmethod DmesgTestBundle.log_locals(var_names=None, level='debug')#

Inherited method, see lisa.utils.Loggable.log_locals()

Debugging aid: log the local variables of the calling function.

DmesgTestBundle.to_dir(res_dir)#

Inherited method, see lisa.tests.base.TestBundleBase.to_dir()

See lisa.utils.Serializable.to_path().

DmesgTestBundle.to_path(filepath, fmt=None)#

Inherited method, see lisa.utils.Serializable.to_path()

Serialize the object to a file.

DmesgTestBundle.to_yaml()#

Inherited method, see lisa.utils.Serializable.to_yaml()

Return a YAML string with the serialized object.