From 02c77da97b3d3bee2b72ad68108283d62c64ef03 Mon Sep 17 00:00:00 2001 From: Ken Tsang Date: Fri, 7 Apr 2017 11:16:39 +0100 Subject: [PATCH 1/4] Add letter-jobs page, update admin menu --- app/main/__init__.py | 3 +- app/main/views/letter_jobs.py | 45 ++++++++++++++++++++++++++++ app/templates/admin_template.html | 3 ++ app/templates/views/letter-jobs.html | 43 ++++++++++++++++++++++++++ 4 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 app/main/views/letter_jobs.py create mode 100644 app/templates/views/letter-jobs.html diff --git a/app/main/__init__.py b/app/main/__init__.py index b70ccb942..0bf151fe3 100644 --- a/app/main/__init__.py +++ b/app/main/__init__.py @@ -26,5 +26,6 @@ from app.main.views import ( invites, feedback, providers, - platform_admin + platform_admin, + letter_jobs ) diff --git a/app/main/views/letter_jobs.py b/app/main/views/letter_jobs.py new file mode 100644 index 000000000..00cb314db --- /dev/null +++ b/app/main/views/letter_jobs.py @@ -0,0 +1,45 @@ +from flask import (render_template, url_for, redirect, request, abort) +from app.main import main +from app import convert_to_boolean +from flask_login import (login_required, current_user) + + +@main.route("/letter-jobs", methods=['GET', 'POST']) +@login_required +def letter_jobs(): + letter_jobs_list = get_letter_jobs() + + msg = '' + if request.method == 'POST': + send_letters = request.form.getlist('send_letter') + for job_id in send_letters: + job = [j for j in letter_jobs_list if job_id == j['job_id']][0] + job['send'] = True + + msg = 'sending:{}'.format(send_letters) + + return render_template('views/letter-jobs.html', letter_jobs_list=letter_jobs_list, message=msg) + + +def get_letter_jobs(): + return [ + { + 'service_name': 'test_name', + 'job_id': 'test_id', + 'status': 'test_status', + 'created_at': '2017-04-01' + }, + { + 'service_name': 'test_name 2', + 'job_id': 'test_id 2', + 'status': 'test_status 2', + 'created_at': '2017-04-02' + + }, + { + 'service_name': 'test_name 3', + 'job_id': 'test_id 3', + 'status': 'test_status 3', + 'created_at': '2017-04-03' + } + ] diff --git a/app/templates/admin_template.html b/app/templates/admin_template.html index 4fc273400..5bd9868ad 100644 --- a/app/templates/admin_template.html +++ b/app/templates/admin_template.html @@ -52,6 +52,9 @@
  • Providers
    • +
  • + Letter jobs +
    • {% endif %}
  • Sign out diff --git a/app/templates/views/letter-jobs.html b/app/templates/views/letter-jobs.html new file mode 100644 index 000000000..aaa50f549 --- /dev/null +++ b/app/templates/views/letter-jobs.html @@ -0,0 +1,43 @@ +{% extends "withoutnav_template.html" %} +{% from "components/page-footer.html" import page_footer %} + +{% block service_page_title %} + Show letter jobs +{% endblock %} + +{% block maincolumn_content %} + +

    Letter jobs

    + +
    +

    + + + + + + + + + + {% for job in letter_jobs_list %} + + + + + + + + {% endfor %} +
    Service nameJob IDStatusCreated at
    {{ job.service_name }}{{ job.job_id }}{{ job.status }}{{ job.created_at }}
    +

    + {{ page_footer('Send') }} + + {% if message %} +

    + {{ message }} +

    + {% endif %} +
    + +{% endblock %} From e5a377edd82dc986346597bcf0c828797120c518 Mon Sep 17 00:00:00 2001 From: Ken Tsang Date: Tue, 11 Apr 2017 10:59:50 +0100 Subject: [PATCH 2/4] Add letter jobs page, client and test --- app/__init__.py | 3 + app/main/views/letter_jobs.py | 56 +++++------- app/notify_client/letter_jobs_client.py | 21 +++++ app/templates/views/letter-jobs.html | 20 +++-- tests/app/main/views/test_letter_jobs.py | 103 +++++++++++++++++++++++ 5 files changed, 161 insertions(+), 42 deletions(-) create mode 100644 app/notify_client/letter_jobs_client.py create mode 100644 tests/app/main/views/test_letter_jobs.py diff --git a/app/__init__.py b/app/__init__.py index a3e22afbd..23f4f8bd5 100644 --- a/app/__init__.py +++ b/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' diff --git a/app/main/views/letter_jobs.py b/app/main/views/letter_jobs.py index 00cb314db..e371f33f2 100644 --- a/app/main/views/letter_jobs.py +++ b/app/main/views/letter_jobs.py @@ -1,45 +1,31 @@ -from flask import (render_template, url_for, redirect, request, abort) +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 import convert_to_boolean -from flask_login import (login_required, current_user) +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(): - letter_jobs_list = get_letter_jobs() - msg = '' - if request.method == 'POST': - send_letters = request.form.getlist('send_letter') - for job_id in send_letters: - job = [j for j in letter_jobs_list if job_id == j['job_id']][0] - job['send'] = True + letter_jobs_list = letter_jobs_client.get_letter_jobs() - msg = 'sending:{}'.format(send_letters) + 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) - - -def get_letter_jobs(): - return [ - { - 'service_name': 'test_name', - 'job_id': 'test_id', - 'status': 'test_status', - 'created_at': '2017-04-01' - }, - { - 'service_name': 'test_name 2', - 'job_id': 'test_id 2', - 'status': 'test_status 2', - 'created_at': '2017-04-02' - - }, - { - 'service_name': 'test_name 3', - 'job_id': 'test_id 3', - 'status': 'test_status 3', - 'created_at': '2017-04-03' - } - ] diff --git a/app/notify_client/letter_jobs_client.py b/app/notify_client/letter_jobs_client.py new file mode 100644 index 000000000..a3337917b --- /dev/null +++ b/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'] diff --git a/app/templates/views/letter-jobs.html b/app/templates/views/letter-jobs.html index aaa50f549..4f039aef4 100644 --- a/app/templates/views/letter-jobs.html +++ b/app/templates/views/letter-jobs.html @@ -17,25 +17,31 @@ Service name Job ID Status - Created at + Created at + {% for job in letter_jobs_list %} - {{ job.service_name }} - {{ job.job_id }} - {{ job.status }} - {{ job.created_at }} - + {{ job.service_name.name }} + {{ job.id }} + {{ job.job_status }} + {{ job.created_at|format_datetime_short }} + + {{ job.sending }} {% endfor %} +

    {{ page_footer('Send') }} {% if message %} -

    +

    {{ message }} + {% if message != 'No jobs selected' %} +

    Refresh page to see status updates
    + {% endif %}

    {% endif %} diff --git a/tests/app/main/views/test_letter_jobs.py b/tests/app/main/views/test_letter_jobs.py new file mode 100644 index 000000000..5e7467a23 --- /dev/null +++ b/tests/app/main/views/test_letter_jobs.py @@ -0,0 +1,103 @@ +from flask import url_for +from bs4 import BeautifulSoup + +from app import format_datetime_short + +valid_letter_jobs = [ + { + 'service_name': {'name': 'test_name'}, + 'template_version': 1, + 'id': 'test_id', + 'job_status': 'test_status', + 'created_at': '2017-04-01T12:00:00' + }, + { + 'service_name': {'name': 'test_name 2'}, + 'template_version': 2, + 'id': 'test_id 2', + 'job_status': 'test_status 2', + 'created_at': '2017-04-02T13:00:00' + }, + { + 'service_name': {'name': 'test_name 3'}, + 'template_version': 3, + 'id': 'test_id 3', + 'job_status': 'test_status 3', + 'created_at': '2017-04-03T14:00:00' + } +] + +send_letter_jobs_response = {"response": "Task created to send files to DVLA"} + + +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' + + table = page.find('table') + table_body = table.find('tbody') + rows = table_body.find_all('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[0].text + assert valid_letter_jobs[row_pos]['id'] == cols[1].text + assert valid_letter_jobs[row_pos]['job_status'] == cols[2].text + assert format_datetime_short(valid_letter_jobs[row_pos]['created_at']) == cols[3].text + + +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') + + table = page.find('table') + table_body = table.find('tbody') + rows = table_body.find_all('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[5].text == "sending" + assert colr1[5].text == "" + assert colr2[5].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 From 9ce4ce803141d4709840ddf47fdf486e05cd6335 Mon Sep 17 00:00:00 2001 From: Ken Tsang Date: Tue, 11 Apr 2017 15:02:20 +0100 Subject: [PATCH 3/4] Add count and disabled checkbox until ready / dvla state --- app/templates/views/letter-jobs.html | 4 ++- tests/app/main/views/test_letter_jobs.py | 42 ++++++++++++++++-------- 2 files changed, 32 insertions(+), 14 deletions(-) diff --git a/app/templates/views/letter-jobs.html b/app/templates/views/letter-jobs.html index 4f039aef4..624358b7f 100644 --- a/app/templates/views/letter-jobs.html +++ b/app/templates/views/letter-jobs.html @@ -16,6 +16,7 @@ Service name Job ID + Count Status Created at @@ -25,9 +26,10 @@ {{ job.service_name.name }} {{ job.id }} + {{ job.notification_count }} {{ job.job_status }} {{ job.created_at|format_datetime_short }} - + {{ job.sending }} {% endfor %} diff --git a/tests/app/main/views/test_letter_jobs.py b/tests/app/main/views/test_letter_jobs.py index 5e7467a23..af95b509e 100644 --- a/tests/app/main/views/test_letter_jobs.py +++ b/tests/app/main/views/test_letter_jobs.py @@ -1,3 +1,4 @@ +from enum import IntEnum from flask import url_for from bs4 import BeautifulSoup @@ -6,23 +7,23 @@ from app import format_datetime_short valid_letter_jobs = [ { 'service_name': {'name': 'test_name'}, - 'template_version': 1, 'id': 'test_id', - 'job_status': 'test_status', + 'notification_count': 2, + 'job_status': 'ready to send', 'created_at': '2017-04-01T12:00:00' }, { 'service_name': {'name': 'test_name 2'}, - 'template_version': 2, 'id': 'test_id 2', - 'job_status': 'test_status 2', + 'notification_count': 1, + 'job_status': 'sent to dvla', 'created_at': '2017-04-02T13:00:00' }, { 'service_name': {'name': 'test_name 3'}, - 'template_version': 3, 'id': 'test_id 3', - 'job_status': 'test_status 3', + 'notification_count': 1, + 'job_status': 'in progress', 'created_at': '2017-04-03T14:00:00' } ] @@ -30,6 +31,16 @@ valid_letter_jobs = [ 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) @@ -49,10 +60,15 @@ def test_get_letter_jobs_returns_list_of_all_letter_jobs(logged_in_platform_admi for row_pos in range(len(rows)): cols = rows[row_pos].find_all('td') - assert valid_letter_jobs[row_pos]['service_name']['name'] == cols[0].text - assert valid_letter_jobs[row_pos]['id'] == cols[1].text - assert valid_letter_jobs[row_pos]['job_status'] == cols[2].text - assert format_datetime_short(valid_letter_jobs[row_pos]['created_at']) == cols[3].text + 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): @@ -79,9 +95,9 @@ def test_post_letter_jobs_select_1_letter_job_submits_1_job(logged_in_platform_a colr1 = rows[1].find_all('td') colr2 = rows[2].find_all('td') - assert colr0[5].text == "sending" - assert colr1[5].text == "" - assert colr2[5].text == "" + 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 From 0f3131cf21d7e4e810d33f6b50b94280714a4705 Mon Sep 17 00:00:00 2001 From: Ken Tsang Date: Tue, 11 Apr 2017 15:17:18 +0100 Subject: [PATCH 4/4] Refactor test_letter_jobs --- tests/app/main/views/test_letter_jobs.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/tests/app/main/views/test_letter_jobs.py b/tests/app/main/views/test_letter_jobs.py index af95b509e..aa63c7bf3 100644 --- a/tests/app/main/views/test_letter_jobs.py +++ b/tests/app/main/views/test_letter_jobs.py @@ -52,9 +52,7 @@ def test_get_letter_jobs_returns_list_of_all_letter_jobs(logged_in_platform_admi page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser') assert page.h1.string == 'Letter jobs' - table = page.find('table') - table_body = table.find('tbody') - rows = table_body.find_all('tr') + rows = page.select('table tbody tr') assert len(rows) == len(valid_letter_jobs) @@ -85,9 +83,7 @@ def test_post_letter_jobs_select_1_letter_job_submits_1_job(logged_in_platform_a page = BeautifulSoup(response.data.decode('utf-8'), 'html.parser') - table = page.find('table') - table_body = table.find('tbody') - rows = table_body.find_all('tr') + rows = page.select('table tbody tr') assert len(rows) == len(valid_letter_jobs)