Fix pep8 violations in csit/libraries/UtilLibrary.py
authorThanh Ha <thanh.ha@linuxfoundation.org>
Sun, 15 Mar 2015 20:15:04 +0000 (16:15 -0400)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Mon, 16 Mar 2015 01:03:59 +0000 (21:03 -0400)
Change-Id: Ic6bc044f7a959470c629983e838693664f33c8ca
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
test/csit/libraries/UtilLibrary.py

index 0312744e55985d929e2213a4996db7826553f9cb..7c08d81b4ebc4d1bed64d3115d14c51e36b2d971 100644 (file)
@@ -12,98 +12,97 @@ import time
 
 global _cache
 
-#
-#Helps in making GET REST calls
-#
 
 def get(url, userId='admin', password='admin'):
+    """Helps in making GET REST calls"""
 
     headers = {}
-    headers['Accept']= 'application/xml'
+    headers['Accept'] = 'application/xml'
 
     # Send the GET request
     session = _cache.switch("CLUSTERING_GET")
-    resp = session.get(url,headers=headers,auth=(userId,password))    
-    #resp = session.get(url,headers=headers,auth={userId,password})
+    resp = session.get(url, headers=headers, auth=(userId, password))
+    # resp = session.get(url,headers=headers,auth={userId,password})
     # Read the response
     return resp
 
-#
-#Helps in making POST REST calls without outputs
-#
+
 def nonprintpost(url, userId, password, data):
+    """Helps in making POST REST calls without outputs"""
 
-    if userId == None:
+    if userId is None:
         userId = 'admin'
 
-    if password == None:
+    if password is None:
         password = 'admin'
 
     headers = {}
     headers['Content-Type'] = 'application/json'
-    #headers['Accept']= 'application/xml'
+    # headers['Accept']= 'application/xml'
 
     session = _cache.switch("CLUSTERING_POST")
-    resp = session.post(url,data.encode('utf-8'),headers=headers,auth=(userId,password))
-
+    resp = session.post(url, data.encode('utf-8'), headers=headers, auth=(userId, password))
 
     return resp
 
-#
-#Helps in making POST REST calls
-#
+
 def post(url, userId, password, data):
+    """Helps in making POST REST calls"""
 
-    if userId == None:
+    if userId is None:
         userId = 'admin'
 
-    if password == None:
+    if password is None:
         password = 'admin'
 
     print("post request with url "+url)
     print("post request with data "+data)
     headers = {}
     headers['Content-Type'] = 'application/json'
-    #headers['Accept']= 'application/xml'
+    # headers['Accept']= 'application/xml'
     session = _cache.switch("CLUSTERING_POST")
-    resp = session.post(url,data.encode('utf-8'),headers=headers,auth=(userId,password))
+    resp = session.post(url, data.encode('utf-8'), headers=headers, auth=(userId, password))
 
-    #print (resp.raise_for_status())
+    # print (resp.raise_for_status())
     print (resp.headers)
-    if (resp.status_code >= 500):
-        print (resp.text)
+    if resp.status_code >= 500:
+        print(resp.text)
 
     return resp
 
-#
-#Helps in making DELET REST calls
-#
+
 def delete(url, userId='admin', password='admin'):
+    """Helps in making DELET REST calls"""
     print("delete all resources belonging to url"+url)
     session = _cache.switch("CLUSTERING_DELETE")
-    resp=session.delete(url,auth=(userId,password))
+    resp = session.delete(url, auth=(userId, password))  # noqa
+
 
 def Should_Not_Be_Type_None(var):
     '''Keyword to check if the given variable is of type NoneType.  If the
         variable type does match  raise an assertion so the keyword will fail
     '''
-    if var == None:
+    if var is None:
         raise AssertionError('the variable passed was type NoneType')
     return 'PASS'
 
-# use username and password of controller server for ssh and need
-# karaf distribution location like /root/Documents/dist
-#
+
 def execute_ssh_command(ip, username, password, command):
+    """Execute SSH Command
+
+    use username and password of controller server for ssh and need
+    karaf distribution location like /root/Documents/dist
+    """
     print "executing ssh command"
     lib = SSHLibrary()
     lib.open_connection(ip)
