Add helpers for configuring the hostname

localstack · simonrw · Mar 20, 2023 · Feb 23, 2023 · Feb 27, 2023 · Feb 27, 2023
commit 61c4994606108b2bb9ae0a9a4264ff2a5b90996b
diff --git a/localstack/utils/urls.py b/localstack/utils/urls.py
@@ -1,6 +1,47 @@
+from dataclasses import dataclass
+from typing import Optional
+
+from localstack import config, constants
+
+
 def path_from_url(url: str) -> str:
     return f'/{url.partition("://")[2].partition("/")[2]}' if "://" in url else url
 
 
 def hostname_from_url(url: str) -> str:
     return url.split("://")[-1].split("/")[0].split(":")[0]
+
+
+@dataclass
+class HostDefinition:
+    host: str
+    port: int
+
+    def __str__(self):
+        return f"{self.host}:{self.port}"
+
+
+def localstack_host(
+    use_hostname_external: bool = False,
+    use_localstack_hostname: bool = False,
+    use_localhost_cloud: bool = False,
+    custom_port: Optional[int] = None,
+) -> HostDefinition:
+    """
+    Determine the host and port to return to the user based on:
+    - the user's configuration (e.g environment variable overrides)
+    - the defaults of the system
+    """
+    port = config.EDGE_PORT
+    if custom_port is not None:
+        port = custom_port
+
+    host = config.LOCALHOST
+    if use_hostname_external:
+        host = config.HOSTNAME_EXTERNAL
+    elif use_localstack_hostname:
+        host = config.LOCALSTACK_HOSTNAME
+    elif use_localhost_cloud:
+        host = constants.LOCALHOST_HOSTNAME
+
+    return HostDefinition(host=host, port=port)