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
-
-
class
leapp.reporting.
ExternalLink
(url=None, title=None)¶ 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
(*args, **kwargs)¶ Bases:
leapp.reporting.Groups
-
ACCESSIBILITY
= 'accessibility'¶
-
AUTHENTICATION
= 'authentication'¶
-
BOOT
= 'boot'¶
-
COMMUNICATION
= 'communication'¶
-
DESKTOP
= 'desktop environment'¶
-
DRIVERS
= 'drivers'¶
-
EMAIL
= 'email'¶
-
ENCRYPTION
= 'encryption'¶
-
FAILURE
= 'failure'¶
-
FILESYSTEM
= 'filesystem'¶
-
FIREWALL
= 'firewall'¶
-
HIGH_AVAILABILITY
= 'high availability'¶
-
INHIBITOR
= 'inhibitor'¶
-
KERNEL
= 'kernel'¶
-
MONITORING
= 'monitoring'¶
-
NETWORK
= 'network'¶
-
OS_FACTS
= 'OS facts'¶
-
POST
= 'post'¶
-
PUBLIC_CLOUD
= 'public cloud'¶
-
PYTHON
= 'python'¶
-
REPOSITORY
= 'repository'¶
-
RHUI
= 'rhui'¶
-
SANITY
= 'sanity'¶
-
SECURITY
= 'security'¶
-
SELINUX
= 'selinux'¶
-
SERVICES
= 'services'¶
-
TIME_MANAGEMENT
= 'time management'¶
-
TOOLS
= 'tools'¶
-
UPGRADE_PROCESS
= 'upgrade process'¶
-
apply
(report)¶ Add report entry to the report dict based on provided path
-
name
= 'groups'¶
-
path
¶ Return report field destination path (nested dict description)
-
to_dict
()¶
-
value
¶ Return report field value
-
-
class
leapp.reporting.
Groups
(value=None)¶ Bases:
leapp.reporting.BaseListPrimitive
Report groups.
-
ACCESSIBILITY
= 'accessibility'¶
-
AUTHENTICATION
= 'authentication'¶
-
BOOT
= 'boot'¶
-
COMMUNICATION
= 'communication'¶
-
DESKTOP
= 'desktop environment'¶
-
DRIVERS
= 'drivers'¶
-
EMAIL
= 'email'¶
-
ENCRYPTION
= 'encryption'¶
-
FAILURE
= 'failure'¶
-
FILESYSTEM
= 'filesystem'¶
-
FIREWALL
= 'firewall'¶
-
HIGH_AVAILABILITY
= 'high availability'¶
-
INHIBITOR
= 'inhibitor'¶
-
KERNEL
= 'kernel'¶
-
MONITORING
= 'monitoring'¶
-
NETWORK
= 'network'¶
-
OS_FACTS
= 'OS facts'¶
-
POST
= 'post'¶
-
PUBLIC_CLOUD
= 'public cloud'¶
-
PYTHON
= 'python'¶
-
REPOSITORY
= 'repository'¶
-
RHUI
= 'rhui'¶
-
SANITY
= 'sanity'¶
-
SECURITY
= 'security'¶
-
SELINUX
= 'selinux'¶
-
SERVICES
= 'services'¶
-
TIME_MANAGEMENT
= 'time management'¶
-
TOOLS
= 'tools'¶
-
UPGRADE_PROCESS
= 'upgrade process'¶
-
apply
(report)¶ Add report entry to the report dict based on provided path
-
name
= 'groups'¶
-
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
(*args, **kwargs)¶ Bases:
leapp.reporting.Groups
-
ACCESSIBILITY
= 'accessibility'¶
-
AUTHENTICATION
= 'authentication'¶
-
BOOT
= 'boot'¶
-
COMMUNICATION
= 'communication'¶
-
DESKTOP
= 'desktop environment'¶
-
DRIVERS
= 'drivers'¶
-
EMAIL
= 'email'¶
-
ENCRYPTION
= 'encryption'¶
-
FAILURE
= 'failure'¶
-
FILESYSTEM
= 'filesystem'¶
-
FIREWALL
= 'firewall'¶
-
HIGH_AVAILABILITY
= 'high availability'¶
-
INHIBITOR
= 'inhibitor'¶
-
KERNEL
= 'kernel'¶
-
MONITORING
= 'monitoring'¶
-
NETWORK
= 'network'¶
-
OS_FACTS
= 'OS facts'¶
-
POST
= 'post'¶
-
PUBLIC_CLOUD
= 'public cloud'¶
-
PYTHON
= 'python'¶
-
REPOSITORY
= 'repository'¶
-
RHUI
= 'rhui'¶
-
SANITY
= 'sanity'¶
-
SECURITY
= 'security'¶
-
SELINUX
= 'selinux'¶
-
SERVICES
= 'services'¶
-
TIME_MANAGEMENT
= 'time management'¶
-
TOOLS
= 'tools'¶
-
UPGRADE_PROCESS
= 'upgrade process'¶
-
apply
(report)¶ Add report entry to the report dict based on provided path
-
name
= 'groups'¶
-
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