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

integrations: Use directory name to get HTTP headers from fixtures.

Browse Source 
Previously, the integration's name was directly being used.
Due to this, the GitHub Sponsors integration which is in the same module
as the GitHub integration could not be used with the
`generate-integration-docs-screenshot` script, as it would be unable to
locate the fixtures.
This commit is contained in:
Niloth P
2025-05-27 12:45:12 +05:30
committed by Tim Abbott
parent f99772b131
commit 6a1d231689
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
tools/screenshots/generate-integration-docs-screenshot
View File

@@ -122,8 +122,8 @@ def get_fixture_info(fixture_path: str) -> tuple[Any, bool, bool, str]:
return data, json_fixture, multipart_fixture, fixture_name
def get_requests_headers(integration_name: str, fixture_name: str) -> dict[str, Any]:
headers = get_fixture_http_headers(integration_name, fixture_name)
def get_requests_headers(integration_dir_name: str, fixture_name: str) -> dict[str, Any]:
headers = get_fixture_http_headers(integration_dir_name, fixture_name)
def fix_name(header: str) -> str:
return header.removeprefix("HTTP_").replace("_", "-")
@@ -153,7 +153,7 @@ def send_bot_payload_message(
Message.objects.filter(realm_id=bot.realm_id, sender=bot).delete()
data, json_fixture, multipart_fixture, fixture_name = get_fixture_info(fixture_path)
headers = get_requests_headers(integration.name, fixture_name)
headers = get_requests_headers(integration.dir_name, fixture_name)
if config.custom_headers:
headers.update(config.custom_headers)
if config.use_basic_auth:

4
zerver/lib/webhooks/common.py
View File

@@ -214,13 +214,13 @@ def validate_extract_webhook_http_header(
return extracted_header
def get_fixture_http_headers(integration_name: str, fixture_name: str) -> dict["str", "str"]:
def get_fixture_http_headers(integration_dir_name: str, fixture_name: str) -> dict["str", "str"]:
"""For integrations that require custom HTTP headers for some (or all)
of their test fixtures, this method will call a specially named
function from the target integration module to determine what set
of HTTP headers goes with the given test fixture.
"""
view_module_name = f"zerver.webhooks.{integration_name}.view"
view_module_name = f"zerver.webhooks.{integration_dir_name}.view"
try:
# TODO: We may want to migrate to a more explicit registration
# strategy for this behavior rather than a try/except import.