paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-22 20:42:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

test_integrations: Improve test_no_missing_screenshot_path.

Browse Source 
Previously, the test would fail at the first missing occurrence, and
not report about any other missing files.
Now, all missing cases are collected and presented together in a single
error message, every run.
This commit is contained in:
Niloth P
2025-05-30 15:45:35 +05:30
committed by Tim Abbott
parent 7b5e4db7ee
commit 0048902853
1 changed files with 18 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
zerver/tests/test_integrations.py
View File

@@ -51,27 +51,29 @@ class IntegrationsTestCase(ZulipTestCase):
self.assertFalse(missing_webhooks, message)
def test_no_missing_screenshot_path(self) -> None:
message = (
'"{path}" does not exist for webhook {webhook_name}.\n'
"Consider updating zerver.lib.integrations.DOC_SCREENSHOT_CONFIG\n"
'and running "tools/screenshots/generate-integration-docs-screenshot" to keep the screenshots up-to-date.'
)
for integration_name in WEBHOOK_SCREENSHOT_CONFIG:
configs = WEBHOOK_SCREENSHOT_CONFIG[integration_name]
for screenshot_config in configs:
message = '"{path}" does not exist for integration {integration_name}.\n'
tip = '\nConsider updating zerver.lib.integrations.DOC_SCREENSHOT_CONFIG\n and running "tools/screenshots/generate-integration-docs-screenshot" to keep the screenshots up-to-date.'
error_message = ""
for integration_name, screenshot_configs in WEBHOOK_SCREENSHOT_CONFIG.items():
for screenshot_config in screenshot_configs:
integration = INTEGRATIONS[integration_name]
assert isinstance(integration, WebhookIntegration)
if screenshot_config.fixture_name == "":
# Such screenshot configs only use a placeholder
# fixture_name.
# Skip screenshot configs of webhooks with a placeholder fixture_name
continue
fixture_path = get_fixture_path(integration, screenshot_config)
self.assertTrue(
os.path.isfile(fixture_path),
message.format(path=fixture_path, webhook_name=integration_name),
error_message = (
error_message
+ message.format(path=fixture_path, integration_name=integration_name)
if not os.path.isfile(fixture_path)
else error_message
)
image_path = get_image_path(integration, screenshot_config)
self.assertTrue(
os.path.isfile(image_path),
message.format(path=image_path, webhook_name=integration_name),
error_message = (
error_message
+ message.format(path=image_path, integration_name=integration_name)
if not os.path.isfile(image_path)
else error_message
)
self.assertEqual(error_message, "", tip)