Merge pull request #1223 from alphagov/letter-jobs-page

Letter jobs page

app/__init__.py

@@ -52,6 +52,7 @@ from app.notify_client.events_api_client import EventsApiClient
 from app.notify_client.provider_client import ProviderClient
 from app.notify_client.organisations_client import OrganisationsClient
 from app.notify_client.models import AnonymousUser
+from app.notify_client.letter_jobs_client import LetterJobsClient
 
 login_manager = LoginManager()
 csrf = CsrfProtect()
@@ -69,6 +70,7 @@ provider_client = ProviderClient()
 organisations_client = OrganisationsClient()
 asset_fingerprinter = AssetFingerprinter()
 statsd_client = StatsdClient()
+letter_jobs_client = LetterJobsClient()
 
 # The current service attached to the request stack.
 current_service = LocalProxy(partial(_lookup_req_object, 'service'))
@@ -100,6 +102,7 @@ def create_app():
     events_api_client.init_app(application)
     provider_client.init_app(application)
     organisations_client.init_app(application)
+    letter_jobs_client.init_app(application)
 
     login_manager.init_app(application)
     login_manager.login_view = 'main.sign_in'

app/main/__init__.py

@@ -26,5 +26,6 @@ from app.main.views import (
     invites,
     feedback,
     providers,
-    platform_admin
+    platform_admin,
+    letter_jobs
 )

app/main/views/letter_jobs.py

@@ -0,0 +1,31 @@
+import datetime
+
+from flask import render_template, request
+from flask_login import login_required
+
+from app import letter_jobs_client, format_datetime_24h
+from app.main import main
+from app.utils import user_has_permissions
+
+
+@main.route("/letter-jobs", methods=['GET', 'POST'])
+@login_required
+@user_has_permissions(admin_override=True)
+def letter_jobs():
+    msg = ''
+    letter_jobs_list = letter_jobs_client.get_letter_jobs()
+
+    if request.method == 'POST':
+        if len(request.form.getlist('job_id')) > 0:
+            job_ids = request.form.getlist('job_id')
+
+            response = letter_jobs_client.send_letter_jobs(job_ids)
+            msg = response['response']
+
+            for job_id in job_ids:
+                job = [j for j in letter_jobs_list if job_id == j['id']][0]
+                job['sending'] = 'sending'
+        else:
+            msg = 'No jobs selected'
+
+    return render_template('views/letter-jobs.html', letter_jobs_list=letter_jobs_list, message=msg)

app/notify_client/letter_jobs_client.py

@@ -0,0 +1,21 @@
+from app.notify_client import NotifyAdminAPIClient
+
+
+class LetterJobsClient(NotifyAdminAPIClient):
+
+    def __init__(self):
+        super().__init__("a", "b", "c")
+
+    def init_app(self, app):
+        self.base_url = app.config['API_HOST_NAME']
+        self.service_id = app.config['ADMIN_CLIENT_USER_NAME']
+        self.api_key = app.config['ADMIN_CLIENT_SECRET']
+
+    def get_letter_jobs(self):
+        return self.get(url='/letter-jobs')['data']
+
+    def send_letter_jobs(self, job_ids):
+        return self.post(
+            url='/send-letter-jobs',
+            data={"job_ids": job_ids}
+        )['data']

app/templates/admin_template.html

@@ -52,6 +52,9 @@
                 <li>
                   <a href="{{ url_for('main.view_providers') }}">Providers</a>
                 </li>
+                <li>
+                  <a href="{{ url_for('main.letter_jobs') }}">Letter jobs</a>
+                </li>
             {% endif %}
             <li>
               <a href="{{ url_for('main.sign_out')}}">Sign out</a>

app/templates/views/letter-jobs.html

@@ -0,0 +1,51 @@
+{% extends "withoutnav_template.html" %}
+{% from "components/page-footer.html" import page_footer %}
+
+{% block service_page_title %}
+  Show letter jobs
+{% endblock %}
+
+{% block maincolumn_content %}
+
+    <h1 class="heading-large">Letter jobs</h1>
+
+    <form autocomplete="off" method="post">
+      <p>
+        <table>
+          <thead>
+            <tr>
+              <th>Service name</th>
+              <th>Job ID</th>
+              <th>Count</th>
+              <th>Status</th>
+              <th colspan="3">Created at</th>
+            </tr>
+          </thead>
+          <tbody>
+        {% for job in letter_jobs_list %}
+            <tr>
+              <td>{{ job.service_name.name }}</td>
+              <td>{{ job.id }}</td>
+              <td>{{ job.notification_count }}</td>
+              <td>{{ job.job_status }}</td>
+              <td>{{ job.created_at|format_datetime_short }}</td>
+              <td><input name="job_id" value='{{ job.id }}' type="checkbox"{% if not (job.job_status == 'ready to send' or job.job_status == 'sent to dvla') %} disabled{% endif %}></td>
+              <td>{{ job.sending }}</td>
+            </tr>
+        {% endfor %}
+        </tbody>
+        </table>
+      </p>
+      {{ page_footer('Send') }}
+
+      {% if message %}
+      <p id='message'>
+        {{ message }}
+        {% if message != 'No jobs selected' %}
+          <div>Refresh page to see status updates</div>
+        {% endif %}
+      </p>
+      {% endif %}
+    </form>
+
+{% endblock %}

