Merge pull request #2115 from alphagov/zendesk-formattin

Zendesk formatting to make tickets easier to read

app/main/views/feedback.py

@@ -103,18 +103,17 @@ def feedback(ticket_type):
         user_email = form.email_address.data
         user_name = form.name.data or None
         if current_service:
-            service_string = 'Service "{name}": {url}\n'.format(
+            service_string = 'Service: "{name}"\n{url}\n'.format(
                 name=current_service['name'],
                 url=url_for('main.service_dashboard', service_id=current_service['id'], _external=True)
             )
         else:
             service_string = ''
 
-        feedback_msg = 'Environment: {}\n{}{}\n{}'.format(
-            url_for('main.index', _external=True),
+        feedback_msg = '{}\n{}{}'.format(
+            form.feedback.data,
             service_string,
-            '' if user_email else '{} (no email address supplied)'.format(form.name.data),
-            form.feedback.data
+            '' if user_email else '{} (no email address supplied)'.format(form.name.data)
         )
 
         zendesk_client.create_ticket(

app/main/views/service_settings.py

@@ -195,7 +195,8 @@ def submit_request_to_go_live(service_id):
         zendesk_client.create_ticket(
             subject='Request to go live - {}'.format(current_service['name']),
             message=(
-                'On behalf of {} ({})\n'
+                'Service: {}\n'
+                '{}\n'
                 '\n---'
                 '\nOrganisation type: {}'
                 '\nAgreement signed: {}'
@@ -934,7 +935,8 @@ def branding_request(service_id):
         zendesk_client.create_ticket(
             subject='Email branding request - {}'.format(current_service['name']),
             message=(
-                'On behalf of {} ({})\n'
+                'Service: {}\n'
+                '{}\n'
                 '\n---'
                 '\nBranding requested: {}'
             ).format(

tests/app/main/views/test_feedback.py

@@ -124,7 +124,7 @@ def test_get_feedback_page_with_prefilled_body(
         _data={'feedback': 'blah', 'name': 'Example', 'email_address': 'test@example.com'}
     )
     message = mock_post.call_args[1]['message']
-    assert message.endswith('blah')
+    assert message.startswith('blah')
     assert 'Please send' not in message
 
 
@@ -144,7 +144,7 @@ def test_passed_non_logged_in_user_details_through_flow(client, mocker, ticket_t
     assert resp.location == url_for('main.thanks', urgent=True, anonymous=False, _external=True)
     mock_post.assert_called_with(
         subject='Notify feedback',
-        message='Environment: http://localhost/\n\nblah',
+        message='blah\n',
         user_email='rip@gmail.com',
         user_name='Steve Irwin',
         ticket_type=ticket_type,
@@ -182,14 +182,14 @@ def test_passes_user_details_through_flow(
         p1=ANY
     )
     assert mock_post.call_args[1]['message'] == '\n'.join([
-        'Environment: http://localhost/',
-        'Service "service one": {}'.format(url_for(
+        'blah',
+        'Service: "service one"',
+        url_for(
             'main.service_dashboard',
             service_id='596364a0-858e-42c8-9062-a8fe822260eb',
             _external=True
-        )),
-        '',
-        'blah',
+        ),
+        ''
     ])
 
 

tests/app/main/views/test_service_settings.py

@@ -595,7 +595,7 @@ def test_should_redirect_after_request_to_go_live(
     )
 
     returned_message = mock_post.call_args[1]['message']
-    assert 'On behalf of service one' in returned_message
+    assert 'Service: service one' in returned_message
     assert 'Organisation type: central' in returned_message
     assert 'Agreement signed: Can’t tell' in returned_message
     assert 'Channel: email and text messages' in returned_message
@@ -2610,13 +2610,13 @@ def test_submit_email_branding_request(
     )
 
     zendesk.assert_called_once_with(
-        message=(
-            'On behalf of service one '
-            '(http://localhost/services/596364a0-858e-42c8-9062-a8fe822260eb)\n'
-            '\n'
-            '---\n'
+        message='\n'.join([
+            'Service: service one',
+            'http://localhost/services/596364a0-858e-42c8-9062-a8fe822260eb',
+            '',
+            '---',
             'Branding requested: {}'
-        ).format(requested_branding),
+        ]).format(requested_branding),
         subject='Email branding request - service one',
         ticket_type='question',
         user_email='test@user.gov.uk',