Add exlclude heroic telescopes option env variable

Author: Jon

configdb/hardware/heroic.py

@@ -128,7 +128,7 @@ def send_to_heroic(api_endpoint: str, payload: dict, update: bool = False):
 def create_heroic_instrument(instrument: Instrument):
     ''' Create a new instrument payload and send it to HEROIC
     '''
-    if (instrument.telescope.enclosure.site.code not in settings.HEROIC_EXCLUDE_SITES):
+    if (instrument.telescope.enclosure.site.code not in settings.HEROIC_EXCLUDE_SITES and str(instrument.telescope) not in settings.HEROIC_EXCLUDE_TELESCOPES):
         instrument_payload = {
             'id': heroic_instrument_id(instrument),
             'name': f"{instrument.instrument_type.name} - {instrument.code}",
@@ -145,7 +145,7 @@ def update_heroic_instrument_capabilities(instrument: Instrument):
     ''' Send the current instrument capabilities of an instrument to HEROIC
         if it is not DISABLED and heroic is set up in settings.py
     '''
-    if can_submit_to_heroic() and instrument.state != 'DISABLED' and instrument.telescope.enclosure.site.code not in settings.HEROIC_EXCLUDE_SITES:
+    if can_submit_to_heroic() and instrument.state != 'DISABLED' and instrument.telescope.enclosure.site.code not in settings.HEROIC_EXCLUDE_SITES and str(instrument.telescope) not in settings.HEROIC_EXCLUDE_TELESCOPES:
         capabilities = instrument_to_heroic_instrument_capabilities(instrument)
         try:
             send_to_heroic('instrument-capabilities/', capabilities)
@@ -156,7 +156,7 @@ def update_heroic_instrument_capabilities(instrument: Instrument):
 def create_heroic_telescope(telescope: Telescope):
     ''' Create a new telescope payload and send it to HEROIC
     '''
-    if telescope.enclosure.site.code not in settings.HEROIC_EXCLUDE_SITES:
+    if telescope.enclosure.site.code not in settings.HEROIC_EXCLUDE_SITES and str(telescope) not in settings.HEROIC_EXCLUDE_TELESCOPES:
         telescope_payload = telescope_to_heroic_telescope_properties(telescope)
         telescope_payload['id'] = heroic_telescope_id(telescope)
         telescope_payload['status'] = telescope_status_conversion(telescope)
@@ -171,7 +171,7 @@ def create_heroic_telescope(telescope: Telescope):
 def update_heroic_telescope_properties(telescope: Telescope):
     ''' Send updated telescope properties to HEROIC when they change
     '''
-    if telescope.enclosure.site.code not in settings.HEROIC_EXCLUDE_SITES:
+    if telescope.enclosure.site.code not in settings.HEROIC_EXCLUDE_SITES and str(telescope) not in settings.HEROIC_EXCLUDE_TELESCOPES:
         telescope_update_payload = telescope_to_heroic_telescope_properties(telescope)
         try:
             send_to_heroic(f'telescopes/{heroic_telescope_id(telescope)}/', telescope_update_payload, update=True)

configdb/hardware/tests.py

@@ -189,6 +189,17 @@ def test_update_instrument_state_on_excluded_site_does_not_call_out_to_heroic(se
         )
         mock_send.assert_not_called()
 
+    @override_settings(HEROIC_EXCLUDE_TELESCOPES=['tst.doma.1m0a'])
+    def test_update_instrument_state_on_excluded_telescope_does_not_call_out_to_heroic(self, mock_send):
+        instrument_update = {
+            'state': Instrument.MANUAL
+        }
+        self.client.patch(
+            reverse('instrument-detail', args=(self.instrument.id,)),
+            data=instrument_update, format='json'
+        )
+        mock_send.assert_not_called()
+
     def test_update_instrument_cameras_calls_out_to_heroic(self, mock_send):
         optical_element = mixer.blend(OpticalElement, name='myOE', code='myoe1', schedulable=True)
         optical_element_group = mixer.blend(OpticalElementGroup, optical_elements=[optical_element], type='filters')

configdb/settings.py

@@ -164,6 +164,7 @@ def get_list_from_env(variable, default=None):
 HEROIC_API_TOKEN = os.getenv('HEROIC_API_TOKEN', '')
 HEROIC_OBSERVATORY = os.getenv('HEROIC_OBSERVATORY', '')
 HEROIC_EXCLUDE_SITES = get_list_from_env('HEROIC_EXCLUDE_SITES', '')
+HEROIC_EXCLUDE_TELESCOPES = get_list_from_env('HEROIC_EXCLUDE_TELESCOPES', '')
 
 CORS_ORIGIN_ALLOW_ALL = True