Fixes for issues reported by pylint.

Fixes for issues in other files.
Ticket #316

6 files changed, 83 insertions, 88 deletions

diff --git a/base/common/python/pki/upgrade.py b/base/common/python/pki/upgrade.py
index e9e40b15c..675f3b903 100644
--- a/base/common/python/pki/upgrade.py
+++ b/base/common/python/pki/upgrade.py
@@ -45,7 +45,7 @@ class Version(object):
         if isinstance(obj, str):
 
             # parse <version>-<release>
-            pos = parts = obj.find('-')
+            pos = obj.find('-')
 
             if pos > 0:
                 self.version = obj[0:pos]
@@ -77,31 +77,28 @@ class Version(object):
     # release is ignored in comparisons
 
     def __eq__(self, other):
-        return self.major == other.major and \
-            self.minor == other.minor and \
-            self.patch == other.patch
-
+        return (self.major == other.major and
+            self.minor == other.minor and
+            self.patch == other.patch)
 
     def __lt__(self, other):
         if self.major < other.major:
             return True
 
-        if self.major == other.major and \
-            self.minor < other.minor:
+        if (self.major == other.major and
+            self.minor < other.minor):
             return True
 
-        if self.major == other.major and \
-            self.minor == other.minor and \
-            self.patch < other.patch:
+        if (self.major == other.major and
+            self.minor == other.minor and
+            self.patch < other.patch):
             return True
 
         return False
 
-
     def __repr__(self):
         return self.version
 
