Merge pull request #1194 from metacpan/oalders/devel-cover

Enable code coverage

Author: mickeyn

.circleci/config.yml

@@ -1,4 +1,6 @@
-# Use the latest 2.1 version of CircleCI pipeline process engine. See: https://circleci.com/docs/2.0/configuration-reference
+---
+# Use the latest 2.1 version of CircleCI pipeline process engine. See:
+# https://circleci.com/docs/2.0/configuration-reference
 version: 2.1
 # Orchestrate or schedule a set of jobs
 workflows:
@@ -44,10 +46,34 @@ jobs:
             pushd metacpan-docker
             ./src/metacpan-api/wait-for-es.sh http://localhost:9200 elasticsearch_test --
           name: wait for ES
+      # We are running coverage inside the container, but creating the report
+      # from outside of the container, so Devel::Cover is installed twice. We
+      # are relying on environment variables from the host to be available when
+      # we publish the report, so we publish from the host rather than trying
+      # to propagate env variables to the container. There is a CircleCI orb
+      # that can publish the report for us, but it is hard to debug. I had to
+      # set up the following config in order to debug the orb, so we may as
+      # well keep it around for now.
       - run:
           command: |
             pushd metacpan-docker
-            docker-compose exec -T api_test prove -lr --jobs 2 t
+            docker-compose exec -T api_test cpm install -g Devel::Cover
+          name: install Devel::Cover
+      - run:
+          command: |
+            pushd metacpan-docker
+            docker-compose exec -T api_test env HARNESS_PERL_SWITCHES="-MDevel::Cover=+ignore,^t/|^test-data/|^etc/" prove -lr --jobs 2 t
+          name: run tests with coverage
+      # The report ends up being owned by root. We need to chown it so that
+      # the cover command can make changes to it.
+      - run:
+          command: |
+            pushd metacpan-docker/src/metacpan-api
+            sudo apt install cpanminus
+            sudo cpanm --notest Devel::Cover Devel::Cover::Report::Codecov Devel::Cover::Report::Codecovbash
+            sudo chown -R circleci.circleci cover_db
+            cover -report codecov
+          name: upload coverage report
       - run:
           command: |
             pushd metacpan-docker