From 9b6a90f1fc2508252bcb33791b24ec53f6b471cb Mon Sep 17 00:00:00 2001

From: Dinesh Prasanth M K <dmoluguw@redhat.com>

Date: Tue, 10 Dec 2019 14:02:16 -0500

Subject: [PATCH] Move config object from plugins to registry

This patch moves the config object from the plugins

to the registry, thereby allowing the plugins to use

the values parsed from the healthcheck.conf file while

initializing. This improves the way a plugin can use

the values defined in the conf

Signed-off-by: Dinesh Prasanth M K <dmoluguw@redhat.com>

---

 src/ipahealthcheck/core/core.py       | 11 ++-

 src/ipahealthcheck/core/plugin.py     |  6 +-

 src/ipahealthcheck/dogtag/plugin.py   |  3 +-

 src/ipahealthcheck/ds/plugin.py       |  3 +-

 src/ipahealthcheck/ipa/plugin.py      |  3 +-

 src/ipahealthcheck/system/plugin.py   |  2 +-

 tests/test_dogtag_ca.py               |  9 +--

 tests/test_dogtag_connectivity.py     |  8 +--

 tests/test_ds_replication.py          |  6 +-

 tests/test_ds_ruv.py                  |  9 +--

 tests/test_ipa_agent.py               | 21 ++----

 tests/test_ipa_certfile_expiration.py |  9 +--

 tests/test_ipa_certmonger_ca.py       |  6 +-

 tests/test_ipa_dna.py                 |  9 +--

 tests/test_ipa_dns.py                 | 27 +++-----

 tests/test_ipa_expiration.py          | 18 ++---

 tests/test_ipa_nssdb.py               | 12 ++--

 tests/test_ipa_nssvalidation.py       |  9 +--

 tests/test_ipa_opensslvalidation.py   |  6 +-

 tests/test_ipa_revocation.py          |  6 +-

 tests/test_ipa_roles.py               | 15 ++---

 tests/test_ipa_topology.py            | 12 ++--

 tests/test_ipa_tracking.py            |  8 +--

 tests/test_ipa_trust.py               | 96 +++++++++------------------

 tests/test_meta_services.py           |  3 +-

 tests/test_system_filesystemspace.py  |  9 +--

 26 files changed, 120 insertions(+), 206 deletions(-)

diff --git a/src/ipahealthcheck/core/core.py b/src/ipahealthcheck/core/core.py

index aef6197..ade8455 100644

--- a/src/ipahealthcheck/core/core.py

+++ b/src/ipahealthcheck/core/core.py

@@ -64,7 +64,7 @@ def source_or_check_matches(plugin, source, check):

     return True

-def run_service_plugins(plugins, config, source, check):

+def run_service_plugins(plugins, source, check):

     """Execute plugins with the base class of ServiceCheck

        This is a specialized check to use systemd to determine

@@ -90,7 +90,7 @@ def run_service_plugins(plugins, config, source, check):

     return results, set(available)

-def run_plugins(plugins, config, available, source, check):

+def run_plugins(plugins, available, source, check):

     """Execute plugins without the base class of ServiceCheck

        These are the remaining, non-service checking checks

@@ -106,7 +106,6 @@ def run_plugins(plugins, config, available, source, check):

             continue

         logger.debug('Calling check %s' % plugin)

