tests packaging and installation methods on Ubuntu Trusty

Author: Sarcasm

.travis.yml

@@ -17,6 +17,8 @@ matrix:
   include:
     - python: 3.6
       env: TOXENV=lint,docs
+    - python: 3.6
+      script: ./tests/integration/packaging-trusty.sh
     - python: 3.6
       install: python setup.py install
       script: ./contrib/zsh/check-all-helps

tests/integration/docker/ubuntu-trusty.sh

@@ -0,0 +1,56 @@
+#!/bin/bash
+
+set -o errexit
+
+LOCAL_PATH=$(cd $(dirname "${BASH_SOURCE[0]}") && pwd)
+COMPDB_PATH=$(cd ${LOCAL_PATH}/../../.. && pwd)
+IMAGE_NAME=sarcasm/compdb-ubuntu-trusty
+
+if [[ $# -ne 1 ]]; then
+    1>&2 cat <<EOF
+Usage: $0 SCRIPT
+
+SCRIPT argument is required.
+EOF
+    exit 1
+fi
+
+USER_SCRIPT=$(realpath "$1")
+
+>/dev/null docker build -q -t ${IMAGE_NAME} "${LOCAL_PATH}/ubuntu-trusty"
+
+tempdir=$(mktemp -d --tmpdir -t compdb_docker_trusty.XXXXXXXXXX)
+>/dev/null pushd "$tempdir"
+
+cp "$USER_SCRIPT" script.sh
+
+cat <<'EOF' > wrapper.sh
+#!/bin/bash
+set -o errexit
+tar xaf /data/compdb.tar.gz
+cd compdb
+exec /data/script.sh
+EOF
+chmod +x wrapper.sh
+
+# TODO: verify that removed files (in the index) are not present in the archive
+>/dev/null pushd "$COMPDB_PATH"
+gitref=$(git stash create)
+git archive --prefix=compdb/ -o "${tempdir}/compdb.tar.gz" ${gitref:-HEAD}
+>/dev/null popd
+
+docker run \
+    --interactive \
+    --tty \
+    --rm \
+    --env USER=user \
+    --env GROUP=grp \
+    --env UID=$(id -u) \
+    --env GID=$(id -g) \
+    --volume $(pwd):/data \
+    ${IMAGE_NAME} \
+    /data/wrapper.sh
+
+>/dev/null popd
+
+rm -rf "$tempdir"

tests/integration/docker/ubuntu-trusty/Dockerfile

@@ -0,0 +1,17 @@
+FROM ubuntu:trusty
+
+MAINTAINER Guillaume Papin "[email protected]"
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+        python-pip \
+        python-virtualenv \
+        python3-pip \
+        runit \
+        \
+        && apt-get clean \
+        && rm -rf /var/lib/apt/lists/*
+
+COPY entrypoint.sh /
+
+ENTRYPOINT ["/entrypoint.sh"]
+

tests/integration/docker/ubuntu-trusty/entrypoint.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+set -o errexit
+
+: "${USER?Please set USER}"
+: "${GROUP?Please set GROUP to the user group using $(id -gn)}"
+: "${UID?Please set UID}"
+: "${GID?Please set GID}"
+
+groupadd --gid "$GID" "$GROUP"
+useradd --create-home --shell /bin/bash --gid "$GROUP" --uid "$UID" "$USER"
+
+export HOME="/home/$USER"
+cd "$HOME"
+exec chpst -u "$USER" "$@"
+

tests/integration/packaging-trusty.sh

@@ -0,0 +1,104 @@
+#!/bin/bash
+
+# This script tests the packaging of compdb on Ubuntu Trusty.
+# It has been made to run on Travis CI and locally on Ubuntu 14.04,
+# or locally inside docker thanks to docker/ubuntu-trusty.sh.
+# The dependencies can be found in docker/ubuntu-trusty/Dockerfile.
+
+if [[ ! -f compdb/__init__.py ]]; then
+    1>&2 echo "error: this script expects to run in compdb root directory!"
+    exit 1
+fi
+
+set -o errexit
+set -o xtrace
+
+# First generate release files to ~/dist
+virtualenv .venv
+source .venv/bin/activate
+pip install -U "setuptools>=18"
+pip install wheel
+python setup.py sdist bdist_wheel
+deactivate
+mv dist ~/dist
+rm -r .venv
+
+# Install from source
+mkdir ~/userbase
+PYTHONUSERBASE=~/userbase python setup.py install --user
+PYTHONUSERBASE=~/userbase PATH="$HOME/userbase/bin:$PATH" compdb version
+rm -r ~/userbase
+
+# Install from source with pip
+mkdir ~/userbase
+PYTHONUSERBASE=~/userbase pip install --user .
+PYTHONUSERBASE=~/userbase PATH="$HOME/userbase/bin:$PATH" compdb version
+rm -r ~/userbase
+
+# Install from source in virtualenv
+# On Ubuntu 14.04, system wide setuptools version is 3.3,
+# but in virtualenv it is 2.2, which is unsufficient.
+virtualenv .venv
+source .venv/bin/activate
+pip install -U "setuptools>=3.3"
+python setup.py install
+compdb version
+deactivate
+rm -r .venv
+
+# Wheel
+mkdir ~/userbase
+PYTHONUSERBASE=~/userbase pip install --user ~/dist/compdb-*.whl
+PYTHONUSERBASE=~/userbase PATH="$HOME/userbase/bin:$PATH" compdb version
+rm -r ~/userbase
+
+# Wheel in virtualenv
+# Seems to work out of the box for ubuntu 14:04: with setuptools 2.2
+# and pip 1.5.x.
+# I assume wheels have support for 'extras_require'
+# for longer than source distributions.
+virtualenv .venv
+source .venv/bin/activate
+pip install ~/dist/compdb-*.whl
+compdb version
+deactivate
+rm -r .venv
+
+# pip install source distribution
+mkdir ~/userbase
+PYTHONUSERBASE=~/userbase pip install --user ~/dist/compdb-*.tar.gz
+PYTHONUSERBASE=~/userbase PATH="$HOME/userbase/bin:$PATH" compdb version
+rm -r ~/userbase
+
+# pip install source distribution in virtualenv
+#
+# 2 alternatives:
+# pip vendors setuptools, in pip 7.1.0 setuptools has been bumped to version 18.
+# Starting from this version 'extras_require' is supported in setup().
+#
+# 1. works but does not use extras_require
+virtualenv .venv
+source .venv/bin/activate
+pip install -U 'setuptools>=3.3,<18'
+pip install -U 'pip<7.1.0'
+pip install ~/dist/compdb-*.tar.gz
+compdb version
+deactivate
+rm -r .venv
+# 2. works by using extras_require
+virtualenv .venv
+source .venv/bin/activate
+pip install -U 'setuptools>=18'
+pip install -U 'pip>=7.1.0'
+pip install ~/dist/compdb-*.tar.gz
+compdb version
+deactivate
+rm -r .venv
+
+# requirements.txt, depends on the pip version that vendors setuptools>=18
+virtualenv .venv
+source .venv/bin/activate
+pip install -U 'pip==7.1.0'
+pip install -r requirements.txt
+deactivate
+rm -r .venv