leapp.reporting package

Module contents

class leapp.reporting.Audience(value=None)

Bases: leapp.reporting.BasePrimitive

Target audience of the report

apply(report)

Add report entry to the report dict based on provided path

name = 'audience'
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

class leapp.reporting.BaseListPrimitive(value=None)

Bases: leapp.reporting.BasePrimitive

Report primitive (field) base class for list targets (we append value to a list)

apply(report)

Add report entry to the report dict based on provided path

name = ''
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

class leapp.reporting.BasePrimitive(value=None)

Bases: object

Report primitive (field) base class for dict targets (implies unique path)

apply(report)

Add report entry to the report dict based on provided path

name = ''
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

class leapp.reporting.BaseRemediation(value=None)

Bases: leapp.reporting.BaseListPrimitive

Remediation base class

apply(report)

Add report entry to the report dict based on provided path

name = 'remediations'
path
to_dict()
value

Return report field value

Bases: leapp.reporting.BaseListPrimitive

External link report detail field

apply(report)

Add report entry to the report dict based on provided path

name = 'external'
path
to_dict()
value

Return report field value

class leapp.reporting.Flags(value=None)

Bases: leapp.reporting.BasePrimitive

Report flags

FAILURE = 'failure'
INHIBITOR = 'inhibitor'
apply(report)

Add report entry to the report dict based on provided path

name = 'flags'
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

class leapp.reporting.Key(uuid)

Bases: leapp.reporting.BasePrimitive

Stable identifier for report entries.

apply(report)

Add report entry to the report dict based on provided path

name = 'key'
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

class leapp.reporting.RelatedResource(scheme=None, identifier=None)

Bases: leapp.reporting.BaseListPrimitive

Report detail field for related resources (e.g. affected packages/files)

apply(report)

Add report entry to the report dict based on provided path

name = 'related_resources'
path
to_dict()
value

Return report field value

class leapp.reporting.Remediation(playbook=None, commands=None, hint=None)

Bases: object

apply(report)
classmethod from_dict(data)
to_dict()
class leapp.reporting.RemediationCommand(value=None)

Bases: leapp.reporting.BaseRemediation

apply(report)

Add report entry to the report dict based on provided path

name = 'remediations'
path
to_dict()
value

Return report field value

class leapp.reporting.RemediationHint(value=None)

Bases: leapp.reporting.BaseRemediation

apply(report)

Add report entry to the report dict based on provided path

name = 'remediations'
path
to_dict()
value

Return report field value

class leapp.reporting.RemediationPlaybook(value=None)

Bases: leapp.reporting.BaseRemediation

apply(report)

Add report entry to the report dict based on provided path

name = 'remediations'
path
to_dict()
value

Return report field value

class leapp.reporting.Report(init_method='from_initialization', **kwargs)

Bases: leapp.models.Model

Framework model used for reporting

create(data)

Create an instance of this class and use the data to initialize the fields within.

Parameters:data (dict) – Data to initialize the Model from deserialized data
Returns:Instance of this class
dump()

Dumps the data in the dictionary form that is safe to serialize to JSON.

Returns:dict with a builtin representation of the data that can be safely serialized to JSON
fields = {'report': <leapp.models.fields.JSON object>}
report = <leapp.models.fields.JSON object>
serialize()

Returns serialized data of the model

topic

alias of ReportTopic

class leapp.reporting.Severity(value=None)

Bases: leapp.reporting.BasePrimitive

Report severity

HIGH = 'high'
INFO = 'info'
LOW = 'low'
MEDIUM = 'medium'
apply(report)

Add report entry to the report dict based on provided path

name = 'severity'
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

class leapp.reporting.Summary(value=None)

Bases: leapp.reporting.BasePrimitive

Report summary

apply(report)

Add report entry to the report dict based on provided path

name = 'summary'
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

class leapp.reporting.Tags(value=None)

Bases: leapp.reporting.BasePrimitive

Report tags

ACCESSIBILITY = <leapp.reporting._Value object>
AUTHENTICATION = <leapp.reporting._Value object>
BOOT = <leapp.reporting._Value object>
COMMUNICATION = <leapp.reporting._Value object>
DESKTOP = <leapp.reporting._Value object>
DRIVERS = <leapp.reporting._Value object>
EMAIL = <leapp.reporting._Value object>
ENCRYPTION = <leapp.reporting._Value object>
FILESYSTEM = <leapp.reporting._Value object>
FIREWALL = <leapp.reporting._Value object>
HIGH_AVAILABILITY = <leapp.reporting._Value object>
KERNEL = <leapp.reporting._Value object>
MONITORING = <leapp.reporting._Value object>
NETWORK = <leapp.reporting._Value object>
OS_FACTS = <leapp.reporting._Value object>
PUBLIC_CLOUD = <leapp.reporting._Value object>
PYTHON = <leapp.reporting._Value object>
REPOSITORY = <leapp.reporting._Value object>
RHUI = <leapp.reporting._Value object>
SANITY = <leapp.reporting._Value object>
SECURITY = <leapp.reporting._Value object>
SELINUX = <leapp.reporting._Value object>
SERVICES = <leapp.reporting._Value object>
TIME_MANAGEMENT = <leapp.reporting._Value object>
TOOLS = <leapp.reporting._Value object>
UPGRADE_PROCESS = <leapp.reporting._Value object>
apply(report)

Add report entry to the report dict based on provided path

name = 'tags'
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

class leapp.reporting.Title(value=None)

Bases: leapp.reporting.BasePrimitive

Report title

apply(report)

Add report entry to the report dict based on provided path

name = 'title'
path

Return report field destination path (nested dict description)

to_dict()
value

Return report field value

leapp.reporting.create_report(entries)

Produce final report message

leapp.reporting.create_report_from_deprecation(deprecation)

Convert deprecation json to report json

leapp.reporting.create_report_from_error(error_dict)

Convert error json to report json