-        plugin.config = config

         if not set(plugin.requires).issubset(available):

             logger.debug('Skipping %s:%s because %s service(s) not running',

                          plugin.__class__.__module__,

@@ -218,7 +217,7 @@ class RunChecks:

         for name, registry in find_registries(self.entry_points).items():

             try:

-                registry.initialize(framework)

+                registry.initialize(framework, config)

             except Exception as e:

                 print("Unable to initialize %s: %s" % (name, e))

                 return 1

@@ -246,10 +245,10 @@ class RunChecks:

             if options.source:

                 results = limit_results(results, options.source, options.check)

         else:

-            results, available = run_service_plugins(plugins, config,

+            results, available = run_service_plugins(plugins,

                                                      options.source,

                                                      options.check)

-            results.extend(run_plugins(plugins, config, available,

+            results.extend(run_plugins(plugins, available,

                                        options.source, options.check))

         if options.source and len(results.results) == 0:

diff --git a/src/ipahealthcheck/core/plugin.py b/src/ipahealthcheck/core/plugin.py

index 6a29a7f..5754808 100644

--- a/src/ipahealthcheck/core/plugin.py

+++ b/src/ipahealthcheck/core/plugin.py

@@ -41,9 +41,11 @@ class Registry:

     def __init__(self):

         self.plugins = []

         self.framework = None

+        self.config = dict()

-    def initialize(self, framework):

+    def initialize(self, framework, config):

         self.framework = framework

+        self.config = config

     def __call__(self, cls):

         if not callable(cls):

@@ -98,7 +100,7 @@ class Plugin:

     def __init__(self, registry):

         self.registry = registry

-        self.config = dict()

+        self.config = registry.config

 class Result:

diff --git a/src/ipahealthcheck/dogtag/plugin.py b/src/ipahealthcheck/dogtag/plugin.py

index 3d8257e..d54fe3b 100644

--- a/src/ipahealthcheck/dogtag/plugin.py

+++ b/src/ipahealthcheck/dogtag/plugin.py

@@ -16,7 +16,8 @@ class DogtagPlugin(Plugin):

 class DogtagRegistry(Registry):

-    def initialize(self, framework):

+    def initialize(self, framework, config):

+        super(DogtagRegistry, self).initialize(framework, config)

         installutils.check_server_configuration()

         if not api.isdone('bootstrap'):

             api.bootstrap(in_server=True,

diff --git a/src/ipahealthcheck/ds/plugin.py b/src/ipahealthcheck/ds/plugin.py

index 9ef3461..0e40922 100644

--- a/src/ipahealthcheck/ds/plugin.py

+++ b/src/ipahealthcheck/ds/plugin.py

@@ -16,7 +16,8 @@ class DSPlugin(Plugin):

 class DSRegistry(Registry):

-    def initialize(self, framework):

+    def initialize(self, framework, config):

+        super(DSRegistry, self).initialize(framework, config)

         installutils.check_server_configuration()

         if not api.isdone('bootstrap'):

             api.bootstrap(in_server=True,

diff --git a/src/ipahealthcheck/ipa/plugin.py b/src/ipahealthcheck/ipa/plugin.py

index 34cb8c9..c1a6d39 100644

--- a/src/ipahealthcheck/ipa/plugin.py

+++ b/src/ipahealthcheck/ipa/plugin.py

@@ -36,7 +36,8 @@ class IPARegistry(Registry):

         self.trust_agent = False

         self.trust_controller = False

-    def initialize(self, framework):

+    def initialize(self, framework, config):

+        super(IPARegistry, self).initialize(framework, config)

         # deferred import for mock

         from ipaserver.servroles import ADtrustBasedRole, ServiceBasedRole

diff --git a/src/ipahealthcheck/system/plugin.py b/src/ipahealthcheck/system/plugin.py

index 23e8b5e..03d8c23 100644

--- a/src/ipahealthcheck/system/plugin.py

+++ b/src/ipahealthcheck/system/plugin.py

@@ -12,7 +12,7 @@ class SystemPlugin(Plugin):

 class SystemRegistry(Registry):

-    def initialize(self, framework):

+    def initialize(self, framework, config):

         pass

diff --git a/tests/test_dogtag_ca.py b/tests/test_dogtag_ca.py

index 48eba20..0820aba 100644

--- a/tests/test_dogtag_ca.py

+++ b/tests/test_dogtag_ca.py

@@ -59,10 +59,9 @@ class TestCACerts(BaseTest):

         mock_directive.side_effect = [name for name, nsstrust in trust.items()]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config())

         f = DogtagCertsConfigCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 6

@@ -98,10 +97,9 @@ class TestCACerts(BaseTest):

         mock_directive.side_effect = nicknames

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = DogtagCertsConfigCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         num = len(self.results.results)

@@ -129,10 +127,9 @@ class TestCACerts(BaseTest):

         mock_cainstance.return_value = CAInstance(False)

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config)

         f = DogtagCertsConfigCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 0

diff --git a/tests/test_dogtag_connectivity.py b/tests/test_dogtag_connectivity.py

index 544e325..7165706 100644

--- a/tests/test_dogtag_connectivity.py

+++ b/tests/test_dogtag_connectivity.py

@@ -5,7 +5,7 @@

 from util import capture_results, CAInstance

 from util import m_api

 from base import BaseTest

-from ipahealthcheck.core import constants

+from ipahealthcheck.core import constants, config

 from ipahealthcheck.dogtag.plugin import registry

 from ipahealthcheck.dogtag.ca import DogtagCertsConnectivityCheck

 from unittest.mock import Mock

@@ -26,7 +26,7 @@ class TestCAConnectivity(BaseTest):

         }

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = DogtagCertsConnectivityCheck(registry)

         self.results = capture_results(f)

@@ -47,7 +47,7 @@ class TestCAConnectivity(BaseTest):

         )

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = DogtagCertsConnectivityCheck(registry)

         self.results = capture_results(f)

@@ -67,7 +67,7 @@ class TestCAConnectivity(BaseTest):

         )

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = DogtagCertsConnectivityCheck(registry)

         self.results = capture_results(f)

diff --git a/tests/test_ds_replication.py b/tests/test_ds_replication.py

index b6b3652..24e909e 100644

--- a/tests/test_ds_replication.py

+++ b/tests/test_ds_replication.py

@@ -44,10 +44,9 @@ class TestReplicationConflicts(BaseTest):

         mock_conn.return_value = mock_ldap(None)

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = ReplicationConflictCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         # A valid call relies on a success to be set by core

@@ -73,10 +72,9 @@ class TestReplicationConflicts(BaseTest):

         mock_conn.return_value = mock_ldap([ldapentry])

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = ReplicationConflictCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         result = self.results.results[0]

diff --git a/tests/test_ds_ruv.py b/tests/test_ds_ruv.py

index 37070f5..8a3fe84 100644

--- a/tests/test_ds_ruv.py

+++ b/tests/test_ds_ruv.py

@@ -63,11 +63,10 @@ class TestRUV(BaseTest):

     def test_no_ruvs(self):

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = RUVCheck(registry)

         f.conn = mock_ldap(None)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 0

@@ -88,11 +87,10 @@ class TestRUV(BaseTest):

         )

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = RUVCheck(registry)

         f.conn = mock_ldap(entries)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 2

