Skip to content

feat(data_classes): case insensitive header lookup #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 4, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions aws_lambda_powertools/utilities/data_classes/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ def get_query_string_value(self, name: str, default_value: Optional[str] = None)
params = self.query_string_parameters
return default_value if params is None else params.get(name, default_value)

def get_header_value(self, name: str, default_value: Optional[str] = None) -> Optional[str]:
def get_header_value(
self, name: str, default_value: Optional[str] = None, case_sensitive: Optional[bool] = False
) -> Optional[str]:
"""Get header value by name

Parameters
Expand All @@ -57,9 +59,14 @@ def get_header_value(self, name: str, default_value: Optional[str] = None) -> Op
Header name
default_value: str, optional
Default value if no value was found by name
case_sensitive: bool
Whether to use a case sensitive look up
Returns
-------
str, optional
Header value
"""
return self.headers.get(name, default_value)
if case_sensitive:
return self.headers.get(name, default_value)

return next((value for key, value in self.headers.items() if name.lower() == key.lower()), default_value)
27 changes: 27 additions & 0 deletions tests/functional/test_lambda_trigger_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -579,13 +579,40 @@ def test_base_proxy_event_get_header_value():
value = event.get_header_value("test", default_value)
assert value == set_value

# Verify that the default look is case insensitive
value = event.get_header_value("Test")
assert value == set_value

value = event.get_header_value("unknown", default_value)
assert value == default_value

value = event.get_header_value("unknown")
assert value is None


def test_base_proxy_event_get_header_value_case_insensitive():
default_value = "default"
set_value = "value"

event = BaseProxyEvent({"headers": {}})

event._data["headers"] = {"Test": set_value}
value = event.get_header_value("test", case_sensitive=True)
assert value is None

value = event.get_header_value("test", default_value=default_value, case_sensitive=True)
assert value == default_value

value = event.get_header_value("Test", case_sensitive=True)
assert value == set_value

value = event.get_header_value("unknown", default_value, case_sensitive=True)
assert value == default_value

value = event.get_header_value("unknown", case_sensitive=True)
assert value is None


def test_kinesis_stream_event():
event = KinesisStreamEvent(load_event("kinesisStreamEvent.json"))

Expand Down