feat: add ability to configure sigmax return state

Author: bartjkdp

app/signals/apps/sigmax/stuf_protocol/incoming/actualiseerZaakstatus_Lk01.py

@@ -7,6 +7,7 @@
 import logging
 import re
 
+from django.conf import settings
 from django.core.exceptions import ValidationError
 from django.shortcuts import render
 from lxml import etree
@@ -105,9 +106,20 @@ def _update_status_actualiseerZaakstatus_Lk01(signal, request_data):
     Note: this is the happy flow, only happens when the Signal was in the
     expected state in SIA --- else see _add_note_actualiseerZaakstatus_Lk01.
     """
-    status_text = _get_status_text_actualiseerZaakstatus_Lk01(request_data)
+    resultaat_text = request_data.get('resultaat', '').strip()
+
+    if settings.SIGMAX_END_STATE_IS_AFGEHANDELD and resultaat_text == 'afgerond':
+        set_status_to_afgehandeld = True
+        note_text = _get_status_text_actualiseerZaakstatus_Lk01(request_data)
+        status_text = settings.SIGMAX_END_STATE_IS_AFGEHANDELD_STATUS_TEXT
+    else:
+        set_status_to_afgehandeld = False
+        note_text = None
+        status_text = _get_status_text_actualiseerZaakstatus_Lk01(request_data)
+
     status_data = {
-        'state': workflow.AFGEHANDELD_EXTERN,
+        'state': workflow.AFGEHANDELD if set_status_to_afgehandeld else workflow.AFGEHANDELD_EXTERN,
+        'send_email': True if set_status_to_afgehandeld else False,
         'text': status_text,
         'extra_properties': {
             'sigmax_datum_afgehandeld': request_data['datum_afgehandeld'],
@@ -116,6 +128,10 @@ def _update_status_actualiseerZaakstatus_Lk01(signal, request_data):
         }
     }
 
+    if note_text:
+        note_data = {'text': note_text}
+        Signal.actions.create_note(note_data, signal)
+
     # We let exceptions bubble up (must lead to a error message to CityControl).
     Signal.actions.update_status(data=status_data, signal=signal)
 

app/signals/apps/sigmax/tests/rest_framework/test_views.py

@@ -326,3 +326,53 @@ def test_with_signal_for_message_correct_state_no_resultaat_toelichting(self):
         })
         self.assertEqual(signal.status.state, workflow.AFGEHANDELD_EXTERN)
         self.assertEqual(signal.status.state, workflow.AFGEHANDELD_EXTERN)
+
+    @mock.patch('signals.settings.SIGMAX_END_STATE_IS_AFGEHANDELD', True)
+    @mock.patch('signals.settings.SIGMAX_END_STATE_IS_AFGEHANDELD_STATUS_TEXT', 'Test opgelost bericht')
+    def test_with_sigmax_end_state_is_afgehandeld_enabled_and_afgerond_result(self):
+        """Test that when SIGMAX_END_STATE_IS_AFGEHANDELD=True and resultaat='afgerond',
+        the signal gets AFGEHANDELD status instead of AFGEHANDELD_EXTERN"""
+        signal = SignalFactoryValidLocation.create()
+        signal.status.state = workflow.VERZONDEN
+        signal.status.save()
+        signal.refresh_from_db()
+
+        self.assertEqual(Signal.objects.count(), 1)
+
+        incoming_context = {
+            'signal': signal,
+            'tijdstipbericht': '20180927100000',
+            'resultaat_omschrijving': 'afgerond',  # This triggers the special behavior
+            'resultaat_toelichting': 'Het probleem is opgelost',
+            'resultaat_datum': '2018101111485276',
+        }
+        incoming_msg = render_to_string('sigmax/actualiseerZaakstatus_Lk01.xml', incoming_context)
+
+        # authenticate
+        self.client.force_authenticate(user=self.sigmax_user)
+
+        # call our SOAP endpoint
+        response = self.client.post(
+            SOAP_ENDPOINT,
+            data=incoming_msg,
+            HTTP_SOAPACTION=ACTUALISEER_ZAAK_STATUS,
+            content_type='text/xml',
+        )
+
+        self.assertEqual(response.status_code, 200)
+
+        signal.refresh_from_db()
+        # Should be AFGEHANDELD instead of AFGEHANDELD_EXTERN when setting is enabled
+        self.assertEqual(signal.status.state, workflow.AFGEHANDELD)
+        # Should use the special status text
+        self.assertEqual(signal.status.text, 'Test opgelost bericht')
+        # Should have the same extra properties
+        self.assertEqual(signal.status.extra_properties, {
+            'sigmax_datum_afgehandeld': incoming_context['resultaat_datum'],
+            'sigmax_resultaat': incoming_context['resultaat_omschrijving'],
+            'sigmax_reden': incoming_context['resultaat_toelichting'],
+        })
+        # Check that a note was added with the regular status text
+        self.assertEqual(signal.notes.count(), 1)
+        note = signal.notes.first()
+        self.assertEqual(note.text, 'afgerond: Het probleem is opgelost')

app/signals/apps/signals/workflow.py

@@ -119,6 +119,7 @@
     ],
     VERZONDEN: [
         AFGEHANDELD_EXTERN,
+        AFGEHANDELD,
         GEANNULEERD,  # SIG-2987
     ],
     VERZENDEN_MISLUKT: [

app/signals/settings.py

@@ -399,6 +399,11 @@ def is_super_user(user) -> bool:
 SIGMAX_CLIENT_CERT: str | None = os.getenv('SIGMAX_CLIENT_CERT', None)
 SIGMAX_CLIENT_KEY: str | None = os.getenv('SIGMAX_CLIENT_KEY', None)
 SIGMAX_SEND_FAIL_TIMEOUT_MINUTES: str | int = os.getenv('SIGMAX_SEND_FAIL_TIMEOUT_MINUTES', 60*24)  # noqa Default is 24hrs.
+SIGMAX_END_STATE_IS_AFGEHANDELD: bool = os.getenv('SIGMAX_END_STATE_IS_AFGEHANDELD', False) in TRUE_VALUES
+SIGMAX_END_STATE_IS_AFGEHANDELD_STATUS_TEXT: str = os.getenv(
+    'SIGMAX_END_STATE_IS_AFGEHANDELD_STATUS_TEXT',
+    'We hebben uw melding opgelost. Bedankt voor het doorgeven!'
+)
 
 SIGMAX_TRANSFORM_DESCRIPTION_BASED_ON_SOURCE: str | None = os.getenv(
     'SIGMAX_TRANSFORM_DESCRIPTION_BASED_ON_SOURCE', None