@@ -123,11 +121,10 @@ class TestRUV(BaseTest):

         entries.append(None)

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = RUVCheck(registry)

         f.conn = mock_ldap(entries)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 1

diff --git a/tests/test_ipa_agent.py b/tests/test_ipa_agent.py

index c58c7a6..8021298 100644

--- a/tests/test_ipa_agent.py

+++ b/tests/test_ipa_agent.py

@@ -76,11 +76,10 @@ class TestNSSAgent(BaseTest):

             ldapentry[attr] = values

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config())

         f = IPARAAgent(registry)

         f.conn = mock_ldap([ldapentry])

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 1

@@ -101,11 +100,10 @@ class TestNSSAgent(BaseTest):

             ldapentry[attr] = values

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config())

         f = IPARAAgent(registry)

         f.conn = mock_ldap([ldapentry])

-        f.config = config.Config()

         self.results = capture_results(f)

         result = self.results.results[0]

@@ -118,10 +116,9 @@ class TestNSSAgent(BaseTest):

         mock_load_cert.side_effect = IOError('test')

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config())

         f = IPARAAgent(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         result = self.results.results[0]

@@ -131,11 +128,10 @@ class TestNSSAgent(BaseTest):

     def test_nss_agent_no_entry_found(self):

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config())

         f = IPARAAgent(registry)

         f.conn = mock_ldap(None)  # None == NotFound

-        f.config = config.Config()

         self.results = capture_results(f)

         result = self.results.results[0]

@@ -158,11 +154,10 @@ class TestNSSAgent(BaseTest):

             ldapentry[attr] = values

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config())

         f = IPARAAgent(registry)

         f.conn = mock_ldap([ldapentry, ldapentry2])

-        f.config = config.Config()

         self.results = capture_results(f)

         result = self.results.results[0]

@@ -183,11 +178,10 @@ class TestNSSAgent(BaseTest):

             ldapentry[attr] = values

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config())

         f = IPARAAgent(registry)

         f.conn = mock_ldap([ldapentry])

-        f.config = config.Config()

         self.results = capture_results(f)

         result = self.results.results[0]

@@ -208,11 +202,10 @@ class TestNSSAgent(BaseTest):

             ldapentry[attr] = values

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPARAAgent(registry)

         f.conn = mock_ldap([ldapentry])

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 1

diff --git a/tests/test_ipa_certfile_expiration.py b/tests/test_ipa_certfile_expiration.py

index d5601c5..43e59b4 100644

--- a/tests/test_ipa_certfile_expiration.py

+++ b/tests/test_ipa_certfile_expiration.py

@@ -41,10 +41,9 @@ class TestIPACertificateFile(BaseTest):

         mock_load_cert.return_value = cert

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACertfileExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 28

         self.results = capture_results(f)

@@ -65,10 +64,9 @@ class TestIPACertificateFile(BaseTest):

         mock_load_cert.return_value = cert

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACertfileExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 30

         self.results = capture_results(f)

@@ -90,10 +88,9 @@ class TestIPACertificateFile(BaseTest):

         mock_load_cert.return_value = cert

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACertfileExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 30

         self.results = capture_results(f)

