Tests

We use pytest to validate that the functionality of the cms works as expected.

In addition, we use the following plugins:

• pytest-cov: This plugin produces coverage reports.

• pytest-django: Provide a few helpers for Django

• pytest-xdist: Enable distributing tests across multiple CPUs to speed up test execution

• Welcome to requests-mock’s documentation!: Mocking requests to external APIs

For more information, see Testing in Django and Writing and running tests.

• API
  • API Config
    • API_ENDPOINTS
    • API_FEEDBACK_VIEWS
  • Test API Chat
    • test_api_chat_create_attachment_success()
    • test_api_chat_first_chat()
    • test_api_chat_force_new_chat()
    • test_api_chat_get_attachment_incorrect_chat_failure()
    • test_api_chat_get_attachment_missing_attachment_failure()
    • test_api_chat_get_attachment_success()
    • test_api_chat_get_messages_failure()
    • test_api_chat_get_messages_success()
    • test_api_chat_incorrect_auth_error()
    • test_api_chat_missing_auth_error()
    • test_api_chat_ratelimiting()
    • test_api_chat_send_message()
    • test_api_is_chat_enabled_for_user()
  • Test API Feedback
    • test_api_feedback_errors()
    • test_api_feedback_invalid_method()
    • test_api_feedback_success()
  • Test API Push Page
    • test_api_push_page_content()
  • Test API Result
    • test_api_result()
  • Test API Social
    • test_api_result()
• CMS
  • Utils
    • Test Content Utils
      • test_clean_content()
    • Test Disable Hix Post Save Signal
      • create_dummy_page_translation()
      • dummy_region()
      • test_disable_hix_post_save_signal()
      • test_rule_out_false_positive()
    • Test Internal Link Checker
      • prepage_url()
      • test_check_internal_invalid()
      • test_check_internal_skipped()
      • test_check_internal_valid()
    • Test Repair Tree
      • test_repair_tree()
      • test_repair_tree_complex()
    • Test Rounded Hix Value
      • test_rounded_hix_value()
    • Test Slug Utils
      • test_generate_unique_slug_fallback()
      • test_generate_unique_slug_no_fallback()
      • test_generate_unique_slug_reserved_page_slug()
      • test_generate_unique_slug_reserved_region_slug()
    • Test Translation Utils
      • test_translate_link()
  • Views
    • Status Code
      • Test View Status Code_1
      • Test View Status Code_10
      • Test View Status Code_11
      • Test View Status Code_12
      • Test View Status Code_13
      • Test View Status Code_14
      • Test View Status Code_15
      • Test View Status Code_16
      • Test View Status Code_2
      • Test View Status Code_3
      • Test View Status Code_4
      • Test View Status Code_5
      • Test View Status Code_6
      • Test View Status Code_7
      • Test View Status Code_8
      • Test View Status Code_9
    • Test Public View Status Code
      • test_public_view_status_code()
    • Test View Redirect
      • test_view_redirect()
    • Utils
      • check_view_status_code()
    • View Config
      • PARAMETRIZED_PUBLIC_VIEWS
      • PARAMETRIZED_REDIRECT_VIEWS
      • PARAMETRIZED_VIEWS
      • REDIRECT_VIEWS
      • VIEWS
  • Test Duplicate Regions
    • test_duplicate_regions()
    • test_duplicate_regions_no_translations()
  • Test Language
    • test_create_new_language_node()
    • test_delete_language_node()
    • test_move_language_node()
    • test_update_language_node()
  • Test Login
    • test_login_failure()
    • test_login_success()
  • Test Media Library
    • test_create_directory()
    • test_delete_directory()
    • test_delete_file()
    • test_directory_path()
    • test_edit_directory()
    • test_edit_file()
    • test_get_directory_content()
    • test_get_file_usages()
    • test_get_search_result()
    • test_move_file()
    • test_replace_file()
    • test_upload_file()
  • Test Page Filters
    • test_page_filters()
