Build docker image with code coverage support

Author: marc-mabe

.github/workflows/test.Dockerfile

@@ -0,0 +1,18 @@
+ARG PHP_VERSION=latest
+FROM php:${PHP_VERSION}-cli-alpine
+
+WORKDIR /workdir
+
+# install composer
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+ENV COMPOSER_ALLOW_SUPERUSER=1
+ENV COMPOSER_HTACCESS_PROTECT=0
+ENV COMPOSER_CACHE_DIR=/.composer
+
+# install PHP extension pcov
+RUN apk add --no-cache --virtual .build-deps $PHPIZE_DEPS \
+    && mkdir -p /usr/src/php/ext/pcov && curl -fsSL https://pecl.php.net/get/pcov | tar xvz -C /usr/src/php/ext/pcov --strip 1 \
+    && docker-php-ext-install pcov \
+    && docker-php-ext-enable pcov \
+    && rm -Rf /usr/src/php/ext/pcov \
+    && apk del --no-cache .build-deps

.github/workflows/test.yml

@@ -14,66 +14,99 @@ jobs:
       matrix:
         include:
           - PHP_VERSION: 7.1
+            CODE_COVERAGE: false
+            RUN_PHPSTAN: false
+            RUN_PSALM: false
+            RUN_BENCHMARK: false
           - PHP_VERSION: 7.2
+            CODE_COVERAGE: true
+            RUN_PHPSTAN: false
+            RUN_PSALM: false
+            RUN_BENCHMARK: false
           - PHP_VERSION: 7.3
+            CODE_COVERAGE: true
+            RUN_PHPSTAN: false
+            RUN_PSALM: false
+            RUN_BENCHMARK: false
           - PHP_VERSION: 7.4
+            CODE_COVERAGE: true
             RUN_PHPSTAN: true
             RUN_PSALM: true
             RUN_BENCHMARK: true
           - PHP_VERSION: 8.0-rc
+            CODE_COVERAGE: true
             RUN_PHPSTAN: true
             RUN_PSALM: true
             RUN_BENCHMARK: true
             COMPOSER_EXTRA_ARGS: --ignore-platform-reqs
-    env:
-      PHP_IMAGE: php:${{ matrix.PHP_VERSION }}-cli-alpine
+
     steps:
       - uses: actions/checkout@v2
 
-      - name: Cache Composer Phar
-        id: cache-composer-phar
+      - name: Cache Docker Image
+        id: cache-docker-image
         uses: actions/cache@v2
         with:
-          path: composer.phar
-          key: cache-composer-phar
+          path: /tmp/docker-image.tar
+          key: cache-docker-image-test:${{ matrix.PHP_VERSION }}
 
-      - name: Install Composer
-        if: steps.cache-composer-phar.outputs.cache-hit != 'true'
-        run: curl -sS https://getcomposer.org/installer | php -- --install-dir=. --filename=composer.phar
+      - name: Load Docker Image
+        if: steps.cache-docker-image.outputs.cache-hit == 'true'
+        run: docker load --input /tmp/docker-image.tar
 
-      - name: Get Composer Setup
-        id: composer-setup
-        run: |
-          echo "::set-output name=version::$(composer --version)"
-          echo "::set-output name=cache-files-dir::$(composer config cache-files-dir)"
+      - name: Build Docker Image
+        if: steps.cache-docker-image.outputs.cache-hit != 'true'
+        run: docker build -f .github/workflows/test.Dockerfile -t 'test:${{ matrix.PHP_VERSION }}' --build-arg 'PHP_VERSION=${{ matrix.PHP_VERSION }}' .
 
       - name: Cache Composer Cache Files
         uses: actions/cache@v2
         with:
-          path: ${{ steps.composer-setup.outputs.cache-files-dir }}
-          key: cache-composer-cache-files-dir-${{ steps.composer-setup.outputs.version }}-${{ matrix.PHP_VERSION }}
+          path: /tmp/composer-cache-files
+          key: cache-composer-cache-files-${{ matrix.PHP_VERSION }}
           restore-keys: |
-            cache-composer-cache-files-dir-${{ steps.composer-setup.outputs.version }}-
-            cache-composer-cache-files-dir-
+            cache-composer-cache-files-
 
       - name: Install Composer Dependencies
         run: |
