feat: add a debug mode for bentoctl

README.md

@@ -36,8 +36,8 @@
 * **Customize deploy target** by creating bentoctl plugin from the [deployment operator template](https://github.com/bentoml/bentoctl-operator-template).
 
 **Upcoming:**
+* [Knative](https://github.com/bentoml/bentoctl/issues/79) (WIP)
 * [Azure Functions](https://github.com/bentoml/azure-functions-deploy)
-* [Knative](https://github.com/bentoml/bentoctl/issues/79)
 
 
 ## Install bentoctl

bentoctl/cli/__init__.py

@@ -18,7 +18,6 @@
     push_docker_image_to_repository,
     tag_docker_image,
 )
-from bentoctl.utils import get_debug_mode
 from bentoctl.utils.terraform import (
     is_terraform_applied,
     terraform_apply,
@@ -147,7 +146,6 @@ def build(
     generate_deployable_container(
         tag=local_docker_tag,
         deployment_config=deployment_config,
-        cleanup=get_debug_mode(),
     )
 
     if not dry_run:

bentoctl/docker_utils.py

@@ -7,6 +7,7 @@
 from bentoctl.console import console
 from bentoctl.deployment_config import DeploymentConfig
 from bentoctl.exceptions import BentoctlDockerException
+from bentoctl.utils import get_debug_mode
 from bentoctl.utils.temp_dir import TempDirectory
 
 # default location were dockerfile can be found
@@ -51,9 +52,13 @@ def __rich_console__(self, *_):
 
 
 def generate_deployable_container(
-    tag: str, deployment_config: DeploymentConfig, cleanup: bool
+    tag: str, deployment_config: DeploymentConfig
 ) -> None:
-    with TempDirectory(cleanup=cleanup) as dist_dir:
+    """
+    Calls the operator and generates the deployable. If in debug more the generated
+    deployable will be moved to the current directory for easier debugging.
+    """
+    with TempDirectory(debug=get_debug_mode()) as dist_dir:
         env = {"DOCKER_BUILDKIT": "1", "DOCKER_SCAN_SUGGEST": "false"}
         buildx_args = {
             "subprocess_env": env,

bentoctl/utils/temp_dir.py

@@ -15,12 +15,14 @@ class TempDirectory(object):
     def __init__(
         self,
         cleanup=True,
+        debug=False,
         prefix="temp",
     ):
 
         self._cleanup = cleanup
         self._prefix = prefix
         self.path = None
+        self.debug = debug
 
     def __repr__(self):
         return "<{} {!r}>".format(self.__class__.__name__, self.path)
@@ -29,6 +31,8 @@ def __enter__(self) -> Path:
         return Path(self.create())
 
     def __exit__(self, exc_type, exc_val, exc_tb):
+        if self.debug:
+            self.move_to_curdir()
         if self._cleanup:
             self.cleanup()
 
@@ -46,4 +50,10 @@ def cleanup(self, ignore_errors=False):
         """
         if self.path is not None and os.path.exists(self.path):
             shutil.rmtree(self.path, ignore_errors=ignore_errors)
-        self.path = None
+
+    def move_to_curdir(self):
+        deployable_path = os.path.join(os.curdir, "bentoctl_deployable")
+        if os.path.exists(deployable_path):
+            shutil.rmtree(deployable_path)
+
+        shutil.copytree(self.path, deployable_path)