Improve default build to support path/ from the stack container definition.

Author: telackey

src/stack/build/build_types.py

@@ -25,7 +25,7 @@
 class BuildContext:
     stack: str
     container: ContainerSpec
-    container_build_dir: Path
+    default_container_base_dir: Path
     container_build_env: Mapping[str,str]
     dev_root_path: str
 

src/stack/build/build_util.py

@@ -50,23 +50,27 @@ class ContainerSpec:
     name: str
     ref: str
     build: str
+    path: str
     file_path: str
 
-    def __init__(self, name: str=None, ref=None, build=None):
+    def __init__(self, name: str=None, ref=None, build=None, path=None):
         self.name = name
         self.ref = ref
         self.build = build
+        self.path = path
         self.file_path = None
 
     def __repr__(self):
         return str(self)
 
     def __str__(self):
-        ret = { "name": self.name, "ref": self.ref, "build": self.build, "file_path": self.file_path }
+        ret = { "name": self.name, "ref": self.ref, "build": self.build, "path": self.path, "file_path": self.file_path }
         return json.dumps(ret)
 
     def init_from_file(self, file_path: Path):
-        self.file_path = file_path
+        self.file_path = Path(file_path).as_posix()
+        self.path = Path(self.file_path).parent.as_posix()
+
         y = get_yaml().load(open(file_path, "r"))
         self.name = y["container"]["name"]
         self.ref = y["container"].get("ref")

src/stack/build/prepare_containers.py

@@ -54,13 +54,13 @@
 #    epilog="Config provided either in .env or settings.ini or env vars: BPI_REPO_BASE_DIR (defaults to ~/bpi)"
 
 
-def make_container_build_env(dev_root_path: str, container_build_dir: str, debug: bool, force_rebuild: bool, extra_build_args: str):
+def make_container_build_env(dev_root_path: str, default_container_base_dir: str, debug: bool, force_rebuild: bool, extra_build_args: str):
     container_build_env = {
         "BPI_NPM_REGISTRY_URL": get_npm_registry_url(),
         "BPI_GO_AUTH_TOKEN": config("BPI_GO_AUTH_TOKEN", default=""),
         "BPI_NPM_AUTH_TOKEN": config("BPI_NPM_AUTH_TOKEN", default=""),
         "BPI_REPO_BASE_DIR": dev_root_path,
-        "BPI_CONTAINER_BASE_DIR": container_build_dir,
+        "BPI_CONTAINER_BASE_DIR": default_container_base_dir,
         "BPI_HOST_UID": f"{os.getuid()}",
         "BPI_HOST_GID": f"{os.getgid()}",
         "BPI_IMAGE_LOCAL_TAG": "stack",
@@ -99,11 +99,11 @@ def process_container(build_context: BuildContext) -> bool:
                 # Now check if the container exists in the external stack.
                 if not temp_build_script_filename.exists():
                     # If not, revert to building an internal container
-                    container_build_script_dir = build_context.container_build_dir
+                    container_build_script_dir = build_context.default_container_base_dir
                 build_dir = container_build_script_dir.joinpath(build_context.container.name.replace("/", "-"))
                 build_script_filename = build_dir.joinpath("build.sh")
     if not build_dir:
-        build_dir = build_context.container_build_dir.joinpath(build_context.container.name.replace("/", "-"))
+        build_dir = build_context.default_container_base_dir.joinpath(build_context.container.name.replace("/", "-"))
         build_script_filename = build_dir.joinpath("build.sh")
 
     if opts.o.verbose:
@@ -117,9 +117,11 @@ def process_container(build_context: BuildContext) -> bool:
         # TODO: make this less of a hack -- should be specified in some metadata somewhere
         # Check if we have a repo for this container. If not, set the context dir to the container-build subdir
         repo_full_path = os.path.join(build_context.dev_root_path, repo_dir)
+        if build_context.container.path:
+            repo_full_path = os.path.join(repo_full_path, build_context.container.path)
         repo_dir_or_build_dir = repo_full_path if os.path.exists(repo_full_path) else build_dir
         build_command = (
-            os.path.join(build_context.container_build_dir, "default-build.sh")
+            os.path.join(build_context.default_container_base_dir, "default-build.sh")
             + f" {default_container_tag} {repo_dir_or_build_dir}"
         )
 
@@ -162,7 +164,7 @@ def command(ctx, stack, include, exclude, git_ssh, build_policy, extra_build_arg
         error_exit(f"{build_policy} is not one of {BUILD_POLICIES}")
 
     # See: https://stackoverflow.com/questions/25389095/python-get-path-of-root-project-structure
-    container_build_dir = Path(__file__).absolute().parent.parent.joinpath("data", "container-build")
+    default_container_base_dir = Path(__file__).absolute().parent.parent.joinpath("data", "container-build")
 
     dev_root_path = get_dev_root_path(ctx)
 
@@ -180,7 +182,7 @@ def command(ctx, stack, include, exclude, git_ssh, build_policy, extra_build_arg
 
 
     container_build_env = make_container_build_env(
-        dev_root_path, container_build_dir, opts.o.debug, "build-force" == build_policy, extra_build_args
+        dev_root_path, default_container_base_dir, opts.o.debug, "build-force" == build_policy, extra_build_args
     )
 
     # check if we have any repos that specify the container targets / build info
@@ -207,6 +209,11 @@ def command(ctx, stack, include, exclude, git_ssh, build_policy, extra_build_arg
                 print(f"Error: Missing container repo for {fs_path_for_container_specs}, run fetch repositories")
                 sys.exit(1)
 
+            if stack_container.path:
+                container_spec.path = Path(os.path.join(fs_path_for_container_specs, stack_container.path)).absolute().as_posix()
+            else:
+                container_spec.path = fs_path_for_container_specs.absolute().as_posix()
+
             image_registries_to_check = [r for r in [image_registry, image_registry_for_repo(stack_container.ref)] if r]
 
             container_spec_yml_path = os.path.join(fs_path_for_container_specs, container_file_name)
@@ -310,7 +317,8 @@ def command(ctx, stack, include, exclude, git_ssh, build_policy, extra_build_arg
         elif container_needs_built:
             if build_policy in ["prebuilt", "prebuilt-local", "prebuilt-remote"]:
                 error_exit(f"No prebuilt image available for: {container_spec.name}")
-            build_context = BuildContext(stack, container_spec, container_build_dir, container_build_env, dev_root_path)
+
+            build_context = BuildContext(stack, container_spec, default_container_base_dir, container_build_env, dev_root_path)
 
             for tag in [stack_legacy_tag, stack_local_tag, container_tag]:
                 try: