Add baculacheck actor

[pcahyna]

Check whether bacula-director is installed and informs about the necessary conversion of Bacula catalog after upgrade.

Copied from the checkpostgresql and checkmariadb actors.

Note: this was unit-tested, but not integration tested. I tried to follow the procedure for running actors, but that's what I got:
First I tried to run redhatsignedrpmscanner, as my actor requires the list of signed RPMs

cd  repos/system_upgrade/el8toel9/
snactor run --verbose --print-output redhatsignedrpmscanner

this failed:

2022-05-12 12:23:58.109 INFO     PID: 19987 leapp: Logging has been initialized
2022-05-12 12:23:58.127 INFO     PID: 19987 leapp.repository.system_upgrade_el8toel9: A new repository 'system_upgrade_el8toel9' is initialized at /root/leapp-repository/repos/system_upgrade/el8toel9
2022-05-12 12:23:58.753 INFO     PID: 19987 leapp.repository.common: A new repository 'common' is initialized at /usr/share/leapp-repository/repositories/common
2022-05-12 12:23:58.784 INFO     PID: 19987 leapp.repository.system_upgrade_common: A new repository 'system_upgrade_common' is initialized at /usr/share/leapp-repository/repositories/system_upgrade/common
Process Process-128:
Traceback (most recent call last):
  File "/usr/lib64/python3.6/multiprocessing/process.py", line 258, in _bootstrap
    self.run()
  File "/usr/lib64/python3.6/multiprocessing/process.py", line 93, in run
    self._target(*self._args, **self._kwargs)
  File "/usr/lib/python3.6/site-packages/leapp/repository/actor_definition.py", line 72, in _do_run
    actor_instance.run(*args, **kwargs)
  File "/usr/lib/python3.6/site-packages/leapp/actors/__init__.py", line 289, in run
    self.process(*args)
  File "/usr/share/leapp-repository/repositories/system_upgrade/common/actors/redhatsignedrpmscanner/actor.py", line 29, in process
    env_vars = self.configuration.leapp_env_vars
  File "/usr/lib/python3.6/site-packages/leapp/actors/__init__.py", line 149, in configuration
    raise WorkflowConfigNotAvailable(self.name)
leapp.exceptions.WorkflowConfigNotAvailable: Actor red_hat_signed_rpm_scanner relies on workflow configuration model which must be produced by a specific actor


===========================================================================================================
Actor red_hat_signed_rpm_scanner unexpectedly terminated with exit code: 1 - Please check the above details
===========================================================================================================

it seems that it requires workflow config, so I attempted to follow https://leapp.readthedocs.io/en/latest/el7toel8/actor-rhel7-to-rhel8.html#executing-a-single-actor-that-uses-the-workflow-config :

snactor run --save-output IPUWorkflowConfig

and it failed with

Process Process-128:
Traceback (most recent call last):
  File "/usr/lib64/python3.6/multiprocessing/process.py", line 258, in _bootstrap
    self.run()
  File "/usr/lib64/python3.6/multiprocessing/process.py", line 93, in run
    self._target(*self._args, **self._kwargs)
  File "/usr/lib/python3.6/site-packages/leapp/repository/actor_definition.py", line 72, in _do_run
    actor_instance.run(*args, **kwargs)
  File "/usr/lib/python3.6/site-packages/leapp/actors/__init__.py", line 289, in run
    self.process(*args)
  File "/usr/share/leapp-repository/repositories/system_upgrade/common/actors/ipuworkflowconfig/actor.py", line 19, in process
    ipuworkflowconfig.produce_ipu_config(self)
  File "/usr/share/leapp-repository/repositories/system_upgrade/common/actors/ipuworkflowconfig/libraries/ipuworkflowconfig.py", line 77, in produce_ipu_config
    target=target_version
  File "/usr/lib/python3.6/site-packages/leapp/models/__init__.py", line 90, in __init__
    getattr(defined_fields[field], init_method)(kwargs, field, self)
  File "/usr/lib/python3.6/site-packages/leapp/models/fields/__init__.py", line 110, in from_initialization
    self._validate_model_value(value=source_value, name=name)
  File "/usr/lib/python3.6/site-packages/leapp/models/fields/__init__.py", line 179, in _validate_model_value
    super(BuiltinField, self)._validate_model_value(value, name)
  File "/usr/lib/python3.6/site-packages/leapp/models/fields/__init__.py", line 60, in _validate_model_value
    raise ModelViolationError('The value of "{name}" field is None, but this is not allowed'.format(name=name))
leapp.models.fields.ModelViolationError: The value of "target" field is None, but this is not allowed


====================================================================================================
Actor ipu_workflow_config unexpectedly terminated with exit code: 1 - Please check the above details
====================================================================================================

