1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
|
from __future__ import annotations
import copy
import datetime
import re
from collections import OrderedDict
from dataclasses import dataclass
from enum import Enum
from typing import Any, Optional
from botocore.utils import merge_dicts
SECONDS_IN_ONE_DAY = 24 * 60 * 60
@dataclass
class FilterDef:
# A list of object attributes to check against the filter values.
# Set to None if filter is not yet implemented in `moto`.
attrs_to_check: list[str] | None
# Description of the filter, e.g. 'Object Identifiers'.
# Used in filter error messaging.
description: str
# Make comparison case-insensitive.
case_insensitive: bool = False
class DbInstanceEngine(str, Enum):
# https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds/client/create_db_instance.html
# 2023-11-08
AURORA_MYSQL = "aurora-mysql"
AURORA_POSTGRESQL = "aurora-postgresql"
CUSTOM_ORACLE_EE = "custom-oracle-ee"
CUSTOM_ORACLE_EE_CDB = "custom-oracle-ee-cdb"
CUSTOM_SQLSERVER_EE = "custom-sqlserver-ee"
CUSTOM_SQLSERVER_SE = "custom-sqlserver-se"
CUSTOM_SQLSERVER_WEB = "custom-sqlserver-web"
MARIADB = "mariadb"
MYSQL = "mysql"
NEPTUNE = "neptune"
ORACLE_EE = "oracle-ee"
ORACLE_EE_CDB = "oracle-ee-cdb"
ORACLE_SE2 = "oracle-se2"
ORACLE_SE2_CDB = "oracle-se2-cdb"
POSTGRES = "postgres"
SQLSERVER_EE = "sqlserver-ee"
SQLSERVER_SE = "sqlserver-se"
SQLSERVER_EX = "sqlserver-ex"
SQLSERVER_WEB = "sqlserver-web"
@classmethod
def valid_db_instance_engine(self) -> list[str]:
return sorted([item.value for item in DbInstanceEngine])
class ClusterEngine(str, Enum):
AURORA_POSTGRESQL = "aurora-postgresql"
AURORA_MYSQL = "aurora-mysql"
NEPTUNE = "neptune"
RDS_POSTGRESQL = "postgres"
RDS_MYSQL = "mysql"
@classmethod
def list_cluster_engines(self) -> list[str]:
return sorted([item.value for item in ClusterEngine])
@classmethod
def serverless_engines(self) -> list[str]:
return [ClusterEngine.AURORA_MYSQL, ClusterEngine.AURORA_POSTGRESQL]
def get_object_value(obj: Any, attr: str) -> Any:
"""Retrieves an arbitrary attribute value from an object.
Nested attributes can be specified using dot notation,
e.g. 'parent.child'.
:param object obj:
A valid Python object.
:param str attr:
The attribute name of the value to retrieve from the object.
:returns:
The attribute value, if it exists, or None.
:rtype:
any
"""
keys = attr.split(".")
val = obj
for key in keys:
if hasattr(val, key):
val = getattr(val, key)
else:
return None
return val
def merge_filters(
filters_to_update: Optional[dict[str, Any]], filters_to_merge: dict[str, Any]
) -> dict[str, Any]:
"""Given two groups of filters, merge the second into the first.
List values are appended instead of overwritten:
>>> merge_filters({'filter-name': ['value1']}, {'filter-name':['value2']})
>>> {'filter-name': ['value1', 'value2']}
:param filters_to_update:
The filters to update.
:type filters_to_update:
dict[str, list] or None
:param filters_to_merge:
The filters to merge.
:type filters_to_merge:
dict[str, list] or None
:returns:
The updated filters.
:rtype:
dict[str, list]
"""
if filters_to_update is None:
filters_to_update = {}
if filters_to_merge is None:
filters_to_merge = {}
merge_dicts(filters_to_update, filters_to_merge, append_lists=True)
return filters_to_update
def validate_filters(
filters: dict[str, Any], filter_defs: dict[str, FilterDef]
) -> None:
"""Validates filters against a set of filter definitions.
Raises standard Python exceptions which should be caught
and translated to an appropriate AWS/Moto exception higher
up the call stack.
:param dict[str, list] filters:
The filters to validate.
:param dict[str, FilterDef] filter_defs:
The filter definitions to validate against.
:returns: None
:rtype: None
:raises KeyError:
if filter name not found in the filter definitions.
:raises ValueError:
if filter values is an empty list.
:raises NotImplementedError:
if `moto` does not yet support this filter.
"""
for filter_name, filter_values in filters.items():
filter_def = filter_defs.get(filter_name)
if filter_def is None:
raise KeyError(f"Unrecognized filter name: {filter_name}")
if not filter_values:
raise ValueError(f"The list of {filter_def.description} must not be empty.")
if filter_def.attrs_to_check is None:
raise NotImplementedError(
f"{filter_name} filter has not been implemented in Moto yet."
)
def apply_filter(
resources: Any, filters: Any, filter_defs: dict[str, FilterDef]
) -> Any:
"""Apply an arbitrary filter to a group of resources.
:param dict[str, object] resources:
A dictionary mapping resource identifiers to resource objects.
:param dict[str, list] filters:
The filters to apply.
:param dict[str, FilterDef] filter_defs:
The supported filter definitions for the resource type.
:returns:
The filtered collection of resources.
:rtype:
dict[str, object]
"""
resources_filtered = OrderedDict()
for identifier, obj in resources.items():
matches_filter = False
for filter_name, filter_values in filters.items():
filter_def = filter_defs.get(filter_name)
if filter_def is None or filter_def.attrs_to_check is None:
continue
for attr in filter_def.attrs_to_check:
if filter_def.case_insensitive:
filter_values = [x.lower() for x in filter_values]
if get_object_value(obj, attr) in filter_values:
matches_filter = True
break
else:
matches_filter = False
if not matches_filter:
break
if matches_filter:
resources_filtered[identifier] = obj
return resources_filtered
def get_start_date_end_date(
base_date: str, window: str
) -> tuple[datetime.datetime, datetime.datetime]:
"""Gets the start date and end date given DDD:HH24:MM-DDD:HH24:MM.
:param base_date:
type datetime
:param window:
DDD:HH24:MM-DDD:HH24:MM
:returns:
Start and End Date in datetime format
:rtype:
tuple
"""
days = {"mon": 1, "tue": 2, "wed": 3, "thu": 4, "fri": 5, "sat": 6, "sun": 7}
start = datetime.datetime.strptime(
base_date + " " + window[4:9], "%d/%m/%y %H:%M"
) + datetime.timedelta(days=days[window[0:3]])
end = datetime.datetime.strptime(
base_date + " " + window[14::], "%d/%m/%y %H:%M"
) + datetime.timedelta(days=days[window[10:13]])
return start, end
def get_start_date_end_date_from_time(
base_date: str, window: str
) -> tuple[datetime.datetime, datetime.datetime, bool]:
"""Gets the start date and end date given HH24:MM-HH24:MM.
:param window:
HH24:MM-HH24:MM
:returns:
Start and End Date in datetime format
along with flag for spills over a day
This is useful when determine time overlaps
:rtype:
tuple
"""
times = window.split("-")
spillover = False
start = datetime.datetime.strptime(base_date + " " + times[0], "%d/%m/%y %H:%M")
end = datetime.datetime.strptime(base_date + " " + times[1], "%d/%m/%y %H:%M")
if end < start:
end += datetime.timedelta(days=1)
spillover = True
return start, end, spillover
def get_overlap_between_two_date_ranges(
start_time_1: datetime.datetime,
end_time_1: datetime.datetime,
start_time_2: datetime.datetime,
end_time_2: datetime.datetime,
) -> int:
"""
Determines overlap between 2 date ranges. Returns the overlap in seconds.
"""
latest_start = max(start_time_1, start_time_2)
earliest_end = min(end_time_1, end_time_2)
delta = earliest_end - latest_start
return (delta.days * SECONDS_IN_ONE_DAY) + delta.seconds
def valid_preferred_maintenance_window(
maintenance_window: Any, backup_window: Any
) -> Optional[str]:
"""Determines validity of preferred_maintenance_window
:param maintenance_windown:
type DDD:HH24:MM-DDD:HH24:MM
:param backup_window:
type HH24:MM-HH24:MM
:returns:
message
:rtype:
str
"""
MINUTES_30 = 1800
HOURS_24 = 86400
base_date = datetime.datetime.now().strftime("%d/%m/%y")
try:
p = re.compile(
"([a-z]{3}):([0-9]{2}):([0-9]{2})-([a-z]{3}):([0-9]{2}):([0-9]{2})"
)
if len(maintenance_window) != 19 or re.search(p, maintenance_window) is None:
return f"Invalid maintenance window format: {maintenance_window}. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). Example: Sun:23:45-Mon:00:15"
if backup_window:
(
backup_window_start,
backup_window_end,
backup_spill,
) = get_start_date_end_date_from_time(base_date, backup_window)
(
maintenance_window_start,
maintenance_window_end,
maintenance_spill,
) = get_start_date_end_date_from_time(
base_date, maintenance_window[4:10] + maintenance_window[14::]
)
if (
get_overlap_between_two_date_ranges(
backup_window_start,
backup_window_end,
maintenance_window_start,
maintenance_window_end,
)
>= 0
):
return "The backup window and maintenance window must not overlap."
# Due to spill overs, adjust the windows
elif maintenance_spill:
backup_window_start += datetime.timedelta(days=1)
backup_window_end += datetime.timedelta(days=1)
elif backup_spill:
maintenance_window_start += datetime.timedelta(days=1)
maintenance_window_end += datetime.timedelta(days=1)
# If spills, rerun overlap test with adjusted windows
if maintenance_spill or backup_spill:
if (
get_overlap_between_two_date_ranges(
backup_window_start,
backup_window_end,
maintenance_window_start,
maintenance_window_end,
)
>= 0
):
return "The backup window and maintenance window must not overlap."
maintenance_window_start, maintenance_window_end = get_start_date_end_date(
base_date, maintenance_window
)
delta = maintenance_window_end - maintenance_window_start
delta_seconds = delta.seconds + (delta.days * SECONDS_IN_ONE_DAY)
if delta_seconds >= MINUTES_30 and delta_seconds <= HOURS_24:
return None
elif delta_seconds >= 0 and delta_seconds <= MINUTES_30:
return "The maintenance window must be at least 30 minutes."
else:
return "Maintenance window must be less than 24 hours."
except Exception:
return f"Invalid day:hour:minute value: {maintenance_window}"
ORDERABLE_DB_INSTANCE_ENCODING = {
"Engine": "E",
"EngineVersion": "EV",
"DBInstanceClass": "DBIC",
"LicenseModel": "L",
"AvailabilityZones": "AZ",
"MultiAZCapable": "MC",
"ReadReplicaCapable": "RC",
"Vpc": "V",
"SupportsStorageEncryption": "SE",
"StorageType": "ST",
"SupportsIops": "SI",
"SupportsEnhancedMonitoring": "SM",
"SupportsIAMDatabaseAuthentication": "SIAM",
"SupportsPerformanceInsights": "SPI",
"AvailableProcessorFeatures": "APF",
"SupportedEngineModes": "SEM",
"SupportsKerberosAuthentication": "SK",
"OutpostCapable": "O",
"SupportedActivityStreamModes": "SSM",
"SupportsGlobalDatabases": "SGD",
"SupportsClusters": "SC",
"SupportedNetworkTypes": "SN",
"SupportsStorageThroughput": "SST",
}
ORDERABLE_DB_INSTANCE_DECODING = {
v: k for (k, v) in ORDERABLE_DB_INSTANCE_ENCODING.items()
}
def encode_orderable_db_instance(db: dict[str, Any]) -> dict[str, Any]:
encoded = copy.deepcopy(db)
if "AvailabilityZones" in encoded:
encoded["AvailabilityZones"] = [
az["Name"] for az in encoded["AvailabilityZones"]
]
return {
ORDERABLE_DB_INSTANCE_ENCODING.get(key, key): value
for key, value in encoded.items()
}
def decode_orderable_db_instance(db: dict[str, Any]) -> dict[str, Any]:
decoded = copy.deepcopy(db)
decoded_az = ORDERABLE_DB_INSTANCE_ENCODING.get(
"AvailabilityZones", "AvailabilityZones"
)
if decoded_az in decoded:
decoded["AvailabilityZones"] = [{"Name": az} for az in decoded[decoded_az]]
return {
ORDERABLE_DB_INSTANCE_DECODING.get(key, key): value
for key, value in decoded.items()
}
|