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 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657
|
import string
from collections.abc import Iterable
from typing import Any, Optional
from moto.core.base_backend import BackendDict, BaseBackend
from moto.core.common_models import BaseModel
from moto.core.utils import unix_time
from moto.moto_api._internal import mock_random as random
from moto.route53 import route53_backends
from moto.utilities.tagging_service import TaggingService
from moto.utilities.utils import get_partition
from .exceptions import (
ConflictingDomainExists,
CustomHealthNotFound,
InstanceNotFound,
InvalidInput,
NamespaceNotFound,
OperationNotFound,
ServiceNotFound,
)
def random_id(size: int) -> str:
return "".join(
[random.choice(string.ascii_lowercase + string.digits) for _ in range(size)]
)
class Namespace(BaseModel):
def __init__(
self,
account_id: str,
region: str,
name: str,
ns_type: str,
creator_request_id: str,
description: str,
dns_properties: dict[str, Any],
http_properties: dict[str, Any],
vpc: Optional[str] = None,
):
self.id = f"ns-{random_id(20)}"
self.arn = f"arn:{get_partition(region)}:servicediscovery:{region}:{account_id}:namespace/{self.id}"
self.name = name
self.type = ns_type
self.creator_request_id = creator_request_id
self.description = description
self.dns_properties = dns_properties
self.http_properties = http_properties
self.vpc = vpc
self.created = unix_time()
self.updated = unix_time()
def to_json(self) -> dict[str, Any]:
return {
"Arn": self.arn,
"Id": self.id,
"Name": self.name,
"Description": self.description,
"Type": self.type,
"Properties": {
"DnsProperties": self.dns_properties,
"HttpProperties": self.http_properties,
},
"CreateDate": self.created,
"UpdateDate": self.updated,
"CreatorRequestId": self.creator_request_id,
}
class Service(BaseModel):
def __init__(
self,
account_id: str,
region: str,
name: str,
namespace_id: str,
description: str,
creator_request_id: str,
dns_config: dict[str, Any],
health_check_config: dict[str, Any],
health_check_custom_config: dict[str, int],
service_type: str,
):
self.id = f"srv-{random_id(8)}"
self.arn = f"arn:{get_partition(region)}:servicediscovery:{region}:{account_id}:service/{self.id}"
self.name = name
self.namespace_id = namespace_id
self.description = description
self.creator_request_id = creator_request_id
self.dns_config: Optional[dict[str, Any]] = dns_config
self.health_check_config = health_check_config
self.health_check_custom_config = health_check_custom_config
self.service_type = service_type
self.created = unix_time()
self.instances: list[ServiceInstance] = []
self.instances_revision: dict[str, int] = {}
def update(self, details: dict[str, Any]) -> None:
if "Description" in details:
self.description = details["Description"]
if "DnsConfig" in details:
if self.dns_config is None:
self.dns_config = {}
self.dns_config["DnsRecords"] = details["DnsConfig"]["DnsRecords"]
else:
# From the docs:
# If you omit any existing DnsRecords or HealthCheckConfig configurations from an UpdateService request,
# the configurations are deleted from the service.
self.dns_config = None
if "HealthCheckConfig" in details:
self.health_check_config = details["HealthCheckConfig"]
def to_json(self) -> dict[str, Any]:
return {
"Arn": self.arn,
"Id": self.id,
"Name": self.name,
"NamespaceId": self.namespace_id,
"CreateDate": self.created,
"Description": self.description,
"CreatorRequestId": self.creator_request_id,
"DnsConfig": self.dns_config,
"HealthCheckConfig": self.health_check_config,
"HealthCheckCustomConfig": self.health_check_custom_config,
"Type": self.service_type,
}
class ServiceInstance(BaseModel):
def __init__(
self,
service_id: str,
instance_id: str,
creator_request_id: Optional[str] = None,
attributes: Optional[dict[str, str]] = None,
):
self.service_id = service_id
self.instance_id = instance_id
self.attributes = attributes if attributes else {}
self.creator_request_id = (
creator_request_id if creator_request_id else random_id(32)
)
self.health_status = "HEALTHY"
def to_json(self) -> dict[str, Any]:
return {
"Id": self.instance_id,
"CreatorRequestId": self.creator_request_id,
"Attributes": self.attributes,
}
class Operation(BaseModel):
def __init__(self, operation_type: str, targets: dict[str, str]):
super().__init__()
self.id = f"{random_id(32)}-{random_id(8)}"
self.status = "SUCCESS"
self.operation_type = operation_type
self.created = unix_time()
self.updated = unix_time()
self.targets = targets
def to_json(self, short: bool = False) -> dict[str, Any]:
if short:
return {"Id": self.id, "Status": self.status}
else:
return {
"Id": self.id,
"Status": self.status,
"Type": self.operation_type,
"CreateDate": self.created,
"UpdateDate": self.updated,
"Targets": self.targets,
}
class ServiceDiscoveryBackend(BaseBackend):
"""Implementation of ServiceDiscovery APIs."""
def __init__(self, region_name: str, account_id: str):
super().__init__(region_name, account_id)
self.operations: dict[str, Operation] = {}
self.namespaces: dict[str, Namespace] = {}
self.services: dict[str, Service] = {}
self.tagger = TaggingService()
def list_namespaces(self) -> Iterable[Namespace]:
"""
Pagination or the Filters-parameter is not yet implemented
"""
return list(self.namespaces.values())
def create_http_namespace(
self,
name: str,
creator_request_id: str,
description: str,
tags: list[dict[str, str]],
) -> str:
namespace = Namespace(
account_id=self.account_id,
region=self.region_name,
name=name,
ns_type="HTTP",
creator_request_id=creator_request_id,
description=description,
dns_properties={"SOA": {}},
http_properties={"HttpName": name},
)
self.namespaces[namespace.id] = namespace
if tags:
self.tagger.tag_resource(namespace.arn, tags)
operation_id = self._create_operation(
"CREATE_NAMESPACE", targets={"NAMESPACE": namespace.id}
)
return operation_id
def _create_operation(self, op_type: str, targets: dict[str, str]) -> str:
operation = Operation(operation_type=op_type, targets=targets)
self.operations[operation.id] = operation
return operation.id
def delete_namespace(self, namespace_id: str) -> str:
if namespace_id not in self.namespaces:
raise NamespaceNotFound(namespace_id)
del self.namespaces[namespace_id]
operation_id = self._create_operation(
op_type="DELETE_NAMESPACE", targets={"NAMESPACE": namespace_id}
)
return operation_id
def get_namespace(self, namespace_id: str) -> Namespace:
if namespace_id not in self.namespaces:
raise NamespaceNotFound(namespace_id)
return self.namespaces[namespace_id]
def list_operations(self) -> Iterable[Operation]:
"""
Pagination or the Filters-argument is not yet implemented
"""
# Operations for namespaces will only be listed as long as namespaces exist
self.operations = {
op_id: op
for op_id, op in self.operations.items()
if op.targets.get("NAMESPACE") in self.namespaces
}
return self.operations.values()
def get_operation(self, operation_id: str) -> Operation:
if operation_id not in self.operations:
raise OperationNotFound()
return self.operations[operation_id]
def tag_resource(self, resource_arn: str, tags: list[dict[str, str]]) -> None:
self.tagger.tag_resource(resource_arn, tags)
def untag_resource(self, resource_arn: str, tag_keys: list[str]) -> None:
self.tagger.untag_resource_using_names(resource_arn, tag_keys)
def list_tags_for_resource(
self, resource_arn: str
) -> dict[str, list[dict[str, str]]]:
return self.tagger.list_tags_for_resource(resource_arn)
def create_private_dns_namespace(
self,
name: str,
creator_request_id: str,
description: str,
vpc: str,
tags: list[dict[str, str]],
properties: dict[str, Any],
) -> str:
for namespace in self.namespaces.values():
if namespace.vpc == vpc:
raise ConflictingDomainExists(vpc)
dns_properties = (properties or {}).get("DnsProperties", {})
# create the hosted zone
hosted_zone = route53_backends[self.account_id][
get_partition(self.region_name)
].create_hosted_zone(
f"{name}-hz",
private_zone=True,
comment=f"hosted zone for private dns namespace {name}",
)
dns_properties["HostedZoneId"] = hosted_zone.id
namespace = Namespace(
account_id=self.account_id,
region=self.region_name,
name=name,
ns_type="DNS_PRIVATE",
creator_request_id=creator_request_id,
description=description,
dns_properties=dns_properties,
http_properties={},
vpc=vpc,
)
self.namespaces[namespace.id] = namespace
if tags:
self.tagger.tag_resource(namespace.arn, tags)
operation_id = self._create_operation(
"CREATE_NAMESPACE", targets={"NAMESPACE": namespace.id}
)
return operation_id
def create_public_dns_namespace(
self,
name: str,
creator_request_id: str,
description: str,
tags: list[dict[str, str]],
properties: dict[str, Any],
) -> str:
dns_properties = (properties or {}).get("DnsProperties", {})
# create the hosted zone
hosted_zone = route53_backends[self.account_id][
get_partition(self.region_name)
].create_hosted_zone(
f"{name}-hz",
private_zone=False,
comment=f"hosted zone for public dns namespace {name}",
)
dns_properties["HostedZoneId"] = hosted_zone.id
namespace = Namespace(
account_id=self.account_id,
region=self.region_name,
name=name,
ns_type="DNS_PUBLIC",
creator_request_id=creator_request_id,
description=description,
dns_properties=dns_properties,
http_properties={},
)
self.namespaces[namespace.id] = namespace
if tags:
self.tagger.tag_resource(namespace.arn, tags)
operation_id = self._create_operation(
"CREATE_NAMESPACE", targets={"NAMESPACE": namespace.id}
)
return operation_id
def create_service(
self,
name: str,
namespace_id: str,
creator_request_id: str,
description: str,
dns_config: dict[str, Any],
health_check_config: dict[str, Any],
health_check_custom_config: dict[str, Any],
tags: list[dict[str, str]],
service_type: str,
) -> Service:
service = Service(
account_id=self.account_id,
region=self.region_name,
name=name,
namespace_id=namespace_id,
description=description,
creator_request_id=creator_request_id,
dns_config=dns_config,
health_check_config=health_check_config,
health_check_custom_config=health_check_custom_config,
service_type=service_type,
)
self.services[service.id] = service
if tags:
self.tagger.tag_resource(service.arn, tags)
return service
def get_service(self, service_id: str) -> Service:
if service_id not in self.services:
raise ServiceNotFound(service_id)
return self.services[service_id]
def delete_service(self, service_id: str) -> None:
self.services.pop(service_id, None)
def list_services(self) -> Iterable[Service]:
"""
Pagination or the Filters-argument is not yet implemented
"""
return self.services.values()
def update_service(self, service_id: str, details: dict[str, Any]) -> str:
service = self.get_service(service_id)
service.update(details=details)
operation_id = self._create_operation(
"UPDATE_SERVICE", targets={"SERVICE": service.id}
)
return operation_id
def update_http_namespace(
self,
_id: str,
namespace_dict: dict[str, Any],
updater_request_id: Optional[str] = None,
) -> str:
if "Description" not in namespace_dict:
raise InvalidInput("Description is required")
namespace = self.get_namespace(namespace_id=_id)
if updater_request_id is None:
# Unused as the operation cannot fail
updater_request_id = random_id(32)
namespace.description = namespace_dict["Description"]
if "Properties" in namespace_dict:
if "HttpProperties" in namespace_dict["Properties"]:
namespace.http_properties = namespace_dict["Properties"][
"HttpProperties"
]
operation_id = self._create_operation(
"UPDATE_NAMESPACE", targets={"NAMESPACE": namespace.id}
)
return operation_id
def update_private_dns_namespace(
self, _id: str, description: str, properties: dict[str, Any]
) -> str:
namespace = self.get_namespace(namespace_id=_id)
if description is not None:
namespace.description = description
if properties is not None:
namespace.dns_properties = properties
operation_id = self._create_operation(
"UPDATE_NAMESPACE", targets={"NAMESPACE": namespace.id}
)
return operation_id
def update_public_dns_namespace(
self, _id: str, description: str, properties: dict[str, Any]
) -> str:
namespace = self.get_namespace(namespace_id=_id)
if description is not None:
namespace.description = description
if properties is not None:
namespace.dns_properties = properties
operation_id = self._create_operation(
"UPDATE_NAMESPACE", targets={"NAMESPACE": namespace.id}
)
return operation_id
def register_instance(
self,
service_id: str,
instance_id: str,
creator_request_id: str,
attributes: dict[str, str],
) -> str:
service = self.get_service(service_id)
instance = ServiceInstance(
service_id=service_id,
instance_id=instance_id,
creator_request_id=creator_request_id,
attributes=attributes,
)
service.instances.append(instance)
service.instances_revision[instance_id] = (
service.instances_revision.get(instance_id, 0) + 1
)
operation_id = self._create_operation(
"REGISTER_INSTANCE", targets={"INSTANCE": instance_id}
)
return operation_id
def deregister_instance(self, service_id: str, instance_id: str) -> str:
service = self.get_service(service_id)
i = 0
while i < len(service.instances):
instance = service.instances[i]
if instance.instance_id == instance_id:
service.instances.remove(instance)
service.instances_revision[instance_id] = (
service.instances_revision.get(instance_id, 0) + 1
)
operation_id = self._create_operation(
"DEREGISTER_INSTANCE", targets={"INSTANCE": instance_id}
)
return operation_id
i += 1
raise InstanceNotFound(instance_id)
def list_instances(self, service_id: str) -> list[ServiceInstance]:
service = self.get_service(service_id)
return service.instances
def get_instance(self, service_id: str, instance_id: str) -> ServiceInstance:
for instance in self.list_instances(service_id):
if instance.instance_id == instance_id:
return instance
raise InstanceNotFound(instance_id)
def get_instances_health_status(
self,
service_id: str,
instances: Optional[list[str]] = None,
) -> list[tuple[str, str]]:
service = self.get_service(service_id)
status = []
if instances is None:
instances = [instance.instance_id for instance in service.instances]
if not isinstance(instances, list):
raise InvalidInput("Instances must be a list")
filtered_instances = [
instance
for instance in service.instances
if instance.instance_id in instances
]
for instance in filtered_instances:
status.append((instance.instance_id, instance.health_status))
return status
def update_instance_custom_health_status(
self, service_id: str, instance_id: str, status: str
) -> None:
if status not in ["HEALTHY", "UNHEALTHY"]:
raise CustomHealthNotFound(service_id)
instance = self.get_instance(service_id, instance_id)
instance.health_status = status
def _filter_instances(
self,
instances: list[ServiceInstance],
query_parameters: Optional[dict[str, str]] = None,
optional_parameters: Optional[dict[str, str]] = None,
health_status: Optional[str] = None,
) -> list[ServiceInstance]:
if query_parameters is None:
query_parameters = {}
if optional_parameters is None:
optional_parameters = {}
if health_status is None:
health_status = "ALL"
filtered_instances = []
has_healthy = False
for instance in instances:
# Filter out instances with mismatching health status
if (
health_status not in ["ALL", "HEALTHY_OR_ELSE_ALL"]
and instance.health_status != health_status
):
continue
# Record if there is at least one healthy instance for HEALTHY_OR_ELSE_ALL
if instance.health_status == "HEALTHY":
has_healthy = True
# Filter out instances with mismatching query parameters
matches_query = True
for param in query_parameters:
if instance.attributes.get(param) != query_parameters[param]:
matches_query = False
break
if not matches_query:
continue
# Add instance to the list if it passed all filters
filtered_instances.append(instance)
# Handle HEALTHY_OR_ELSE_ALL
if has_healthy and health_status == "HEALTHY_OR_ELSE_ALL":
filtered_instances = [
instance
for instance in filtered_instances
if instance.health_status == "HEALTHY"
]
# Filter out instances with mismatching optional parameters
opt_filtered_instances = []
for instance in filtered_instances:
matches_optional = True
for param in optional_parameters:
if instance.attributes.get(param) != optional_parameters[param]:
matches_optional = False
break
if matches_optional:
opt_filtered_instances.append(instance)
# If no instances passed the optional parameters, return the original filtered list
return opt_filtered_instances if opt_filtered_instances else filtered_instances
def discover_instances(
self,
namespace_name: str,
service_name: str,
query_parameters: Optional[dict[str, str]] = None,
optional_parameters: Optional[dict[str, str]] = None,
health_status: Optional[str] = None,
) -> tuple[list[ServiceInstance], dict[str, int]]:
if query_parameters is None:
query_parameters = {}
if optional_parameters is None:
optional_parameters = {}
if health_status is None:
health_status = "ALL"
if health_status not in ["HEALTHY", "UNHEALTHY", "ALL", "HEALTHY_OR_ELSE_ALL"]:
raise InvalidInput("Invalid health status")
try:
namespace = [
ns for ns in self.list_namespaces() if ns.name == namespace_name
][0]
except IndexError:
raise NamespaceNotFound(namespace_name)
try:
service = [
srv
for srv in self.list_services()
if srv.name == service_name and srv.namespace_id == namespace.id
][0]
except IndexError:
raise ServiceNotFound(service_name)
instances = self.list_instances(service.id)
# Filter instances based on query parameters, optional parameters, and health status
final_instances = self._filter_instances(
instances, query_parameters, optional_parameters, health_status
)
# Get the revision number for each instance that passed the filters
instance_revisions = {
instance.instance_id: service.instances_revision.get(
instance.instance_id, 0
)
for instance in final_instances
}
return final_instances, instance_revisions
def discover_instances_revision(
self, namespace_name: str, service_name: str
) -> int:
return sum(self.discover_instances(namespace_name, service_name)[1].values())
def paginate(
self,
items: list[Any],
max_results: Optional[int] = None,
next_token: Optional[str] = None,
) -> tuple[list[Any], Optional[str]]:
"""
Paginates a list of items. If called without optional parameters, the entire list is returned as-is.
"""
# Default to beginning of list
if next_token is None:
next_token = "0"
# Return empty list if next_token is invalid
if not next_token.isdigit():
return [], None
# Default to the entire list
if max_results is None:
max_results = len(items)
new_token = int(next_token) + max_results
# If the new token overflows the list, return the rest of the list
if new_token >= len(items):
return items[int(next_token) :], None
return items[int(next_token) : new_token], str(new_token)
servicediscovery_backends = BackendDict(ServiceDiscoveryBackend, "servicediscovery")
|