Remove old binderhub.build.Build

Author: manics

binderhub/app.py

@@ -845,22 +845,15 @@ def initialize(self, *args, **kwargs):
         self.tornado_settings.update(
             {
                 "log_function": log_request,
-                "push_secret": self.push_secret,
                 "image_prefix": self.image_prefix,
                 "debug": self.debug,
                 "launcher": self.launcher,
-                "appendix": self.appendix,
                 "ban_networks": self.ban_networks,
                 "ban_networks_min_prefix_len": self.ban_networks_min_prefix_len,
-                "build_namespace": self.build_namespace,
-                "build_image": self.build_image,
-                "build_node_selector": self.build_node_selector,
                 "build_pool": self.build_pool,
                 "build_token_check_origin": self.build_token_check_origin,
                 "build_token_secret": self.build_token_secret,
                 "build_token_expires_seconds": self.build_token_expires_seconds,
-                "sticky_builds": self.sticky_builds,
-                "log_tail_lines": self.log_tail_lines,
                 "pod_quota": self.pod_quota,
                 "per_repo_quota": self.per_repo_quota,
                 "per_repo_quota_higher": self.per_repo_quota_higher,
@@ -877,9 +870,6 @@ def initialize(self, *args, **kwargs):
                 "banner_message": self.banner_message,
                 "extra_footer_scripts": self.extra_footer_scripts,
                 "jinja2_env": jinja_env,
-                "build_memory_limit": self.build_memory_limit,
-                "build_memory_request": self.build_memory_request,
-                "build_docker_host": self.build_docker_host,
                 "build_docker_config": self.build_docker_config,
                 "base_url": self.base_url,
                 "badge_base_url": self.badge_base_url,

binderhub/build.py

@@ -77,7 +77,6 @@ class BuildExecutor(LoggingConfigurable):
 
     git_credentials = Unicode(
         "",
-        allow_none=True,
         help=(
             "Git credentials to use when cloning the repository, passed via the GIT_CREDENTIAL_ENV environment variable."
             "Can be anything that will be accepted by git as a valid output from a git-credential helper. "
@@ -88,7 +87,6 @@ class BuildExecutor(LoggingConfigurable):
 
     push_secret = Unicode(
         "",
-        allow_none=True,
         help="Implementation dependent secret for pushing image to a registry.",
         config=True,
     )
@@ -220,6 +218,13 @@ def _default_api(self):
             kubernetes.config.load_kube_config()
         return client.CoreV1Api()
 
+    # Overrides the default for BuildExecutor
+    push_secret = Unicode(
+        "binder-build-docker-config",
+        help="Implementation dependent secret for pushing image to a registry.",
+        config=True,
+    )
+
     namespace = Unicode(
         help="Kubernetes namespace to spawn build pods into", config=True
     )
@@ -710,89 +715,3 @@ def stream_logs(self):
                 }
             ),
         )
-
-
-class Build(KubernetesBuildExecutor):
-    """DEPRECATED: Use KubernetesBuildExecutor and configure with Traitlets
-
-    Represents a build of a git repository into a docker image.
-
-    This ultimately maps to a single pod on a kubernetes cluster. Many
-    different build objects can point to this single pod and perform
-    operations on the pod. The code in this class needs to be careful and take
-    this into account.
-
-    For example, operations a Build object tries might not succeed because
-    another Build object pointing to the same pod might have done something
-    else. This should be handled gracefully, and the build object should
-    reflect the state of the pod as quickly as possible.
-
-    ``name``
-        The ``name`` should be unique and immutable since it is used to
-        sync to the pod. The ``name`` should be unique for a
-        ``(repo_url, ref)`` tuple, and the same tuple should correspond
-        to the same ``name``. This allows use of the locking provided by k8s
-        API instead of having to invent our own locking code.
-
-    """
-
-    """
-    For backwards compatibility: BinderHub previously assumed a single cleaner for all builds
-    """
-    _cleaners = {}
-
-    def __init__(
-        self,
-        q,
-        api,
-        name,
-        *,
-        namespace,
-        repo_url,
-        ref,
-        build_image,
-        docker_host,
-        image_name,
-        git_credentials=None,
-        push_secret=None,
-        memory_limit=0,
-        memory_request=0,
-        node_selector=None,
-        appendix="",
-        log_tail_lines=100,
-        sticky_builds=False,
-    ):
-        warnings.warn(
-            "Class Build is deprecated, use KubernetesBuildExecutor and configure with Traitlets",
-            DeprecationWarning,
-        )
-
-        super().__init__()
-
-        self.q = q
-        self.api = api
-        self.repo_url = repo_url
-        self.ref = ref
-        self.name = name
-        self.namespace = namespace
-        self.image_name = image_name
-        self.push_secret = push_secret
-        self.build_image = build_image
-        self.memory_limit = memory_limit
-        self.memory_request = memory_request
-        self.docker_host = docker_host
-        self.node_selector = node_selector
-        self.appendix = appendix
-        self.log_tail_lines = log_tail_lines
-        self.git_credentials = git_credentials
-        self.sticky_builds = sticky_builds
-
-    @classmethod
-    def cleanup_builds(cls, kube, namespace, max_age):
-        """Delete stopped build pods and build pods that have aged out"""
-        key = (kube, namespace, max_age)
-        if key not in Build._cleaners:
-            Build._cleaners[key] = KubernetesCleaner(
-                kube=kube, namespace=namespace, max_age=max_age
-            )
-        Build._cleaners[key].cleanup()

binderhub/builder.py

@@ -22,7 +22,7 @@
 from tornado.web import Finish, authenticated
 
 from .base import BaseHandler
-from .build import Build, ProgressEvent
+from .build import ProgressEvent
 from .utils import KUBE_REQUEST_TIMEOUT
 
 # Separate buckets for builds and launches.
@@ -410,64 +410,31 @@ async def get(self, provider_prefix, _unescaped_spec):
         # Prepare to build
         q = Queue()
 
-        if self.settings["use_registry"] or self.settings["build_docker_config"]:
-            push_secret = self.settings["push_secret"]
-        else:
-            push_secret = None
+        # if self.settings["use_registry"] or self.settings["build_docker_config"]:
+        #     push_secret = self.settings["push_secret"]
+        # else:
+        #     push_secret = None
 
         BuildClass = self.settings.get("build_class")
 
-        appendix = self.settings["appendix"].format(
-            binder_url=self.binder_launch_host + self.binder_request,
-            persistent_binder_url=self.binder_launch_host
-            + self.binder_persistent_request,
+        # appendix = self.settings["appendix"].format(
+        #     binder_url=self.binder_launch_host + self.binder_request,
+        #     persistent_binder_url=self.binder_launch_host
+        #     + self.binder_persistent_request,
+        #     repo_url=repo_url,
+        #     ref_url=self.ref_url,
+        # )
+
+        build = BuildClass(
+            # All other properties should be set in traitlets config
+            parent=self.settings["traitlets_parent"],
+            q=q,
+            name=build_name,
             repo_url=repo_url,
-            ref_url=self.ref_url,
+            ref=ref,
+            image_name=image_name,
+            git_credentials=provider.git_credentials,
         )
-
-        if issubclass(BuildClass, Build):
-            # Deprecated, see docstring of the Build class for more details
-            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():

binderhub/tests/test_build.py

@@ -13,7 +13,7 @@
 from tornado.httputil import url_concat
 from tornado.queues import Queue
 
-from binderhub.build import Build, ProgressEvent
+from binderhub.build import KubernetesBuildExecutor, ProgressEvent
 from binderhub.build_local import LocalRepo2dockerBuild, ProcessTerminated, _execute_cmd
 
 from .utils import async_requests
@@ -117,8 +117,8 @@ def test_default_affinity():
 
     mock_k8s_api = _list_dind_pods_mock()
 
-    build = Build(
-        mock.MagicMock(),
+    build = KubernetesBuildExecutor(
+        q=mock.MagicMock(),
         api=mock_k8s_api,
         name="test_build",
         namespace="build_namespace",
@@ -128,7 +128,7 @@ def test_default_affinity():
         image_name="name",
         push_secret="",
         memory_limit=0,
-        git_credentials=None,
+        git_credentials="",
         docker_host="http://mydockerregistry.local",
         node_selector={},
     )
@@ -145,8 +145,8 @@ def test_sticky_builds_affinity():
     # Setup some mock objects for the response from the k8s API
     mock_k8s_api = _list_dind_pods_mock()
 
-    build = Build(
-        mock.MagicMock(),
+    build = KubernetesBuildExecutor(
+        q=mock.MagicMock(),
         api=mock_k8s_api,
         name="test_build",
         namespace="build_namespace",
@@ -156,7 +156,7 @@ def test_sticky_builds_affinity():
         image_name="name",
         push_secret="",
         memory_limit=0,
-        git_credentials=None,
+        git_credentials="",
         docker_host="http://mydockerregistry.local",
         node_selector={},
         sticky_builds=True,
@@ -183,8 +183,8 @@ def test_git_credentials_passed_to_podspec_upon_submit():
 
     mock_k8s_api = _list_dind_pods_mock()
 
-    build = Build(
-        mock.MagicMock(),
+    build = KubernetesBuildExecutor(
+        q=mock.MagicMock(),
         api=mock_k8s_api,
         name="test_build",
         namespace="build_namespace",