Merge KubeProfileSpawner into KubeSpawner

kubespawner/spawner.py

@@ -48,6 +48,8 @@ class KubeSpawner(Spawner):
     Implement a JupyterHub spawner to spawn pods in a Kubernetes Cluster.
     """
 
+    UNDEFINED_DISPLAY_NAME = "?? undefined 'display_name' ??"
+
     # We want to have one threadpool executor that is shared across all spawner objects
     # This is initialized by the first spawner that is created
     executor = None
@@ -781,6 +783,46 @@ def _hub_connect_port_default(self):
         """
     )
 
+    form_template = Unicode(
+        """<label for="profile">Please select a profile for your Jupyter:</label>
+        <select class="form-control" name="profile" required autofocus>
+        {input_template}
+        </select>
+        """,
+        config = True,
+        help = """Template to use to construct options_form text. {input_template} is replaced with
+            the result of formatting input_template against each item in the profiles list."""
+        )
+
+    input_template = Unicode("""
+        <option value="{key}" {first}>{display}</option>""",
+        config = True,
+        help = """Template to construct {input_template} in form_template. This text will be formatted
+            against each item in the profiles list, in order, using the following key names:
+            ( display, key, type ) for the first three items in the tuple, and additionally
+            first = "checked" (taken from first_template) for the first item in the list, so that
+            the first item starts selected."""
+        )
+
+    first_template = Unicode('selected',
+        config=True,
+        help="Text to substitute as {first} in input_template"
+        )
+
+    options_form = Unicode()
+
+    single_user_profile_list = List(
+        trait = Dict(),
+        default_value = None,
+        minlen = 0,
+        config = True,
+        help = """List of profiles to offer for selection. Signature is:
+            List(Dict()), where each item is a dictionary that has two keys:
+            - 'display_name': the human readable display name
+            - 'kubespawner_override': a dictionary with overrides to apply to the KubeSpawner 
+              settings."""
+        )
+
     def _expand_user_properties(self, template):
         # Make sure username and servername match the restrictions for DNS labels
         safe_chars = set(string.ascii_lowercase + string.digits)
@@ -1082,3 +1124,29 @@ def get_args(self):
                 args[i] = '--hub-api-url="%s"' % (self.accessible_hub_api_url)
                 break
         return args
+
+    def _options_form_default(self):
+        if not self.single_user_profile_list:
+            return
+        temp_keys = [
+            {
+                'display': p.get('display_name', self.UNDEFINED_DISPLAY_NAME), 
+                'key': i, 
+                'first': '',
+        } for i, p in enumerate(self.single_user_profile_list)]
+        temp_keys[0]['first'] = self.first_template
+        text = ''.join([ self.input_template.format(**tk) for tk in temp_keys ])
+        return self.form_template.format(input_template=text)
+
+    def options_from_form(self, formdata):
+        if not self.single_user_profile_list:
+            return form_data
+        # Default to first profile if somehow none is provided
+        selected_profile = int(formdata.get('profile',[0])[0])
+        options = self.single_user_profile_list[selected_profile]
+        self.log.debug("Applying KubeSpawner override for profile '%s'", 
+                  options.get('display_name', self.UNDEFINED_DISPLAY_NAME))
+        kubespawner_override = options.get('kubespawner_override', {})
+        for k, v in kubespawner_override.items():
+            setattr(self, k, v)
+        return options