Merge pull request #705 from alphagov/filter-test-messages-jobs

Filter test messages from jobs on the dashboard

app/main/views/dashboard.py

@@ -7,7 +7,8 @@ from flask import (
     redirect,
     url_for,
     session,
-    jsonify
+    jsonify,
+    current_app
 )
 
 from flask_login import login_required
@@ -169,5 +170,8 @@ def get_dashboard_statistics_for_service(service_id):
         'sms_allowance_remaining': max(0, (sms_free_allowance - sms_sent)),
         'sms_chargeable': max(0, sms_sent - sms_free_allowance),
         'sms_rate': sms_rate,
-        'jobs': add_rate_to_jobs(job_api_client.get_job(service_id, limit_days=7)['data'])
+        'jobs': add_rate_to_jobs(filter(
+            lambda job: job['original_file_name'] != current_app.config['TEST_MESSAGE_FILENAME'],
+            job_api_client.get_job(service_id, limit_days=7)['data']
+        ))
     }

app/main/views/send.py

@@ -144,7 +144,7 @@ def get_example_csv(service_id, template_id):
 @user_has_permissions('send_texts', 'send_emails', 'send_letters')
 def send_test(service_id, template_id):
 
-    file_name = 'Test message'
+    file_name = current_app.config['TEST_MESSAGE_FILENAME']
 
     template = Template(
         service_api_client.get_service_template(service_id, template_id)['data'],

config.py

@@ -40,6 +40,7 @@ class Config(object):
     DESKPRO_DEPT_ID = os.environ['DESKPRO_DEPT_ID']
     DESKPRO_ASSIGNED_AGENT_TEAM_ID = os.environ['DESKPRO_ASSIGNED_AGENT_TEAM_ID']
     ACTIVITY_STATS_LIMIT_DAYS = 7
+    TEST_MESSAGE_FILENAME = 'Test message'
 
     EMAIL_DOMAIN_REGEXES = [
         "gov\.uk",

tests/app/main/views/test_dashboard.py

@@ -2,6 +2,7 @@ import copy
 from flask import url_for
 
 from bs4 import BeautifulSoup
+from freezegun import freeze_time
 
 from tests import validate_route_permission
 from tests.conftest import SERVICE_ONE_ID
@@ -140,6 +141,49 @@ def test_should_show_all_templates_on_template_statistics_page(
         assert '13' in table_rows[1].find_all('td')[0].text
 
 
+@freeze_time("2016-01-01 11:09:00.061258")
+def test_should_show_recent_jobs_on_dashboard(
+    app_,
+    mocker,
+    api_user_active,
+    mock_get_service,
+    mock_get_service_templates,
+    mock_get_service_statistics,
+    mock_get_aggregate_service_statistics,
+    mock_get_user,
+    mock_get_user_by_email,
+    mock_login,
+    mock_get_template_statistics,
+    mock_get_jobs,
+    mock_has_permissions,
+    mock_get_usage
+):
+
+    with app_.test_request_context(), app_.test_client() as client:
+        client.login(api_user_active)
+        response = client.get(url_for('main.service_dashboard', service_id=SERVICE_ONE_ID))
+
+    mock_get_jobs.assert_called_once_with(SERVICE_ONE_ID, limit_days=7)
+    assert response.status_code == 200
+
+    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
+    table_rows = page.find_all('tbody')[1].find_all('tr')
+
+    assert "Test message" not in page.text
+    assert len(table_rows) == 4
+
+    for index, filename in enumerate((
+        "export 1/1/2016.xls",
+        "all email addresses.xlsx",
+        "applicants.ods",
+        "thisisatest.csv",
+    )):
+        assert filename in table_rows[index].find_all('th')[0].text
+        assert 'Uploaded 1 January at 11:09' in table_rows[index].find_all('th')[0].text
+        for column_index, count in enumerate((1, 0, 0)):
+            assert table_rows[index].find_all('td')[column_index].text.strip() == str(count)
+
+
 def _test_dashboard_menu(mocker, app_, usr, service, permissions):
     with app_.test_request_context():
         with app_.test_client() as client:

tests/conftest.py

@@ -779,7 +779,7 @@ def mock_check_verify_code_code_expired(mocker):
 @pytest.fixture(scope='function')
 def mock_create_job(mocker, api_user_active):
     def _create(job_id, service_id, template_id, file_name, notification_count):
-        job_data = job_json(
+        return job_json(
             service_id,
             api_user_active,
             job_id=job_id,
@@ -787,7 +787,6 @@ def mock_create_job(mocker, api_user_active):
             bucket_name='service-{}-notify'.format(job_id),
             original_file_name='{}.csv'.format(job_id),
             notification_count=notification_count)
-        return job_data
 
     return mocker.patch('app.job_api_client.create_job', side_effect=_create)
 
@@ -795,8 +794,7 @@ def mock_create_job(mocker, api_user_active):
 @pytest.fixture(scope='function')
 def mock_get_job(mocker, api_user_active):
     def _get_job(service_id, job_id):
-        job_data = job_json(service_id, api_user_active, job_id=job_id)
+        return {"data": job_json(service_id, api_user_active, job_id=job_id)}
-        return {"data": job_data}
 
     return mocker.patch('app.job_api_client.get_job', side_effect=_get_job)
 
@@ -804,11 +802,16 @@ def mock_get_job(mocker, api_user_active):
 @pytest.fixture(scope='function')
 def mock_get_jobs(mocker, api_user_active):
     def _get_jobs(service_id, limit_days=None):
-        data = []
+        return {"data": [
-        for i in range(5):
+            job_json(service_id, api_user_active, original_file_name=filename)
-            job_data = job_json(service_id, api_user_active)
+            for filename in (
-            data.append(job_data)
+                "Test message",
-        return {"data": data}
+                "export 1/1/2016.xls",
+                "all email addresses.xlsx",
+                "applicants.ods",
+                "thisisatest.csv",
+            )
+        ]}
 
     return mocker.patch('app.job_api_client.get_job', side_effect=_get_jobs)