Introduction of 'offline' parameter

Adds a boolean parameter to the createEvent() method which specifies whether the event was found by an offline (True) or online/low-latency search (False). Default is set to offline=False so that in the worst-case scenario, an offline event is marked as online, which is the same as the current behavior.

Note that this branch is based off of !15 (merged), so that should be merged first (hence why this is marked as WIP). Currently the changes shown below feature those changes as well. This requires a server code update as well, which is shown here: gracedb!4.

ligo/gracedb/test/test.py

@@ -197,12 +197,42 @@ class TestGracedb(unittest.TestCase):
 
     def test_label_event(self):
         """Label an event"""
-        r = gracedb.writeLabel(eventId, "DQV")
+        r = gracedb.writeLabel(eventId, labelName)
         self.assertEqual(r.status, 201) # CREATED
-        r = gracedb.labels(eventId, "DQV")
+        r = gracedb.labels(eventId, labelName)
         self.assertEqual(r.status, 200)
         label = r.json()
-        self.assertEqual("DQV", label['name'])
+        self.assertEqual(labelName, label['name'])
+
+    def test_remove_label_event(self):
+        """Remove label added by test_label_event"""
+        r = gracedb.removeLabel(eventId, labelName)
+        self.assertEqual(r.status, 200)
+
+    def test_create_event_with_label(self):
+        """Create an event with a single label"""
+        time.sleep(SLEEP_TIME)
+        eventFile = os.path.join(testdatadir, "burst-cwb.txt")
+        r = gracedb.createEvent("Test", "CWB", eventFile, labels=labelName)
+        gid = r.json()['graceid']
+        self.assertEqual(r.status, 201)
+        r = gracedb.labels(gid, labelName)
+        label = r.json()
+        self.assertEqual(labelName, label['name'])
+
+    def test_create_event_with_labels(self):
+        """Create an event with multiple labels"""
+        label_list = [labelName, "INJ", "PE_READY"]
+        time.sleep(SLEEP_TIME)
+        eventFile = os.path.join(testdatadir, "burst-cwb.txt")
+        r = gracedb.createEvent("Test", "CWB", eventFile, labels=label_list)
+        temp = r.json()
+        gid = temp['graceid']
+        self.assertEqual(r.status, 201)
+        for l in label_list:
+            r = gracedb.labels(gid, l)
+            label = r.json()
+            self.assertEqual(l, label['name'])
 
     def test_create_cwb(self):
         """Create a CWB event"""
@@ -286,6 +316,18 @@ class TestGracedb(unittest.TestCase):
         r = gracedb.writeFile(eventId, uploadFile)
         self.assertEqual(r.status, 201) # CREATED
 
+    def test_offline_param(self):
+        """
+        Tests whether offline parameter is transmitted to database
+        properly or not. Creates an event with offline=True and checks it;
+        also checks createdEvent, which uses offline=False.
+        """
+        self.assertEqual(createdEvent['offline'], offline)
+        r = gracedb.createEvent("Test", "gstlal", eventFile,
+            search="LowMass",offline=True)
+        temp = r.json()
+        self.assertEqual(temp['offline'], True)
+
     def test_logger(self):
         import logging
         import ligo.gracedb.rest
@@ -358,12 +400,12 @@ class TestGracedb(unittest.TestCase):
 
 if __name__ == "__main__":
 
-    global gracedb, testdatadir, createdEvent, eventId
+    global gracedb, testdatadir, createdEvent, eventId, labelName, offline
 
-#   Hacky "global" fixture.
-#   Do not want to create a millions events
-#   in order to test out event-updating features,
-#   which is what a normal test case setUp() would do.
+    # Hacky "global" fixture.
+    # Do not want to create a million events
+    # in order to test out event-updating features,
+    # which is what a normal test case setUp() would do.
 
     testdatadir = os.path.join(os.path.dirname(__file__), "data")
 
@@ -371,12 +413,14 @@ if __name__ == "__main__":
     testdatadir = os.environ.get('TEST_DATA_DIR', testdatadir)
 
     gracedb = GraceDb(service)
+    labelName = "DQV"
+    offline = False
     #gracedb = GraceDbBasic(service)
     print("Using service", service)
 
     eventFile = os.path.join(testdatadir, "cbc-lm.xml")
-    createdEvent = gracedb.createEvent(
-            "Test", "gstlal", eventFile, "LowMass").json()
+    createdEvent = gracedb.createEvent("Test", "gstlal", eventFile, 
+        "LowMass", offline=offline).json()
     eventId = createdEvent["graceid"]
 
     unittest.main()