-
 class PKIUpgradeTracker(object):
 
     def __init__(self, name, filename,
@@ -121,14 +118,16 @@ class PKIUpgradeTracker(object):
 
     def remove(self):
 
-        if verbose: print 'Removing ' + self.name + ' tracker.'
+        if verbose:
+            print 'Removing ' + self.name + ' tracker.'
 
         self.remove_version()
         self.remove_index()
 
     def set(self, version):
 
-        if verbose: print 'Setting ' + self.name + ' tracker to version ' + str(version) + '.'
+        if verbose:
+            print 'Setting ' + self.name + ' tracker to version ' + str(version) + '.'
 
         self.set_version(version)
         self.remove_index()
@@ -325,7 +324,7 @@ class PKIUpgradeScriptlet(object):
         if os.path.exists(oldfiles):
 
             # restore all backed up files
-            for root, dirnames, filenames in os.walk(oldfiles):
+            for root, _, filenames in os.walk(oldfiles):  #unused item _ for dirnames
                 path = root[len(oldfiles):]
                 for filename in filenames:
                     source = root + '/' + filename
@@ -466,11 +465,11 @@ class PKIUpgrader(object):
                 continue
 
             # load scriptlet class
-            vars = {}
-            execfile(os.path.join(version_dir, filename), vars)
+            variables = {}
+            execfile(os.path.join(version_dir, filename), variables)
 
             # create scriptlet object
-            scriptlet = vars[classname]()
+            scriptlet = variables[classname]()
 
             scriptlet.upgrader = self
             scriptlet.version = version
diff --git a/base/server/python/pki/server/upgrade.py b/base/server/python/pki/server/upgrade.py
index 5de961df3..b89cef607 100644
--- a/base/server/python/pki/server/upgrade.py
+++ b/base/server/python/pki/server/upgrade.py
@@ -166,14 +166,14 @@ class PKIServerUpgrader(pki.upgrade.PKIUpgrader):
         if self.instanceName and self.instanceType:
             return [pki.server.PKIInstance(self.instanceName, self.instanceType)]
 
-        list = []
+        instance_list = []
 
         if not self.instanceType or self.instanceType >= 10:
             if os.path.exists(os.path.join(pki.server.REGISTRY_DIR, 'tomcat')):
                 for instanceName in os.listdir(pki.server.INSTANCE_BASE_DIR):
                     if not self.instanceName or \
                         self.instanceName == instanceName:
-                        list.append(pki.server.PKIInstance(instanceName))
+                        instance_list.append(pki.server.PKIInstance(instanceName))
 
         if not self.instanceType or self.instanceType == 9:
             for s in pki.server.SUBSYSTEM_TYPES:
@@ -182,11 +182,11 @@ class PKIServerUpgrader(pki.upgrade.PKIUpgrader):
                         os.listdir(os.path.join(pki.server.REGISTRY_DIR, s)):
                         if not self.instanceName or \
                             self.instanceName == instanceName:
-                            list.append(pki.server.PKIInstance(instanceName, 9))
+                            instance_list.append(pki.server.PKIInstance(instanceName, 9))
 
-        list.sort()
+        instance_list.sort()
 
-        return list
+        return instance_list
 
 
     def subsystems(self, instance):
@@ -194,14 +194,14 @@ class PKIServerUpgrader(pki.upgrade.PKIUpgrader):
         if self.subsystemName:
             return [pki.server.PKISubsystem(instance, self.subsystemName)]
 
-        list = []
+        subsystem_list = []
 
         if instance.type >= 10:
             registry_dir = os.path.join(pki.server.REGISTRY_DIR, 'tomcat',
                 instance.name)
             for subsystemName in os.listdir(registry_dir):
                 if subsystemName in pki.server.SUBSYSTEM_TYPES:
-                    list.append(pki.server.PKISubsystem(instance, subsystemName))
+                    subsystem_list.append(pki.server.PKISubsystem(instance, subsystemName))
         else:
             for subsystemName in pki.server.SUBSYSTEM_TYPES:
                 registry_dir = os.path.join(
@@ -209,11 +209,11 @@ class PKIServerUpgrader(pki.upgrade.PKIUpgrader):
                     subsystemName,
                     instance.name)
                 if os.path.exists(registry_dir):
-                    list.append(pki.server.PKISubsystem(instance, subsystemName))
+                    subsystem_list.append(pki.server.PKISubsystem(instance, subsystemName))
 
-        list.sort()
+        subsystem_list.sort()
 
-        return list
+        return subsystem_list
 
     def get_tracker(self, instance, subsystem=None):
 
diff --git a/base/server/src/engine/pkihelper.py b/base/server/src/engine/pkihelper.py
index 7fff398a6..c33abe0f8 100644
--- a/base/server/src/engine/pkihelper.py
+++ b/base/server/src/engine/pkihelper.py
@@ -1079,6 +1079,7 @@ class Directory:
     def __init__(self, deployer):
         self.master_dict = deployer.master_dict
         self.identity = deployer.identity
+        self.manifest_db = deployer.manifest_db
 
     def create(self, name, uid=None, gid=None,
                perms=config.PKI_DEPLOYMENT_DEFAULT_DIR_PERMISSIONS,
@@ -1103,7 +1104,7 @@ class Directory:
                                      extra=config.PKI_INDENTATION_LEVEL_3)
                 os.chown(name, uid, gid)
                 # Store record in installation manifest
-                record = manifest.record()
+                record = manifest.Record()
                 record.name = name
                 record.type = manifest.RECORD_TYPE_DIRECTORY
                 record.user = self.master_dict['pki_user']
@@ -1112,7 +1113,7 @@ class Directory:
                 record.gid = gid
                 record.permissions = perms
                 record.acls = acls
-                manifest.database.append(record)
+                self.manifest_db.append(record)
             elif not os.path.isdir(name):
                 config.pki_log.error(
                     log.PKI_DIRECTORY_ALREADY_EXISTS_NOT_A_DIRECTORY_1, name,
@@ -1161,7 +1162,7 @@ class Directory:
                 os.chown(name, uid, gid)
                 # Store record in installation manifest
                 if not silent:
-                    record = manifest.record()
+                    record = manifest.Record()
                     record.name = name
                     record.type = manifest.RECORD_TYPE_DIRECTORY
                     record.user = self.master_dict['pki_user']
@@ -1170,7 +1171,7 @@ class Directory:
                     record.gid = gid
                     record.permissions = perms
                     record.acls = acls
-                    manifest.database.append(record)
+                    self.manifest_db.append(record)
             else:
                 config.pki_log.error(
                     log.PKI_DIRECTORY_MISSING_OR_NOT_A_DIRECTORY_1, name,
@@ -1276,7 +1277,7 @@ class Directory:
                                     extra=config.PKI_INDENTATION_LEVEL_3)
                                 os.chown(temp_file, uid, gid)
                                 # Store record in installation manifest
-                                record = manifest.record()
+                                record = manifest.Record()
                                 record.name = name
                                 record.type = manifest.RECORD_TYPE_FILE
                                 record.user = self.master_dict['pki_user']
@@ -1285,7 +1286,7 @@ class Directory:
                                 record.gid = gid
                                 record.permissions = file_perms
                                 record.acls = file_acls
-                                manifest.database.append(record)
+                                self.manifest_db.append(record)
                             else:
                                 symlink = entity
                                 config.pki_log.debug(
@@ -1302,7 +1303,7 @@ class Directory:
                                     extra=config.PKI_INDENTATION_LEVEL_3)
                                 os.lchown(symlink, uid, gid)
                                 # Store record in installation manifest
-                                record = manifest.record()
+                                record = manifest.Record()
                                 record.name = name
                                 record.type = manifest.RECORD_TYPE_SYMLINK
                                 record.user = self.master_dict['pki_user']
@@ -1311,7 +1312,7 @@ class Directory:
                                 record.gid = gid
                                 record.permissions = symlink_perms
                                 record.acls = symlink_acls
-                                manifest.database.append(record)
+                                self.manifest_db.append(record)
                         for name in dirs:
                             temp_dir = os.path.join(root, name)
                             config.pki_log.debug(
@@ -1328,7 +1329,7 @@ class Directory:
                                 extra=config.PKI_INDENTATION_LEVEL_3)
                             os.chown(temp_dir, uid, gid)
                             # Store record in installation manifest
-                            record = manifest.record()
+                            record = manifest.Record()
                             record.name = name
                             record.type = manifest.RECORD_TYPE_DIRECTORY
                             record.user = self.master_dict['pki_user']
@@ -1337,7 +1338,7 @@ class Directory:
                             record.gid = gid
                             record.permissions = dir_perms
                             record.acls = dir_acls
-                            manifest.database.append(record)
+                            self.manifest_db.append(record)
                 else:
                     config.pki_log.debug(
                         log.PKIHELPER_IS_A_DIRECTORY_1, name,
@@ -1354,7 +1355,7 @@ class Directory:
                                          extra=config.PKI_INDENTATION_LEVEL_3)
                     os.chown(name, uid, gid)
                     # Store record in installation manifest
-                    record = manifest.record()
+                    record = manifest.Record()
                     record.name = name
                     record.type = manifest.RECORD_TYPE_DIRECTORY
                     record.user = self.master_dict['pki_user']
@@ -1363,7 +1364,7 @@ class Directory:
                     record.gid = gid
                     record.permissions = dir_perms
                     record.acls = dir_acls
-                    manifest.database.append(record)
+                    self.manifest_db.append(record)
         except OSError as exc:
             config.pki_log.error(log.PKI_OSERROR_1, exc,
                                  extra=config.PKI_INDENTATION_LEVEL_2)
@@ -1437,6 +1438,7 @@ class File:
         self.master_dict = deployer.master_dict
         self.slots = deployer.slots
         self.identity = deployer.identity
+        self.manifest_db = deployer.manifest_db
 
     def create(self, name, uid=None, gid=None,
                perms=config.PKI_DEPLOYMENT_DEFAULT_FILE_PERMISSIONS,
@@ -1461,7 +1463,7 @@ class File:
                                      extra=config.PKI_INDENTATION_LEVEL_3)
                 os.chown(name, uid, gid)
                 # Store record in installation manifest
-                record = manifest.record()
+                record = manifest.Record()
                 record.name = name
                 record.type = manifest.RECORD_TYPE_FILE
                 record.user = self.master_dict['pki_user']
@@ -1470,7 +1472,7 @@ class File:
                 record.gid = gid
                 record.permissions = perms
                 record.acls = acls
-                manifest.database.append(record)
+                self.manifest_db.append(record)
             elif not os.path.isfile(name):
                 config.pki_log.error(
                     log.PKI_FILE_ALREADY_EXISTS_NOT_A_FILE_1, name,
@@ -1519,7 +1521,7 @@ class File:
                 os.chown(name, uid, gid)
                 # Store record in installation manifest
                 if not silent:
-                    record = manifest.record()
+                    record = manifest.Record()
                     record.name = name
                     record.type = manifest.RECORD_TYPE_FILE
                     record.user = self.master_dict['pki_user']
@@ -1528,7 +1530,7 @@ class File:
                     record.gid = gid
                     record.permissions = perms
                     record.acls = acls
-                    manifest.database.append(record)
+                    self.manifest_db.append(record)
             else:
                 config.pki_log.error(
                     log.PKI_FILE_MISSING_OR_NOT_A_FILE_1, name,
@@ -1608,7 +1610,7 @@ class File:
                                      extra=config.PKI_INDENTATION_LEVEL_3)
                 os.chown(new_name, uid, gid)
                 # Store record in installation manifest
-                record = manifest.record()
+                record = manifest.Record()
                 record.name = new_name
                 record.type = manifest.RECORD_TYPE_FILE
                 record.user = self.master_dict['pki_user']
@@ -1617,7 +1619,7 @@ class File:
                 record.gid = gid
                 record.permissions = perms
                 record.acls = acls
-                manifest.database.append(record)
+                self.manifest_db.append(record)
         except OSError as exc:
             config.pki_log.error(log.PKI_OSERROR_1, exc,
                                  extra=config.PKI_INDENTATION_LEVEL_2)
@@ -1668,7 +1670,7 @@ class File:
                                  extra=config.PKI_INDENTATION_LEVEL_3)
             os.chown(name, uid, gid)
             # Store record in installation manifest
-            record = manifest.record()
+            record = manifest.Record()
             record.name = name
             record.type = manifest.RECORD_TYPE_FILE
             record.user = self.master_dict['pki_user']
@@ -1677,7 +1679,7 @@ class File:
             record.gid = gid
             record.permissions = perms
             record.acls = acls
-            manifest.database.append(record)
+            self.manifest_db.append(record)
         except OSError as exc:
             config.pki_log.error(log.PKI_OSERROR_1, exc,
                                  extra=config.PKI_INDENTATION_LEVEL_2)
@@ -1737,7 +1739,7 @@ class File:
                                      extra=config.PKI_INDENTATION_LEVEL_3)
                 os.chown(new_name, uid, gid)
                 # Store record in installation manifest
-                record = manifest.record()
+                record = manifest.Record()
                 record.name = new_name
                 record.type = manifest.RECORD_TYPE_FILE
                 record.user = self.master_dict['pki_user']
@@ -1746,7 +1748,7 @@ class File:
                 record.gid = gid
                 record.permissions = perms
                 record.acls = acls
-                manifest.database.append(record)
+                self.manifest_db.append(record)
         except OSError as exc:
             config.pki_log.error(log.PKI_OSERROR_1, exc,
                                  extra=config.PKI_INDENTATION_LEVEL_2)
@@ -1787,7 +1789,7 @@ class File:
                                      extra=config.PKI_INDENTATION_LEVEL_3)
                 os.chown(name, uid, gid)
                 # Store record in installation manifest
