LDR: selectable local mounts (#12092)

simonrw · web-flow · commit ed8046a0d957 · 2025-01-03T20:28:43.000Z
diff --git a/localstack-core/localstack/dev/run/__main__.py b/localstack-core/localstack/dev/run/__main__.py
@@ -27,7 +27,7 @@
     PortConfigurator,
     SourceVolumeMountConfigurator,
 )
-from .paths import HostPaths
+from .paths import HOST_PATH_MAPPINGS, HostPaths
 
 
 @click.command("run")
@@ -114,6 +114,14 @@
     required=False,
     help="Docker network to start the container in",
 )
+@click.option(
+    "--local-packages",
+    "-l",
+    multiple=True,
+    required=False,
+    type=click.Choice(HOST_PATH_MAPPINGS.keys(), case_sensitive=False),
+    help="Mount specified packages into the container",
+)
 @click.argument("command", nargs=-1, required=False)
 def run(
     image: str = None,
@@ -130,6 +138,7 @@ def run(
     publish: Tuple = (),
     entrypoint: str = None,
     network: str = None,
+    local_packages: list[str] | None = None,
     command: str = None,
 ):
     """
@@ -214,6 +223,16 @@ def run(
         │   ├── tests
         │   └── ...
 
+    You can choose which local source repositories are mounted in. For example, if `moto` and `rolo` are
+    both present, only mount `rolo` into the container.
+
+    \b
+        python -m localstack.dev.run --local-packages rolo
+
+    If both `rolo` and `moto` are available and both should be mounted, use the flag twice.
+
+    \b
+        python -m localstack.dev.run --local-packages rolo --local-packages moto
     """
     with console.status("Configuring") as status:
         env_vars = parse_env_vars(env)
@@ -288,6 +307,7 @@ def run(
                 SourceVolumeMountConfigurator(
                     host_paths=host_paths,
                     pro=pro,
+                    chosen_packages=local_packages,
                 )
             )
         if mount_entrypoints:
diff --git a/localstack-core/localstack/dev/run/configurators.py b/localstack-core/localstack/dev/run/configurators.py
@@ -20,7 +20,13 @@
 from localstack.utils.run import run
 from localstack.utils.strings import md5
 
-from .paths import CommunityContainerPaths, ContainerPaths, HostPaths, ProContainerPaths
+from .paths import (
+    HOST_PATH_MAPPINGS,
+    CommunityContainerPaths,
+    ContainerPaths,
+    HostPaths,
+    ProContainerPaths,
+)
 
 
 class ConfigEnvironmentConfigurator:
@@ -117,10 +123,12 @@ def __init__(
         *,
         host_paths: HostPaths = None,
         pro: bool = False,
+        chosen_packages: list[str] | None = None,
     ):
         self.host_paths = host_paths or HostPaths()
         self.container_paths = ProContainerPaths() if pro else CommunityContainerPaths()
         self.pro = pro
+        self.chosen_packages = chosen_packages or []
 
     def __call__(self, cfg: ContainerConfiguration):
         # localstack source code if available
@@ -142,17 +150,11 @@ def __call__(self, cfg: ContainerConfiguration):
                     )
                 )
 
-        # moto code if available
-        self.try_mount_to_site_packages(cfg, self.host_paths.moto_project_dir / "moto")
-
-        # postgresql-proxy code if available
-        self.try_mount_to_site_packages(cfg, self.host_paths.postgresql_proxy / "postgresql_proxy")
-
-        # rolo code if available
-        self.try_mount_to_site_packages(cfg, self.host_paths.rolo_dir / "rolo")
-
-        # plux
-        self.try_mount_to_site_packages(cfg, self.host_paths.workspace_dir / "plux" / "plugin")
+        # mount local code checkouts if possible
+        for package_name in self.chosen_packages:
+            # Unconditional lookup because the CLI rejects incorect items
+            extractor = HOST_PATH_MAPPINGS[package_name]
+            self.try_mount_to_site_packages(cfg, extractor(self.host_paths))
 
         # docker entrypoint
         if self.pro:
diff --git a/localstack-core/localstack/dev/run/paths.py b/localstack-core/localstack/dev/run/paths.py
@@ -2,7 +2,7 @@
 
 import os
 from pathlib import Path
-from typing import Optional, Union
+from typing import Callable, Optional, Union
 
 
 class HostPaths:
@@ -49,6 +49,21 @@ def aws_pro_package_dir(self) -> Path:
         )
 
 
+# Type representing how to extract a specific path from a common root path, typically a lambda function
+PathMappingExtractor = Callable[[HostPaths], Path]
+
+# Declaration of which local packages can be mounted into the container, and their locations on the host
+HOST_PATH_MAPPINGS: dict[
+    str,
+    PathMappingExtractor,
+] = {
+    "moto": lambda paths: paths.moto_project_dir / "moto",
+    "postgresql_proxy": lambda paths: paths.postgresql_proxy / "postgresql_proxy",
+    "rolo": lambda paths: paths.rolo_dir / "rolo",
+    "plux": lambda paths: paths.workspace_dir / "plux" / "plugin",
+}
+
+
 class ContainerPaths:
     """Important paths in the container"""
 
