autopep8
[sfa.git] / sfa / client / manifolduploader.py
index 3b9de16..e377c8d 100755 (executable)
@@ -16,7 +16,7 @@
 # v1, that offers an AddCredential API call, towards a new API v2 that
 # manages credentials with the same set of Get/Update calls as other
 # objects
-# 
+#
 
 # mostly this is intended to be used through 'sfi myslice'
 # so the defaults below are of no real importance
@@ -27,64 +27,75 @@ DEFAULT_PLATFORM = 'ple'
 
 # starting with 2.7.9 we need to turn off server verification
 import ssl
-try:    turn_off_server_verify = { 'context' : ssl._create_unverified_context() } 
-except: turn_off_server_verify = {}
+try:
+    turn_off_server_verify = {'context': ssl._create_unverified_context()}
+except:
+    turn_off_server_verify = {}
 
 import getpass
 
 from sfa.util.py23 import xmlrpc_client
 
+
 class ManifoldUploader:
     """A utility class for uploading delegated credentials to a manifold/MySlice infrastructure"""
 
-    # platform is a name internal to the manifold deployment, 
+    # platform is a name internal to the manifold deployment,
     # that maps to a testbed, like e.g. 'ple'
-    def __init__ (self, logger, url=None, platform=None, username=None, password=None, ):
-        self._url=url
-        self._platform=platform
-        self._username=username
-        self._password=password
-        self.logger=logger
-        self._proxy=None
-
-    def username (self):
+    def __init__(self, logger, url=None, platform=None, username=None, password=None, ):
+        self._url = url
+        self._platform = platform
+        self._username = username
+        self._password = password
+        self.logger = logger
+        self._proxy = None
+
+    def username(self):
         if not self._username:
-            self._username=raw_input("Enter your manifold username: ")
+            self._username = raw_input("Enter your manifold username: ")
         return self._username
 
-    def password (self):
+    def password(self):
         if not self._password:
-            username=self.username()
-            self._password=getpass.getpass("Enter password for manifold user %s: "%username)
+            username = self.username()
+            self._password = getpass.getpass(
+                "Enter password for manifold user %s: " % username)
         return self._password
 
-    def platform (self):
+    def platform(self):
         if not self._platform:
-            self._platform=raw_input("Enter your manifold platform [%s]: "%DEFAULT_PLATFORM)
-            if self._platform.strip()=="": self._platform = DEFAULT_PLATFORM
+            self._platform = raw_input(
+                "Enter your manifold platform [%s]: " % DEFAULT_PLATFORM)
+            if self._platform.strip() == "":
+                self._platform = DEFAULT_PLATFORM
         return self._platform
 
-    def url (self):
+    def url(self):
         if not self._url:
-            self._url=raw_input("Enter the URL for your manifold API [%s]: "%DEFAULT_URL)
-            if self._url.strip()=="": self._url = DEFAULT_URL
+            self._url = raw_input(
+                "Enter the URL for your manifold API [%s]: " % DEFAULT_URL)
+            if self._url.strip() == "":
+                self._url = DEFAULT_URL
         return self._url
 
     def prompt_all(self):
-        self.username(); self.password(); self.platform(); self.url()
+        self.username()
+        self.password()
+        self.platform()
+        self.url()
 
     # looks like the current implementation of manifold server
     # won't be happy with several calls issued in the same session
     # so we do not cache this one