-          if [ "${{ matrix.RUN_PHPSTAN }}" != "true" ]; then ./composer.phar remove --dev phpstan/phpstan --no-update --no-interaction; fi
-          if [ "${{ matrix.RUN_PSALM }}" != "true" ]; then ./composer.phar remove --dev vimeo/psalm --no-update --no-interaction; fi
-          if [ "${{ matrix.RUN_BENCHMARK }}" != "true" ]; then ./composer.phar remove --dev phpbench/phpbench --no-update --no-interaction; fi
-          docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" -w '/workdir' -v '${{ steps.composer-setup.outputs.cache-files-dir }}:/.composer' -e 'COMPOSER_CACHE_DIR=/.composer' $PHP_IMAGE php ./composer.phar install --no-interaction --no-progress --prefer-dist ${{ matrix.COMPOSER_EXTRA_ARGS }}
+          if [ "${{ matrix.RUN_PHPSTAN }}" != "true" ]; then composer remove --dev phpstan/phpstan --no-update --no-interaction; fi
+          if [ "${{ matrix.RUN_PSALM }}" != "true" ]; then composer remove --dev vimeo/psalm --no-update --no-interaction; fi
+          if [ "${{ matrix.RUN_BENCHMARK }}" != "true" ]; then composer remove --dev phpbench/phpbench --no-update --no-interaction; fi
+          docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" -v '/tmp/composer-cache-files:/.composer' 'test:${{ matrix.PHP_VERSION }}' composer install --no-interaction --no-progress --prefer-dist ${{ matrix.COMPOSER_EXTRA_ARGS }}
 
       - name: Run Unit Test
-        run: docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" -w '/workdir' $PHP_IMAGE php -d 'zend.assertions=1' ./vendor/bin/phpunit
+        run: |
+          if [ "${{ matrix.CODE_COVERAGE }}" == "true" ]; then
+            docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" 'test:${{ matrix.PHP_VERSION }}' php -d 'zend.assertions=1' -d 'pcov.enabled=1' ./vendor/bin/phpunit --coverage-clover=.clover.xml --coverage-html=./coverage-html
+          else
+            docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" 'test:${{ matrix.PHP_VERSION }}' php -d 'zend.assertions=1' ./vendor/bin/phpunit
+          fi
+
+      - name: Archive Code Coverage
+        uses: actions/upload-artifact@v2
+        if: ${{ matrix.CODE_COVERAGE }}
+        with:
+          name: code-coverage-${{ matrix.PHP_VERSION }}
+          path: ./coverage-html
+
+      - name: Upload Codecov Report
+        uses: codecov/codecov-action@v1
+        if: ${{ matrix.CODE_COVERAGE }}
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: .clover.xml
 
       - name: Run PHPStan
         if: ${{ matrix.RUN_PHPSTAN }}
-        run: docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" -w '/workdir' $PHP_IMAGE php ./vendor/bin/phpstan analyse --level max src/ tests/
+        run: docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" 'test:${{ matrix.PHP_VERSION }}' php ./vendor/bin/phpstan analyse --level max src/ tests/
 
       - name: Run psalm
         if: ${{ matrix.RUN_PSALM }}
-        run: mkdir -p "$HOME/.cache/psalm" && docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" -w '/workdir' -v "$HOME/.cache/psalm:/.cache/psalm" $PHP_IMAGE php ./vendor/bin/psalm
+        run: mkdir -p "$HOME/.cache/psalm" && docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" -v "$HOME/.cache/psalm:/.cache/psalm" 'test:${{ matrix.PHP_VERSION }}' php ./vendor/bin/psalm
 
       - name: Run benchmark
         if: ${{ matrix.RUN_BENCHMARK }}
-        run: docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" -w '/workdir' $PHP_IMAGE php -d 'zend.assertions=-1' ./vendor/bin/phpbench run --no-interaction --revs=1 --retry-threshold=100 --progress=travis
+        run: docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/workdir" 'test:${{ matrix.PHP_VERSION }}' php -d 'zend.assertions=-1' ./vendor/bin/phpbench run --no-interaction --revs=1 --retry-threshold=100 --progress=travis
+
+      - name: Export Docker Image
+        if: steps.cache-docker-image.outputs.cache-hit != 'true'
+        run: docker save --output /tmp/docker-image.tar 'test:${{ matrix.PHP_VERSION }}'