feat: New spec to get the count of revoked certificates on satellite (#…

…3988)

Signed-off-by: Huanhuan Li <[email protected]>

insights/parsers/satellite_postgresql_query.py

@@ -22,6 +22,8 @@
 ---------------------------------------------------------------------------------------------------------------------------------------
 SatelliteQualifiedKatelloRepos - command ``psql -d foreman -c "select id, name, url, download_policy from katello_root_repositories where download_policy = 'background' or url is NULL" --csv``
 ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+SatelliteRevokedCertCount - command ``psql -d candlepin -c \"select count(cp_certificate.id) from cp_cert_serial inner join cp_certificate on cp_certificate.serial_id = cp_cert_serial.id where cp_cert_serial.revoked = 't'\" --csv``
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 SatelliteRHVHostsCount - command ``psql -d foreman -c "select count(*) from hosts where \"compute_resource_id\" in (select id from compute_resources where type='Foreman::Model::Ovirt')" --csv``
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 SatelliteSCAStatus - command ``psql -d candlepin -c "select displayname, content_access_mode from cp_owner" --csv``
@@ -378,6 +380,25 @@ class SatelliteRHVHostsCount(SatellitePostgreSQLQuery):
     columns = ['count']
 
 
+@parser(Specs.satellite_revoked_cert_count)
+class SatelliteRevokedCertCount(SatellitePostgreSQLQuery):
+    """
+    Parse the output of the command ``psql -d candlepin -c "select count(cp_certificate.id) from cp_cert_serial inner join cp_certificate on cp_certificate.serial_id = cp_cert_serial.id where cp_cert_serial.revoked = 't'\" --csv``.
+
+    Sample output::
+
+        count
+        0
+
+    Examples:
+        >>> type(revoked_certs)
+        <class 'insights.parsers.satellite_postgresql_query.SatelliteRevokedCertCount'>
+        >>> revoked_certs[0]['count']
+        '0'
+    """
+    columns = ['count']
+
+
 @parser(Specs.satellite_sca_status)
 class SatelliteSCAStatus(SatellitePostgreSQLQuery):
     """

insights/specs/__init__.py

@@ -658,6 +658,7 @@ class Specs(SpecSet):
     satellite_provision_param_settings = RegistryPoint()
     satellite_qualified_capsules = RegistryPoint()
     satellite_qualified_katello_repos = RegistryPoint()
+    satellite_revoked_cert_count = RegistryPoint()
     satellite_rhv_hosts_count = RegistryPoint()
     satellite_sca_status = RegistryPoint()
     satellite_settings = RegistryPoint()

insights/specs/default.py

@@ -557,6 +557,10 @@ class DefaultSpecs(Specs):
         "/usr/bin/sudo -iu postgres /usr/bin/psql -d foreman -c \"select id, name, url, download_policy from katello_root_repositories where download_policy = 'background' or url is NULL\" --csv",
         deps=[IsSatellite]
     )
+    satellite_revoked_cert_count = simple_command(
+        "/usr/bin/sudo -iu postgres /usr/bin/psql -d candlepin -c \"select count(cp_certificate.id) from cp_cert_serial inner join cp_certificate on cp_certificate.serial_id = cp_cert_serial.id where cp_cert_serial.revoked = 't'\" --csv",
+        deps=[IsSatellite]
+    )
     satellite_rhv_hosts_count = simple_command(
         "/usr/bin/sudo -iu postgres /usr/bin/psql -d foreman -c \"select count(*) from hosts where \"compute_resource_id\" in (select id from compute_resources where type='Foreman::Model::Ovirt')\" --csv",
         deps=[IsSatellite]

insights/tests/parsers/test_satellite_postgresql_query.py

@@ -218,6 +218,11 @@
 2
 """.strip()
 
+SATELLITE_REVOKED_CERT_COUNT = """
+count
+0
+""".strip()
+
 SATELLITE_IGNORE_SOURCE_RPMS_REPOS = """
 id,name
 4,Red Hat Enterprise Linux 8 for x86_64 - AppStream RPMs 8
@@ -236,6 +241,7 @@ def test_HTL_doc_examples():
     param_settings = satellite_postgresql_query.SatelliteProvisionParamSettings(context_wrap(SATELLITE_PROVISION_PARAMETERS_HIT_1))
     logs_table = satellite_postgresql_query.SatelliteLogsTableSize(context_wrap(SATELLITE_LOGS_TABLE_SIZE1))
     rhv_hosts = satellite_postgresql_query.SatelliteRHVHostsCount(context_wrap(SATELLITE_RHV_HOSTS_COUNT))
+    revoked_certs = satellite_postgresql_query.SatelliteRevokedCertCount(context_wrap(SATELLITE_REVOKED_CERT_COUNT))
     ignore_srpm_repos = satellite_postgresql_query.SatelliteIgnoreSourceRpmsRepos(context_wrap(SATELLITE_IGNORE_SOURCE_RPMS_REPOS))
     globs = {
         'table': settings,
@@ -248,6 +254,7 @@ def test_HTL_doc_examples():
         'param_settings': param_settings,
         'logs_table': logs_table,
         'rhv_hosts': rhv_hosts,
+        'revoked_certs': revoked_certs,
         'i_srpm_repos': ignore_srpm_repos
     }
     failed, _ = doctest.testmod(satellite_postgresql_query, globs=globs)
@@ -382,6 +389,12 @@ def test_satelite_rhv_hosts():
     assert int(rhv_hosts[0]['count']) == 2
 
 
+def test_satelite_revoked_certs():
+    revoked_certs = satellite_postgresql_query.SatelliteRevokedCertCount(context_wrap(SATELLITE_REVOKED_CERT_COUNT))
+    assert len(revoked_certs) == 1
+    assert int(revoked_certs[0]['count']) == 0
+
+
 def test_satellite_logs_table_size_except():
     with pytest.raises(ParseException):
         satellite_postgresql_query.SatelliteLogsTableSize(context_wrap(SATELLITE_LOGS_TABLE_SIZE3))