• Core
  • Management
    • Commands
      • Test Duplicate Pages
      • Test Find Large Files
      • Test Find Missing Versions
      • Test Fix Internal Links
      • Test Hix Bulk
      • Test Import Events
      • Test Repair Tree
      • Test Replace Links
      • Test Reset Deepl Budget
      • Test Send Push Notifications
      • Test SUMM.AI Bulk
    • Utils
      • get_command_output()
• Firebase API
  • Test Firebase API Client
    • TestFirebaseApiClient
      • TestFirebaseApiClient.__init__()
      • TestFirebaseApiClient.response_mock_data
      • TestFirebaseApiClient.send_all_with_mocked_response()
      • TestFirebaseApiClient.setup_method()
      • TestFirebaseApiClient.teardown_method()
      • TestFirebaseApiClient.test_client_throws_exception_when_fcm_disabled()
      • TestFirebaseApiClient.test_firebase_api_200_success()
      • TestFirebaseApiClient.test_firebase_api_200_unexpected_api_response()
      • TestFirebaseApiClient.test_firebase_api_403_wrong_token()
      • TestFirebaseApiClient.test_firebase_api_404()
      • TestFirebaseApiClient.test_is_invalid_when_no_title()
      • TestFirebaseApiClient.test_is_invalid_when_no_translation()
      • TestFirebaseApiClient.test_is_valid()
      • TestFirebaseApiClient.test_multiple_regions_notification_send()
      • TestFirebaseApiClient.test_region_notification_send()
  • Test Firebase Data Client
    • TestFirebaseDataClient
      • TestFirebaseDataClient.__init__()
      • TestFirebaseDataClient.endpoint_mock_url
      • TestFirebaseDataClient.response_mock_data
      • TestFirebaseDataClient.test_avg_per_region()
      • TestFirebaseDataClient.test_client_throws_exception_when_fcm_disabled()
      • TestFirebaseDataClient.test_without_analytics_labels()
      • TestFirebaseDataClient.unlabeled_response_mock_data
• Mt API
  • Deepl API Test
    • setup_deepl_supported_languages()
    • setup_fake_deepl_api_server()
    • test_deepl_bulk_mt_api_error()
  • Google Translate API Test
    • FakeClient
      • FakeClient.__init__()
      • FakeClient.translate()
    • setup_fake_google_translate_api()
    • setup_google_translate_supported_languages()
    • test_google_translate_error()
  • Mt API Test
    • mt_setup()
    • test_automatic_translation()
    • test_bulk_mt()
    • test_bulk_mt_exceeds_limit()
    • test_bulk_mt_no_source_language()
    • test_bulk_mt_up_to_date()
    • test_bulk_mt_up_to_date_and_ready_for_mt()
    • test_deepl_bulk_mt_no_target_language()
  • Mt Provider Assignment Test
    • check_mt_provider()
    • test_both_providers_available()
    • test_change_to_not_supporting_provider()
    • test_change_to_supporting_provider()
    • test_no_available_provider()
    • test_only_deepl_available()
    • test_only_google_translate_available()
  • Utils
    • get_content_translations()
    • get_english_name()
    • get_word_count()
• PDF
  • Dummy Django App
    • Static Urls
  • Test PDF Export
    • test_pdf_export()
    • test_pdf_export_invalid()
• Sitemap
  • Sitemap Config
    • SITEMAPS
  • Test Sitemap
    • test_sitemap()
• SUMM.AI API
  • SUMM.AI Test
    • attempts
    • test_auto_translate_easy_german()
    • test_check_rate_limit_exceeded()
    • test_missing_translation()
    • test_patient_task_queue_hit_rate_limit()
    • test_patient_task_queue_max_retries()
    • test_patient_task_queue_normal_deque()
    • test_summ_ai_error_handling()
    • test_translate_text_field_ddos_defense()
    • test_translate_text_field_hit_rate_limit()
    • test_translate_text_field_internal_server_error()
    • test_translate_text_field_successful_translation()
    • test_translate_text_forbidden()
    • test_translate_text_with_empty_text_field()
    • test_unexpected_html()
    • test_validate_response_invalid()
    • test_validate_response_valid()
    • test_worker()
  • Utils
    • MockedRegion
      • MockedRegion.__init__()
    • MockedRequest
      • MockedRequest.__init__()
    • enable_summ_api()
    • get_changed_pages()
    • make_mock_summ_ai_server()
    • make_mock_summ_ai_server_rate_limited()
    • make_rogue_summ_ai_server()