-                record = manifest.record()
+                record = manifest.Record()
                 record.name = name
                 record.type = manifest.RECORD_TYPE_FILE
                 record.user = self.master_dict['pki_user']
@@ -1796,7 +1798,7 @@ class File:
                 record.gid = gid
                 record.permissions = perms
                 record.acls = acls
-                manifest.database.append(record)
+                self.manifest_db.append(record)
             elif not os.path.isfile(name):
                 config.pki_log.error(
                     log.PKI_FILE_ALREADY_EXISTS_NOT_A_FILE_1, name,
@@ -1819,6 +1821,7 @@ class Symlink:
     def __init__(self, deployer):
         self.master_dict = deployer.master_dict
         self.identity = deployer.identity
+        self.manifest_db = deployer.manifest_db
 
     def create(self, name, link, uid=None, gid=None,
                acls=None, allow_dangling_symlink=False, critical_failure=True):
@@ -1847,7 +1850,7 @@ class Symlink:
                                      extra=config.PKI_INDENTATION_LEVEL_3)
                 os.lchown(link, uid, gid)
                 # Store record in installation manifest
-                record = manifest.record()
+                record = manifest.Record()
                 record.name = link
                 record.type = manifest.RECORD_TYPE_SYMLINK
                 record.user = self.master_dict['pki_user']
