313 lines
10 KiB
Python
313 lines
10 KiB
Python
import datetime
|
|
import inspect
|
|
import re
|
|
from botocore.exceptions import ClientError
|
|
from typing import Any, Optional, List, Callable, Dict
|
|
from urllib.parse import urlparse
|
|
from .common_types import TYPE_RESPONSE
|
|
|
|
|
|
def camelcase_to_underscores(argument: str) -> str:
|
|
"""Converts a camelcase param like theNewAttribute to the equivalent
|
|
python underscore variable like the_new_attribute"""
|
|
result = ""
|
|
prev_char_title = True
|
|
if not argument:
|
|
return argument
|
|
for index, char in enumerate(argument):
|
|
try:
|
|
next_char_title = argument[index + 1].istitle()
|
|
except IndexError:
|
|
next_char_title = True
|
|
|
|
upper_to_lower = char.istitle() and not next_char_title
|
|
lower_to_upper = char.istitle() and not prev_char_title
|
|
|
|
if index and (upper_to_lower or lower_to_upper):
|
|
# Only add underscore if char is capital, not first letter, and next
|
|
# char is not capital
|
|
result += "_"
|
|
prev_char_title = char.istitle()
|
|
if not char.isspace(): # Only add non-whitespace
|
|
result += char.lower()
|
|
return result
|
|
|
|
|
|
def underscores_to_camelcase(argument: str) -> str:
|
|
"""Converts a camelcase param like the_new_attribute to the equivalent
|
|
camelcase version like theNewAttribute. Note that the first letter is
|
|
NOT capitalized by this function"""
|
|
result = ""
|
|
previous_was_underscore = False
|
|
for char in argument:
|
|
if char != "_":
|
|
if previous_was_underscore:
|
|
result += char.upper()
|
|
else:
|
|
result += char
|
|
previous_was_underscore = char == "_"
|
|
return result
|
|
|
|
|
|
def pascal_to_camelcase(argument: str) -> str:
|
|
"""Converts a PascalCase param to the camelCase equivalent"""
|
|
return argument[0].lower() + argument[1:]
|
|
|
|
|
|
def camelcase_to_pascal(argument: str) -> str:
|
|
"""Converts a camelCase param to the PascalCase equivalent"""
|
|
return argument[0].upper() + argument[1:]
|
|
|
|
|
|
def method_names_from_class(clazz: object) -> List[str]:
|
|
predicate = inspect.isfunction
|
|
return [x[0] for x in inspect.getmembers(clazz, predicate=predicate)]
|
|
|
|
|
|
def convert_regex_to_flask_path(url_path: str) -> str:
|
|
"""
|
|
Converts a regex matching url to one that can be used with flask
|
|
"""
|
|
for token in ["$"]:
|
|
url_path = url_path.replace(token, "")
|
|
|
|
def caller(reg: Any) -> str:
|
|
match_name, match_pattern = reg.groups()
|
|
return '<regex("{0}"):{1}>'.format(match_pattern, match_name)
|
|
|
|
url_path = re.sub(r"\(\?P<(.*?)>(.*?)\)", caller, url_path)
|
|
|
|
if url_path.endswith("/?"):
|
|
# Flask does own handling of trailing slashes
|
|
url_path = url_path.rstrip("/?")
|
|
return url_path
|
|
|
|
|
|
class convert_to_flask_response(object):
|
|
def __init__(self, callback: Callable[..., Any]):
|
|
self.callback = callback
|
|
|
|
@property
|
|
def __name__(self) -> str:
|
|
# For instance methods, use class and method names. Otherwise
|
|
# use module and method name
|
|
if inspect.ismethod(self.callback):
|
|
outer = self.callback.__self__.__class__.__name__
|
|
else:
|
|
outer = self.callback.__module__
|
|
return "{0}.{1}".format(outer, self.callback.__name__)
|
|
|
|
def __call__(self, args: Any = None, **kwargs: Any) -> Any:
|
|
from flask import request, Response
|
|
from moto.moto_api import recorder
|
|
|
|
try:
|
|
recorder._record_request(request)
|
|
result = self.callback(request, request.url, dict(request.headers))
|
|
except ClientError as exc:
|
|
result = 400, {}, exc.response["Error"]["Message"]
|
|
# result is a status, headers, response tuple
|
|
if len(result) == 3:
|
|
status, headers, content = result
|
|
else:
|
|
status, headers, content = 200, {}, result
|
|
|
|
response = Response(response=content, status=status, headers=headers)
|
|
if request.method == "HEAD" and "content-length" in headers:
|
|
response.headers["Content-Length"] = headers["content-length"]
|
|
return response
|
|
|
|
|
|
class convert_flask_to_responses_response(object):
|
|
def __init__(self, callback: Callable[..., Any]):
|
|
self.callback = callback
|
|
|
|
@property
|
|
def __name__(self) -> str:
|
|
# For instance methods, use class and method names. Otherwise
|
|
# use module and method name
|
|
if inspect.ismethod(self.callback):
|
|
outer = self.callback.__self__.__class__.__name__
|
|
else:
|
|
outer = self.callback.__module__
|
|
return "{0}.{1}".format(outer, self.callback.__name__)
|
|
|
|
def __call__(self, request: Any, *args: Any, **kwargs: Any) -> TYPE_RESPONSE:
|
|
for key, val in request.headers.items():
|
|
if isinstance(val, bytes):
|
|
request.headers[key] = val.decode("utf-8")
|
|
|
|
result = self.callback(request, request.url, request.headers)
|
|
status, headers, response = result
|
|
return status, headers, response
|
|
|
|
|
|
def iso_8601_datetime_with_milliseconds(value: datetime.datetime) -> str:
|
|
return value.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
|
|
|
|
|
|
# Even Python does not support nanoseconds, other languages like Go do (needed for Terraform)
|
|
def iso_8601_datetime_with_nanoseconds(value: datetime.datetime) -> str:
|
|
return value.strftime("%Y-%m-%dT%H:%M:%S.%f000Z")
|
|
|
|
|
|
def iso_8601_datetime_without_milliseconds(value: datetime.datetime) -> Optional[str]:
|
|
return value.strftime("%Y-%m-%dT%H:%M:%SZ") if value else None
|
|
|
|
|
|
def iso_8601_datetime_without_milliseconds_s3(
|
|
value: datetime.datetime,
|
|
) -> Optional[str]:
|
|
return value.strftime("%Y-%m-%dT%H:%M:%S.000Z") if value else None
|
|
|
|
|
|
RFC1123 = "%a, %d %b %Y %H:%M:%S GMT"
|
|
|
|
|
|
def rfc_1123_datetime(src: datetime.datetime) -> str:
|
|
return src.strftime(RFC1123)
|
|
|
|
|
|
def str_to_rfc_1123_datetime(value: str) -> datetime.datetime:
|
|
return datetime.datetime.strptime(value, RFC1123)
|
|
|
|
|
|
def unix_time(dt: Optional[datetime.datetime] = None) -> float:
|
|
dt = dt or datetime.datetime.utcnow()
|
|
epoch = datetime.datetime.utcfromtimestamp(0)
|
|
delta = dt - epoch
|
|
return (delta.days * 86400) + (delta.seconds + (delta.microseconds / 1e6))
|
|
|
|
|
|
def unix_time_millis(dt: Optional[datetime.datetime] = None) -> float:
|
|
return unix_time(dt) * 1000.0
|
|
|
|
|
|
def path_url(url: str) -> str:
|
|
parsed_url = urlparse(url)
|
|
path = parsed_url.path
|
|
if not path:
|
|
path = "/"
|
|
if parsed_url.query:
|
|
path = path + "?" + parsed_url.query
|
|
return path
|
|
|
|
|
|
def tags_from_query_string(
|
|
querystring_dict: Dict[str, Any],
|
|
prefix: str = "Tag",
|
|
key_suffix: str = "Key",
|
|
value_suffix: str = "Value",
|
|
) -> Dict[str, str]:
|
|
response_values = {}
|
|
for key in querystring_dict.keys():
|
|
if key.startswith(prefix) and key.endswith(key_suffix):
|
|
tag_index = key.replace(prefix + ".", "").replace("." + key_suffix, "")
|
|
tag_key = querystring_dict[
|
|
"{prefix}.{index}.{key_suffix}".format(
|
|
prefix=prefix, index=tag_index, key_suffix=key_suffix
|
|
)
|
|
][0]
|
|
tag_value_key = "{prefix}.{index}.{value_suffix}".format(
|
|
prefix=prefix, index=tag_index, value_suffix=value_suffix
|
|
)
|
|
if tag_value_key in querystring_dict:
|
|
response_values[tag_key] = querystring_dict[tag_value_key][0]
|
|
else:
|
|
response_values[tag_key] = None
|
|
return response_values
|
|
|
|
|
|
def tags_from_cloudformation_tags_list(
|
|
tags_list: List[Dict[str, str]]
|
|
) -> Dict[str, str]:
|
|
"""Return tags in dict form from cloudformation resource tags form (list of dicts)"""
|
|
tags = {}
|
|
for entry in tags_list:
|
|
key = entry["Key"]
|
|
value = entry["Value"]
|
|
tags[key] = value
|
|
|
|
return tags
|
|
|
|
|
|
def remap_nested_keys(root: Any, key_transform: Callable[[str], str]) -> Any:
|
|
"""This remap ("recursive map") function is used to traverse and
|
|
transform the dictionary keys of arbitrarily nested structures.
|
|
List comprehensions do not recurse, making it tedious to apply
|
|
transforms to all keys in a tree-like structure.
|
|
|
|
A common issue for `moto` is changing the casing of dict keys:
|
|
|
|
>>> remap_nested_keys({'KeyName': 'Value'}, camelcase_to_underscores)
|
|
{'key_name': 'Value'}
|
|
|
|
Args:
|
|
root: The target data to traverse. Supports iterables like
|
|
:class:`list`, :class:`tuple`, and :class:`dict`.
|
|
key_transform (callable): This function is called on every
|
|
dictionary key found in *root*.
|
|
"""
|
|
if isinstance(root, (list, tuple)):
|
|
return [remap_nested_keys(item, key_transform) for item in root]
|
|
if isinstance(root, dict):
|
|
return {
|
|
key_transform(k): remap_nested_keys(v, key_transform)
|
|
for k, v in root.items()
|
|
}
|
|
return root
|
|
|
|
|
|
def merge_dicts(
|
|
dict1: Dict[str, Any], dict2: Dict[str, Any], remove_nulls: bool = False
|
|
) -> None:
|
|
"""Given two arbitrarily nested dictionaries, merge the second dict into the first.
|
|
|
|
:param dict dict1: the dictionary to be updated.
|
|
:param dict dict2: a dictionary of keys/values to be merged into dict1.
|
|
|
|
:param bool remove_nulls: If true, updated values equal to None or an empty dictionary
|
|
will be removed from dict1.
|
|
"""
|
|
for key in dict2:
|
|
if isinstance(dict2[key], dict):
|
|
if key in dict1 and key in dict2:
|
|
merge_dicts(dict1[key], dict2[key], remove_nulls)
|
|
else:
|
|
dict1[key] = dict2[key]
|
|
if dict1[key] == {} and remove_nulls:
|
|
dict1.pop(key)
|
|
else:
|
|
dict1[key] = dict2[key]
|
|
if dict1[key] is None and remove_nulls:
|
|
dict1.pop(key)
|
|
|
|
|
|
def aws_api_matches(pattern: str, string: str) -> bool:
|
|
"""
|
|
AWS API can match a value based on a glob, or an exact match
|
|
"""
|
|
# use a negative lookback regex to match stars that are not prefixed with a backslash
|
|
# and replace all stars not prefixed w/ a backslash with '.*' to take this from "glob" to PCRE syntax
|
|
pattern, _ = re.subn(r"(?<!\\)\*", r".*", pattern)
|
|
|
|
# ? in the AWS glob form becomes .? in regex
|
|
# also, don't substitute it if it is prefixed w/ a backslash
|
|
pattern, _ = re.subn(r"(?<!\\)\?", r".?", pattern)
|
|
|
|
# aws api seems to anchor
|
|
anchored_pattern = f"^{pattern}$"
|
|
|
|
if re.match(anchored_pattern, str(string)):
|
|
return True
|
|
else:
|
|
return False
|
|
|
|
|
|
def extract_region_from_aws_authorization(string: str) -> Optional[str]:
|
|
auth = string or ""
|
|
region = re.sub(r".*Credential=[^/]+/[^/]+/([^/]+)/.*", r"\1", auth)
|
|
if region == auth:
|
|
return None
|
|
return region
|