jupyter-base-notebook.yaml

package:
  name: jupyter-base-notebook
  version: "7.4.1"
  epoch: 1
  description: Jupyter Notebook
  dependencies:
    runtime:
      - python-3.12
  copyright:
    - license: BSD-3-Clause

environment:
  contents:
    packages:
      - busybox
      - py3.12-pip

pipeline:
  - name: Install dependencies
    runs: |
      mkdir -p ${{targets.contextdir}}/usr/local/bin
      mkdir -p ${{targets.contextdir}}/home/jovyan/.jupyter
      # install jupyterlab, nbclassic and notebook
      pip install jupyterlab --prefix=/usr --root=${{targets.contextdir}}
      pip install nbclassic --prefix=/usr --root=${{targets.contextdir}}
      pip install notebook --prefix=/usr --root=${{targets.contextdir}}
      pip install jupyterhub --prefix=/usr --root=${{targets.contextdir}}
      # https://github.com/jupyter/docker-stacks/blob/9ffeb238dc8e363b5bddd779442b4f32d06aff0d/images/base-notebook/Dockerfile#L50 (else browser is not detected)
      pip install jupyterlab
      # Remediate GHSA-vqfr-h8mv-ghfj
      pip install --upgrade h11==0.16.0
      jupyter server --generate-config
      cp /home/build/.jupyter/jupyter_server_config.py ${{targets.contextdir}}/home/jovyan/.jupyter/jupyter_server_config.py
      jupyter lab clean

  - name: Remove unused files causing false positives for vulnerabilities
    runs: |
      rm -fR ${{targets.contextdir}}/usr/lib/python*/site-packages/psutil/tests/test_windows*
      rm -fR ${{targets.contextdir}}/usr/lib/python*/site-packages/psutil/tests/__pycache__/test_windows*

test:
  environment:
    contents:
      packages:
        - jq
        - linux-pam
        - py3.12-pip
        - jupyterhub-k8s-hub
    environment:
      JUPYTERHUB_SERVICE_URL: "127.0.0.1:8000"
  pipeline:
    - runs: |
        pip list | grep jupyterlab
        pip list | grep nbclassic
        pip list | grep notebook
        jupyter --version
        cat <<EOF > notebook.ipynb
        {
         "cells": [
          {
           "cell_type": "code",
           "execution_count": 0,
           "metadata":{},
           "outputs": [],
           "source": [
            "import sys\n",
            "print(sys.version_info)\n"
           ]
          }
         ],
         "metadata": {
          "kernelspec": {
           "display_name": "Python 3 (ipykernel)",
           "language": "python",
           "name": "python3"
          },
          "language_info": {
           "codemirror_mode": {
            "name": "ipython",
            "version": 3
           },
           "file_extension": ".py",
           "mimetype": "text/x-python",
           "name": "python"
          }
         },
         "nbformat": 4,
         "nbformat_minor": 4
        }
        EOF
        jupyter-execute --inplace notebook.ipynb
        export PYVERSION=$(python -c 'import sys; print(sys.version_info)')
        cat notebook.ipynb | jq '.cells [] .outputs [] .text []' | grep -F "$PYVERSION"
    - uses: test/tw/ldd-check
      with:
        packages: jupyter-base-notebook
    - name: Run and test jupyter server
      uses: test/daemon-check-output
      with:
        start: jupyter server
        timeout: 30
        expected_output: |
          extension was successfully linked
          extension was successfully loaded
    - name: Run and test jupyterhub-singleuser
      uses: test/daemon-check-output
      with:
        setup: |
          jupyterhub --ip 127.0.0.1 >/dev/null 2>&1 &
          sleep 3
        start: jupyterhub-singleuser --allow-root
        timeout: 30
        expected_output: |
          nbclassic | extension was successfully loaded.
          notebook | extension was successfully loaded.
          Serving notebooks from local directory: /home/build
          is running at:
          http://127.0.0.1:8888/lab

update:
  enabled: true
  github:
    identifier: jupyter/notebook
    strip-prefix: v
    tag-filter: v