Test automatic loading of /etc/jupyterhub.d files

Author: consideRatio

dev-config.yaml

@@ -51,6 +51,12 @@ hub:
       memory: 0
       cpu: 0
   extraFiles:
+    my_config:
+      name: my_config.py
+      mountPath: /etc/jupyterhub.d
+      stringData: |
+        with open("/tmp/created-by-extra-files-config.txt", "w") as f:
+            f.write("hello world!")
     binaryData.txt: &binaryData
       mountPath: /tmp/
       mode: 0666

jupyterhub/schema.yaml

@@ -272,6 +272,8 @@ properties:
           ```yaml
           hub:
             extraFiles:
+              # Explicitly set the name to avoid having the file key include a .
+              # as it can hamper our ability to use --set-file.
               my_image:
                 name: my_image.png
                 mountPath: /usr/local/share/jupyterhub/static/

tests/test_spawn.py

@@ -153,6 +153,27 @@ def test_hub_mounted_extra_files():
     ), f"The hub.extraFiles configuration doesn't seem to have been honored!"
 
 
+def test_hub_etc_jupyterhub_d_folder():
+    """
+    Tests that the extra jupyterhub config file put into /etc/jupyterhub.d by
+    the hub.extraFiles configuration was loaded.
+    """
+    c = subprocess.run(
+        [
+            "kubectl",
+            "exec",
+            "deploy/hub",
+            "--",
+            "sh",
+            "-c",
+            "cat /tmp/created-by-extra-files-config.txt | grep -- 'hello world' || exit 1",
+        ]
+    )
+    assert (
+        c.returncode == 0
+    ), f"The hub.extraFiles configuration should have mounted a config file to /etc/jupyterhub.d which should have been loaded to write a dummy file for us!"
+
+
 def test_hub_api_request_user_spawn(
     api_request, jupyter_user, request_data, pebble_acme_ca_cert
 ):