Added env.enable_ra variable and change cert.py and ra.py plugin modules to register plugins conditionally

ipalib/__init__.py

@@ -701,7 +701,7 @@ plugin (or plugins) is imported.  For example:
 1
 >>> api.bootstrap(in_server=True) # We want to execute, not forward
 >>> len(api.env)
-38
+39
 
 `Env._bootstrap()`, which is called by `API.bootstrap()`, will create several
 run-time variables that connot be overriden in configuration files or through

ipalib/constants.py

@@ -115,6 +115,9 @@ DEFAULT_CONFIG = (
     ('prompt_all', False),
     ('interactive', True),
 
+    # Enable certain optional plugins:
+    ('enable_ra', False),
+
     # ********************************************************
     #  The remaining keys are never set from the values here!
     # ********************************************************

ipalib/plugins/cert.py

@@ -22,108 +22,110 @@
 Command plugins for IPA-RA certificate operations.
 """
 
-from ipalib import api, Command, Str, Int
+from ipalib import api
+
+if api.env.enable_ra:
+    from ipalib import Command, Str, Int
+
+    class cert_request(Command):
+        """
+        Submit a certificate singing request.
+        """
+
+        takes_args = ('csr',)
+
+        takes_options = (
+            Str('request_type', default=u'pkcs10', autofill=True),
+        )
+
+        def execute(self, csr, **options):
+            return self.Backend.ra.request_certificate(csr, **options)
+
+        def output_for_cli(self, textui, result, *args, **options):
+            if isinstance(result, dict) and len(result) > 0:
+                textui.print_entry(result, 0)
+            else:
+                textui.print_plain('Failed to submit a certificate request.')
+
+    api.register(cert_request)
 
 
-class cert_request(Command):
+    class cert_status(Command):
-    """
+        """
-    Submit a certificate singing request.
+        Check status of a certificate signing request.
-    """
+        """
 
-    takes_args = ('csr',)
+        takes_args = ['request_id']
-
-    takes_options = (
-        Str('request_type', default=u'pkcs10', autofill=True),
-    )
-
-    def execute(self, csr, **options):
-        return self.Backend.ra.request_certificate(csr, **options)
-
-    def output_for_cli(self, textui, result, *args, **options):
-        if isinstance(result, dict) and len(result) > 0:
-            textui.print_entry(result, 0)
-        else:
-            textui.print_plain('Failed to submit a certificate request.')
-
-api.register(cert_request)
 
 
-class cert_status(Command):
+        def execute(self, request_id, **options):
-    """
+            return self.Backend.ra.check_request_status(request_id)
-    Check status of a certificate signing request.
-    """
 
-    takes_args = ['request_id']
+        def output_for_cli(self, textui, result, *args, **options):
+            if isinstance(result, dict) and len(result) > 0:
+                textui.print_entry(result, 0)
+            else:
+                textui.print_plain('Failed to retrieve a request status.')
+
+    api.register(cert_status)
 
 
-    def execute(self, request_id, **options):
+    class cert_get(Command):
-        return self.Backend.ra.check_request_status(request_id)
+        """
+        Retrieve an existing certificate.
+        """
 
-    def output_for_cli(self, textui, result, *args, **options):
+        takes_args = ['serial_number']
-        if isinstance(result, dict) and len(result) > 0:
-            textui.print_entry(result, 0)
-        else:
-            textui.print_plain('Failed to retrieve a request status.')
 
-api.register(cert_status)
+        def execute(self, serial_number):
+            return self.Backend.ra.get_certificate(serial_number)
+
+        def output_for_cli(self, textui, result, *args, **options):
+            if isinstance(result, dict) and len(result) > 0:
+                textui.print_entry(result, 0)
+            else:
+                textui.print_plain('Failed to obtain a certificate.')
+
+    api.register(cert_get)
 
 
-class cert_get(Command):
+    class cert_revoke(Command):
-    """
+        """
-    Retrieve an existing certificate.
+        Revoke a certificate.
-    """
+        """
 
-    takes_args = ['serial_number']
+        takes_args = ['serial_number']
 
-    def execute(self, serial_number):
+        # FIXME: The default is 0.  Is this really an Int param?
-        return self.Backend.ra.get_certificate(serial_number)
+        takes_options = [Int('revocation_reason?', default=0)]
-
-    def output_for_cli(self, textui, result, *args, **options):
-        if isinstance(result, dict) and len(result) > 0:
-            textui.print_entry(result, 0)
-        else:
-            textui.print_plain('Failed to obtain a certificate.')
-
-api.register(cert_get)
 
 
-class cert_revoke(Command):
+        def execute(self, serial_number, **options):
-    """
+            return self.Backend.ra.revoke_certificate(serial_number, **options)
-    Revoke a certificate.
-    """
 
-    takes_args = ['serial_number']
+        def output_for_cli(self, textui, result, *args, **options):
+            if isinstance(result, dict) and len(result) > 0:
+                textui.print_entry(result, 0)
+            else:
+                textui.print_plain('Failed to revoke a certificate.')
 
-    # FIXME: The default is 0.  Is this really an Int param?
+    api.register(cert_revoke)
-    takes_options = [Int('revocation_reason?', default=0)]
 
 
-    def execute(self, serial_number, **options):
+    class cert_remove_hold(Command):
-        return self.Backend.ra.revoke_certificate(serial_number, **options)
+        """
+        Take a revoked certificate off hold.
+        """
 
-    def output_for_cli(self, textui, result, *args, **options):
+        takes_args = ['serial_number']
-        if isinstance(result, dict) and len(result) > 0:
-            textui.print_entry(result, 0)
-        else:
-            textui.print_plain('Failed to revoke a certificate.')
 
-api.register(cert_revoke)
+        def execute(self, serial_number, **options):
+            return self.Backend.ra.take_certificate_off_hold(serial_number)
 
+        def output_for_cli(self, textui, result, *args, **options):
+            if isinstance(result, dict) and len(result) > 0:
+                textui.print_entry(result, 0)
+            else:
+                textui.print_plain('Failed to take a revoked certificate off hold.')
 
-class cert_remove_hold(Command):
+    api.register(cert_remove_hold)
-    """
-    Take a revoked certificate off hold.
-    """
-
-    takes_args = ['serial_number']
-
-    def execute(self, serial_number, **options):
-        return self.Backend.ra.take_certificate_off_hold(serial_number)
-
-    def output_for_cli(self, textui, result, *args, **options):
-        if isinstance(result, dict) and len(result) > 0:
-            textui.print_entry(result, 0)
-        else:
-            textui.print_plain('Failed to take a revoked certificate off hold.')
-
-api.register(cert_remove_hold)

ipaserver/plugins/ra.py

@@ -418,4 +418,5 @@ class ra(Backend):
         # self.debug("IPA-RA: stderr: '%s'" % stderr)
         return (p.returncode, stdout, stderr)
 
-api.register(ra)
+if api.env.enable_ra:
+    api.register(ra)