MAINT: Run CI with Docker

Author: Nick Zaccardi

circle.yml

@@ -1,15 +1,21 @@
----
-
 machine:
   services:
-    - postgresql
+    - docker
 
 dependencies:
-  post:
-    - pip install tox-pyenv
-    - pyenv local 2.7.11 3.5.1
+  override:
+    # We override the dependencies section so that CircleCI doesn't find the
+    # setup.py and install the dependencies. This is mostly an issue with
+    # libraries but can carry over into applications as well. (NZ)
+    - pwd
 
 test:
-  post:
-    - pip install codecov && codecov
-    - mv *.pytests.xml $CIRCLE_TEST_REPORTS
+  override:
+    - ls -la
+    - /home/ubuntu/$CIRCLE_PROJECT_REPONAME/docker-run-tests
+
+deployment:
+  codecov:
+    branch: /.*/
+    commands:
+      - bash <(curl -s https://codecov.io/bash)

codecov.yml

@@ -0,0 +1,30 @@
+codecov:
+  bot: level12-codecov-bot
+  notify:
+    require_ci_to_pass: true
+
+comment:
+  behavior: default
+  layout: header, diff
+  require_changes: false
+
+coverage:
+  precision: 2
+  range:
+  - 70.0
+  - 100.0
+  round: down
+  status:
+    changes: false
+    patch: true
+    project: true
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: true
+      loop: true
+      macro: false
+      method: false
+  javascript:
+    enable_partials: false

docker-entry

@@ -0,0 +1,27 @@
+#!/bin/bash
+set -e
+
+# This script is ran by the docker image.  It does any necessary setup and should then kick-off
+# whatever tests you want ran by CI, presumably by using tox.  However, you can customize as
+# needed.
+#
+# Image Modification Notice: if you find yourself needing to modify the OS in any way, e.g.
+# `apt-get install ...`, this probably isn't the place to do that.  It would be better to get
+# the docker image that you are using for testing updated to have your modifications.
+# While you can technically do it here and it will probably work, it's much slower to have to do
+# that modification every time the tests run than to rebuild the docker image with the changes
+# needed.
+
+# just some debugging info
+pwd
+ls -la
+
+# Install tox from the wheelhouse using our target python version.
+# You could skip this step and use the tox installed in the docker image.  I (RS) like this option
+# b/c it gives me control over what version of tox I'm using without having to rebuild the
+# docker image.
+python3.5 -m pip install --upgrade --force-reinstall \
+    --quiet --use-wheel --no-index --find-links=requirements/wheelhouse tox
+
+# run the tests using our target python version
+python3.5 -m tox -e py27,py35,flake8

docker-run-tests

@@ -0,0 +1,42 @@
+#!/bin/bash
+# This script is used to run tox in the same docker container and in the same manner that our CI
+# will run tox.  If tox is passing locally, but CI is failing, use this script to troubleshoot.
+
+set -e
+
+if [ -z "${CIRCLECI}" ]; then
+    # When testing locally, don't actually run docker mapped to the real source directory.  Since
+    # Docker runs as root, the file permissions get jacked up and you have to use sudo to fix it.
+    # Instead, git clone the source to a temporary directory and link the docker volume to that.
+    # This also simulates what CircleCI does and will reveal testing errors caused by files
+    # that exist locally but have not been checked into git.
+    local_src_dpath="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+    src_dname=$(basename "$local_src_dpath")
+    random_st=$(env LC_CTYPE=C tr -dc 'a-zA-Z0-9' < /dev/urandom| fold -w 8 | head -n 1)
+    tmp_src_dpath="/tmp/docker-$src_dname-$random_st"
+
+    SRC_DPATH=$tmp_src_dpath
+    ARTIFACTS_DPATH="$tmp_src_dpath/.ci/artifacts"
+    TEST_REPORTS_DPATH="$tmp_src_dpath/.ci/test-reports"
+
+    set -x
+    git clone "$local_src_dpath/" "$tmp_src_dpath"
+else
+    SRC_DPATH="/home/ubuntu/$CIRCLE_PROJECT_REPONAME"
+    ARTIFACTS_DPATH=$CIRCLE_ARTIFACTS
+    TEST_REPORTS_DPATH=$CIRCLE_TEST_REPORTS
+
+    DATABASE_HOST=$(ip -4 addr show docker0 | grep -Po 'inet \K[\d.]+')
+    DOCKER_FLAGS="--add-host=database:$DATABASE_HOST"
+fi
+
+set -x
+docker run \
+    -v "$SRC_DPATH:/opt/src" \
+    -v "$ARTIFACTS_DPATH:/opt/src/.ci/artifacts" \
+    -v "$TEST_REPORTS_DPATH:/opt/src/.ci/test-reports" \
+    "$DOCKER_FLAGS" \
+    level12/python-test-multi
+
+ls "$ARTIFACTS_DPATH"
+ls "$TEST_REPORTS_DPATH"

keg_apps/db/config.py

@@ -14,6 +14,6 @@ class TestProfile(object):
         # The postgres connection defaults to what our travis build needs.  If testing as a
         # developer, then you should setup a TestProfile config for these tests in
         # file: ~/.config/keg_apps.db/keg_apps.db-config.py
-        'postgres': 'postgresql://ubuntu:@localhost/circle_test',
+        'postgres': 'postgresql://ubuntu:@database/circle_test',
         'sqlite2': 'sqlite:///'
     }