el8to9: actors: mysql: Add MySQL actor with recommendations

Checks if `mysql-server` package is installed and if so provide
recommendations for upgrade.

Author: SlouchyButton

repos/system_upgrade/el8toel9/actors/mysqlcheck/actor.py

@@ -0,0 +1,20 @@
+from leapp.actors import Actor
+from leapp.libraries.actor.mysqlcheck import report_installed_packages
+from leapp.models import DistributionSignedRPM, Report
+from leapp.tags import ChecksPhaseTag, IPUWorkflowTag
+
+
+class MySQLCheck(Actor):
+    """
+    Actor checking for presence of MySQL installation.
+
+    Provides user with information related to upgrading systems
+    with MySQL installed.
+    """
+    name = 'mysql_check'
+    consumes = (DistributionSignedRPM,)
+    produces = (Report,)
+    tags = (ChecksPhaseTag, IPUWorkflowTag)
+
+    def process(self):
+        report_installed_packages()

repos/system_upgrade/el8toel9/actors/mysqlcheck/libraries/mysqlcheck.py

@@ -0,0 +1,61 @@
+from leapp import reporting
+from leapp.libraries.common.rpms import has_package
+from leapp.libraries.stdlib import api
+from leapp.models import DistributionSignedRPM
+
+# Summary for mysql-server report
+# TODO: Fix versions
+report_server_inst_summary = (
+    'MySQL server component will be reinstalled during upgrade with RHEL 9 version. '
+    'Since RHEL 9 includes the same version by default, no action should be '
+    'needed and there shouldn\'t be any compatibility issues. It is still advisable '
+    'to follow documentation/article on this topic for up to date recommendations. '
+    'Keep in mind that MySQL version 8.0, which is present as a default in RHEL 9, '
+    'will go out of the \'Extended Support\' in April 2026. MySQL 8.4 will be '
+    'provided in RHEL 9 via module, and it is advisable to upgrade to that version. '
+    'MySQL 8.4 is also the default version for RHEL 10, so having the MySQL 8.4 '
+    'on RHEL 9 system will make the process of upgrading to RHEL 10 even smoother.'
+)
+
+report_server_inst_hint = (
+    'Dump or backup your data before proceeding with the upgrade '
+    'and consult attached article '
+    '\'Migrating MySQL databases from RHEL 8 to RHEL 9\' '
+    'with up to date recommended steps before and after the upgrade.'
+)
+
+# TODO: Replace with mysql-report
+# Link URL for mysql-server report
+report_server_inst_link_url = 'https://access.redhat.com/articles/7099753'
+
+
+def _report_server_installed():
+    """
+    Create report on mysql-server package installation detection.
+
+    Should remind user about present MySQL server package
+    installation, warn them about necessary additional steps, and
+    redirect them to online documentation for the upgrade process.
+    """
+    reporting.create_report([
+        reporting.Title('Further action to upgrade MySQL might be needed'),
+        reporting.Summary(report_server_inst_summary),
+        reporting.Severity(reporting.Severity.MEDIUM),
+        reporting.Groups([reporting.Groups.SERVICES]),
+        reporting.ExternalLink(title='Migrating MySQL databases from RHEL 8 to RHEL 9',
+                               url=report_server_inst_link_url),
+        reporting.RelatedResource('package', 'mysql-server'),
+        reporting.Remediation(hint=report_server_inst_hint),
+        ])
+
+
+def report_installed_packages(_context=api):
+    """
+    Create reports according to detected MySQL packages.
+
+    Create the report if the mysql-server rpm (RH signed) is installed.
+    """
+    has_server = has_package(DistributionSignedRPM, 'mysql-server', context=_context)
+
+    if has_server:
+        _report_server_installed()

repos/system_upgrade/el8toel9/actors/mysqlcheck/tests/test_mysqlcheck.py

@@ -0,0 +1,65 @@
+import pytest
+
+from leapp import reporting
+from leapp.libraries.actor.mysqlcheck import report_installed_packages
+from leapp.libraries.common.testutils import create_report_mocked, CurrentActorMocked
+from leapp.libraries.stdlib import api
+from leapp.models import DistributionSignedRPM, RPM
+
+
+def _generate_rpm_with_name(name):
+    """
+    Generate new RPM model item with given name.
+
+    Parameters:
+        name (str): rpm name
+
+    Returns:
+        rpm  (RPM): new RPM object with name parameter set
+    """
+    return RPM(name=name,
+               version='0.1',
+               release='1.sm01',
+               epoch='1',
+               pgpsig='RSA/SHA256, Mon 01 Jan 1970 00:00:00 AM -03, Key ID 199e2f91fd431d51',
+               packager='Red Hat, Inc. <http://bugzilla.redhat.com/bugzilla>',
+               arch='noarch')
+
+
+@pytest.mark.parametrize('has_server', [
+    (True),  # with server
+    (False),  # without server
+])
+def test_actor_execution(monkeypatch, has_server):
+    """
+    Parametrized helper function for test_actor_* functions.
+
+    First generate list of RPM models based on set arguments. Then, run
+    the actor fed with our RPM list. Finally, assert Reports
+    according to set arguments.
+
+    Parameters:
+        has_server  (bool): mysql-server installed
+    """
+
+    # Couple of random packages
+    rpms = [_generate_rpm_with_name('sed'),
+            _generate_rpm_with_name('htop')]
+
+    if has_server:
+        # Add mysql-server
+        rpms += [_generate_rpm_with_name('mysql-server')]
+
+    curr_actor_mocked = CurrentActorMocked(msgs=[DistributionSignedRPM(items=rpms)])
+    monkeypatch.setattr(api, 'current_actor', curr_actor_mocked)
+    monkeypatch.setattr(reporting, "create_report", create_report_mocked())
+
+    # Executed actor fed with fake RPMs
+    report_installed_packages(_context=api)
+
+    if has_server:
+        # Assert for mysql-server package installed
+        assert reporting.create_report.called == 1
+    else:
+        # Assert for no mysql packages installed
+        assert not reporting.create_report.called