diff --git a/tests/test_ipa_certmonger_ca.py b/tests/test_ipa_certmonger_ca.py

index 4eec1ba..3b67784 100644

--- a/tests/test_ipa_certmonger_ca.py

+++ b/tests/test_ipa_certmonger_ca.py

@@ -4,7 +4,7 @@

 from util import capture_results, CAInstance

 from base import BaseTest

-from ipahealthcheck.core import constants

+from ipahealthcheck.core import constants, config

 from ipahealthcheck.ipa.plugin import registry

 from ipahealthcheck.ipa.certs import IPACertmongerCA

 from unittest.mock import Mock, patch

@@ -24,7 +24,7 @@ class TestCertmonger(BaseTest):

             'dogtag-ipa-ca-renew-agent-reuse'

         ]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACertmongerCA(registry)

         self.results = capture_results(f)

@@ -44,7 +44,7 @@ class TestCertmonger(BaseTest):

         ]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACertmongerCA(registry)

         self.results = capture_results(f)

diff --git a/tests/test_ipa_dna.py b/tests/test_ipa_dna.py

index 5450642..5c88c22 100644

--- a/tests/test_ipa_dna.py

+++ b/tests/test_ipa_dna.py

@@ -31,10 +31,9 @@ class TestDNARange(BaseTest):

     def test_dnarange_set(self, mock_manager):

         mock_manager.return_value = mock_ReplicationManager(start=1, max=100)

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNARangeCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 1

@@ -52,10 +51,9 @@ class TestDNARange(BaseTest):

     def test_dnarange_noset(self, mock_manager):

         mock_manager.return_value = mock_ReplicationManager()

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNARangeCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 1

@@ -76,10 +74,9 @@ class TestDNARange(BaseTest):

                                                             next=101,

                                                             next_max=200)

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNARangeCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 1

diff --git a/tests/test_ipa_dns.py b/tests/test_ipa_dns.py

index dde4c4d..61e9a27 100644

--- a/tests/test_ipa_dns.py

+++ b/tests/test_ipa_dns.py

@@ -192,10 +192,9 @@ class TestDNSSystemRecords(BaseTest):

             ]

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 9

@@ -235,10 +234,9 @@ class TestDNSSystemRecords(BaseTest):

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 17

@@ -286,10 +284,9 @@ class TestDNSSystemRecords(BaseTest):

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 25

@@ -335,10 +332,9 @@ class TestDNSSystemRecords(BaseTest):

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 23

@@ -389,10 +385,9 @@ class TestDNSSystemRecords(BaseTest):

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 25

@@ -447,10 +442,9 @@ class TestDNSSystemRecords(BaseTest):

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 25

@@ -509,10 +503,9 @@ class TestDNSSystemRecords(BaseTest):

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 32

@@ -545,10 +538,9 @@ class TestDNSSystemRecords(BaseTest):

             ]

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 9

@@ -581,10 +573,9 @@ class TestDNSSystemRecords(BaseTest):

             ]

         }]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPADNSSystemRecordsCheck(registry)

-        f.config = config.Config()

         self.results = capture_results(f)

         assert len(self.results) == 15

diff --git a/tests/test_ipa_expiration.py b/tests/test_ipa_expiration.py

index 6cd6952..cd7de82 100644

--- a/tests/test_ipa_expiration.py

+++ b/tests/test_ipa_expiration.py

@@ -30,10 +30,9 @@ class TestExpiration(BaseTest):

         set_requests()

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACertmongerExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 7

         self.results = capture_results(f)

@@ -66,10 +65,9 @@ class TestExpiration(BaseTest):

         set_requests(remove=0, add=replaceme)

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACertmongerExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 30

         self.results = capture_results(f)

@@ -122,10 +120,9 @@ class TestChainExpiration(BaseTest):

             )

         ]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACAChainExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 7

         self.results = capture_results(f)

@@ -160,10 +157,9 @@ class TestChainExpiration(BaseTest):

             )

         ]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACAChainExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 7

         self.results = capture_results(f)

@@ -200,10 +196,9 @@ class TestChainExpiration(BaseTest):

             )

         ]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACAChainExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 7

         self.results = capture_results(f)

@@ -238,10 +233,9 @@ class TestChainExpiration(BaseTest):

             )

         ]

         framework = object()

-        registry.initialize(framework)

+        registry.initialize(framework, config.Config)

         f = IPACAChainExpirationCheck(registry)

-        f.config = config.Config()

         f.config.cert_expiration_days = 7

         self.results = capture_results(f)

diff --git a/tests/test_ipa_nssdb.py b/tests/test_ipa_nssdb.py