Merge pull request #976 from bollwyvl/add-target-repo-dir-perms

Allow REPO_DIR to be a non-existing folder by creating it and providing the user with permissions

Author: consideRatio

repo2docker/buildpacks/base.py

@@ -27,18 +27,18 @@
 RUN echo "en_US.UTF-8 UTF-8" > /etc/locale.gen && \
     locale-gen
 
-ENV LC_ALL en_US.UTF-8
-ENV LANG en_US.UTF-8
-ENV LANGUAGE en_US.UTF-8
+ENV LC_ALL=en_US.UTF-8 \
+    LANG=en_US.UTF-8 \
+    LANGUAGE=en_US.UTF-8
 
 # Use bash as default shell, rather than sh
-ENV SHELL /bin/bash
+ENV SHELL=/bin/bash
 
 # Set up user
 ARG NB_USER
 ARG NB_UID
-ENV USER ${NB_USER}
-ENV HOME /home/${NB_USER}
+ENV USER=${NB_USER} \
+    HOME=/home/${NB_USER}
 
 RUN groupadd \
         --gid ${NB_UID} \
@@ -81,13 +81,13 @@
 {% if build_env -%}
 # Environment variables required for build
 {% for item in build_env -%}
-ENV {{item[0]}} {{item[1]}}
+ENV {{item[0]}}={{item[1]}}
 {% endfor -%}
 {% endif -%}
 
 {% if path -%}
 # Special case PATH
-ENV PATH {{ ':'.join(path) }}:${PATH}
+ENV PATH={{ ':'.join(path) }}:${PATH}
 {% endif -%}
 
 {% if build_script_files -%}
@@ -105,7 +105,12 @@
 
 # Allow target path repo is cloned to be configurable
 ARG REPO_DIR=${HOME}
-ENV REPO_DIR ${REPO_DIR}
+ENV REPO_DIR=${REPO_DIR}
+# Create a folder and grant the user permissions if it doesn't exist
+RUN if [ ! -d "${REPO_DIR}" ]; then \
+        /usr/bin/install -o ${NB_USER} -g ${NB_USER} -d "${REPO_DIR}"; \
+    fi
+
 WORKDIR ${REPO_DIR}
 RUN chown ${NB_USER}:${NB_USER} ${REPO_DIR}
 
@@ -117,12 +122,12 @@
 #
 # The XDG standard suggests ~/.local/bin as the path for local user-specific
 # installs. See https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
-ENV PATH ${HOME}/.local/bin:${REPO_DIR}/.local/bin:${PATH}
+ENV PATH=${HOME}/.local/bin:${REPO_DIR}/.local/bin:${PATH}
 
 {% if env -%}
 # The rest of the environment
 {% for item in env -%}
-ENV {{item[0]}} {{item[1]}}
+ENV {{item[0]}}={{item[1]}}
 {% endfor -%}
 {% endif -%}
 
@@ -144,7 +149,7 @@
 USER root
 
 # Copy stuff.
-COPY --chown={{ user }}:{{ user }} src/ ${REPO_DIR}
+COPY --chown={{ user }}:{{ user }} src/ ${REPO_DIR}/
 
 # Run assemble scripts! These will actually turn the specification
 # in the repository into an image.
@@ -173,7 +178,7 @@
 # Add start script
 {% if start_script is not none -%}
 RUN chmod +x "{{ start_script }}"
-ENV R2D_ENTRYPOINT "{{ start_script }}"
+ENV R2D_ENTRYPOINT="{{ start_script }}"
 {% endif -%}
 
 # Add entrypoint

tests/conda/r3.6-target-repo-dir-flag/verify.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 import sys
 import os
+from glob import glob
 
 # conda should still be in /srv/conda
 # and Python should still be in $NB_PYTHON_PREFIX
@@ -15,3 +16,12 @@
 
 # Repo should be writable
 assert os.access("/srv/repo", os.W_OK)
+
+# All files in repo dir should be readable and writeable
+for path in glob("/src/repo/**/*", recursive=True):
+    assert os.access(path, os.R_OK)
+    assert os.access(path, os.W_OK)
+
+# Should be able to make a new file
+with open("/srv/repo/writeable", "w") as fp:
+    fp.write("writeable")

tests/conftest.py

@@ -1,11 +1,19 @@
 """
 Custom test collector for our integration tests.
 
-Each directory that has a script named 'verify' is considered
-a test. jupyter-repo2docker is run on that directory,
-and then ./verify is run inside the built container. It should
-return a non-zero exit code for the test to be considered a
-success.
+
+Test lifecycle:
+- Find all directories that contain `verify` or `*.repos.yaml`
+- If `verify` is found:
+    - Run `jupyter-repo2docker` on the test directory.
+      - Extra arguments may be added as YAML list of strings in `extra-args.yaml`.
+    - Run `./verify` inside the built container.
+    - It should return a non-zero exit code for the test to be considered a
+      successful.
+- If a `*.repos.yaml` is found:
+    - For each entry of the form `{name, url, ref, verify}`
+        - Run `jupyter-repo2docker` with the `url` and `ref`
+        - Run the `verify` inside the built container
 """
 
 import os