Use traitlets BuildExecutor in app

Author: manics

binderhub/app.py

@@ -41,7 +41,7 @@
 from traitlets.config import Application
 
 from .base import AboutHandler, Custom404, VersionHandler
-from .build import Build
+from .build import Build, BuildExecutor
 from .builder import BuildHandler
 from .config import ConfigHandler
 from .events import EventLog
@@ -270,10 +270,11 @@ def _valid_badge_base_url(self, proposal):
 
     build_class = Type(
         Build,
+        klass=BuildExecutor,
         help="""
         The class used to build repo2docker images.
 
-        Must inherit from binderhub.build.Build
+        Must inherit from binderhub.build.BuildExecutor
         """,
         config=True,
     )
@@ -818,6 +819,7 @@ def initialize(self, *args, **kwargs):
                 "build_class": self.build_class,
                 "registry": registry,
                 "traitlets_config": self.config,
+                "traitlets_parent": self,
                 "google_analytics_code": self.google_analytics_code,
                 "google_analytics_domain": self.google_analytics_domain,
                 "about_message": self.about_message,

binderhub/builder.py

@@ -22,7 +22,7 @@
 from tornado.web import Finish, authenticated
 
 from .base import BaseHandler
-from .build import ProgressEvent
+from .build import Build, ProgressEvent
 from .utils import KUBE_REQUEST_TIMEOUT
 
 # Separate buckets for builds and launches.
@@ -425,26 +425,50 @@ async def get(self, provider_prefix, _unescaped_spec):
             ref_url=self.ref_url,
         )
 
-        self.build = build = BuildClass(
-            q=q,
-            # api object can be None if we are using FakeBuild
-            api=self.settings.get("kubernetes_client"),
-            name=build_name,
-            namespace=self.settings["build_namespace"],
-            repo_url=repo_url,
-            ref=ref,
-            image_name=image_name,
-            push_secret=push_secret,
-            build_image=self.settings["build_image"],
-            memory_limit=self.settings["build_memory_limit"],
-            memory_request=self.settings["build_memory_request"],
-            docker_host=self.settings["build_docker_host"],
-            node_selector=self.settings["build_node_selector"],
-            appendix=appendix,
-            log_tail_lines=self.settings["log_tail_lines"],
-            git_credentials=provider.git_credentials,
-            sticky_builds=self.settings["sticky_builds"],
-        )
+        if issubclass(BuildClass, Build):
+            # Deprecated
+            build = BuildClass(
+                q=q,
+                # api object can be None if we are using FakeBuild
+                api=self.settings.get("kubernetes_client"),
+                name=build_name,
+                namespace=self.settings["build_namespace"],
+                repo_url=repo_url,
+                ref=ref,
+                image_name=image_name,
+                push_secret=push_secret,
+                build_image=self.settings["build_image"],
+                memory_limit=self.settings["build_memory_limit"],
+                memory_request=self.settings["build_memory_request"],
+                docker_host=self.settings["build_docker_host"],
+                node_selector=self.settings["build_node_selector"],
+                appendix=appendix,
+                log_tail_lines=self.settings["log_tail_lines"],
+                git_credentials=provider.git_credentials,
+                sticky_builds=self.settings["sticky_builds"],
+            )
+        else:
+            build = BuildClass(
+                # Commented properties should be set in traitlets config
+                parent=self.settings["traitlets_parent"],
+                q=q,
+                name=build_name,
+                # namespace=self.settings["build_namespace"],
+                repo_url=repo_url,
+                ref=ref,
+                image_name=image_name,
+                # push_secret=push_secret,
+                # build_image=self.settings["build_image"],
+                # memory_limit=self.settings["build_memory_limit"],
+                # memory_request=self.settings["build_memory_request"],
+                # docker_host=self.settings["build_docker_host"],
+                # node_selector=self.settings["build_node_selector"],
+                appendix=appendix,
+                # log_tail_lines=self.settings["log_tail_lines"],
+                git_credentials=provider.git_credentials,
+                # sticky_builds=self.settings["sticky_builds"],
+            )
+        self.build = build
 
         with BUILDS_INPROGRESS.track_inprogress():
             done = False