Add selected navigation for organisations page

To match how the navigation works for a single service.

app/__init__.py

@@ -39,7 +39,7 @@ from werkzeug.local import LocalProxy
 from app import proxy_fix
 from app.config import configs
 from app.asset_fingerprinter import AssetFingerprinter
-from app.navigation import HeaderNavigation, MainNavigation
+from app.navigation import HeaderNavigation, MainNavigation, OrgNavigation
 from app.notify_client.service_api_client import ServiceAPIClient
 from app.notify_client.api_key_api_client import ApiKeyApiClient
 from app.notify_client.invite_api_client import InviteApiClient
@@ -93,6 +93,7 @@ current_organisation = LocalProxy(partial(_lookup_req_object, 'organisation'))
 navigation = {
     'main_navigation': MainNavigation(),
     'header_navigation': HeaderNavigation(),
+    'org_navigation': OrgNavigation(),
 }
 
 

app/navigation.py

@@ -473,3 +473,215 @@ class MainNavigation(Navigation):
         'view_providers',
         'view_template_version_preview',
     }
+
+
+class OrgNavigation(Navigation):
+
+    mapping = {
+        'dashboard': {
+            'organisation_dashboard',
+        },
+        'settings': {
+            'confirm_edit_organisation_name',
+            'edit_organisation_name',
+            'organisation_settings',
+        },
+        'team-members': {
+            'edit_user_org_permissions',
+            'invite_org_user',
+            'manage_org_users',
+            'remove_user_from_organisation',
+        }
+    }
+
+    exclude = {
+        'accept_invite',
+        'accept_org_invite',
+        'action_blocked',
+        'add_organisation',
+        'add_service',
+        'add_service_template',
+        'add_template_by_type',
+        'agreement',
+        'api_callbacks',
+        'api_documentation',
+        'api_integration',
+        'api_keys',
+        'archive_service',
+        'bat_phone',
+        'callbacks',
+        'cancel_invited_org_user',
+        'cancel_invited_user',
+        'cancel_job',
+        'check_and_resend_text_code',
+        'check_and_resend_verification_code',
+        'check_messages',
+        'check_messages_preview',
+        'check_notification',
+        'choose_account',
+        'choose_service',
+        'choose_template',
+        'confirm_redact_template',
+        'conversation',
+        'conversation_reply',
+        'conversation_reply_with_template',
+        'conversation_updates',
+        'cookies',
+        'create_api_key',
+        'create_email_branding',
+        'delete_service_template',
+        'delivery_and_failure',
+        'delivery_status_callback',
+        'design_content',
+        'documentation',
+        'download_agreement',
+        'download_notifications_csv',
+        'edit_provider',
+        'edit_service_template',
+        'edit_user_permissions',
+        'email_branding',
+        'email_not_received',
+        'email_template',
+        'error',
+        'features',
+        'feedback',
+        'forgot_password',
+        'get_example_csv',
+        'get_notifications_as_json',
+        'go_to_dashboard_after_tour',
+        'inbound_sms_admin',
+        'inbox',
+        'inbox_download',
+        'inbox_updates',
+        'index',
+        'information_risk_management',
+        'information_security',
+        'integration_testing',
+        'invite_user',
+        'letter_jobs',
+        'link_service_to_organisation',
+        'live_services',
+        'manage_users',
+        'monthly',
+        'new_password',
+        'old_feedback',
+        'old_integration_testing',
+        'old_roadmap',
+        'old_service_dashboard',
+        'old_submit_feedback',
+        'old_terms',
+        'old_using_notify',
+        'organisations',
+        'platform_admin',
+        'pricing',
+        'received_text_messages_callback',
+        'redact_template',
+        'register',
+        'register_from_invite',
+        'register_from_org_invite',
+        'registration_continue',
+        'remove_user_from_service',
+        'request_to_go_live',
+        'resend_email_link',
+        'resend_email_verification',
+        'resume_service',
+        'revoke_api_key',
+        'roadmap',
+        'security',
+        'send_messages',
+        'send_notification',
+        'send_one_off',
+        'send_one_off_step',
+        'send_test',
+        'send_test_preview',
+        'send_test_step',
+        'service_add_email_reply_to',
+        'service_add_letter_contact',
+        'service_add_sms_sender',
+        'service_dashboard',
+        'service_dashboard_updates',
+        'service_edit_email_reply_to',
+        'service_edit_letter_contact',
+        'service_edit_sms_sender',
+        'service_email_reply_to',
+        'service_letter_contact_details',
+        'service_name_change',
+        'service_name_change_confirm',
+        'service_set_auth_type',
+        'service_set_email',
+        'service_set_email_branding',
+        'service_set_inbound_number',
+        'service_set_inbound_sms',
+        'service_set_international_sms',
+        'service_set_letter_contact_block',
+        'service_set_letters',
+        'service_set_reply_to_email',
+        'service_set_sms',
+        'service_set_sms_prefix',
+        'service_settings',
+        'service_sms_senders',
+        'service_switch_can_send_email',
+        'service_switch_can_send_precompiled_letter',
+        'service_switch_can_send_sms',
+        'service_switch_email_auth',
+        'service_switch_live',
+        'service_switch_research_mode',
+        'services_or_dashboard',
+        'set_free_sms_allowance',
+        'set_letter_branding',
+        'set_organisation_type',
+        'set_sender',
+        'set_template_sender',
+        'show_accounts_or_dashboard',
+        'sign_in',
+        'sign_out',
+        'start_job',
+        'start_tour',
+        'styleguide',
+        'submit_request_to_go_live',
+        'support',
+        'suspend_service',
+        'temp_service_history',
+        'template_history',
+        'template_usage',
+        'terms',
+        'thanks',
+        'triage',
+        'trial_mode',
+        'trial_services',
+        'two_factor',
+        'two_factor_email',
+        'two_factor_email_sent',
+        'update_email_branding',
+        'usage',
+        'user_profile',
+        'user_profile_email',
+        'user_profile_email_authenticate',
+        'user_profile_email_confirm',
+        'user_profile_mobile_number',
+        'user_profile_mobile_number_authenticate',
+        'user_profile_mobile_number_confirm',
+        'user_profile_name',
+        'user_profile_password',
+        'using_notify',
+        'verify',
+        'verify_email',
+        'verify_mobile',
+        'view_job',
+        'view_job_csv',
+        'view_job_updates',
+        'view_jobs',
+        'view_letter_notification_as_preview',
+        'view_letter_template_preview',
+        'view_notification',
+        'view_notification_updates',
+        'view_notifications',
+        'view_notifications_csv',
+        'view_provider',
+        'view_providers',
+        'view_template',
+        'view_template_version',
+        'view_template_version_preview',
+        'view_template_versions',
+        'whitelist',
+    }

