feat: add acceptance tests

.github/workflows/acceptance_tests.yml

@@ -0,0 +1,78 @@
+name: Acceptance tests
+
+on:
+  pull_request:
+    types:
+    - synchronize
+
+jobs:
+  acceptance-tests:
+    strategy:
+      max-parallel: 1
+      matrix:
+        include:
+          - image_name: py
+            test_user: jovyan
+          - image_name: cuda-tf
+            build_arg: BASE_IMAGE=py
+            test_user: jovyan
+          - image_name: generic
+            build_arg: RENKU_BASE=py
+            test_user: jovyan
+          - image_name: julia
+            build_arg: BASE_IMAGE=py
+            test_user: jovyan
+          - image_name: r
+            build_arg: RENKU_BASE=py
+            test_user: jovyan
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+        with:
+          driver-opts: |
+            network=host
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+      - name: Build Py Image
+        uses: docker/build-push-action@v2
+        with:
+          context: docker/py/
+          push: false
+          tags: py
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new
+          load: true
+      - name: Build Test Image
+        if: ${{ matrix.image_name != 'py' }}
+        uses: docker/build-push-action@v2
+        with:
+          context: docker/${{ matrix.image_name }}/
+          push: false
+          tags: ${{ matrix.image_name }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new
+          build-args: ${{ matrix.build_arg }}
+          load: true
+      - name: Move Cache
+        # Temp fix
+        # https://github.com/docker/build-push-action/issues/252
+        # https://github.com/moby/buildkit/issues/1896
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache
+      - name: Image Acceptance Tests
+        uses: cypress-io/github-action@v2
+        env:
+          TEST_IMAGE_NAME: ${{ matrix.image_name }}
+          TEST_USER_NAME: ${{ matrix.test_user }}
+        with:
+          working-directory: tests
+          command: npx mocha test.js
+

.gitignore

@@ -12,4 +12,10 @@
 # Ignore all local history of files
 .history
 
+## Node modules
+**/node_modules/*
+## Cypress
+tests/cypress/videos/*
+tests/cypress/screenshots/*
+
 # End of https://www.gitignore.io/api/visualstudiocode

docker/generic/Dockerfile

@@ -51,6 +51,9 @@ ENV PATH ${CONDA_PATH}/bin:$PATH
 
 # inject the renku-jupyter stack
 COPY --from=renku_base /opt/conda /opt/conda
+COPY --from=renku_base /usr/bin/tini /usr/bin/tini
+COPY --from=renku_base --chown=1000:1000 /usr/local/bin/*sh /usr/local/bin/
+COPY --from=renku_base /entrypoint.sh /entrypoint.sh
 COPY --from=renku_base --chown=1000:1000 \
     /home/jovyan/ /home/${NB_USER}/
 

docker/r/Dockerfile

@@ -71,6 +71,7 @@ COPY --from=renku_base --chown=rstudio:rstudio  /usr/local/bin/ /usr/local/bin/
 COPY --from=renku_base --chown=rstudio:rstudio \
     /home/jovyan/ /home/rstudio/
 COPY --from=renku_base /entrypoint.sh /entrypoint.sh
+COPY --from=renku_base /usr/bin/tini /usr/bin/tini
 
 # set permissions of the R library directory to be editable by NB_USER
 ADD fix-permissions.sh /usr/local/bin

tests/README.md

@@ -0,0 +1,16 @@
+# Acceptance Tests for Renkulab Images
+
+## Requirements
+- node
+
+## Run Tests
+1. Install node packages: `cd tests && npm install`
+2. Build a docker image: `docker build -t py docker/py`
+3. Test images: `cd tests && TEST_IMAGE_NAME="py" "TEST_USER_NAME=jovyan" npx mocha test.js`
+
+Mocha is used to launch a test session with Cypress for each image. Mocha
+captures and displays the logs from Cypress for each test. The reason for having Mocha
+launch the Cypress tests is because the Cypress tests cannot run terminal commands
+to launch a Jupyterlab container beacuse they operate only in the browser. However,
+running Mocha tests does not have this limitation and the Mocha tests can launch 
+containers with Jupyterlab as well as all Cypress tests.

tests/cypress.json

@@ -0,0 +1,3 @@
+{
+    "defaultCommandTimeout": 10000
+}

tests/cypress/integration/test.spec.js

@@ -0,0 +1,14 @@
+describe('Basic functionality', function() {
+  before(function() {
+    cy.visit(Cypress.env("URL"))
+  })
+  it('Can find launcher icons', function() {
+    cy.get('div.jp-LauncherCard')
+  })
+  it('Can find main menu at the top', function() {
+    cy.get('div#jp-menu-panel')
+  })
+  it('Can launch terminal', function() {
+    cy.get('div.jp-LauncherCard[title="Start a new terminal session"]').click()
+  })
+})

tests/cypress/plugins/index.js

@@ -0,0 +1,22 @@
+/// <reference types="cypress" />
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+/**
+ * @type {Cypress.PluginConfig}
+ */
+// eslint-disable-next-line no-unused-vars
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+}

tests/cypress/support/index.js

@@ -0,0 +1,24 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+// import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')
+
+Cypress.on('uncaught:exception', (err) => {
+  return false
+})