Create event with labels

Adds a 'labels' argument to the createEvent() method. 'labels' can be specified as a string (for a single label) or a list of strings (for one or more labels). 'labels' is then joined into a comma-separated string for passing to the server, which parses the string and adds the labels.

Adds the allowed_labels property to the GraceDb class, which gets the list of available labels from the server. This is used to test the labels submitted by the user and raise an exception if it doesn't match a label in the list.

Adds unit tests for testing this feature and for testing removal of labels. I've run the unit tests successfully and manually tested creating events with no labels, one label, several labels, bad labels, etc. to ensure that it works as expected.

This patch should be coordinated with the merge request to the server code shown here: https://git.ligo.org/lscsoft/gracedb/merge_requests/3. It cannot function properly unless the server code patch is already in place.

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"""
@@ -358,12 +388,12 @@ class TestGracedb(unittest.TestCase):
 
 if __name__ == "__main__":
 
-    global gracedb, testdatadir, createdEvent, eventId
+    global gracedb, testdatadir, createdEvent, eventId, labelName
 
-#   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,6 +401,7 @@ if __name__ == "__main__":
     testdatadir = os.environ.get('TEST_DATA_DIR', testdatadir)
 
     gracedb = GraceDb(service)
+    labelName = "DQV"
     #gracedb = GraceDbBasic(service)
     print("Using service", service)