From 8501aa4ad6715303170abd948d90c0bca6abffc1 Mon Sep 17 00:00:00 2001 From: Pea Tyczynska Date: Fri, 21 May 2021 17:10:34 +0100 Subject: [PATCH] Change name of the form and form field for consistency Following PR review. Also update function name for update name of security key in user api client to be more specific. --- app/main/forms.py | 4 ++-- app/main/views/user_profile.py | 10 +++++----- app/notify_client/user_api_client.py | 2 +- .../views/user-profile/manage-security-key.html | 2 +- tests/app/main/views/test_user_profile.py | 10 +++++----- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/app/main/forms.py b/app/main/forms.py index 6775cef50..d4e7a0867 100644 --- a/app/main/forms.py +++ b/app/main/forms.py @@ -2506,8 +2506,8 @@ class BroadcastAreaFormWithSelectAll(BroadcastAreaForm): return self.areas.data -class ChangeNameOfSecurityKey(StripWhitespaceForm): - name_of_key = GovukTextInputField( +class ChangeSecurityKeyNameForm(StripWhitespaceForm): + security_key_name = GovukTextInputField( 'Name of key', validators=[ DataRequired(message='Cannot be empty'), diff --git a/app/main/views/user_profile.py b/app/main/views/user_profile.py index 2437eb200..23106bb9e 100644 --- a/app/main/views/user_profile.py +++ b/app/main/views/user_profile.py @@ -20,8 +20,8 @@ from app.main.forms import ( ChangeEmailForm, ChangeMobileNumberForm, ChangeNameForm, - ChangeNameOfSecurityKey, ChangePasswordForm, + ChangeSecurityKeyNameForm, ConfirmPasswordForm, ServiceOnOffSettingForm, TwoFactorForm, @@ -261,14 +261,14 @@ def user_profile_manage_security_key(key_id): if not security_key: abort(404) - form = ChangeNameOfSecurityKey(name_of_key=security_key["name"]) + form = ChangeSecurityKeyNameForm(security_key_name=security_key["name"]) if form.validate_on_submit(): - if form.name_of_key.data != security_key["name"]: - user_api_client.update_webauthn_credential_for_user( + if form.security_key_name.data != security_key["name"]: + user_api_client.update_webauthn_credential_name_for_user( user_id=current_user.id, credential_id=key_id, - new_name_for_credential=form.name_of_key.data + new_name_for_credential=form.security_key_name.data ) return redirect(url_for('.user_profile_security_keys')) diff --git a/app/notify_client/user_api_client.py b/app/notify_client/user_api_client.py index 3909dbbea..915b87a2f 100644 --- a/app/notify_client/user_api_client.py +++ b/app/notify_client/user_api_client.py @@ -201,7 +201,7 @@ class UserApiClient(NotifyAdminAPIClient): return self.post(endpoint, data=credential.serialize()) - def update_webauthn_credential_for_user(self, *, user_id, credential_id, new_name_for_credential): + def update_webauthn_credential_name_for_user(self, *, user_id, credential_id, new_name_for_credential): endpoint = f'/user/{user_id}/webauthn/{credential_id}' return self.post(endpoint, data={"name": new_name_for_credential}) diff --git a/app/templates/views/user-profile/manage-security-key.html b/app/templates/views/user-profile/manage-security-key.html index 7e21f2202..7e6c53068 100644 --- a/app/templates/views/user-profile/manage-security-key.html +++ b/app/templates/views/user-profile/manage-security-key.html @@ -19,7 +19,7 @@
{% call form_wrapper(autocomplete=True) %} - {{ form.name_of_key }} + {{ form.security_key_name }} {{ page_footer( 'Save', delete_link=url_for( diff --git a/tests/app/main/views/test_user_profile.py b/tests/app/main/views/test_user_profile.py index 01947d688..a153d43ce 100644 --- a/tests/app/main/views/test_user_profile.py +++ b/tests/app/main/views/test_user_profile.py @@ -401,7 +401,7 @@ def test_should_show_manage_security_key_page( assert page.select_one('.govuk-back-link').text.strip() == 'Back' assert page.select_one('.govuk-back-link')['href'] == url_for('.user_profile_security_keys') - assert page.select_one('#name_of_key')["value"] == webauthn_credential["name"] + assert page.select_one('#security_key_name')["value"] == webauthn_credential["name"] def test_manage_security_key_page_404s_when_key_not_found( @@ -464,14 +464,14 @@ def test_should_redirect_after_change_of_security_key_name( ) mock_update = mocker.patch( - 'app.user_api_client.update_webauthn_credential_for_user', + 'app.user_api_client.update_webauthn_credential_name_for_user', return_value=[webauthn_credential], ) client_request.post( 'main.user_profile_manage_security_key', key_id=webauthn_credential['id'], - _data={'name_of_key': "new name"}, + _data={'security_key_name': "new name"}, _expected_status=302, _expected_redirect=url_for( 'main.user_profile_security_keys', @@ -501,14 +501,14 @@ def test_user_profile_manage_security_key_should_not_call_api_if_key_name_stays_ ) mock_update = mocker.patch( - 'app.user_api_client.update_webauthn_credential_for_user', + 'app.user_api_client.update_webauthn_credential_name_for_user', return_value=[webauthn_credential], ) client_request.post( 'main.user_profile_manage_security_key', key_id=webauthn_credential['id'], - _data={'name_of_key': webauthn_credential['name']}, + _data={'security_key_name': webauthn_credential['name']}, _expected_status=302, _expected_redirect=url_for( 'main.user_profile_security_keys',