tests/app/main/views/test_letter_jobs.py

@@ -0,0 +1,115 @@
+from enum import IntEnum
+from flask import url_for
+from bs4 import BeautifulSoup
+
+from app import format_datetime_short
+
+valid_letter_jobs = [
+    {
+        'service_name': {'name': 'test_name'},
+        'id': 'test_id',
+        'notification_count': 2,
+        'job_status': 'ready to send',
+        'created_at': '2017-04-01T12:00:00'
+    },
+    {
+        'service_name': {'name': 'test_name 2'},
+        'id': 'test_id 2',
+        'notification_count': 1,
+        'job_status': 'sent to dvla',
+        'created_at': '2017-04-02T13:00:00'
+    },
+    {
+        'service_name': {'name': 'test_name 3'},
+        'id': 'test_id 3',
+        'notification_count': 1,
+        'job_status': 'in progress',
+        'created_at': '2017-04-03T14:00:00'
+    }
+]
+
+send_letter_jobs_response = {"response": "Task created to send files to DVLA"}
+
+
+class letter_jobs_header(IntEnum):
+    SERVICE_NAME = 0
+    JOB_ID = 1
+    NOTIFICATION_COUNT = 2
+    JOB_STATUS = 3
+    CREATED_AT = 4
+    CHECKBOX = 5
+    TEMP_STATUS = 6
+
+
+def test_get_letter_jobs_returns_list_of_all_letter_jobs(logged_in_platform_admin_client, mocker):
+    mock_get_letters = mocker.patch('app.letter_jobs_client.get_letter_jobs', return_value=valid_letter_jobs)
+
+    response = logged_in_platform_admin_client.get(url_for('main.letter_jobs'))
+
+    assert mock_get_letters.called
+    assert response.status_code == 200
+
+    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
+    assert page.h1.string == 'Letter jobs'
+
+    rows = page.select('table tbody tr')
+
+    assert len(rows) == len(valid_letter_jobs)
+
+    for row_pos in range(len(rows)):
+        cols = rows[row_pos].find_all('td')
+        assert valid_letter_jobs[row_pos]['service_name']['name'] == cols[letter_jobs_header.SERVICE_NAME].text
+        assert valid_letter_jobs[row_pos]['id'] == cols[letter_jobs_header.JOB_ID].text
+        assert valid_letter_jobs[row_pos]['notification_count'] == int(cols[letter_jobs_header.NOTIFICATION_COUNT].text)
+        assert valid_letter_jobs[row_pos]['job_status'] == cols[letter_jobs_header.JOB_STATUS].text
+        assert format_datetime_short(
+            valid_letter_jobs[row_pos]['created_at']) == cols[letter_jobs_header.CREATED_AT].text
+        if not (valid_letter_jobs[row_pos]['job_status'] == 'ready to send' or
+                valid_letter_jobs[row_pos]['job_status'] == 'sent to dvla'):
+            assert 'disabled' in str(cols[letter_jobs_header.CHECKBOX])
+
+
+def test_post_letter_jobs_select_1_letter_job_submits_1_job(logged_in_platform_admin_client, mocker):
+    letter_jobs_first_selected = {'job_id': ['test_id']}
+
+    mock_get_letters = mocker.patch('app.letter_jobs_client.get_letter_jobs', return_value=valid_letter_jobs)
+    mock_send_letters = mocker.patch('app.letter_jobs_client.send_letter_jobs', return_value=send_letter_jobs_response)
+
+    response = logged_in_platform_admin_client.post(url_for('main.letter_jobs'), data=letter_jobs_first_selected)
+
+    assert mock_get_letters.called
+    assert mock_send_letters.called
+    assert response.status_code == 200
+
+    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
+
+    rows = page.select('table tbody tr')
+
+    assert len(rows) == len(valid_letter_jobs)
+
+    colr0 = rows[0].find_all('td')
+    colr1 = rows[1].find_all('td')
+    colr2 = rows[2].find_all('td')
+
+    assert colr0[letter_jobs_header.TEMP_STATUS].text == "sending"
+    assert colr1[letter_jobs_header.TEMP_STATUS].text == ""
+    assert colr2[letter_jobs_header.TEMP_STATUS].text == ""
+
+    message = page.find('p', attrs={'id': 'message'}).text
+    assert "Task created to send files to DVLA" in message
+
+
+def test_post_letter_jobs_none_selected_shows_message(logged_in_platform_admin_client, mocker):
+    mock_get_letters = mocker.patch('app.letter_jobs_client.get_letter_jobs', return_value=valid_letter_jobs)
+    mock_send_letters = mocker.patch('app.letter_jobs_client.send_letter_jobs', return_value=send_letter_jobs_response)
+
+    response = logged_in_platform_admin_client.post(url_for('main.letter_jobs'), data={})
+
+    assert mock_get_letters.called
+    assert not mock_send_letters.called
+    assert response.status_code == 200
+
+    page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser')
+    message = page.find('p', attrs={'id': 'message'}).text
+
+    assert "No jobs selected" in message