RPP / Add 100% unit test coverage requirement for src (#7510)

Automattic · Oct 27, 2023 · a08754d · a08754d
1 parent 9df23da
commit a08754d
Show file tree

Hide file tree

Showing 11 changed files with 102 additions and 23 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -18,9 +18,11 @@ jobs:
         woocommerce: [ 'latest' ]
         wordpress:   [ 'latest' ]
         php:         [ '7.4' ]
+        directory:   [ 'includes', 'src' ]
     env:
-      WP_VERSION: ${{ matrix.wordpress }}
-      WC_VERSION: ${{ matrix.woocommerce }}
+      WP_VERSION:   ${{ matrix.wordpress }}
+      WC_VERSION:   ${{ matrix.woocommerce }}
+      COVERAGE_DIR: ${{ matrix.directory }}
     steps:
       # clone the repository
       - uses: actions/checkout@v3

diff --git a/bin/check-test-coverage.sh b/bin/check-test-coverage.sh
@@ -2,6 +2,14 @@
 
 set -e
 
+if [ "$1" == "src" ]; then
+	CONFIGURATION_FILE=phpunit-src.xml.dist
+	COVERAGE=100
+else
+	CONFIGURATION_FILE=phpunit-includes.xml.dist
+	COVERAGE=60
+fi
+
 echo "Installing the test environment..."
 
 docker-compose exec -u www-data wordpress \
@@ -12,6 +20,8 @@ echo "Checking coverage..."
 docker-compose exec -u www-data wordpress \
 	php -d xdebug.remote_autostart=on \
 	/var/www/html/wp-content/plugins/woocommerce-payments/vendor/bin/phpunit \
-	--configuration /var/www/html/wp-content/plugins/woocommerce-payments/phpunit.xml.dist \
-	--coverage-html /var/www/html/php-test-coverage
-	$*
+	--configuration "/var/www/html/wp-content/plugins/woocommerce-payments/$CONFIGURATION_FILE" \
+	--coverage-html /var/www/html/php-test-coverage \
+	--coverage-clover /var/www/html/clover.xml
+
+./vendor/bin/coverage-check docker/wordpress/clover.xml $COVERAGE
diff --git a/bin/phpunit.sh b/bin/phpunit.sh
@@ -13,13 +13,13 @@ SUPPORTED_PHP_MAJOR_VERSION_FOR_PHPUNIT_INSTALLED_VIA_COMPOSER_JSON=7
 SUPPORTED_PHP_MINOR_VERSION_FOR_PHPUNIT_INSTALLED_VIA_COMPOSER_JSON=3
 
 if [ $CURRENT_PHP_MAJOR_VERSION -gt $SUPPORTED_PHP_MAJOR_VERSION_FOR_PHPUNIT_INSTALLED_VIA_COMPOSER_JSON ]; then
-	./vendor/bin/phpunit -c phpunit.xml.dist "$@";
+	./vendor/bin/phpunit "$@";
 else
 	if [ $CURRENT_PHP_MINOR_VERSION -ge $SUPPORTED_PHP_MINOR_VERSION_FOR_PHPUNIT_INSTALLED_VIA_COMPOSER_JSON ]; then
-		./vendor/bin/phpunit -c phpunit.xml.dist "$@";
+		./vendor/bin/phpunit "$@";
 	else
     	chmod +x ./bin/phpunit6
-    	./bin/phpunit6 -c phpunit.xml.dist "$@";
+    	./bin/phpunit6 "$@";
     fi
 fi
 
diff --git a/bin/run-ci-tests-check-coverage.bash b/bin/run-ci-tests-check-coverage.bash
@@ -7,10 +7,19 @@ IFS=$'\n\t'
 # set environment variables
 WCPAY_DIR="$GITHUB_WORKSPACE"
 
+# determine whether to test everything, or just src, and what coverage to require
+if [ "$COVERAGE_DIR" == "src" ]; then
+	CONFIGURATION_FILE=phpunit-src.xml.dist
+	COVERAGE=100
+else
+	CONFIGURATION_FILE=phpunit-includes.xml.dist
+	COVERAGE=60
+fi
+
 composer self-update && composer install --no-progress
 sudo systemctl start mysql.service
 bash bin/install-wp-tests.sh woocommerce_test root root localhost $WP_VERSION $WC_VERSION false
 echo 'Running the tests...'
-bash bin/phpunit.sh --coverage-clover /tmp/clover.xml
-vendor/bin/coverage-check /tmp/clover.xml 60
+bash bin/phpunit.sh -c $CONFIGURATION_FILE --coverage-clover /tmp/clover.xml
+vendor/bin/coverage-check /tmp/clover.xml $COVERAGE
 
diff --git a/bin/run-ci-tests.bash b/bin/run-ci-tests.bash
@@ -24,4 +24,4 @@ echo 'Setting up test environment...'
 bash bin/install-wp-tests.sh woocommerce_test root root localhost $WP_VERSION $WC_VERSION false $GUTENBERG_VERSION
 
 echo 'Running the tests...'
-bash bin/phpunit.sh
+bash bin/phpunit.sh -c phpunit.xml.dist
diff --git a/changelog/patch b/changelog/patch
@@ -0,0 +1,5 @@
+Significance: patch
+Type: dev
+Comment: Adding 100% src coverage helpers.
+
+
diff --git a/package.json b/package.json
@@ -39,6 +39,7 @@
     "test:update-snapshots": "npm run test:js -- --updateSnapshot",
     "test:php": "./bin/run-tests.sh",
     "test:php-coverage": "./bin/check-test-coverage.sh",
+    "test:php-coverage-src": "./bin/check-test-coverage.sh src",
     "test:php-watch": "npm run test:php -- -w",
     "test:qit": "npm run build:release && ./tests/qit/security.sh",
     "watch": "webpack --watch",

diff --git a/phpunit-includes.xml.dist b/phpunit-includes.xml.dist
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!-- Configuration for coverage checks for `includes` -->
+<phpunit
+	bootstrap="tests/unit/bootstrap.php"
+	backupGlobals="false"
+	colors="true"
+	convertErrorsToExceptions="true"
+	convertNoticesToExceptions="true"
+	convertWarningsToExceptions="true"
+	>
+	<testsuites>
+		<testsuite name="WCPay">
+			<directory suffix=".php">./tests/unit</directory>
+			<exclude>./tests/unit/multi-currency</exclude>
+			<!-- This configuration is only for `includes` -->
+			<exclude>./tests/unit/src</exclude>
+		</testsuite>
+		<testsuite name="WCPayMultiCurrency">
+			<directory suffix=".php">./tests/unit/helpers</directory>
+			<directory suffix=".php">./tests/unit/multi-currency</directory>
+		</testsuite>
+	</testsuites>
+
+	<!-- Set a whitelist for code coverage analysis -->
+	<filter>
+		<whitelist>
+			<directory suffix=".php">includes</directory>
+		</whitelist>
+	</filter>
+</phpunit>
diff --git a/phpunit-src.xml.dist b/phpunit-src.xml.dist
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!-- Configuration for coverage checks for `src` -->
+<phpunit
+	bootstrap="tests/unit/bootstrap.php"
+	backupGlobals="false"
+	colors="true"
+	convertErrorsToExceptions="true"
+	convertNoticesToExceptions="true"
+	convertWarningsToExceptions="true"
+	>
+	<testsuites>
+		<testsuite name="WCPaySrc">
+			<directory suffix=".php">./tests/unit/helpers</directory>
+			<directory suffix=".php">./tests/unit/src</directory>
+		</testsuite>
+	</testsuites>
+
+	<!-- Set a whitelist for code coverage analysis -->
+	<filter>
+		<whitelist>
+			<directory suffix=".php">src</directory>
+			<exclude>
+				<!-- Service providers are simple, and ideally should not be used within tests. -->
+				<directory suffix=".php">src/Internal/DependencyManagement/ServiceProvider</directory>
+			</exclude>
+		</whitelist>
+	</filter>
+</phpunit>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
+<!-- Configuration for tests for both `includes` and `src`, but without checking code coverage. -->
 <phpunit
 	bootstrap="tests/unit/bootstrap.php"
 	backupGlobals="false"
@@ -18,16 +19,5 @@
 		</testsuite>
 	</testsuites>
 
-	<!-- Set a whitelist for code coverage analysis -->
-	<filter>
-		<whitelist>
-			<directory suffix=".php">includes</directory>
-			<directory suffix=".php">src</directory>
-			<exclude>
-				<!-- Service providers are simple, and ideally should not be used within tests. -->
-				<directory suffix=".php">src/Internal/DependencyManagement/ServiceProvider</directory>
-			</exclude>
-		</whitelist>
-	</filter>
-
+	<!-- No code coverage settings here, there are separate coverages for `includes` and `src`. -->
 </phpunit>
diff --git a/src/Container.php b/src/Container.php
@@ -16,6 +16,8 @@
 use WCPay\Internal\DependencyManagement\ServiceProvider\GenericServiceProvider;
 use WCPay\Internal\DependencyManagement\ServiceProvider\ProxiesServiceProvider;
 
+// @codeCoverageIgnoreStart
+
 /**
  * Hides errors during update from 6.6.0 or 6.6.1 to 6.6.2.
  *
@@ -36,6 +38,8 @@
 	wp_die();
 }
 
+// @codeCoverageIgnoreEnd
+
 /**
  * WCPay Dependency Injection Container.
  *