client: add get_event_status method (#72)

Fixes cbsinteractive/propeller#1529

Author: Allison Deal

elemental/client.py

@@ -144,15 +144,20 @@ def describe_event(self, event_id: str, timeout: Optional[int] = None) -> EventS
             uri = destinations[1].find('uri')
             event_info['backup_url'] = uri.text if uri is not None else ''
 
-        status = ET.fromstring(response.text).find('status')
-        event_info['status'] = status.text if status is not None else 'unknown'
+        event_info['status'] = self._parse_status(response.text)
 
         return EventStatusDict(
             status=str(event_info['status']),
             origin_url=str(event_info['origin_url']),
             backup_url=event_info.get('backup_url')
         )
 
+    def get_event_status(self, event_id: str, timeout: Optional[int] = None) -> str:
+        url = f'{self.server_url}/live_events/{event_id}/status'
+        headers = self.generate_headers(url)
+        response = self.send_request(http_method="GET", url=url, headers=headers, timeout=timeout)
+        return self._parse_status(response.text)
+
     def find_devices_in_use(self, timeout: Optional[int] = None) -> Set[Optional[str]]:
         events_url = f'{self.server_url}/live_events?filter=active'
         events_headers = self.generate_headers(events_url)
@@ -249,3 +254,7 @@ def generate_preview(self, input_id: str, timeout: Optional[int] = None) -> Prev
     def event_can_delete(self, channel_id: str, timeout: Optional[int] = None) -> bool:
         channel_info = self.describe_event(channel_id, timeout=timeout)
         return channel_info['status'] not in ('pending', 'running', 'preprocessing', 'postprocessing',)
+
+    def _parse_status(self, text):
+        status = ET.fromstring(text).find('status')
+        return status.text if status is not None else 'unknown'

tests/client_test.py

@@ -440,6 +440,67 @@ def test_describe_event_will_return_event_info_as_expect():
                           'status': 'complete'}
 
 
+def test_get_event_status():
+    client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)
+
+    client.generate_headers = mock.Mock()
+    client.generate_headers.return_value = HEADERS
+
+    client.send_request = mock.Mock()
+    response_from_elemental_api = """<?xml version="1.0" encoding="UTF-8"?>
+    <live_event href="/live_events/18">
+      <node>ctcsdprdel5</node>
+      <user_data/>
+      <submitted>2020-11-02 18:38:27 -0500</submitted>
+      <priority>50</priority>
+      <restart_on_failure>false</restart_on_failure>
+      <status>pending</status>
+      <average_fps>0</average_fps>
+      <start_time/>
+      <elapsed>0</elapsed>
+      <elapsed_time_in_words>00:00:00</elapsed_time_in_words>
+      <dropped_frames/>
+      <buffer_avg/>
+      <buffer_max/>
+    </live_event>
+    """
+    client.send_request.return_value = mock_response(
+        status=200, text=response_from_elemental_api)
+    event_id = '999'
+
+    status = client.get_event_status(event_id)
+
+    assert status == 'pending'
+    client.send_request.assert_called_once_with(
+        http_method='GET',
+        url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}/status',
+        headers=HEADERS, timeout=None)
+
+
+def test_get_event_status_missing_status_in_elemental_response():
+    client = ElementalLive(ELEMENTAL_ADDRESS, USER, API_KEY)
+
+    client.generate_headers = mock.Mock()
+    client.generate_headers.return_value = HEADERS
+
+    client.send_request = mock.Mock()
+    response_from_elemental_api = """<?xml version="1.0" encoding="UTF-8"?>
+    <live_event href="/live_events/18">
+    </live_event>
+    """
+    client.send_request.return_value = mock_response(
+        status=200, text=response_from_elemental_api)
+    event_id = '999'
+
+    status = client.get_event_status(event_id)
+
+    assert status == 'unknown'
+    client.send_request.assert_called_once_with(
+        http_method='GET',
+        url=f'{ELEMENTAL_ADDRESS}/live_events/{event_id}/status',
+        headers=HEADERS, timeout=None)
+
+
 @pytest.mark.parametrize('status,expected_result', [
     ('pending', False),
     ('running', False),