playground-ls-cli 4.14.1.dev8__py3-none-any.whl

localstack_cli/utils/common.py

@@ -0,0 +1,229 @@
+from localstack_cli import config
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.archives import get_unzipped_size, is_zip_file, untar, unzip  # noqa
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.collections import (  # noqa
+    DelSafeDict,
+    HashableList,
+    PaginatedList,
+    ensure_list,
+    is_list_or_tuple,
+    is_none_or_empty,
+    is_sub_dict,
+    items_equivalent,
+    last_index_of,
+    merge_dicts,
+    merge_recursive,
+    remove_attributes,
+    remove_none_values_from_dict,
+    rename_attributes,
+    select_attributes,
+    to_unique_items_list,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.crypto import (  # noqa
+    PEM_CERT_END,
+    PEM_CERT_START,
+    PEM_KEY_END_REGEX,
+    PEM_KEY_START_REGEX,
+    generate_ssl_cert,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.files import (  # noqa
+    TMP_FILES,
+    chmod_r,
+    chown_r,
+    cleanup_tmp_files,
+    cp_r,
+    disk_usage,
+    ensure_readable,
+    file_exists_not_empty,
+    get_or_create_file,
+    is_empty_dir,
+    load_file,
+    mkdir,
+    new_tmp_dir,
+    new_tmp_file,
+    replace_in_file,
+    rm_rf,
+    save_file,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.functions import (  # noqa
+    call_safe,
+    empty_context_manager,
+    prevent_stack_overflow,
+    run_safe,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.http import (  # noqa
+    NetrcBypassAuth,
+    _RequestsSafe,
+    download,
+    get_proxies,
+    make_http_request,
+    parse_request_data,
+    replace_response_content,
+    safe_requests,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.json import (  # noqa
+    CustomEncoder,
+    FileMappedDocument,
+    assign_to_path,
+    canonical_json,
+    clone,
+    clone_safe,
+    extract_from_jsonpointer_path,
+    extract_jsonpath,
+    fix_json_keys,
+    json_safe,
+    parse_json_or_yaml,
+    try_json,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.net import (  # noqa
+    PortNotAvailableException,
+    PortRange,
+    get_free_tcp_port,
+    is_ip_address,
+    is_ipv4_address,
+    is_port_open,
+    port_can_be_bound,
+    resolve_hostname,
+    wait_for_port_closed,
+    wait_for_port_open,
+    wait_for_port_status,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.numbers import format_bytes, format_number, is_number  # noqa
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.objects import (  # noqa
+    ArbitraryAccessObj,
+    Mock,
+    ObjectIdHashComparator,
+    SubtypesInstanceManager,
+    fully_qualified_class_name,
+    get_all_subclasses,
+    keys_to_lower,
+    not_none_or,
+    recurse_object,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.platform import (  # noqa
+    get_arch,
+    get_os,
+    in_docker,
+    is_debian,
+    is_linux,
+    is_mac_os,
+    is_windows,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.run import (  # noqa
+    CaptureOutput,
+    ShellCommandThread,
+    get_os_user,
+    is_command_available,
+    is_root,
+    kill_process_tree,
+    run,
+    run_for_max_seconds,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.strings import (  # noqa
+    base64_to_hex,
+    camel_to_snake_case,
+    canonicalize_bool_to_str,
+    convert_to_printable_chars,
+    first_char_to_lower,
+    first_char_to_upper,
+    is_base64,
+    is_string,
+    is_string_or_bytes,
+    long_uid,
+    md5,
+    short_uid,
+    short_uid_from_seed,
+    snake_to_camel_case,
+    str_insert,
+    str_remove,
+    str_startswith_ignore_case,
+    str_to_bool,
+    to_bytes,
+    to_str,
+    truncate,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.sync import (  # noqa
+    poll_condition,
+    retry,
+    sleep_forever,
+    synchronized,
+    wait_until,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.threads import (  # noqa
+    TMP_PROCESSES,
+    TMP_THREADS,
+    FuncThread,
+    cleanup_threads_and_processes,
+    parallelize,
+    start_thread,
+    start_worker_thread,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.time import (  # noqa
+    TIMESTAMP_FORMAT,
+    TIMESTAMP_FORMAT_MICROS,
+    TIMESTAMP_FORMAT_TZ,
+    epoch_timestamp,
+    isoformat_milliseconds,
+    mktime,
+    now,
+    now_utc,
+    parse_timestamp,
+    timestamp,
+    timestamp_millis,
+)
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.urls import path_from_url  # noqa
+
+# TODO: remove imports from here (need to update any client code that imports these from utils.common)
+from localstack_cli.utils.xml import obj_to_xml, strip_xmlns  # noqa
+
+
+# TODO: move somewhere sensible (probably localstack.runtime)
+class ExternalServicePortsManager(PortRange):
+    """Manages the ports used for starting external services like ElasticSearch, OpenSearch,..."""
+
+    def __init__(self):
+        super().__init__(config.EXTERNAL_SERVICE_PORTS_START, config.EXTERNAL_SERVICE_PORTS_END)
+
+
+external_service_ports = ExternalServicePortsManager()
+"""The PortRange object of LocalStack's external service port range. This port range is by default exposed by the
+localstack container when starting via the CLI."""
+
+# TODO: replace references with config.get_protocol/config.edge_ports_info
+get_service_protocol = config.get_protocol
+
+# TODO: replace references to safe_run with localstack.utils.run.run
+safe_run = run

localstack_cli/utils/container_networking.py

@@ -0,0 +1,142 @@
+import logging
+import os
+import re
+from functools import lru_cache
+
+from localstack_cli import config, constants
+from localstack_cli.utils.container_utils.container_client import ContainerException
+from localstack_cli.utils.docker_utils import DOCKER_CLIENT
+from localstack_cli.utils.net import get_docker_host_from_container
+
+LOG = logging.getLogger(__name__)
+
+
+@lru_cache
+def get_main_container_network() -> str | None:
+    """
+    Gets the main network of the LocalStack container (if we run in one, bridge otherwise)
+    If there are multiple networks connected to the LocalStack container, we choose the first as "main" network
+
+    :return: Network name
+    """
+    if config.MAIN_DOCKER_NETWORK:
+        if config.is_in_docker:
+            networks = DOCKER_CLIENT.get_networks(get_main_container_name())
+            if config.MAIN_DOCKER_NETWORK not in networks:
+                LOG.warning(
+                    "The specified 'MAIN_DOCKER_NETWORK' is not connected to the LocalStack container! Falling back to %s",
+                    networks[0],
+                )
+                return networks[0]
+        return config.MAIN_DOCKER_NETWORK
+
+    # use the default bridge network in case of host mode or if we can't resolve the networks for the main container
+    main_container_network = "bridge"
+    if config.is_in_docker:
+        try:
+            networks = DOCKER_CLIENT.get_networks(get_main_container_name())
+            main_container_network = networks[0]
+        except Exception as e:
+            container_name = get_main_container_name()
+            LOG.info(
+                'Unable to get network name of main container "%s", falling back to "bridge": %s',
+                container_name,
+                e,
+            )
+
+    LOG.info("Determined main container network: %s", main_container_network)
+    return main_container_network
+
+
+@lru_cache
+def get_endpoint_for_network(network: str | None = None) -> str:
+    """
+    Get the LocalStack endpoint (= IP address) on the given network.
+    If a network is given, it will return the IP address/hostname of LocalStack on that network
+    If omitted, it will return the IP address/hostname of the main container network
+    This is a cached call, clear cache if networks might have changed
+
+    :param network: Network to return the endpoint for
+    :return: IP address or hostname of LS on the given network
+    """
+    container_name = get_main_container_name()
+    network = network or get_main_container_network()
+    main_container_ip = None
+    try:
+        if config.is_in_docker:
+            main_container_ip = DOCKER_CLIENT.get_container_ipv4_for_network(
+                container_name_or_id=container_name,
+                container_network=network,
+            )
+        else:
+            # default gateway for the network should be the host
+            # In a Linux host-mode environment, the default gateway for the network should be the IP of the host
+            if config.is_in_linux:
+                main_container_ip = DOCKER_CLIENT.inspect_network(network)["IPAM"]["Config"][0][
+                    "Gateway"
+                ]
+            else:
+                # In a non-Linux host-mode environment, we need to determine the IP of the host by running a container
+                # (basically macOS host mode, i.e. this is a feature to improve the developer experience)
+                image_name = constants.DOCKER_IMAGE_NAME_PRO
+                out, _ = DOCKER_CLIENT.run_container(
+                    image_name,
+                    remove=True,
+                    entrypoint="",
+                    command=["ping", "-c", "1", "host.docker.internal"],
+                )
+                out = out.decode(config.DEFAULT_ENCODING) if isinstance(out, bytes) else out
+                ip = re.match(r"PING[^\(]+\(([^\)]+)\).*", out, re.MULTILINE | re.DOTALL)
+                ip = ip and ip.group(1)
+                if ip:
+                    main_container_ip = ip
+        LOG.info("Determined main container target IP: %s", main_container_ip)
+    except Exception as e:
+        LOG.info("Unable to get main container IP address: %s", e)
+
+    if not main_container_ip:
+        # fall back to returning the hostname/IP of the Docker host, if we cannot determine the main container IP
+        return get_docker_host_from_container()
+
+    return main_container_ip
+
+
+def get_main_container_ip():
+    """
+    Get the container IP address of the LocalStack container.
+    Use get_endpoint_for network where possible, as it allows better control about which address to return
+
+    :return: IP address of LocalStack container
+    """
+    container_name = get_main_container_name()
+    return DOCKER_CLIENT.get_container_ip(container_name)
+
+
+def get_main_container_id():
+    """
+    Return the container ID of the LocalStack container
+
+    :return: container ID
+    """
+    container_name = get_main_container_name()
+    try:
+        return DOCKER_CLIENT.get_container_id(container_name)
+    except ContainerException:
+        return None
+
+
+@lru_cache
+def get_main_container_name():
+    """
+    Returns the container name of the LocalStack container
+
+    :return: LocalStack container name
+    """
+    hostname = os.environ.get("HOSTNAME")
+    if hostname:
+        try:
+            return DOCKER_CLIENT.get_container_name(hostname)
+        except ContainerException:
+            return config.MAIN_CONTAINER_NAME
+    else:
+        return config.MAIN_CONTAINER_NAME