Setup initial github action (#1)

Setup an initial github action for building and pushing the docker image. The test_notebooks are used for test, with the exception of the cadquery one that seems to need more changes. Another one importing all the packages was added. No output validation is done, but an exception will lead to a test failure.

Remove the tag from the repo, replace it with docker/metadata-actio from the github context.

To make the build and test work, multiple changes are done:

 - Explicitly add pip in the dependencies, conda was complaining about it in loop during docker build.
 - The pyvista wheel that was included was triggering import failures (missing pyvista.jupyter). Replace it with the latest version
 - Minor update to the test example to allow running with an X server
 - Replace ipyvtk_simple with ipyvtklink, that was throwing a deprecated error

Author: plule-ansys

.github/workflows/ci.yaml

@@ -0,0 +1,73 @@
+name: ci
+
+on:
+  push:
+    tags:
+    - 'v*'
+  pull_request:
+
+env:
+  TEST_TAG: user/myapp:test
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Read IMAGE_NAME
+        id: image_name
+        uses: falti/[email protected] 
+        with:
+          path: IMAGE_NAME
+      - name: Login to ${{ steps.image_name.outputs.registry }}
+        uses: docker/login-action@v1
+        with:
+          registry: ${{ steps.image_name.outputs.registry }}
+          username: ${{ secrets.REGISTRY_USER }}
+          password: ${{ secrets.REGISTRY_PASSWORD }}
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: ${{ steps.image_name.outputs.registry }}/${{ steps.image_name.outputs.repository }}
+          github-token: ${{ github.token }}
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+      - name: Build and export to Docker
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          load: true
+          tags: ${{ env.TEST_TAG }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+      - name: Test
+        run: >-
+          docker run --rm
+          -v `pwd`/test_notebooks:/test_notebooks
+          --user $(id -u):$(id -g) -e HOME=/tmp
+          ${{ env.TEST_TAG }}
+          jupyter nbconvert --to html --execute $NOTEBOOKS --output-dir=/test_notebooks/out
+        env:
+          # Need fix: cadquery.ipynb
+          NOTEBOOKS: >-
+            /test_notebooks/import-all.ipynb
+            /test_notebooks/ipygany.ipynb
+            /test_notebooks/ipyvtk-simple.ipynb
+            /test_notebooks/panel.ipynb
+      - name: Save notebook HTML out
+        uses: actions/upload-artifact@v2
+        with:
+          name: test-notebooks-html-out
+          path: test_notebooks/out/*.html
+      - name: Push the image
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          push: ${{ github.event_name == 'push' && contains(github.ref, '/tags/v') }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.gitignore

@@ -1,4 +1,8 @@
 NVIDIA-Linux*
 *.whl
 *~
-ipynb_checkpoints/
+ipynb_checkpoints/
+test_notebooks/out
+
+# Secrets when running github actions locally with nektos/act
+.secrets

Dockerfile

@@ -30,10 +30,6 @@ COPY environment.yml labextensions.txt /tmp/
 RUN mamba env update -n base --file /tmp/environment.yml
 RUN conda run jupyter labextension install $(cat /tmp/labextensions.txt)
 
-COPY pyvista-0.29.1-py3-none-any.whl pyvista-0.29.1-py3-none-any.whl 
-RUN pip install pyvista-0.29.1-py3-none-any.whl \
-    && rm pyvista-0.29.1-py3-none-any.whl
-
 # make jovyan sudo
 USER root
 RUN echo 'export PATH="/opt/conda/bin:$PATH"' >> /etc/profile

IMAGE_NAME

@@ -1,5 +1,6 @@
 #!/bin/bash
 
 # contains base image name version
-VERSION=v0.6.1
-IMAGE=mapdlhelm.azurecr.io/jupyterlab_base:$VERSION
+REGISTRY=mapdlhelm.azurecr.io
+REPOSITORY=jupyterlab_base
+IMAGE=$REGISTRY/$REPOSITORY:dev

README.md

@@ -2,10 +2,7 @@
 
 This repository contains a `Dockerfile` to generate the base image
 required for upstream images for pyansys.com.  Images are generated by
-running the scripts in the following order:
-
-- build.sh
-- push.sh
+pushing a git tag starting with `v`.
 
 Image is named and is built to be deployed at the MBU container
 repository, but this will be changed to be deployed via dockerhub or
@@ -18,10 +15,12 @@ mapdlhelm.azurecr.io/jupyterlab_base:$VERSION
 Obtain docker login credentials by following the steps at:
 https://portal.azure.com/#@ansys.com/resource/subscriptions/2870ae10-53f8-46b1-8971-93761377c38b/resourceGroups/PyANSYS/providers/Microsoft.ContainerRegistry/registries/mapdlhelm
 
+It can be run locally by running the scripts in the following order:
+
+- build_image.sh
+- run_image.sh
 
 #### Notes
- - We're currently using a custom image of pyvista at the moment, and
-   this needs to be upgraded to the latest pyvista release.
  - GPU image on dev.pyansys.com contains additional GPU remote
    rendering features not included in this image.  Ping @akaszynski to
    create that branch.

environment.yml

@@ -8,7 +8,7 @@ dependencies:
   - ipywidgets=7.6.3
   - pandas=1.2.3
   - ipygany=0.5.0
-  - pyvista=0.29.0
+  - pyvista=0.32.1
   - panel=0.11.0
   - plotly=4.14.3
   - cadquery=master
@@ -20,8 +20,9 @@ dependencies:
   - ipyevents=0.8.2
   - ipycanvas=0.8.2
   - dash-bootstrap-components=0.11.3
+  - ipyvtklink==0.2.1
+  - pip=21.2.4
   - pip:
-    - ipyvtk_simple==0.1.4
     - jupyter-cadquery==2.0.0
     - dash-vtk==0.0.6
     - dash-treeview-antd==0.0.1

push_image.sh

@@ -0,0 +1,43 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "source": [
+    "# Import all the packages from environment.yml\n",
+    "import jupyterlab\n",
+    "import ipywidgets\n",
+    "import pandas\n",
+    "import ipygany\n",
+    "import pyvista\n",
+    "import panel\n",
+    "import plotly\n",
+    "import cadquery\n",
+    "import networkx\n",
+    "import colour\n",
+    "import ipympl\n",
+    "import ipyevents\n",
+    "import ipycanvas\n",
+    "import dash\n",
+    "import dash_bootstrap_components\n",
+    "import pip\n",
+    "import ipyvtklink\n",
+    "import jupyter_cadquery\n",
+    "import dash_vtk\n",
+    "import dash_treeview_antd\n",
+    "\n",
+    "# Uncovered: jupyter-dash, cairo"
+   ],
+   "outputs": [],
+   "metadata": {}
+  }
+ ],
+ "metadata": {
+  "orig_nbformat": 4,
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

pyvista-0.29.1-py3-none-any.whl

@@ -7,7 +7,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import pyvista as pv"
+    "import pyvista as pv\n",
+    "import os"
    ]
   },
   {
@@ -17,8 +18,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "pv.set_jupyter_backend('ipyvtk_simple')\n",
-    "# pv.start_xvfb()"
+    "pv.set_jupyter_backend('ipyvtklink')\n",
+    "if 'DISPLAY' not in os.environ:\n",
+    "    pv.start_xvfb()"
    ]
   },
   {