leapp.reporting package
Module contents
- class leapp.reporting.Audience(value=None)
Bases:
BasePrimitive
Target audience of the report
- name = 'audience'
- class leapp.reporting.BaseListPrimitive(value=None)
Bases:
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
- 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 = ''
- property path
Return report field destination path (nested dict description)
- to_dict()
- property value
Return report field value
- class leapp.reporting.BaseRemediation(value=None)
Bases:
BaseListPrimitive
Remediation base class
- name = 'remediations'
- property path
Return report field destination path (nested dict description)
- class leapp.reporting.ExternalLink(url=None, title=None)
Bases:
BaseListPrimitive
External link report detail field
- name = 'external'
- property path
Return report field destination path (nested dict description)
- class leapp.reporting.Groups(value=None)
Bases:
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'
- name = 'groups'
- class leapp.reporting.Key(uuid)
Bases:
BasePrimitive
Stable identifier for report entries.
- name = 'key'
- class leapp.reporting.RelatedResource(scheme=None, identifier=None)
Bases:
BaseListPrimitive
Report detail field for related resources (e.g. affected packages/files)
- name = 'related_resources'
- property path
Return report field destination path (nested dict description)
- 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:
BaseRemediation
- class leapp.reporting.RemediationHint(value=None)
Bases:
BaseRemediation
- class leapp.reporting.RemediationPlaybook(value=None)
Bases:
BaseRemediation
- class leapp.reporting.Report(init_method='from_initialization', **kwargs)
Bases:
Model
Framework model used for reporting
- fields = {'report': <leapp.models.fields.JSON object>}
fields contains a dictionary with all attributes of the py:class:leapp.models.fields.Field type in the class.
Note: Dynamically added fields are ignored by the framework.
- report = <leapp.models.fields.JSON object>
- topic
alias of
ReportTopic
- class leapp.reporting.Severity(value=None)
Bases:
BasePrimitive
Report severity
- HIGH = 'high'
- INFO = 'info'
- LOW = 'low'
- MEDIUM = 'medium'
- name = 'severity'
- class leapp.reporting.Summary(value=None)
Bases:
BasePrimitive
Report summary
- name = 'summary'
- class leapp.reporting.Title(value=None)
Bases:
BasePrimitive
Report title
- name = 'title'
- 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