-    lib.login(username=username,password=password)
+    lib.login(username=username, password=password)
     print "login done"
     lib.execute_command(command)
     print "command executed : " + command
     lib.close_connection()
 
+
 def wait_for_controller_up(ip, port="8181"):
     url = "http://" + ip + ":" + str(port) + \
           "/restconf/config/opendaylight-inventory:nodes/node/controller-config/yang-ext:mount/config:modules"
@@ -126,6 +125,7 @@ def wait_for_controller_up(ip, port="8181"):
     print "Wait for controller " + ip + " failed"
     return False
 
+
 def startAllControllers(username, password, karafhome, port, *ips):
     # Start all controllers
     for ip in ips:
@@ -134,58 +134,67 @@ def startAllControllers(username, password, karafhome, port, *ips):
     # Wait for all of them to be up
     for ip in ips:
         rc = wait_for_controller_up(ip, port)
-        if (rc == False):
+        if rc is False:
             return False
     return True
 
-def startcontroller(ip,username,password,karafhome,port):
-    execute_ssh_command(ip, username, password, karafhome+"/bin/start")
+
+def startcontroller(ip, username, password, karafhome, port):
+    execute_ssh_command(ip, username, password, karafhome + "/bin/start")
     return wait_for_controller_up(ip, port)
 
-def stopcontroller(ip,username,password,karafhome):
-    executeStopController(ip,username,password,karafhome)
 
-    wait_for_controller_stopped(ip,username,password,karafhome)
+def stopcontroller(ip, username, password, karafhome):
+    executeStopController(ip, username, password, karafhome)
+
+    wait_for_controller_stopped(ip, username, password, karafhome)
 
-def executeStopController(ip,username,password,karafhome):
+
+def executeStopController(ip, username, password, karafhome):
     execute_ssh_command(ip, username, password, karafhome+"/bin/stop")
 
-def stopAllControllers(username,password,karafhome,*ips):
+
+def stopAllControllers(username, password, karafhome, *ips):
     for ip in ips:
-        executeStopController(ip,username,password,karafhome)
+        executeStopController(ip, username, password, karafhome)
 
     for ip in ips:
         wait_for_controller_stopped(ip, username, password, karafhome)
 
+
 def wait_for_controller_stopped(ip, username, password, karafHome):
     lib = SSHLibrary()
     lib.open_connection(ip)
-    lib.login(username=username,password=password)
+    lib.login(username=username, password=password)
 
-    # Wait 1 minute for the controller to stop gracefully   
+    # Wait 1 minute for the controller to stop gracefully
     tries = 20
-    i=1
+    i = 1
     while i <= tries:
         stdout = lib.execute_command("ps -axf | grep karaf | grep -v grep | wc -l")
-        #print "stdout: "+stdout
+        # print "stdout: "+stdout
         processCnt = stdout[0].strip('\n')
-        print "processCnt: "+processCnt
+        print("processCnt: " + processCnt)
         if processCnt == '0':
-            break;
-        i = i+1
+            break
+        i = i + 1
         time.sleep(3)
 
     lib.close_connection()
 
     if i > tries:
         print "Killing controller"
-        kill_controller(ip, username, password, karafHome)   
+        kill_controller(ip, username, password, karafHome)
+
 
 def clean_journal(ip, username, password, karafHome):
     execute_ssh_command(ip, username, password, "rm -rf " + karafHome + "/journal")
 
+
 def kill_controller(ip, username, password, karafHome):
-    execute_ssh_command(ip, username, password, "ps axf | grep karaf | grep -v grep | awk '{print \"kill -9 \" $1}' | sh")
+    execute_ssh_command(ip, username, password,
+                        "ps axf | grep karaf | grep -v grep | awk '{print \"kill -9 \" $1}' | sh")
+
 
 #
 # main invoked
@@ -193,5 +202,5 @@ if __name__ != "__main__":
     _cache = robot.utils.ConnectionCache('No sessions created')
     # here create one session for each HTTP functions
     _cache.register(requests.session(), alias='CLUSTERING_GET')
-    _cache.register(requests.session(),alias='CLUSTERING_POST')
-    _cache.register(requests.session(),alias='CLUSTERING_DELETE')
+    _cache.register(requests.session(), alias='CLUSTERING_POST')
+    _cache.register(requests.session(), alias='CLUSTERING_DELETE')