Merge pull request #2874 from jeff1evesque/feature-2697

#2697: Send '.coverage' docker output to coveralls

Author: jeff1evesque

.coveragerc

@@ -0,0 +1,4 @@
+[paths]
+source =
+    .
+    /var/machine-learning

.gitignore

@@ -19,6 +19,7 @@
 !/test
 !/log/
 !*.dockerfile
+!.coveragerc
 
 # Ignore and don't commit the following directories
 *.sass-cache/

.travis.yml

@@ -35,11 +35,11 @@ before_install:
   - sudo /opt/puppetlabs/bin/puppet -V
 
 ## install packages for linting
-#
-#  @trusty-backports, allows additional packages (i.e. shellcheck) to be installed
-#
-#  Note: unit testing is performed within the docker container, which is
-#        defined from the Dockerfile.
+##
+## @trusty-backports, allows additional packages (i.e. shellcheck) to be installed
+##
+## Note: unit testing is performed within the docker container, which is
+##        defined from the Dockerfile.
 install:
   - sudo add-apt-repository "deb http://archive.ubuntu.com/ubuntu/ trusty-backports restricted main universe"
   - pip install flake8==2.5.4
@@ -60,21 +60,22 @@ install:
   - gem install yaml-lint -v 0.0.7
   - npm install -g dockerlint@0.2.0
   - pip install restructuredtext_lint==0.17.2
+  - pip install python-coveralls==2.9.0
 
 ## implement linting / unit tests
-#
-#  @puppet-lint, the following issue needs to be checked if it has been
-#      resolved, so the '--no-ensure_first_param-check' abusive flag
-#      implementation (below) can be removed:
-#
-#      - https://github.com/rodjek/puppet-lint/issues/410
-#
-#  @docker run:
-#      -d, run container in background and print container ID
-#      -t, allocate pseudo-tty instead of default tty to running container
-#
-#  Note: unit testing is performed within the docker container, which is
-#        defined from the Dockerfile.
+##
+## @puppet-lint, the following issue needs to be checked if it has been
+##     resolved, so the '--no-ensure_first_param-check' abusive flag
+##     implementation (below) can be removed:
+##
+##     - https://github.com/rodjek/puppet-lint/issues/410
+##
+## @docker run:
+##     -d, run container in background and print container ID
+##     -t, allocate pseudo-tty instead of default tty to running container
+##
+## Note: unit testing is performed within the docker container, which is
+##       defined from the Dockerfile.
 script:
   # lint codebase
   - flake8 .
@@ -113,10 +114,28 @@ script:
   - cat pytest.log
   - (! grep -qE '= FAILURES =|= ERRORS =|= no tests ran in 0.00 seconds =' pytest.log)
 
+  ## acquire coverage results
+  ##
+  ## Note: more information regarding the '.coverage.docker' naming convention:
+  ##
+  ##       https://github.com/pytest-dev/pytest-cov/issues/146#issuecomment-272971136
+  ##
+  - docker cp webserver-pytest:/var/machine-learning/.coverage .coverage.docker
+
   # check exit code: 'docker exec' will fail if the container has an exit code
   - docker exec -it webserver echo "'docker exec' only works on an active running container"
   - docker exec -it database echo "'docker exec' only works on an active running container"
   - docker exec -it redis echo "'docker exec' only works on an active running container"
 
   # list all containers
   - docker ps -a
+
+## post build: the following commands are run after a successful build.
+##
+## Note: more information regarding the coverage-coverall implementation:
+##
+##       https://github.com/pytest-dev/pytest-cov/issues/146
+##
+after_success:
+  - coverage combine
+  - coveralls

app.py

@@ -18,7 +18,10 @@
 # run unit test
 if len(sys.argv) > 1:
     if sys.argv[1] == 'test':
-        pytest.main(['test/live_server'])
+        pytest.main([
+            '--cov', '.',
+            'test/live_server'
+        ])
     elif sys.argv[1] == 'run':
         args = {
             'prefix': 'test',

default.dockerfile

@@ -9,12 +9,13 @@ ENV ENVIRONMENT_DIR $ROOT_PROJECT/puppet/environment/$ENVIRONMENT
 RUN mkdir /var/machine-learning
 COPY . /var/machine-learning
 
-## install git, and wget
+## install git, wget, pip
 #
 #  Note: r10k requires 'git' installed
 RUN apt-get -y update
 RUN apt-get -y install git=1:1.9.1-1ubuntu0.3
 RUN apt-get -y install wget=1.15-1ubuntu1.14.04.2
+RUN apt-get -y install python-pip=1.5.4-1ubuntu4
 
 ## install puppet
 RUN wget https://apt.puppetlabs.com/puppetlabs-release-pc1-trusty.deb
@@ -26,6 +27,9 @@ RUN apt-get -y install puppet-agent
 RUN apt-get -y install rubygems-integration=1.5
 RUN gem install r10k -v 2.2.0
 
+## install pytest-cov
+RUN pip install pytest-cov==2.4.0
+
 ## install puppet modules using puppetfile with r10k
 RUN mkdir -p $ENVIRONMENT_DIR/modules_contrib/
 RUN PUPPETFILE=$ENVIRONMENT_DIR/Puppetfile PUPPETFILE_DIR=$ENVIRONMENT_DIR/modules_contrib/ r10k puppetfile install