• XLIFF
  • Dummy Django App
    • Static Urls
  • Utils
    • get_and_assert_200()
    • get_open_kwargs()
    • upload_files()
    • validate_xliff_import_response()
  • XLIFF Config
    • XLIFF_IMPORTS
  • XLIFF Test
    • test_xliff_export()
    • test_xliff_import()

Conftest

This module contains shared fixtures for pytest

tests.conftest.ALL_ROLES: Final = ['MANAGEMENT', 'EDITOR', 'AUTHOR', 'EVENT_MANAGER', 'OBSERVER', 'ROOT', 'SERVICE_TEAM', 'CMS_TEAM', 'APP_TEAM', 'MARKETING_TEAM', 'ANONYMOUS']

All region and staff roles and anonymous users

[
    'MANAGEMENT',
    'EDITOR',
    'AUTHOR',
    'EVENT_MANAGER',
    'OBSERVER',
    'ROOT',
    'SERVICE_TEAM',
    'CMS_TEAM',
    'APP_TEAM',
    'MARKETING_TEAM',
    'ANONYMOUS',
]

tests.conftest.ANONYMOUS: Final = 'ANONYMOUS'

A role identifier for anonymous users

tests.conftest.HIGH_PRIV_STAFF_ROLES: Final = ['ROOT', 'SERVICE_TEAM', 'CMS_TEAM']

All roles of staff users that don’t just have read-only permissions

['ROOT', 'SERVICE_TEAM', 'CMS_TEAM']

tests.conftest.PRIV_STAFF_ROLES: Final = ['ROOT', 'APP_TEAM', 'SERVICE_TEAM', 'CMS_TEAM']

All roles of staff users that don’t just have read-only permissions

['ROOT', 'APP_TEAM', 'SERVICE_TEAM', 'CMS_TEAM']

tests.conftest.REGION_ROLES: Final = ['MANAGEMENT', 'EDITOR', 'AUTHOR', 'EVENT_MANAGER', 'OBSERVER']

All roles of region users

['MANAGEMENT', 'EDITOR', 'AUTHOR', 'EVENT_MANAGER', 'OBSERVER']

tests.conftest.ROLES: Final = ['MANAGEMENT', 'EDITOR', 'AUTHOR', 'EVENT_MANAGER', 'OBSERVER', 'ROOT', 'SERVICE_TEAM', 'CMS_TEAM', 'APP_TEAM', 'MARKETING_TEAM']

All region and staff roles

[
    'MANAGEMENT',
    'EDITOR',
    'AUTHOR',
    'EVENT_MANAGER',
    'OBSERVER',
    'ROOT',
    'SERVICE_TEAM',
    'CMS_TEAM',
    'APP_TEAM',
    'MARKETING_TEAM',
]

tests.conftest.ROOT: Final = 'ROOT'

A role identifier for superusers

tests.conftest.STAFF_ROLES: Final = ['ROOT', 'SERVICE_TEAM', 'CMS_TEAM', 'APP_TEAM', 'MARKETING_TEAM']

All roles of staff users

['ROOT', 'SERVICE_TEAM', 'CMS_TEAM', 'APP_TEAM', 'MARKETING_TEAM']

tests.conftest.WRITE_ROLES: Final = ['MANAGEMENT', 'EDITOR', 'AUTHOR', 'EVENT_MANAGER']

All roles with editing permissions

['MANAGEMENT', 'EDITOR', 'AUTHOR', 'EVENT_MANAGER']