app/templates/org_nav.html

@@ -1,7 +1,7 @@
 <nav class="navigation">
   <ul>
-  	<li><a href="{{ url_for('.organisation_dashboard', org_id=current_org.id) }}">Dashboard</a></li>
-    <li><a href="{{ url_for('.manage_org_users', org_id=current_org.id) }}">Team members</a></li>
-    <li><a href="{{ url_for('.organisation_settings', org_id=current_org.id) }}">Settings</a></li>
+  	<li><a href="{{ url_for('.organisation_dashboard', org_id=current_org.id) }}" {{ org_navigation.is_selected('dashboard') }}>Dashboard</a></li>
+    <li><a href="{{ url_for('.manage_org_users', org_id=current_org.id) }}" {{ org_navigation.is_selected('team-members') }}>Team members</a></li>
+    <li><a href="{{ url_for('.organisation_settings', org_id=current_org.id) }}" {{ org_navigation.is_selected('settings') }}>Settings</a></li>
   </ul>
 </nav>

tests/app/test_navigation.py

@@ -1,7 +1,7 @@
 import pytest
-from tests.conftest import SERVICE_ONE_ID, app_
+from tests.conftest import ORGANISATION_ID, SERVICE_ONE_ID, app_
 
-from app.navigation import HeaderNavigation, MainNavigation
+from app.navigation import HeaderNavigation, MainNavigation, OrgNavigation
 
 all_endpoints = [
     rule.endpoint for rule in next(app_(None)).url_map.iter_rules()
@@ -11,6 +11,7 @@ all_endpoints = [
 @pytest.mark.parametrize('navigation_instance', [
     MainNavigation(),
     HeaderNavigation(),
+    OrgNavigation(),
 ])
 def test_navigation_items_are_properly_defined(navigation_instance):
     for endpoint in navigation_instance.endpoints_with_navigation:
@@ -38,6 +39,7 @@ def test_navigation_items_are_properly_defined(navigation_instance):
 @pytest.mark.parametrize('navigation_instance', [
     MainNavigation(),
     HeaderNavigation(),
+    OrgNavigation(),
 ])
 def test_excluded_navigation_items_are_properly_defined(navigation_instance):
     for endpoint in navigation_instance.endpoints_without_navigation:
@@ -65,6 +67,7 @@ def test_excluded_navigation_items_are_properly_defined(navigation_instance):
 @pytest.mark.parametrize('navigation_instance', [
     MainNavigation(),
     HeaderNavigation(),
+    OrgNavigation(),
 ])
 def test_all_endpoints_are_covered(navigation_instance):
     for endpoint in all_endpoints:
@@ -80,6 +83,7 @@ def test_all_endpoints_are_covered(navigation_instance):
 @pytest.mark.parametrize('navigation_instance', [
     MainNavigation(),
     HeaderNavigation(),
+    OrgNavigation(),
 ])
 @pytest.mark.xfail(raises=KeyError)
 def test_raises_on_invalid_navigation_item(
@@ -119,3 +123,22 @@ def test_a_page_should_nave_selected_header_navigation_item(
     selected_nav_items = page.select('#proposition-links a.active')
     assert len(selected_nav_items) == 1
     assert selected_nav_items[0].text.strip() == selected_nav_item
+
+
+@pytest.mark.parametrize('endpoint, selected_nav_item', [
+    ('main.organisation_dashboard', 'Dashboard'),
+    ('main.manage_org_users', 'Team members'),
+])
+def test_a_page_should_nave_selected_org_navigation_item(
+    client_request,
+    mock_get_organisation,
+    mock_get_organisation_services,
+    mock_get_users_for_organisation,
+    mock_get_invited_users_for_organisation,
+    endpoint,
+    selected_nav_item,
+):
+    page = client_request.get(endpoint, org_id=ORGANISATION_ID)
+    selected_nav_items = page.select('.navigation a.selected')
+    assert len(selected_nav_items) == 1
+    assert selected_nav_items[0].text.strip() == selected_nav_item