@@ -1857,7 +1860,7 @@ class Symlink:
                 record.permissions = \
                     config.PKI_DEPLOYMENT_DEFAULT_SYMLINK_PERMISSIONS
                 record.acls = acls
-                manifest.database.append(record)
+                self.manifest_db.append(record)
             elif not os.path.islink(link):
                 config.pki_log.error(
                     log.PKI_SYMLINK_ALREADY_EXISTS_NOT_A_SYMLINK_1, link,
@@ -1903,7 +1906,7 @@ class Symlink:
                 os.lchown(link, uid, gid)
                 # Store record in installation manifest
                 if not silent:
-                    record = manifest.record()
+                    record = manifest.Record()
                     record.name = link
                     record.type = manifest.RECORD_TYPE_SYMLINK
                     record.user = self.master_dict['pki_user']
@@ -1913,7 +1916,7 @@ class Symlink:
                     record.permissions = \
                         config.PKI_DEPLOYMENT_DEFAULT_SYMLINK_PERMISSIONS
                     record.acls = acls
-                    manifest.database.append(record)
+                    self.manifest_db.append(record)
             else:
                 config.pki_log.error(
                     log.PKI_SYMLINK_MISSING_OR_NOT_A_SYMLINK_1, link,
@@ -2691,7 +2694,6 @@ class KRAConnector:
 
     def execute_using_sslget(self, caport, cahost, subsystemnick,
       token_pwd, krahost, kraport):
-        #urlheader = "https://{}:{}".format(cahost, caport) - unused variable
         updateURL = "/ca/rest/admin/kraconnector/remove"
 
         params = "host=" + str(krahost) + \
@@ -2728,12 +2730,10 @@ class SecurityDomain:
         sport = cs_cfg.get('service.securityDomainPort')
         ncsport = cs_cfg.get('service.non_clientauth_securePort', '')
         sechost = cs_cfg.get('securitydomain.host')
-        #httpport = cs_cfg.get('securitydomain.httpport') - Security domain http port
         seceeport = cs_cfg.get('securitydomain.httpseeport')
         secagentport = cs_cfg.get('securitydomain.httpsagentport')
         secadminport = cs_cfg.get('securitydomain.httpsadminport')
         secname = cs_cfg.get('securitydomain.name', 'unknown')
-        #secselect = cs_cfg.get('securitydomain.select') - Selected security domain
         adminsport = cs_cfg.get('pkicreate.admin_secure_port', '')
         typeval = cs_cfg.get('cs.type', '')
         agentsport = cs_cfg.get('pkicreate.agent_secure_port', '')
@@ -2761,9 +2761,6 @@ class SecurityDomain:
                             secname,
                             extra=config.PKI_INDENTATION_LEVEL_2)
         listval = typeval.lower() + "List"
-        #urlheader = "https://{}:{}".format(sechost, seceeport) - Security domain EE URL
-        #urlagentheader = "https://{}:{}".format(sechost, secagentport) - Agent URL
-        #urladminheader = "https://{}:{}".format(sechost, secadminport) - Admin URL
         updateURL = "/ca/agent/ca/updateDomainXML"
 
         params = "name=" + "\"" + self.master_dict['pki_instance_path'] + "\"" + \
@@ -3497,6 +3494,7 @@ class PKIDeployer:
         # Global dictionary variables
         self.master_dict = pki_master_dict
         self.slots = pki_slots_dict
+        self.manifest_db = []
 
         # Utility objects
         self.identity = Identity(self)
diff --git a/base/server/src/engine/pkimanifest.py b/base/server/src/engine/pkimanifest.py
index aaabbf5fd..721373eac 100644
--- a/base/server/src/engine/pkimanifest.py
+++ b/base/server/src/engine/pkimanifest.py
@@ -20,10 +20,7 @@
 #
 
 # System Imports
-from collections import namedtuple
 import csv
-import sys
-
 
 # PKI Deployment Imports
 import pkiconfig as config
@@ -37,7 +34,7 @@ RECORD_TYPE_SYMLINK = "symlink"
 
 
 # PKI Deployment Manifest Record Class
-class record(object):
+class Record(object):
     __slots__ = "name", \
                "type", \
                "user", \
@@ -47,6 +44,9 @@ class record(object):
                "permissions", \
                "acls",
 
+    def __init__(self):
+        pass
+
     def items(self):
         "dict style items"
         return [
@@ -64,9 +64,11 @@ class record(object):
 
 
 # PKI Deployment Manifest File Class
-class file:
-    global database
-    filename = None
+class File:
+
+    def __init__(self, database):
+        self.filename = None
+        self.database = database
 
     def register(self, name):
         self.filename = name
@@ -75,7 +77,7 @@ class file:
         try:
             with open(self.filename, "wt") as fd:
                 c = csv.writer(fd)
-                for record in database:
+                for record in self.database:
                     c.writerow(tuple(record))
         except IOError as exc:
             config.pki_log.error(log.PKI_IOERROR_1, exc,
@@ -93,6 +95,3 @@ class file:
                                  extra=config.PKI_INDENTATION_LEVEL_1)
             raise
 
-# PKI Deployment Global Named Tuples
-database = []
-file = file()
diff --git a/base/server/src/pkispawn b/base/server/src/pkispawn
index 75a04b4a6..6339b1096 100755
--- a/base/server/src/pkispawn
+++ b/base/server/src/pkispawn
@@ -28,16 +28,13 @@ if not hasattr(sys, "hexversion") or sys.hexversion < 0x020700f0:
     print "Please upgrade to at least Python 2.7.0."
     sys.exit(1)
 try:
-    import argparse
     import ldap
-    import logging
     import os
     import requests
     import socket
     import struct
     import subprocess
     import time
-    import urllib2
     import traceback
     from time import strftime as date
     from pki.deployment import pkiconfig as config
@@ -373,7 +370,7 @@ def main(argv):
         instance = scriptlet.PkiScriptlet()
         try:
             rv = instance.spawn(deployer)
-        except:
+        except Exception:
             log_error_details()
             print
             print "Installation failed."
@@ -412,15 +409,16 @@ def print_install_information(pki_master_dict):
     print log.PKI_SPAWN_INFORMATION_FOOTER
 
 def log_error_details():
-        type, value, stacktrace = sys.exc_info()
-        config.pki_log.debug("Error Type: " + type.__name__, extra=config.PKI_INDENTATION_LEVEL_2)
-        config.pki_log.debug("Error Message: " + str(value), extra=config.PKI_INDENTATION_LEVEL_2)
-        stacktrace_list = traceback.format_list(traceback.extract_tb(stacktrace))
-        stacktrace = ""
-        for l in stacktrace_list:
-            stacktrace += l
-        config.pki_log.debug(stacktrace, extra=config.PKI_INDENTATION_LEVEL_2)
-        sys.exc_clear()
+
+    type, value, stacktrace = sys.exc_info()
+    config.pki_log.debug("Error Type: " + type.__name__, extra=config.PKI_INDENTATION_LEVEL_2)
+    config.pki_log.debug("Error Message: " + str(value), extra=config.PKI_INDENTATION_LEVEL_2)
+    stacktrace_list = traceback.format_list(traceback.extract_tb(stacktrace))
+    stacktrace = ""
+    for l in stacktrace_list:
+        stacktrace += l
+    config.pki_log.debug(stacktrace, extra=config.PKI_INDENTATION_LEVEL_2)
+    sys.exc_clear()
 
 # PKI Deployment Entry Point
 if __name__ == "__main__":
diff --git a/base/server/src/scriptlets/finalization.py b/base/server/src/scriptlets/finalization.py
index 45b4a3ceb..529f9d45d 100644
--- a/base/server/src/scriptlets/finalization.py
+++ b/base/server/src/scriptlets/finalization.py
@@ -53,8 +53,9 @@ class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
                             extra=config.PKI_INDENTATION_LEVEL_2)
         # for record in manifest.database:
         #     print tuple(record)
-        manifest.file.register(deployer.master_dict['pki_manifest'])
-        manifest.file.write()
+        manifest_file = manifest.File(deployer.manifest_db)
+        manifest_file.register(deployer.master_dict['pki_manifest'])
+        manifest_file.write()
         deployer.file.modify(deployer.master_dict['pki_manifest'], silent=True)
 
         # Also, for debugging/auditing purposes, save a timestamped copy of