-    def proxy (self):
-#        if not self._proxy:
-#            url=self.url()
-#            self.logger.info("Connecting manifold url %s"%url)
-#            self._proxy = xmlrpc_client.ServerProxy(url, allow_none = True)
-#        return self._proxy
-        url=self.url()
-        self.logger.debug("Connecting manifold url %s"%url)
-        proxy = xmlrpc_client.ServerProxy(url, allow_none = True,
+    def proxy(self):
+        #        if not self._proxy:
+        #            url=self.url()
+        #            self.logger.info("Connecting manifold url %s"%url)
+        #            self._proxy = xmlrpc_client.ServerProxy(url, allow_none = True)
+        #        return self._proxy
+        url = self.url()
+        self.logger.debug("Connecting manifold url %s" % url)
+        proxy = xmlrpc_client.ServerProxy(url, allow_none=True,
                                           **turn_off_server_verify)
 
         return proxy
@@ -92,19 +103,21 @@ class ManifoldUploader:
     # does the job for one credential
     # expects the credential (string) and an optional message (e.g. hrn) for reporting
     # return True upon success and False otherwise
-    def upload (self, delegated_credential, message=None):
-        platform=self.platform()
-        username=self.username()
-        password=self.password()
-        auth = {'AuthMethod': 'password', 'Username': username, 'AuthString': password}
-        if not message: message=""
+    def upload(self, delegated_credential, message=None):
+        platform = self.platform()
+        username = self.username()
+        password = self.password()
+        auth = {'AuthMethod': 'password',
+                'Username': username, 'AuthString': password}
+        if not message:
+            message = ""
 
         try:
-            manifold=self.proxy()
+            manifold = self.proxy()
             # the code for a V2 interface
-            query = { 'action':     'update',
+            query = {'action':     'update',
                      'object':     'local:account',
-                     'filters':    [ ['platform', '=', platform] ] ,
+                     'filters':    [['platform', '=', platform]],
                      'params':     {'credential': delegated_credential, },
                      }
             annotation = {'authentication': auth, }
@@ -112,61 +125,71 @@ class ManifoldUploader:
             # but fill in error code and messages instead
             # however this is only theoretical so let's be on the safe side
             try:
-                self.logger.debug("Using new v2 method forward+annotation@%s %s"%(platform,message))
-                retcod2=manifold.forward (query, annotation)
+                self.logger.debug(
+                    "Using new v2 method forward+annotation@%s %s" % (platform, message))
+                retcod2 = manifold.forward(query, annotation)
             except Exception as e:
-                # xxx we need a constant constant for UNKNOWN, how about using 1
-                MANIFOLD_UNKNOWN=1
-                retcod2={'code':MANIFOLD_UNKNOWN,'description':"%s"%e}
-            if retcod2['code']==0:
-                info=""
-                if message: info += message+" "
+                # xxx we need a constant constant for UNKNOWN, how about using
+                # 1
+                MANIFOLD_UNKNOWN = 1
+                retcod2 = {'code': MANIFOLD_UNKNOWN, 'description': "%s" % e}
+            if retcod2['code'] == 0:
+                info = ""
+                if message:
+                    info += message + " "
                 info += 'v2 upload OK'
                 self.logger.info(info)
                 return True
             # everything has failed, let's report
-            self.logger.error("Could not upload %s"%(message if message else "credential"))
-            self.logger.info("  V2 Update returned code %s and error >>%s<<"%(retcod2['code'],retcod2['description']))
+            self.logger.error("Could not upload %s" %
+                              (message if message else "credential"))
+            self.logger.info("  V2 Update returned code %s and error >>%s<<" % (
+                retcod2['code'], retcod2['description']))
             self.logger.debug("****** full retcod2")
-            for (k,v) in retcod2.items(): self.logger.debug("**** %s: %s"%(k,v))
+            for k, v in retcod2.items():
+                self.logger.debug("**** %s: %s" % (k, v))
             return False
         except Exception as e:
-            if message: self.logger.error("Could not upload %s %s"%(message,e))
-            else:        self.logger.error("Could not upload credential %s"%e)
+            if message:
+                self.logger.error("Could not upload %s %s" % (message, e))
+            else:
+                self.logger.error("Could not upload credential %s" % e)
             if self.logger.debugEnabled():
                 import traceback
                 traceback.print_exc()
             return False
 
-### this is mainly for unit testing this class but can come in handy as well
-def main ():
+# this is mainly for unit testing this class but can come in handy as well
+
+
+def main():
     from argparse import ArgumentParser
-    parser = ArgumentParser (description="manifoldupoader simple tester.")
-    parser.add_argument ('credential_files',metavar='FILE',type=str,nargs='+',
-                         help="the filenames to upload")
-    parser.add_argument ('-u','--url',dest='url', action='store',default=None,
-                         help='the URL of the manifold API')
-    parser.add_argument ('-p','--platform',dest='platform',action='store',default=None,
-                         help='the manifold platform name')
-    parser.add_argument ('-U','--user',dest='username',action='store',default=None,
-                         help='the manifold username')
-    parser.add_argument ('-P','--password',dest='password',action='store',default=None,
-                         help='the manifold password')
-    parser.add_argument ('-v','--verbose',dest='verbose',action='count',default=0,
-                         help='more and more verbose')
-    args = parser.parse_args ()
-    
+    parser = ArgumentParser(description="manifoldupoader simple tester.")
+    parser.add_argument('credential_files', metavar='FILE', type=str, nargs='+',
+                        help="the filenames to upload")
+    parser.add_argument('-u', '--url', dest='url', action='store', default=None,
+                        help='the URL of the manifold API')
+    parser.add_argument('-p', '--platform', dest='platform', action='store', default=None,
+                        help='the manifold platform name')
+    parser.add_argument('-U', '--user', dest='username', action='store', default=None,
+                        help='the manifold username')
+    parser.add_argument('-P', '--password', dest='password', action='store', default=None,
+                        help='the manifold password')
+    parser.add_argument('-v', '--verbose', dest='verbose', action='count', default=0,
+                        help='more and more verbose')
+    args = parser.parse_args()
+
     from sfa.util.sfalogging import sfi_logger
     sfi_logger.enable_console()
     sfi_logger.setLevelFromOptVerbose(args.verbose)
-    uploader = ManifoldUploader (url=args.url, platform=args.platform,
-                                 username=args.username, password=args.password,
-                                 logger=sfi_logger)
+    uploader = ManifoldUploader(url=args.url, platform=args.platform,
+                                username=args.username, password=args.password,
+                                logger=sfi_logger)
 
     for filename in args.credential_files:
         with open(filename) as f:
-            result=uploader.upload (f.read(),filename)
-            sfi_logger.info('... result=%s'%result)
+            result = uploader.upload(f.read(), filename)
+            sfi_logger.info('... result=%s' % result)
 
 if __name__ == '__main__':
     main()