Merge pull request #40 from shingo78/feature/repo2docker-service

cwh-repo2docker: Switch from c.JupyterHub.extra_handlers to services

Author: shingo78

jupyterhub/Dockerfile

@@ -64,6 +64,7 @@ RUN python3 -m pip install --no-cache /tmp/wheelhouse/*
 # Resources
 RUN mkdir /var/jupyterhub
 ADD jupyterhub_config.py /srv/jupyterhub/
+ADD cwh_repo2docker_config.py /srv/jupyterhub/
 ADD resources-schema.json /srv/jupyterhub/
 ADD get_user_id.sh /
 RUN chmod +x /get_user_id.sh

jupyterhub/cwh-repo2docker/MANIFEST.in

@@ -1,2 +1,3 @@
+recursive-include cwh_repo2docker/custom_templates/ *
 recursive-include cwh_repo2docker/templates/ *
 recursive-include cwh_repo2docker/static/ *

jupyterhub/cwh-repo2docker/cwh_repo2docker/__init__.py

@@ -1,14 +1,12 @@
 import os
+import sys
 
 from coursewareuserspawner import CoursewareUserSpawner
 from jinja2 import Environment, BaseLoader
-from jupyterhub.handlers.static import CacheControlStaticFilesHandler
 from traitlets import Unicode
+from tornado import web
 
-from .builder import BuildHandler, DefaultCouseImageHandler
 from .registry import get_registry, split_image_name
-from .images import ImagesHandler
-from .logs import LogsHandler
 
 
 class Repo2DockerSpawner(CoursewareUserSpawner):
@@ -102,6 +100,19 @@ async def get_options_form(self):
         )
         return image_form_template.render(image_list=images, registry_host=self._registry.host)
 
+    async def check_allowed(self, image):
+        images = await self._registry.list_images()
+
+        registry_host = self._registry.host
+        image_names = [
+            f'{registry_host}/{image["image_name"]}'
+            for image in images
+        ]
+
+        if image not in image_names:
+            raise web.HTTPError(400, "Specifying image to launch is not allowed")
+        return image
+
     def _use_default_course_image(self, images):
         self.image = self._registry.get_default_course_image()
 
@@ -156,28 +167,49 @@ async def create_object(self, *args, **kwargs):
         return await super().create_object(*args, **kwargs)
 
 
-def cwh_repo2docker_jupyterhub_config(c):
+def cwh_repo2docker_jupyterhub_config(
+        c,
+        config_file=None,
+        service_name='environments',
+        custom_menu=False,
+        service_environments={},
+        debug=False):
     # hub
     c.JupyterHub.spawner_class = Repo2DockerSpawner
 
-    # add extra templates for the service UI
-    c.JupyterHub.template_paths.insert(
-        0, os.path.join(os.path.dirname(__file__), "templates")
-    )
-
     c.DockerSpawner.cmd = ["jupyterhub-singleuser"]
 
-    # register the handlers to manage the user images
-    c.JupyterHub.extra_handlers.extend(
-        [
-            (r"environments", ImagesHandler),
-            (r"api/environments", BuildHandler),
-            (r"api/environments/default-course-image", DefaultCouseImageHandler),
-            (r"api/environments/([^/]+)/logs", LogsHandler),
-            (
-                r"environments-static/(.*)",
-                CacheControlStaticFilesHandler,
-                {"path": os.path.join(os.path.dirname(__file__), "static")},
-            ),
-        ]
-    )
+    if custom_menu:
+        # add extra templates for the service UI
+        c.JupyterHub.template_paths.insert(
+            0, os.path.join(os.path.dirname(__file__), "custom_templates")
+        )
+
+    service_command = [
+        sys.executable,
+        "-m", "cwh_repo2docker.service",
+    ]
+
+    if config_file is not None:
+        service_command.extend([
+            "--config-file", config_file
+        ])
+
+    if debug:
+        service_command.extend([
+            "--debug"
+        ])
+
+    c.JupyterHub.template_vars.update({
+        'cwh_repo2docker_service_name': service_name
+    })
+
+    c.JupyterHub.services.extend([{
+        "name": service_name,
+        "command": service_command,
+        "url": "http://127.0.0.1:10101",
+        "display": not custom_menu,
+        "oauth_no_confirm": True,
+        "environment": service_environments,
+        "oauth_client_allowed_scopes": ["inherit"]
+    }])

jupyterhub/cwh-repo2docker/cwh_repo2docker/base.py

@@ -0,0 +1,49 @@
+import json
+
+from tornado import web
+from tornado.log import app_log
+
+from jupyterhub.utils import url_path_join
+
+
+class BaseHandler(web.RequestHandler):
+    @property
+    def log(self):
+        return self.settings.get('log', app_log)
+
+    def render_template(self, name, **ns):
+        template_ns = {}
+        template_ns.update(self.template_namespace)
+        template_ns["xsrf_token"] = self.xsrf_token.decode("ascii")
+        template_ns.update(ns)
+        template = self.settings['jinja2_env'].get_template(name)
+        return template.render_async(**template_ns)
+
+    @property
+    def template_namespace(self):
+        user = self.current_user
+        ns = dict(
+            base_url=url_path_join(
+                self.settings['base_url'],
+                self.settings['hub_prefix']),
+            prefix=self.settings['base_url'],
+            service_prefix=self.settings['service_prefix'],
+            brand_text=self.settings['brand_text'],
+            user=user,
+            static_url=self.static_url,
+            no_spawner_check=True
+        )
+        return ns
+
+    def get_json_body(self):
+        """Return the body of the request as JSON data."""
+        if not self.request.body:
+            return None
+        body = self.request.body.strip().decode('utf-8')
+        try:
+            model = json.loads(body)
+        except Exception:
+            self.log.debug("Bad JSON: %r", body)
+            self.log.error("Couldn't parse JSON", exc_info=True)
+            raise web.HTTPError(400, 'Invalid JSON in body of request')
+        return model

jupyterhub/cwh-repo2docker/cwh_repo2docker/builder.py

@@ -2,23 +2,22 @@
 import re
 
 from aiodocker import Docker, DockerError
-from jupyterhub.apihandlers import APIHandler
-from jupyterhub.scopes import needs_scope
+from jupyterhub.services.auth import HubOAuthenticated
 from tornado import web
 
 from .docker import build_image
 from .registry import get_registry, split_image_name
+from .base import BaseHandler
 
 IMAGE_NAME_RE = r"^[a-z0-9-_]+$"
 
 
-class BuildHandler(APIHandler):
+class BuildHandler(HubOAuthenticated, BaseHandler):
     """
     Handle requests to build user environments as Docker images
     """
 
     @web.authenticated
-    @needs_scope('admin-ui')
     async def delete(self):
         data = self.get_json_body()
         name = data["name"]
@@ -37,10 +36,10 @@ async def delete(self):
                 raise web.HTTPError(500, e.message)
 
         self.set_status(200)
+        self.set_header('content-type', 'application/json')
         self.finish(json.dumps({"status": "ok"}))
 
     @web.authenticated
-    @needs_scope('admin-ui')
     async def post(self):
         data = self.get_json_body()
         repo = data["repo"]
@@ -74,16 +73,16 @@ async def post(self):
         await build_image(registry.host, repo, ref, name, username, password, extra_buildargs)
 
         self.set_status(200)
+        self.set_header('content-type', 'application/json')
         self.finish(json.dumps({"status": "ok"}))
 
 
-class DefaultCouseImageHandler(APIHandler):
+class DefaultCourseImageHandler(HubOAuthenticated, BaseHandler):
     """
     Handler to update the default course image
     """
 
     @web.authenticated
-    @needs_scope('admin-ui')
     async def put(self):
         data = self.get_json_body()
         name = data["name"]
@@ -95,4 +94,5 @@ async def put(self):
         await registry.set_default_course_image(repo, digest)
 
         self.set_status(200)
+        self.set_header('content-type', 'application/json')
         self.finish(json.dumps({"status": "ok"}))

jupyterhub/cwh-repo2docker/cwh_repo2docker/custom_templates/page.html

@@ -0,0 +1,8 @@
+{% extends "templates/page.html" %}
+
+{% block nav_bar_left_items %}
+{{ super() }}
+{% if 'access:services!service={{cwh_repo2docker_service_name}}' in expanded_scopes or 'access:services' in expanded_scopes %}
+<li><a href="{{prefix}}services/{{cwh_repo2docker_service_name}}/">Environments</a></li>
+{% endif %}
+{% endblock %}

jupyterhub/cwh-repo2docker/cwh_repo2docker/images.py

@@ -1,20 +1,17 @@
-from inspect import isawaitable
-from jupyterhub.handlers.base import BaseHandler
-from jupyterhub.scopes import needs_scope
+from jupyterhub.services.auth import HubOAuthenticated
 from tornado import web
-import json
 
 from .docker import list_containers
 from .registry import get_registry
+from .base import BaseHandler
 
 
-class ImagesHandler(BaseHandler):
+class ImagesHandler(HubOAuthenticated, BaseHandler):
     """
     Handler to show the list of environments as Docker images
     """
 
     @web.authenticated
-    @needs_scope('admin-ui')
     async def get(self):
         registry = get_registry(config=self.settings['config'])
         images = await registry.list_images()
@@ -23,7 +20,4 @@ async def get(self):
             "images.html",
             images=images + containers
         )
-        if isawaitable(result):
-            self.write(await result)
-        else:
-            self.write(result)
+        self.write(await result)

jupyterhub/cwh-repo2docker/cwh_repo2docker/logs.py

@@ -1,18 +1,18 @@
 import json
 
 from aiodocker import Docker
-from jupyterhub.apihandlers import APIHandler
-from jupyterhub.utils import admin_only
+from jupyterhub.services.auth import HubOAuthenticated
 from tornado import web
 from tornado.iostream import StreamClosedError
 
+from .base import BaseHandler
 
-class LogsHandler(APIHandler):
+
+class LogsHandler(HubOAuthenticated, BaseHandler):
     """
     Expose a handler to follow the build logs.
     """
     @web.authenticated
-    @admin_only
     async def get(self, name):
         self.set_header("Content-Type", "text/event-stream")
         self.set_header("Cache-Control", "no-cache")