If you are able to actually run the actor (preferably on asystem where bacula-director is installed), I would be glad to see the results.

[github-actions]

Thank you for contributing to the Leapp project!

Please note that every PR needs to comply with the Leapp Guidelines and must pass all tests in order to be mergable.
If you want to request a review or rebuild a package in copr, you can use following commands as a comment:

• review please to notify leapp developers of review request
• /packit copr-build to submit a public copr build using packit

To launch regression testing public members of oamg organization can leave the following comment:

• /rerun to schedule tests using this pr build and leappmaster as artifacts
• /rerun 42 to schedule tests using this pr build and leappPR42 as artifacts

Please open ticket in case you experience technical problem with the CI. (RH internal only)

Note: In case there are problems with tests not being triggered automatically on new PR/commit or pending for a long time, please consider rerunning the CI by commenting leapp-ci build (might require several comments). If the problem persists, contact leapp-infra.

[leapp-bot]

This PR has been linked in issue tracker (#OAMG-6897).

[fernflower]

@pcahyna Hi, this looks similar to #864 (comment)

Could you try setting env variables before running snactor? For example, for rhel8to9 upgrade it will be

export LEAPP_UPGRADE_PATH_TARGET_RELEASE=9.0
export LEAPP_UPGRADE_PATH_FLAVOUR=default

[pcahyna]

@fernflower thank you, that worked. After installing bacula-director and saving output from IPUWorkflowConfig, rpmscanner and redhatsignedrpmscanner, my actor outputs this

[
  {
    "type": "Report",
    "actor": "bacula_check",
    "topic": "report_topic",
    "stamp": "2022-05-23T09:49:21.496915Z",
    "phase": "NON-WORKFLOW-EXECUTION",
    "context": "986b4b22-b020-48c7-8fa3-3170ef385907",
    "hostname": "(...)",
    "message": {
      "data": "{\"report\": \"{\\\"audience\\\": \\\"sysadmin\\\", \\\"detail\\\": {\\\"related_resources\\\": [{\\\"scheme\\\": \\\"package\\\", \\\"title\\\": \\\"bacula-director\\\"}], \\\"remediations\\\": [{\\\"context\\\": \\\"Back up your data before proceeding with the upgrade and use the /usr/libexec/bacula/update_bacula_tables <dbtype> to upgrade the Bacula dadabase after the system upgrade. The value of <dbtype> depends on the database backend, possible values are sqlite3, mysql, postgresql.\\\", \\\"type\\\": \\\"hint\\\"}]}, \\\"key\\\": \\\"55cdaa415c408e2a0a784b99d3151db12ff8aac2\\\", \\\"severity\\\": \\\"medium\\\", \\\"summary\\\": \\\"Bacula director component will be upgraded. Since RHEL-9 includes Bacula director 11, which is incompatible with version 9 included in RHEL-8, it is necessary to proceed with additional steps for the complete upgrade of the Bacula backup database.\\\", \\\"tags\\\": [\\\"services\\\"], \\\"title\\\": \\\"bacula (bacula-director) has been detected on your system\\\"}\"}",
      "hash": "3e70e24273985f444031e4808d7cef5746bda64fab4772ebc15f4c9fc270b8cc"
    }
  }
]

which is what I expect, although the message could be probably tweaked a bit (amend the /usr/libexec/bacula/update_bacula_tables <dbtype> to the /usr/libexec/bacula/update_bacula_tables <dbtype> command and perhaps markup /usr/libexec/bacula/update_bacula_tables <dbtype> as verbatim/command, if the report supports any kind of markup).

[fernflower]

Great, thanks for update! I will add a comment to the issue oamg/leapp#771 we have, we will cover it in the upstream docs.

[pcahyna]

I also think the actor could be moved to common and be used also for RHEL 7 -> RHEL 8 upgrades, where the same issue needs to be resolved. It would require rewriting the message "Since RHEL-9 includes Bacula director 11, which is incompatible with version 9 included in RHEL-8" to something more generic, or parameterize it.

[Rezney]

@pcahyna If you believe the actor is useful for both paths, please go ahead and move it to the common with more generic message. Thank you.

[fernflower]

/rerun

[github-actions]

Copr build succeeded: https://copr.fedorainfracloud.org/coprs/build/4505642

[github-actions]

Testing Farm request for RHEL-8.6.0-Nightly/4505642 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[github-actions]

Testing Farm request for RHEL-7.9-rhui/4505642 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[github-actions]

Testing Farm request for RHEL-7.9-ZStream/4505642 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[fernflower]

@pcahyna Could you please rebase against master and run make lint_fix? This should make linter happy.

[fernflower]

Please rebase and run lint_fix, otherwise lgtm.

[fernflower]

/rerun

[pcahyna]

I made the message version-independent:

Bacula director component will be upgraded. Since the upgraded RHEL release includes Bacula director that is incompatible with the version included in the previous RHEL release, it is necessary to proceed with additional steps for the complete upgrade of the Bacula backup database.

perhaps it would be simpler to say "Bacula director component will be upgraded. Since the new version is incompatible with the current version, it is necessary to proceed with additional steps for the complete upgrade of the Bacula backup database." WDYT?

[github-actions]

Copr build succeeded: https://copr.fedorainfracloud.org/coprs/build/4695277

[github-actions]

Testing Farm request for RHEL-8.6-rhui/4695277 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[fernflower]

leapp preupgrade left me with the following bacula-related info in reports:

leapp-report.json

{
  "entries": [
    {
      "audience": "sysadmin",
      "detail": {
        "related_resources": [
          {
            "scheme": "package",
            "title": "bacula-director"
          }
        ],
        "remediations": [
          {
            "context": "Back up your data before proceeding with the upgrade and use the command \"/usr/libexec/bacula/update_bacula_tables <dbtype>\" to upgrade the Bacula database after the system upgrade. The value of <dbtype> depends on the database backend, possible values are sqlite3, mysql, postgresql.",
            "type": "hint"
          }
        ]
      },
      "key": "55cdaa415c408e2a0a784b99d3151db12ff8aac2",
      "severity": "medium",
      "summary": "Bacula director component will be upgraded. Since the upgraded RHEL release includes Bacula director that is incompatible with the version included in the previous RHEL release, it is necessary to proceed with additional steps for the complete upgrade of the Bacula backup database.",
      "title": "bacula (bacula-director) has been detected on your system",
      "timeStamp": "2022-08-01T14:39:26.096784Z",
      "hostname": "ci-vm-10-0-137-194.hosted.upshift.rdu2.redhat.com",
      "actor": "bacula_check",
      "id": "cee6515aef49d0776adc41f4ca1cc3cfecf26902c5075d7d14ca96d809c352b4",
      "flags": [],
      "tags": [
        "services"
      ]
    },

leapp-report.txt

Risk Factor: medium
Title: bacula (bacula-director) has been detected on your system
Summary: Bacula director component will be upgraded. Since the upgraded RHEL release includes Bacula director that is incompatible with the version included in the previous RHEL release, it is necessary to proceed with additional steps for the complete upgrade of the Bacula backup database.
Remediation: [hint] Back up your data before proceeding with the upgrade and use the command "/usr/libexec/bacula/update_bacula_tables <dbtype>" to upgrade the Bacula database after the system upgrade. The value of <dbtype> depends on the database backend, possible values are sqlite3, mysql, postgresql.
Key: 55cdaa415c408e2a0a784b99d3151db12ff8aac2

@pcahyna If this seems valid from your POV I am happy to merge this PR as soon as our regression tests succeed.

[fernflower]

lgtm, waiting for regression testing results

[github-actions]

Testing Farm request for RHEL-7.9-rhui/4695277 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[pcahyna]

@fernflower see #896 (comment) , any opinion please? I would change the message before merging.

[github-actions]

Testing Farm request for RHEL-8.6.0-Nightly/4695277 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[fernflower]

@pirat89 I am wondering if time has come to introduce the brand new Groups.POST group here https://github.com/oamg/leapp/blob/master/leapp/reporting/__init__.py#L143 ? WDYT?

[pirat89]

that's a question. it's mixing work that is supposed to be done prior the upgrade and after the upgrade, however POST group should refer just to work supposed to be done after the upgrade.

[pcahyna]

well it will be common to do work both before and after the upgrade: back up your stuff before in case the conversion goes wrong and convert it to an incompatible format after.

[fernflower]

@pirat89 I'd say we are not ready to introduce Groups.POST yet - we should first take care of our contributors' guidelines and explain, how we expect this group to be used.
So I'd leave this PR as is.

[github-actions]

Testing Farm request for RHEL-7.9-ZStream/4695277 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[pcahyna]

@fernflower from my POV the output looks good.

[fernflower]

lgtm. @pirat89 let's merge?

[fernflower]

/rerun

[github-actions]

Copr build succeeded: https://copr.fedorainfracloud.org/coprs/build/4696709

[github-actions]

Testing Farm request for RHEL-8.6-rhui/4696709 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[github-actions]

Testing Farm request for RHEL-7.9-rhui/4696709 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[github-actions]

Testing Farm request for RHEL-8.6.0-Nightly/4696709 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.

[github-actions]

Testing Farm request for RHEL-7.9-ZStream/4696709 regression testing has been created.
Once finished, results should be available here.
Full pipeline log.