feat: add jupyter installation

Author: koralowiec

.ansible-lint

@@ -6,6 +6,7 @@ exclude_paths:
   - .cache/
   - molecule/default
   - molecule/aws-ec2
+  - molecule/jupyter-system
 offline: false
 use_default_rules: true
 parseable: true

defaults/main.yml

@@ -4,3 +4,16 @@ python_versions:
   - 3.10.6
   - 3.9.13
 python_jupyter_kernel: true
+python_jupyter_install: true
+# Possible values: system, virtualenv
+python_jupyter_install_method: virtualenv
+# Python version to use for Jupyter installation
+python_jupyter_python_version: "{{ python_versions[0] }}"
+python_jupyter_virtualenv_path: /opt/jupyter
+python_jupyter_packages:
+  - jupyterlab
+  - notebook>=6.0.0,<7.0.0
+python_jupyter_workbench: true
+python_jupyter_workbench_packages:
+  - rsp_jupyter
+  - workbench_jupyterlab==1.1.315

molecule/jupyter-system/converge.yml

@@ -0,0 +1,11 @@
+---
+- name: Converge
+  hosts: all
+  become: true
+  pre_tasks:
+    - name: Include main vars
+      include_vars: "{{ playbook_dir }}/../../tests/vars/main.yml"
+    - name: Include jupyter-system vars
+      include_vars: "{{ playbook_dir }}/../../tests/vars/jupyter-system.yml"
+  roles:
+    - "{{ playbook_dir }}/../../"

molecule/jupyter-system/molecule.yml

@@ -0,0 +1,21 @@
+---
+dependency:
+  name: galaxy
+driver:
+  name: docker
+platforms:
+  - name: instance-jupyter-system
+    image: "geerlingguy/docker-${MOLECULE_DISTRO:-ubuntu2004}-ansible:latest"
+    command: ${MOLECULE_DOCKER_COMMAND:-""}
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:rw
+    privileged: true
+    cgroupns_mode: host
+    pre_build_image: true
+    platform: linux/amd64
+provisioner:
+  name: ansible
+  playbooks:
+    prepare: prepare.yml
+    converge: converge.yml
+    verify: verify.yml

molecule/jupyter-system/prepare.yml

@@ -0,0 +1,5 @@
+---
+- name: Prepare
+  hosts: all
+  become: true
+  tasks: []

molecule/jupyter-system/verify.yml

@@ -0,0 +1,10 @@
+---
+- name: Verify
+  hosts: all
+  become: true
+  pre_tasks:
+    - name: Include vars
+      ansible.builtin.include_vars: "{{ playbook_dir }}/../../tests/vars/main.yml"
+  tasks:
+    - name: Include tasks
+      ansible.builtin.include_tasks: "{{ playbook_dir }}/../../tests/tasks/post.yml"

tasks/install-jupyter.yml

@@ -0,0 +1,39 @@
+---
+- name: Combine jupyter packages
+  ansible.builtin.set_fact:
+    python_jupyter_packages: "{{ python_jupyter_packages + python_jupyter_workbench_packages }}"
+  when: python_jupyter_workbench
+
+- name: Install jupyter packages (virtualenv method)
+  ansible.builtin.pip:
+    name: "{{ python_jupyter_packages }}"
+    virtualenv_command: "/opt/python/{{ python_jupyter_python_version }}/bin/python -m venv"
+    virtualenv: "{{ python_jupyter_virtualenv_path }}"
+  when: python_jupyter_install_method == "virtualenv"
+
+- name: Install jupyter packages (system method)
+  ansible.builtin.pip:
+    name: "{{ python_jupyter_packages }}"
+    executable: pip3
+  when: python_jupyter_install_method == "system"
+
+- name: Set path to jupyter-nbextension
+  ansible.builtin.set_fact:
+    jupyter_nbextension_path: "{{ (python_jupyter_install_method == 'virtualenv') | ternary(python_jupyter_virtualenv_path + '/bin/', '') }}jupyter-nbextension"
+    jupyter_etc_nbconfig: "{{ (python_jupyter_install_method == 'virtualenv') | ternary('/opt/jupyter', '/usr') }}/etc/jupyter/nbconfig"
+
+- name: Install Workbench's jupyter plugin
+  ansible.builtin.command: |
+    {{ jupyter_nbextension_path }} install --sys-prefix --py rsp_jupyter
+  register: command_result
+  # jupyter-nbextension returns the needed information in stderr
+  changed_when: "'Copying:' in command_result.stderr"
+  when: python_jupyter_workbench
+
+- name: Enable Workbench's jupyter plugin
+  ansible.builtin.shell: |
+    grep 'rsp_jupyter/index' {{ jupyter_etc_nbconfig }}/notebook.json || echo "File doesn't exist yet"
+    {{ jupyter_nbextension_path }} enable --sys-prefix --py rsp_jupyter
+  register: command_result
+  changed_when: "'\"rsp_jupyter/index\": true' not in command_result.stdout"
+  when: python_jupyter_workbench

tasks/main.yml

@@ -57,3 +57,6 @@
         index_var: index
       register: command_result
       changed_when: kernel_json.results[index].stat.exists == false
+
+- name: Include tasks | Jupyter installation
+  ansible.builtin.include_tasks: './install-jupyter.yml'

tests/vars/jupyter-system.yml

@@ -0,0 +1,3 @@
+# vars file
+---
+python_jupyter_install_method: system