Add support for pcov

Author: andrewnicols

Dockerfile

@@ -5,8 +5,8 @@ ARG TARGETPLATFORM
 ENV TARGETPLATFORM=${TARGETPLATFORM:-linux/amd64}
 RUN echo "Building for ${TARGETPLATFORM}"
 
-ADD root/ /
 # Fix the original permissions of /tmp, the PHP default upload tmp dir.
+ADD root/tmp /tmp/
 RUN chmod 777 /tmp && chmod +t /tmp
 
 # Install some packages that are useful within the images.
@@ -34,6 +34,10 @@ RUN /tmp/setup/php-extensions.sh
 RUN /tmp/setup/oci8-extension.sh
 ENV LD_LIBRARY_PATH /usr/local/instantclient
 
+ADD root/usr /usr/
+
+ENTRYPOINT ["moodle-docker-php-entrypoint"]
+
 RUN mkdir /var/www/moodledata && chown www-data /var/www/moodledata && \
     mkdir /var/www/phpunitdata && chown www-data /var/www/phpunitdata && \
     mkdir /var/www/behatdata && chown www-data /var/www/behatdata && \

README.md

@@ -41,6 +41,24 @@ To faciliate testing and easy setup the following directories are created and ow
 * `/var/www/behatdata`
 * `/var/www/behatfaildumps`
 
+## Configuration
+### PCov
+
+pcov can be configured by setting the following environment variables when creating the container:
+
+| Environment variable  | Default value                                   | Description                                           |
+| --------------------- | ----------------------------------------------- | ----------------------------------------------------- |
+| `PCOV_ENABLED`        | 0 (disabled)                                    | Whether pcov is enabled                               |
+| `PCOV_DIRECTORY`      | `/var/www/html`                                 | Restrict collection to files under this path          |
+| `PCOV_EXCLUDE`        | See note                                        | Exclude files under pcov.directory matching this PCRE |
+| `PCOV_INITIAL_MEMORY` | `65536`                                         | Initial size of the arena                             |
+| `PCOV_INITIAL_FILES`  | `1024`                                          | Initial size of the tables                            |
+
+The default value for pcov.exclude is intended to remove tests, coverage, vendor, and similar paths from code coverage:
+
+    ~\/(tests|coverage|vendor|node_modules)\/~
+
+See https://github.com/krakjoe/pcov#configuration for documentation on these options.
 
 ## See also
 This container is part of a set of containers for Moodle development, see also:

root/tmp/setup/php-extensions.sh

@@ -64,8 +64,8 @@ docker-php-ext-configure ldap
 docker-php-ext-install -j$(nproc) ldap
 
 # APCu, igbinary, Memcached, MongoDB, Redis, Solr, uuid, XMLRPC (beta)
-pecl install apcu igbinary memcached mongodb redis solr uuid xmlrpc-beta
-docker-php-ext-enable apcu igbinary memcached mongodb redis solr uuid xmlrpc
+pecl install apcu igbinary memcached mongodb redis solr uuid xmlrpc-beta pcov
+docker-php-ext-enable apcu igbinary memcached mongodb redis solr uuid xmlrpc pcov
 
 echo 'apc.enable_cli = On' >> /usr/local/etc/php/conf.d/docker-php-ext-apcu.ini
 

root/usr/local/bin/moodle-docker-php-entrypoint

@@ -0,0 +1,17 @@
+#!/bin/sh
+set -e
+
+# PCOV Configuration.
+PCOV_ENABLED="${PCOV_ENABLED:-0}"
+PCOV_EXCLUDE="${PCOV_EXCLUDE:-'~\/(tests|coverage|vendor|node_modules)\/~'}"
+PCOV_DIRECTORY="${PCOV_DIRECTORY:-'/var/www/html'}"
+PCOV_INITIAL_MEMORY="${PCOV_INITIAL_MEMORY:-65536}"
+PCOV_INITIAL_FILES="${PCOV_INITIAL_FILES:-1024}"
+
+echo "pcov.enabled=${PCOV_ENABLED}" >> /usr/local/etc/php/conf.d/docker-php-ext-pcov.ini
+echo "pcov.exclude=${PCOV_EXCLUDE}" >> /usr/local/etc/php/conf.d/docker-php-ext-pcov.ini
+echo "pcov.directory=${PCOV_DIRECTORY}" >> /usr/local/etc/php/conf.d/docker-php-ext-pcov.ini
+echo "pcov.initial.memory=${PCOV_INITIAL_MEMORY}" >> /usr/local/etc/php/conf.d/docker-php-ext-pcov.ini
+echo "pcov.initial.files=${PCOV_INITIAL_FILES}" >> /usr/local/etc/php/conf.d/docker-php-ext-pcov.ini
+
+docker-php-entrypoint "$@"