itkdb-gtk 0.10.9.dev3__py3-none-any.whl → 0.10.10__py3-none-any.whl

itkdb_gtk/ITkDButils.py

@@ -10,19 +10,31 @@ import itkdb
 
 # The response of the DB
 db_response = ""
+attachment_urls = {}
+uploaded_test_runs = []
 
 
 # define an Attachment object.
 class Attachment(object):
     """Encapsulates Attachment information."""
 
-    def __init__(self, path=None, title=None, desc=None):
+    def __init__(self, path=None, url=None, title=None, desc=None):
         """Initialization."""
         if path is not None:
             self.path = Path(path).expanduser().resolve()
+            self.type = "file"
         else:
             self.path = None
 
+        if url is not None:
+            self.url = url
+            self.type = "link"
+        else:
+            self.url = None
+
+        if self.path and self.url:
+            raise ValueError("Invalid Attachment. Has both file and link.")
+
         self.title = title
         self.desc = desc
 
@@ -44,7 +56,6 @@ def get_db_response():
     It is stores in a global variable. Trust the function if call
     right after your interaction with the DB.
     """
-    global db_response
     return db_response
 
 
@@ -72,7 +83,8 @@ def get_db_date(timestamp=None):
         try:
             this_date = dateutil.parser.parse(timestamp)
             out = date2string(this_date)
-        except Exception:
+
+        except (OverflowError, dateutil.parser.ParserError):
             out = ""
 
     return out
@@ -161,13 +173,13 @@ def create_component_attachment(client, SN, file_path, title=None, description="
     return db_response
 
 
-def set_component_property(client, SN, property, value):
+def set_component_property(client, SN, the_property, value):
     """Set the value of an object property.
 
     Args:
         client: The DB client
         SN: The object SN
-        property: The property name
+        the_property: The property name
         value: The property value
 
     """
@@ -175,7 +187,7 @@ def set_component_property(client, SN, property, value):
     try:
         db_response = client.post('setComponentProperty',
                                   json={'component': SN,
-                                        'code': property,
+                                        'code': the_property,
                                         'value': value})
         return db_response
 
@@ -247,7 +259,7 @@ def get_DB_component(client, SN):
         db_response = str(e)
         return None
 
-def upload_test(client, data, attachments=None):
+def upload_test(client, data, attachments=None, check_runNumber=False):
     """Upload a test to the DB.
 
     Args:
@@ -260,39 +272,129 @@ def upload_test(client, data, attachments=None):
 
     """
     global db_response
+    global attachment_urls
+    global uploaded_test_runs
+
+    uploaded_test_runs = []
+    attachment_urls = {}
+    db_response = None
+
+    # Check the given run_number. If already existing, give another one which
+    # will try to be consecutive.
+    if check_runNumber:
+        # Get all the runNumbers in this test
+        test_list = client.get("listTestRunsByComponent",
+                               json={
+                                    "filterMap":{
+                                    "serialNumber": data["component"],
+                                    "state": "ready",
+                                    "testType":[data["testType"]]
+                                    }
+                                }
+                               )
+        runN= {}
+        for T in test_list:
+            runN[T["runNumber"]] = 1
+
+        if data["runNumber"] in runN:
+            # if the given runNumber is there, try to create a new one.
+            #print("runNumber {} already in {} of {}".format(data["runNumber"], data["testType"], data["component"]))
+            try:
+                irun = int(data["runNumber"])
+                for i in range(irun+1, 100):
+                    newRn = "{}".format(i)
+                    if newRn not in runN:
+                        data["runNumber"] = newRn
+                        break
+
+            except ValueError:
+                for i in range(100):
+                    newRn = "{}_{}".format(data["runNumber"], i+1)
+                    if newRn not in runN:
+                        data["runNumber"] = newRn
+                        break
+
+    # Try to upload the test
     try:
         db_response = client.post("uploadTestRunResults", json=data)
         testRun = db_response["testRun"]["id"]
+        uploaded_test_runs.append(testRun)
+
+        # Handle attachments.
+        attachment_urls = {}
         if attachments is not None:
             if not isinstance(attachments, Iterable):
                 attachments = (attachments)
 
             for att in attachments:
-                path = Path(att.path).expanduser().resolve()
-                if not path.exists():
-                    print("File {} does not exist".format(path))
-                    continue
-
                 data = {"testRun": testRun,
                         "title": att.title if att.title is not None else path.name,
                         "description": att.desc if att.desc is not None else path.name,
-                        "type": "file",
+                        "type": att.type,
                         }
-                filetype = mimetypes.guess_type(path.name)
-                attachment = {'data': (path.name, open(path.as_posix(), 'rb'), filetype[0])}
+                if att.type == "file":
+                    path = Path(att.path).expanduser().resolve()
+                    if not path.exists():
+                        print("File {} does not exist".format(path))
+                        continue
+
+                    data["url"] = path.name
+                    filetype = mimetypes.guess_type(path.name)
+                    attachment = {'data': (path.name, open(path.as_posix(), 'rb'), filetype[0])}
+                else:
+                    data["url"] = att.url
+                    filetype = mimetypes.guess_type(att.url)
+                    attachment = {'data':(att.url, None, "text/x-uri") }
+
                 db_response = client.post('createTestRunAttachment',
                                           data=data,
                                           files=attachment)
-                
+                try:
+                    url = db_response['url'].replace("https://eosatlas.cern.ch","https://cernbox.cern.ch/files/spaces")
+                    attachment_urls[path.name] = url
+
+                except KeyError:
+                    pass
+
 
         return None
 
     except Exception as e:
         return (str(e))
 
+def set_test_run_parameter(session, test_run, parameter, value):
+    """Modify testRun Parameter
+
+    Args:
+        session: The ITkDB session
+        test_run: ID of test run
+        parameter: parameter code
+        value: The new value
+    """
+    global db_response
+    try:
+        db_response = session.post("setTestRunParameter",
+                                   json={"testRun": test_run, "code": parameter, "value": value})
+        return None
+
+    except Exception as E:
+        return (str(E))
+
+def create_test_run_comment(session, test_run, comments):
+    """Adds a new comment in testRun."""
+    global db_response
+    if not isinstance(comments, Iterable):
+        comments = (comments)
+
+    try:
+        db_response = session.post("createTestRunComment", json={"testRun": test_run, "comments": comments})
+        return None
+
+    except Exception as E:
+        return (str(E))
 
 def create_shipment(session, sender, recipient, items, name=None, send=False,
-                    type="domestic", attachment=None, comments=None):
+                    shipment_type="domestic", attachment=None, comments=None):
     """Create a chipment.
 
     Args:
@@ -311,7 +413,7 @@ def create_shipment(session, sender, recipient, items, name=None, send=False,
     if name is None:
         name = "From {} to {}".format(sender, recipient)
 
-    if type not in ["domestic", "intraContinental", "continental"]:
+    if shipment_type not in ["domestic", "intraContinental", "continental"]:
         db_response = "Wrong shipment type."
         return None
 
@@ -330,7 +432,7 @@ def create_shipment(session, sender, recipient, items, name=None, send=False,
         "name": name,
         "sender": sender,
         "recipient": recipient,
-        "type": type,
+        "type": shipment_type,
         "shipmentItems": items,
     }
 
@@ -569,3 +671,20 @@ def create_client():
     client.user.authenticate()
     print("Hello {} !".format(client.user.name))
     return client
+
+def get_db_user(client):
+    """REturn PDB information of current user.
+
+    Args:
+        client (itkdb.Client): The DB client.
+
+    """
+    global db_response
+    if client is None:
+        return None
+
+    try:
+        db_response = client.get("getUser", json={"userIdentity": client.user.identity})
+        return db_response
+    except Exception:
+        return None