darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-02-05 19:03:30 -05:00
Code Issues Packages Projects Releases Wiki Activity

notify-admin-529 remove provider view

Browse Source
This commit is contained in:
Kenneth Kehl
2023-12-06 13:40:15 -08:00
parent 414352ea69
commit d218fd2178
13 changed files with 1 additions and 762 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/__init__.py
View File

@@ -105,7 +105,6 @@ from app.notify_client.performance_dashboard_api_client import (
performance_dashboard_api_client,
)
from app.notify_client.platform_stats_api_client import platform_stats_api_client
from app.notify_client.provider_client import provider_client
from app.notify_client.service_api_client import service_api_client
from app.notify_client.status_api_client import status_api_client
from app.notify_client.template_folder_api_client import template_folder_api_client
@@ -191,7 +190,6 @@ def create_app(application):
organizations_client,
performance_dashboard_api_client,
platform_stats_api_client,
provider_client,
service_api_client,
status_api_client,
template_folder_api_client,

1
app/main/__init__.py
View File

@@ -26,7 +26,6 @@ from app.main.views import ( # noqa isort:skip
performance,
platform_admin,
pricing,
providers,
register,
security_policy,
send,

46
app/main/forms.py
View File

@@ -1440,52 +1440,6 @@ class EstimateUsageForm(StripWhitespaceForm):
return super().validate(*args, **kwargs)
class AdminProviderRatioForm(Form):
def __init__(self, providers):
self._providers = providers
# hack: https://github.com/wtforms/wtforms/issues/736
self._unbound_fields = [
(
provider["identifier"],
GovukIntegerField(
f"{provider['display_name']} (%)",
validators=[
validators.NumberRange(
min=0, max=100, message="Must be between 0 and 100"
)
],
param_extensions={
"classes": "width-8",
},
),
)
for provider in providers
]
super().__init__(
data={
provider["identifier"]: provider["priority"] for provider in providers
}
)
def validate(self, extra_validators=None):
if not super().validate(extra_validators):
return False
total = sum(
getattr(self, provider["identifier"]).data for provider in self._providers
)
if total == 100:
return True
for provider in self._providers:
getattr(self, provider["identifier"]).errors += ["Must add up to 100%"]
return False
class ServiceContactDetailsForm(StripWhitespaceForm):
contact_details_type = RadioField(
"Type of contact details",

79
app/main/views/providers.py
View File

@@ -1,79 +0,0 @@
from datetime import datetime
from flask import render_template, url_for
from werkzeug.utils import redirect
from app import provider_client
from app.main import main
from app.main.forms import AdminProviderRatioForm
from app.utils.user import user_is_platform_admin
PROVIDER_PRIORITY_MEANING_SWITCHOVER = datetime(2019, 11, 29, 11, 0).isoformat()
@main.route("/providers")
@user_is_platform_admin
def view_providers():
providers = provider_client.get_all_providers()["provider_details"]
domestic_email_providers, domestic_sms_providers, intl_sms_providers = [], [], []
for provider in providers:
if provider["notification_type"] == "sms":
domestic_sms_providers.append(provider)
if provider.get("supports_international", None):
intl_sms_providers.append(provider)
elif provider["notification_type"] == "email":
domestic_email_providers.append(provider)
add_monthly_traffic(domestic_sms_providers)
return render_template(
"views/providers/providers.html",
email_providers=domestic_email_providers,
domestic_sms_providers=domestic_sms_providers,
intl_sms_providers=intl_sms_providers,
)
def add_monthly_traffic(domestic_sms_providers):
total_sms_sent = sum(
provider["current_month_billable_sms"] for provider in domestic_sms_providers
)
for provider in domestic_sms_providers:
percentage = (
(provider["current_month_billable_sms"] / total_sms_sent * 100)
if total_sms_sent
else 0
)
provider["monthly_traffic"] = round(percentage)
@main.route("/provider/edit-sms-provider-ratio", methods=["GET", "POST"])
@user_is_platform_admin
def edit_sms_provider_ratio():
providers = [
provider
for provider in provider_client.get_all_providers()["provider_details"]
if provider["notification_type"] == "sms" and provider["active"]
]
form = AdminProviderRatioForm(providers)
if form.validate_on_submit():
for provider in providers:
field = getattr(form, provider["identifier"])
provider_client.update_provider(provider["id"], field.data)
return redirect(url_for(".view_providers"))
return render_template(
"views/providers/edit-sms-provider-ratio.html", form=form, providers=providers
)
@main.route("/provider/<uuid:provider_id>")
@user_is_platform_admin
def view_provider(provider_id):
versions = provider_client.get_provider_versions(provider_id)
return render_template(
"views/providers/provider.html", provider_versions=versions["data"]
)

3
app/navigation.py
View File

@@ -165,7 +165,6 @@ class HeaderNavigation(Navigation):
"change_user_auth",
"clear_cache",
"create_email_branding",
"edit_sms_provider_ratio",
"email_branding",
"find_services_by_name",
"find_users_by_email",
@@ -186,8 +185,6 @@ class HeaderNavigation(Navigation):
"trial_services",
"update_email_branding",
"user_information",
"view_provider",
"view_providers",
},
"sign-in": {
"revalidate_email_sent",

20
app/notify_client/provider_client.py
View File

@@ -1,20 +0,0 @@
from app.notify_client import NotifyAdminAPIClient, _attach_current_user
class ProviderClient(NotifyAdminAPIClient):
def get_all_providers(self):
return self.get(url="/provider-details")
def get_provider_by_id(self, provider_id):
return self.get(url="/provider-details/{}".format(provider_id))
def get_provider_versions(self, provider_id):
return self.get(url="/provider-details/{}/versions".format(provider_id))
def update_provider(self, provider_id, priority):
data = {"priority": priority}
data = _attach_current_user(data)
return self.post(url="/provider-details/{}".format(provider_id), data=data)
provider_client = ProviderClient()

2
app/templates/views/platform-admin/_base_template.html
View File

@@ -19,12 +19,12 @@
<div class="tablet:grid-col-3 margin-top-4">
<nav class="navigation">
<ul class="usa-sidenav">
{% for link_text, url in [
('Summary', ('main.platform_admin')),
('Live services', ('main.live_services')),
('Trial mode services', ('main.trial_services')),
('Organizations', ('main.organizations')),
('Providers', ('main.view_providers')),
('Reports', ('main.platform_admin_reports')),
('Email branding', ('main.email_branding')),
('Inbound SMS numbers', ('main.inbound_sms_admin')),

25
app/templates/views/providers/edit-sms-provider-ratio.html
View File

@@ -1,25 +0,0 @@
{% extends "views/platform-admin/_base_template.html" %}
{% from "components/page-header.html" import page_header %}
{% from "components/page-footer.html" import page_footer %}
{% from "components/form.html" import form_wrapper %}
{% block per_page_title %}
Edit SMS provider priorities
{% endblock %}
{% block platform_admin_content %}
{{ page_header('Edit SMS provider priorities') }}
<p>
If you change one priority you will need to change the others so they add up to 100%.
</p>
{% call form_wrapper() %}
{% for field in form %}
{{ field }}
{% endfor %}
{{ page_footer('Save') }}
{% endcall %}
{% endblock %}

58
app/templates/views/providers/provider.html
View File

@@ -1,58 +0,0 @@
{% extends "withoutnav_template.html" %}
{% from "components/table.html" import list_table, field, text_field, link_field, right_aligned_field_heading, hidden_field_heading %}
{% from "components/page-header.html" import page_header %}
{% from "components/page-footer.html" import page_footer %}
{% from "components/components/back-link/macro.njk" import usaBackLink %}
{% block per_page_title %}
{{ provider_versions[0].display_name }}
{% endblock %}
{% block backLink %}
{{ usaBackLink({ "href": url_for('main.view_providers') }) }}
{% endblock %}
{% block maincolumn_content %}
<div class="grid-row">
<div class="grid-col-8">
{{ page_header(provider_versions[0].display_name) }}
<p>
Only showing the latest 100 versions.
</p>
{% call(item, row_number) list_table(
provider_versions,
caption='',
caption_visible=False,
empty_message='No history for this provider',
field_headings=['Version', 'Last Updated', 'Updated By', 'Priority', 'Active'],
field_headings_visible=True
) %}
{{ text_field(item.version) }}
{% if item.updated_at %}
{{ text_field(item.updated_at|format_datetime_short) }}
{% else %}
{{ text_field('None') }}
{% endif %}
{% if item.created_by %}
{{ text_field(item.created_by.name) }}
{% else %}
{{ text_field('None') }}
{% endif %}
{{ text_field(item.priority) }}
{{ text_field(item.active) }}
{% endcall %}
</div>
</div>
{% endblock %}

90
app/templates/views/providers/providers.html
View File

@@ -1,90 +0,0 @@
{% extends "views/platform-admin/_base_template.html" %}
{% from "components/table.html" import list_table, field, text_field, link_field, right_aligned_field_heading, hidden_field_heading, optional_text_field %}
{% from "components/show-more.html" import show_more %}
{% block per_page_title %}
Providers
{% endblock %}
{% block platform_admin_content %}
<h1 class="font-body-2xl">Providers</h1>
<h2 class="font-body-lg">SMS</h2>
<a class="usa-link" href="{{ url_for('main.edit_sms_provider_ratio') }}">Change priority</a>
{% call(item, row_number) list_table(
domestic_sms_providers,
caption="Domestic SMS providers",
caption_visible=False,
empty_message='No domestic sms providers',
field_headings=['Provider', 'Priority', '% monthly traffic', 'Active', 'Last Updated', 'Updated By'],
field_headings_visible=True
) %}
{{ link_field(item.display_name, url_for('main.view_provider', provider_id=item.id)) }}
{{ optional_text_field(item.priority if item.active, default='None') }}
{{ text_field(item.monthly_traffic) }}
{{ text_field(item.active) }}
{{ optional_text_field(
item.updated_at|format_datetime_short if item.updated_at,
default='None'
) }}
{{ optional_text_field(item.created_by_name, default='None') }}
{% endcall %}
<h2 class="font-body-lg">Email</h2>
{% call(item, row_number) list_table(
email_providers,
caption="Email providers",
caption_visible=False,
empty_message='No email providers',
field_headings=['Provider', 'Active', 'Last Updated', 'Updated By'],
field_headings_visible=True
) %}
{{ link_field(item.display_name, url_for('main.view_provider', provider_id=item.id)) }}
{{ text_field(item.active) }}
{{ optional_text_field(
item.updated_at|format_datetime_short if item.updated_at,
default='None'
) }}
{{ optional_text_field(item.created_by_name, default='None') }}
{% endcall %}
<h2 class="font-body-lg">International SMS Providers</h2>
{% call(item, row_number) list_table(
intl_sms_providers,
caption="International SMS providers",
caption_visible=False,
empty_message='No international sms providers',
field_headings=['Provider', 'Active', 'Last Updated', 'Updated By'],
field_headings_visible=True
) %}
{{ link_field(item.display_name, url_for('main.view_provider', provider_id=item.id)) }}
{{ text_field(item.active) }}
{{ optional_text_field(
item.updated_at|format_datetime_short if item.updated_at,
default='None'
) }}
{{ optional_text_field(item.created_by_name, default='None') }}
{% endcall %}
{% endblock %}

1
tests/app/main/views/test_dashboard.py
View File

@@ -1056,7 +1056,6 @@ def test_menu_send_messages(
assert url_for("main.service_settings", service_id=service_one["id"]) not in page
# assert url_for('main.api_keys', service_id=service_one['id']) not in page
assert url_for("main.view_providers") not in page
def test_menu_manage_service(

433
tests/app/main/views/test_providers.py
View File

@@ -1,433 +0,0 @@
from datetime import datetime
from unittest.mock import call
import pytest
from flask import url_for
from app.main.views.providers import add_monthly_traffic
def provider_json(overrides):
provider = {
"id": "override-me",
"active": True,
"priority": 20,
"display_name": "Provider",
"identifier": "override-me",
"notification_type": "sms",
"updated_at": None,
"version": 1,
"created_by_name": None,
"supports_international": False,
"current_month_billable_sms": 0,
}
provider.update(**overrides)
return provider
@pytest.fixture()
def sms_provider_1():
return provider_json(
{
"id": "sms_provider_1-id",
"priority": 20,
"display_name": "SMS Provider 1",
"identifier": "sms_provider_1",
"notification_type": "sms",
"updated_at": datetime(2017, 1, 16, 15, 20, 40).isoformat(),
"created_by_name": "Test User",
"current_month_billable_sms": 5020,
}
)
@pytest.fixture()
def sms_provider_2():
return provider_json(
{
"id": "sms_provider_2-id",
"priority": 10,
"display_name": "SMS Provider 2",
"identifier": "sms_provider_2",
"notification_type": "sms",
"current_month_billable_sms": 6891,
}
)
@pytest.fixture()
def email_provider_1():
return provider_json(
{
"id": "email_provider_1-id",
"display_name": "Email Provider 1",
"identifier": "email_provider_1",
"notification_type": "email",
}
)
@pytest.fixture()
def email_provider_2():
return provider_json(
{
"id": "email_provider_2-id",
"display_name": "Email Provider 2",
"identifier": "email_provider_2",
"notification_type": "email",
}
)
@pytest.fixture()
def sms_provider_intl_1():
return provider_json(
{
"id": "sms_provider_intl_1-id",
"active": False,
"display_name": "SMS Provider Intl 1",
"identifier": "sms_provider_intl_1",
"notification_type": "sms",
"supports_international": True,
}
)
@pytest.fixture()
def sms_provider_intl_2():
return provider_json(
{
"id": "sms_provider_intl_2-id",
"active": False,
"display_name": "SMS Provider Intl 2",
"identifier": "sms_provider_intl_2",
"notification_type": "sms",
"supports_international": True,
}
)
@pytest.fixture()
def stub_providers(
sms_provider_1,
sms_provider_2,
email_provider_1,
email_provider_2,
sms_provider_intl_1,
sms_provider_intl_2,
):
return {
"provider_details": [
sms_provider_1,
sms_provider_2,
email_provider_1,
email_provider_2,
sms_provider_intl_1,
sms_provider_intl_2,
]
}
@pytest.fixture()
def stub_provider_history():
return {
"data": [
{
"id": "f9af1ec7-58ef-4f7d-a6f4-5fe7e48644cb",
"active": True,
"priority": 20,
"display_name": "Foo",
"identifier": "foo",
"notification_type": "sms",
"updated_at": None,
"version": 2,
"created_by": {
"email_address": "test@foo.bar",
"name": "Test User",
"id": "7cc1dddb-bcbc-4739-8fc1-61bedde3332a",
},
"supports_international": False,
},
{
"id": "f9af1ec7-58ef-4f7d-a6f4-5fe7e48644cb",
"active": True,
"priority": 10,
"display_name": "Bar",
"identifier": "bar",
"notification_type": "sms",
"updated_at": None,
"version": 1,
"created_by": None,
"supports_international": False,
},
]
}
def test_view_providers_shows_all_providers(
client_request,
platform_admin_user,
mocker,
stub_providers,
):
mocker.patch("app.provider_client.get_all_providers", return_value=stub_providers)
client_request.login(platform_admin_user)
page = client_request.get("main.view_providers")
h1 = [header.text.strip() for header in page.find_all("h1")]
assert "Providers" in h1
h2 = [header.text.strip() for header in page.find_all("h2")]
assert "Email" in h2
assert "SMS" in h2
tables = page.find_all("table")
assert len(tables) == 3
domestic_sms_table = tables[0]
domestic_email_table = tables[1]
international_sms_table = tables[2]
domestic_sms_first_row = domestic_sms_table.tbody.find_all("tr")[0]
table_data = domestic_sms_first_row.find_all("td")
assert table_data[0].find_all("a")[0]["href"] == "/provider/sms_provider_1-id"
assert table_data[0].text.strip() == "SMS Provider 1"
assert table_data[1].text.strip() == "20"
assert table_data[2].text.strip() == "42"
assert table_data[3].text.strip() == "True"
assert table_data[4].text.strip() == "16 January at 10:20 US/Eastern"
assert table_data[5].text.strip() == "Test User"
domestic_sms_second_row = domestic_sms_table.tbody.find_all("tr")[1]
table_data = domestic_sms_second_row.find_all("td")
assert table_data[0].find_all("a")[0]["href"] == "/provider/sms_provider_2-id"
assert table_data[0].text.strip() == "SMS Provider 2"
assert table_data[1].text.strip() == "10"
assert table_data[2].text.strip() == "58"
assert table_data[3].text.strip() == "True"
assert table_data[4].text.strip() == "None"
assert table_data[5].text.strip() == "None"
domestic_email_first_row = domestic_email_table.tbody.find_all("tr")[0]
domestic_email_table_data = domestic_email_first_row.find_all("td")
assert (
domestic_email_table_data[0].find_all("a")[0]["href"]
== "/provider/email_provider_1-id"
)
assert domestic_email_table_data[0].text.strip() == "Email Provider 1"
assert domestic_email_table_data[1].text.strip() == "True"
assert domestic_email_table_data[2].text.strip() == "None"
assert domestic_email_table_data[3].text.strip() == "None"
domestic_email_second_row = domestic_email_table.tbody.find_all("tr")[1]
domestic_email_table_data = domestic_email_second_row.find_all("td")
assert (
domestic_email_table_data[0].find_all("a")[0]["href"]
== "/provider/email_provider_2-id"
)
assert domestic_email_table_data[0].text.strip() == "Email Provider 2"
assert domestic_email_table_data[1].text.strip() == "True"
assert domestic_email_table_data[2].text.strip() == "None"
assert domestic_email_table_data[3].text.strip() == "None"
international_sms_first_row = international_sms_table.tbody.find_all("tr")[0]
table_data = international_sms_first_row.find_all("td")
assert table_data[0].find_all("a")[0]["href"] == "/provider/sms_provider_intl_1-id"
assert table_data[0].text.strip() == "SMS Provider Intl 1"
assert table_data[1].text.strip() == "False"
assert table_data[2].text.strip() == "None"
assert table_data[3].text.strip() == "None"
def test_add_monthly_traffic():
domestic_sms_providers = [
{
"identifier": "mmg",
"current_month_billable_sms": 27,
},
{
"identifier": "firetext",
"current_month_billable_sms": 5,
},
{
"identifier": "loadtesting",
"current_month_billable_sms": 0,
},
]
add_monthly_traffic(domestic_sms_providers)
assert domestic_sms_providers == [
{"identifier": "mmg", "current_month_billable_sms": 27, "monthly_traffic": 84},
{
"identifier": "firetext",
"current_month_billable_sms": 5,
"monthly_traffic": 16,
},
{
"identifier": "loadtesting",
"current_month_billable_sms": 0,
"monthly_traffic": 0,
},
]
def test_view_provider_shows_version_history(
client_request, platform_admin_user, mocker, stub_provider_history
):
mocker.patch(
"app.provider_client.get_provider_versions", return_value=stub_provider_history
)
client_request.login(platform_admin_user)
page = client_request.get(
"main.view_provider", provider_id=stub_provider_history["data"][0]["id"]
)
table = page.find("table")
table_rows = table.find_all("tr")
table_headings = table_rows[0].find_all("th")
first_row = table_rows[1].find_all("td")
second_row = table_rows[2].find_all("td")
assert (
page.find_all("h1")[0].text.strip()
== stub_provider_history["data"][0]["display_name"]
)
assert len(table_rows) == 3
assert table_headings[0].text.strip() == "Version"
assert table_headings[1].text.strip() == "Last Updated"
assert table_headings[2].text.strip() == "Updated By"
assert table_headings[3].text.strip() == "Priority"
assert table_headings[4].text.strip() == "Active"
assert first_row[0].text.strip() == "2"
assert first_row[1].text.strip() == "None"
assert first_row[2].text.strip() == "Test User"
assert first_row[3].text.strip() == "20"
assert first_row[4].text.strip() == "True"
assert second_row[0].text.strip() == "1"
assert second_row[1].text.strip() == "None"
assert second_row[2].text.strip() == "None"
assert second_row[3].text.strip() == "10"
assert second_row[4].text.strip() == "True"
def test_edit_sms_provider_provider_ratio(
client_request, platform_admin_user, mocker, stub_providers, sms_provider_1
):
mocker.patch("app.provider_client.get_all_providers", return_value=stub_providers)
client_request.login(platform_admin_user)
page = client_request.get(
".edit_sms_provider_ratio",
)
inputs = page.select('.usa-input[type="text"]')
assert len(inputs) == 2
first_input = page.select_one('.usa-input[name="sms_provider_1"]')
assert first_input.attrs["value"] == str(sms_provider_1["priority"])
def test_edit_sms_provider_provider_ratio_only_shows_active_providers(
client_request,
platform_admin_user,
mocker,
stub_providers,
sms_provider_1,
):
sms_provider_1["active"] = False
mocker.patch(
"app.provider_client.get_all_providers",
return_value=stub_providers,
)
client_request.login(platform_admin_user)
page = client_request.get(
".edit_sms_provider_ratio",
)
inputs = page.select('.usa-input[type="text"]')
assert len(inputs) == 1
@pytest.mark.parametrize(
("post_data", "expected_calls"),
[
(
{"sms_provider_1": 10, "sms_provider_2": 90},
[
call("sms_provider_1-id", 10),
call("sms_provider_2-id", 90),
],
),
(
{"sms_provider_1": 80, "sms_provider_2": 20},
[
call("sms_provider_1-id", 80),
call("sms_provider_2-id", 20),
],
),
],
)
def test_edit_sms_provider_ratio_submit(
client_request,
platform_admin_user,
mocker,
post_data,
expected_calls,
stub_providers,
):
mocker.patch("app.provider_client.get_all_providers", return_value=stub_providers)
mock_update_provider = mocker.patch("app.provider_client.update_provider")
client_request.login(platform_admin_user)
client_request.post(
".edit_sms_provider_ratio",
_data=post_data,
_expected_redirect=url_for(
".view_providers",
),
)
assert mock_update_provider.call_args_list == expected_calls
@pytest.mark.parametrize(
("post_data", "expected_error"),
[
({"sms_provider_1": 90, "sms_provider_2": 20}, "Must add up to 100%"),
({"sms_provider_1": 101, "sms_provider_2": 20}, "Must be between 0 and 100"),
],
)
def test_edit_sms_provider_submit_invalid_percentages(
client_request,
platform_admin_user,
mocker,
post_data,
expected_error,
stub_providers,
):
mocker.patch("app.provider_client.get_all_providers", return_value=stub_providers)
mock_update_provider = mocker.patch("app.provider_client.update_provider")
client_request.login(platform_admin_user)
page = client_request.post(
".edit_sms_provider_ratio", _data=post_data, _follow_redirects=True
)
assert expected_error in page.select_one(".usa-error-message").text
mock_update_provider.assert_not_called()

3
tests/app/test_navigation.py
View File

@@ -84,7 +84,6 @@ EXCLUDED_ENDPOINTS = tuple(
"edit_service_billing_details",
"edit_service_notes",
"edit_service_template",
"edit_sms_provider_ratio",
"edit_user_email",
"edit_user_mobile_number",
"edit_user_permissions",
@@ -265,8 +264,6 @@ EXCLUDED_ENDPOINTS = tuple(
"view_notification_updates",
"view_notifications",
"view_notifications_csv",
"view_provider",
"view_providers",
"view_template",
"view_template_version",
"view_template_versions",