scanInfo timeout

Author: kasemir

scan/client/scanclient.py

@@ -40,7 +40,7 @@
     from java.io import BufferedReader, InputStreamReader, OutputStream
     from java.net import HttpURLConnection, URL
 
-    def perform_request(url, method='GET', data=None):
+    def perform_request(url, method='GET', data=None, timeout=None):
         try:
             connection = URL(url).openConnection()
             connection.setRequestProperty("Connection", "close")
@@ -73,7 +73,7 @@ def perform_request(url, method='GET', data=None):
 else:
     import urllib2
 
-    def perform_request(url, method='GET', data=None):
+    def perform_request(url, method='GET', data=None, timeout=None):
         """Perform HTTP request with scan server
         
         :param url:    URL
@@ -93,7 +93,10 @@ def perform_request(url, method='GET', data=None):
             opener = urllib2.build_opener()
 
             if method=='GET':
-                response = opener.open(req)
+                if timeout:
+                    response = opener.open(req, timeout=timeout)
+                else:
+                    response = opener.open(req)
 
             elif method=='POST':
                 response = opener.open(req, data)
@@ -264,43 +267,44 @@ def __submitScanSequence(self, cmdSeq, scanName, queue=True):
         return self.__submitScanXML(cmdSeq.genSCN(),scanName, queue)
 
 
-    def scanInfos(self):
+    def scanInfos(self, timeout=20):
         """Get information of all scans 
         
         Using `GET {BaseURL}/scans`
         
+        :param timeout: Throws exception when no reply within that time in seconds
         :return: List of :class:`~scan.client.scaninfo.ScanInfo`
         
         Example::
 
         >>> infos = client.scanInfos()
         >>> print [ str(info) for info in infos ]
         """
-        xml = perform_request(self.__baseURL + "/scans")
+        xml = perform_request(self.__baseURL + "/scans", timeout=timeout)
         scans = ET.fromstring(xml)
         result = list()
         for scan in scans.findall('scan'):
             result.append(ScanInfo(scan))
         return result
 
 
-    def scanInfo(self, scanID):
+    def scanInfo(self, scanID, timeout=10):
         """Get information for a scan
         
         Using `GET {BaseURL}/scan/{id}`
               
         :param scanID: The ID of scan for which to fetch information.
+        :param timeout: Throws exception when no reply within that time in seconds
         :return: :class:`~scan.client.scaninfo.ScanInfo`
         
         Example::
         
         >>> client = ScanClient()
         >>> print client.scanInfo(42)
         """
-        xml = perform_request(self.__baseURL + "/scan/" + str(scanID))
+        xml = perform_request(self.__baseURL + "/scan/" + str(scanID), timeout=timeout)
         return ScanInfo(ET.fromstring(xml))
 
-
     def scanCmds(self, scanID):
         """Get the commands of scan.
         
@@ -381,19 +385,26 @@ def waitUntilDone(self, scanID):
         
         In case the scan failed or was aborted,
         an exception is raised.
+
+        If scan information is not available
+        (timeout while requesting it),
+        keep checking.
         
         :param scanID: ID of scan on which to wait
         
         :return: Scan info
         :raise Exception: If scan was aborted or failed. 
         """
-        info = self.scanInfo(scanID)
-        while not info.isDone():
+        while True:
+            try:
+                info = self.scanInfo(scanID)
+                if info.isDone():
+                    return info
+                if info.state in ( 'Aborted', 'Failed' ):
+                    raise Exception(str(info))
+            except:
+                pass
             time.sleep(1)
-            info = self.scanInfo(scanID)
-        if info.state in ( 'Aborted', 'Failed' ):
-            raise Exception(str(info))
-        return info
 
 
     def pause(self, scanID=-1):

scan/version.py

@@ -1,7 +1,8 @@
 
-__version__ = '1.5.4'
+__version__ = '1.5.5'
 
 version_history = """
+1.5.5 - scanInfo() time out
 1.5.4 - Add '!=' to If() and Wait()
 1.5.3 - Fix 'id' vs. 'scanID' in patch()
 1.5.2 - Try to use cElementTree