add Docker container with tox, Python, Node.js, npm and javascript dependencies

Author: TSC21

nodethon/Dockerfile

@@ -0,0 +1,22 @@
+#
+# Builds a docker image with Python and Node.js to use for tox runs.
+#
+FROM ubuntu:18.04
+
+VOLUME /repo
+
+WORKDIR /repo
+
+
+ENV SONAR_SCANNER_VERSION 4.2.0.1873
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_ALL=en_US.UTF-8
+ENV SONAR_SCANNER_HOME=/sonar-scanner-${SONAR_SCANNER_VERSION}-linux
+ENV SONAR_SCANNER_OPTS="-server"
+
+ENV PATH="${SONAR_SCANNER_HOME}/sonar-scanner-${SONAR_SCANNER_VERSION}-linux/bin:${PATH}"
+
+COPY provision.sh /
+
+RUN /provision.sh

nodethon/README.md

@@ -0,0 +1,72 @@
+# "Nodethon" (Node.js + Python) Docker
+
+Builds and pushes a docker environment for use with tox testing. This environment contains Node.js 13 and some other JavaScript dependencies, besides a series of python versions allowing multi-version tox testing locally and in CI services.
+
+The "sq" suffix indicates that the ["sonarqube"](https://www.sonarqube.org) scanner has been included in the image. This scanner allows tox builds to upload coverage and other reports to a sonarqube instance.
+
+## Build and Push
+
+These instructions are for maintainers with permissions to push to the "uavcan" organization on Docker Hub.
+
+```
+docker build .
+```
+```
+docker images
+
+REPOSITORY      TAG            IMAGE ID
+nodethon        latest         d7ab132649d6
+```
+```
+# We use the range of python environments supported as the version tag.
+docker tag d7ab132649d6 uavcan/nodethon:py35-py38-node13-sq
+docker login --username=yourhubusername
+docker push uavcan/nodethon:py35-py38-node13-sq
+```
+
+## Testing out the container
+
+Start an interactive session:
+
+```bash
+docker run --rm -it -v ${PWD}:/repo uavcan/nodethon:py35-py38-node13-sq
+```
+
+On MacOS you'll probably want to optimize `osxfs` with something like cached or delegated:
+
+```bash
+docker run --rm -it -v ${PWD}:/repo:delegated uavcan/nodethon:py35-py38-node13-sq
+```
+
+See ["Performance tuning for volume mounts"](https://docs.docker.com/docker-for-mac/osxfs-caching/) for details.
+
+## Travis CI
+
+You can use this in your .travis.yml like this:
+
+```none
+services:
+  - docker
+
+before_install:
+- docker pull uavcan/nodethon:py35-py38-node13-sq
+
+script:
+- docker run --rm -v $TRAVIS_BUILD_DIR:/repo uavcan/nodethon:py35-py38-node13-sq /bin/sh -c tox
+
+```
+
+## BuildKite
+
+Example pipeline.yml:
+
+```yaml
+- label: ":github: my containerized build"
+    command: "nodethon tox"
+    plugins:
+      - docker#v3.5.0:
+          workdir: /repo
+          image: "uavcan/nodethon:py35-py38-node13-sq"
+          propagate-environment: true
+          mount-ssh-agent: true
+```

nodethon/provision.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+# +----------------------------------------------------------+
+# | BASH : Modifying Shell Behaviour
+# |    (https://www.gnu.org/software/bash/manual)
+# +----------------------------------------------------------+
+# Treat unset variables and parameters other than the special
+# parameters ‘@’ or ‘*’ as an error when performing parameter
+# expansion. An error message will be written to the standard
+# error, and a non-interactive shell will exit.
+set -o nounset
+
+# Exit immediately if a pipeline returns a non-zero status.
+set -o errexit
+
+# If set, the return value of a pipeline is the value of the
+# last (rightmost) command to exit with a non-zero status, or
+# zero if all commands in the pipeline exit successfully.
+set -o pipefail
+
+# +----------------------------------------------------------+
+export DEBIAN_FRONTEND=noninteractive
+
+apt-get update
+
+# setup locales in the container so Python can default to utf-8.
+apt-get -y install locales
+# from http://jaredmarkell.com/docker-and-locales/
+locale-gen en_US.UTF-8
+export ENV LANG=en_US.UTF-8
+export ENV LANGUAGE=en_US:en
+export ENV LC_ALL=en_US.UTF-8
+
+apt-get -y install software-properties-common
+apt-get -y install git
+apt-get -y install curl
+apt-get -y install unzip
+
+# deadsnakes maintains a bunch of python versions for Ubuntu.
+add-apt-repository -y ppa:deadsnakes/ppa
+apt-get update
+apt-get -y install python3.5
+apt-get -y install python3.6
+apt-get -y install python3.7
+apt-get -y install python3.8
+apt-get -y install python3-pip
+pip3 install tox
+
+# Node.js (13), npm (6.14) and JS dependencies
+curl -sL https://deb.nodesource.com/setup_13.x | sudo -E bash -
+apt-get -y install nodejs
+node -v
+npm -v
+# install JSdoc to be used with sphinx-js
+npm install -g jsdoc
+# install Mocha JavaScript test framework
+npm install -g mocha
+
+# Sonarqube
+curl --create-dirs -sSLo $HOME/.sonar/sonar-scanner.zip https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-$SONAR_SCANNER_VERSION-linux.zip
+unzip -o $HOME/.sonar/sonar-scanner.zip -d $SONAR_SCANNER_HOME
+
+rm -rf $HOME/.sonar
+
+echo "export PATH=$PATH" >> ~/.bashrc
+echo "export LANG=en_US.UTF-8" >> ~/.bashrc
+echo "export LANGUAGE=en_US:en" >> ~/.bashrc
+echo "export LC_ALL=en_US.UTF-8" >> ~/.bashrc

toxic/provision.sh

@@ -47,7 +47,7 @@ apt-get -y install python3-pip
 pip3 install tox
 
 # Sonarqube
-curl --create-dirs -sSLo $HOME/.sonar/sonar-scanner.zip https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-$SONAR_SCANNER_VERSION-linux.zip 
+curl --create-dirs -sSLo $HOME/.sonar/sonar-scanner.zip https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-$SONAR_SCANNER_VERSION-linux.zip
 unzip -o $HOME/.sonar/sonar-scanner.zip -d $SONAR_SCANNER_HOME
 
 rm -rf $HOME/.sonar