tests.conftest.load_test_data(django_db_setup: None, django_db_blocker: _DatabaseBlocker) → None

Load the test data initially for all test cases

Parameters:

• django_db_setup (None) – The fixture providing the database availability

• django_db_blocker (_DatabaseBlocker) – The fixture providing the database blocker

Return type:

None

tests.conftest.load_test_data_transactional(transactional_db: None, django_db_blocker: _DatabaseBlocker) → None

Load the test data initially for all transactional test cases

Parameters:

• transactional_db (None) – The fixture providing transaction support for the database

• django_db_blocker (_DatabaseBlocker) – The fixture providing the database blocker

Return type:

None

tests.conftest.login_role_user(request: SubRequest, load_test_data: None, django_db_blocker: _DatabaseBlocker) → tuple[Client, str]

Get the test user of the current role and force a login. Gets executed only once per user.

Parameters:

• request (SubRequest) – The request object providing the parametrized role variable through request.param

• load_test_data (None) – The fixture providing the test data (see load_test_data())

• django_db_blocker (_DatabaseBlocker) – The fixture providing the database blocker

Returns:

The http client and the current role

Return type:

tuple[Client, str]

tests.conftest.login_role_user_async(request: SubRequest, load_test_data: None, django_db_blocker: _DatabaseBlocker) → tuple[AsyncClient, str]

Get the test user of the current role and force a login. Gets executed only once per user. Identical to login_role_user() with the difference that it returns an django.test.client.AsyncClient instead of django.test.client.Client.

Parameters:

• request (SubRequest) – The request object providing the parametrized role variable through request.param

• load_test_data (None) – The fixture providing the test data (see load_test_data())

• django_db_blocker (_DatabaseBlocker) – The fixture providing the database blocker

Returns:

The http client and the current role

Return type:

tuple[AsyncClient, str]

tests.conftest.mock_firebase_credentials() → Generator[None, None, None]

Return type:

Generator[None, None, None]

tests.conftest.mock_server(httpserver: HTTPServer) → MockServer

Parameters:

httpserver (HTTPServer)

Return type:

MockServer

tests.conftest.pytest_plugins: Final = 'aiohttp.pytest_plugin'

Enable the aiohttp pytest plugin to make use of the test server

Mock

class tests.mock.MockServer(http_server: HTTPServer)

Bases: object

Http server instance that allowes to configure mock responses

Parameters:

http_server (HTTPServer)

__init__(http_server: HTTPServer) → None

Parameters:

http_server (HTTPServer)

Return type:

None

configure(path: str, response_status: int, response_data: dict) → None

Parameters:

• path (str)

• response_status (int)

• response_data (dict)

Return type:

None

property port: int

Utils

This file contains helper functions for tests.

tests.utils.assert_message_in_log(message: str, caplog: LogCaptureFixture) → None

Check whether a given message is in the messages div

Parameters:

• message (str) – The expected message

• caplog (LogCaptureFixture) – The caplog fixture

Raises:

AssertionError – When the expected message was not found in the logs

Return type:

None

tests.utils.assert_no_error_messages(caplog: LogCaptureFixture) → None

Assert that no error messages were shown to the user

Parameters:

caplog (LogCaptureFixture) – The caplog fixture

Raises:

AssertionError – When the the logs contains error messages

Return type:

None

tests.utils.disable_hix_post_save_signal() → Generator[None, None, None]

Return type:

Generator[None, None, None]

tests.utils.get_error_messages(caplog: LogCaptureFixture) → list[str]

Get all errors from the messages framework

Parameters:

caplog (LogCaptureFixture) – The caplog fixture

Returns:

The list of error messages that were shown to the user

Return type:

list[str]

tests.utils.get_messages(caplog: LogCaptureFixture) → list[str]

Get all logs from the messages framework

Parameters:

caplog (LogCaptureFixture) – The caplog fixture

Returns:

The list of messages that were shown to the user

Return type:

list[str]