#50 PHP-Scoper がテスト可能に

.github/actions/php-scoper/action.yml

@@ -0,0 +1,28 @@
+name: Setup PHP Scoper
+description: Setup PHP Scoper
+inputs:
+  scoper:
+    description: Whether to do PHP Scoper
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Add Prefix
+      if: inputs.scoper
+      shell: bash
+      run: |
+        composer global require humbug/php-scoper
+        ~/.composer/vendor/bin/php-scoper add-prefix --output-dir=vendor-prefixed --force
+        composer dump-autoload --working-dir vendor-prefixed --classmap-authoritative
+        composer scoper-patch
+
+    - name: Cleanup Vendor
+      if: inputs.scoper
+      run: rm -rf vendor
+      shell: bash
+
+    - name: Skip PHP Scoper
+      if: inputs.scoper != true
+      run: echo "Skipping Scoper"
+      shell: bash

.github/workflows/wordpress.yml

@@ -19,7 +19,7 @@ jobs:
         php: [ '7.2', '7.4', '8.0' ] # PHP versions to check.
         wp: [ 'latest', '5.9' ]      # WordPress version to check.
         tools: [ composer ]
-
+        scoper: [ true, false ]
     services:
       mysql:
         image: mysql:8.0
@@ -31,7 +31,7 @@ jobs:
           MYSQL_AUTHENTICATION_PLUGIN: mysql_native_password
     name: UnitTest on WordPress ${{ matrix.wp }} in PHP ${{ matrix.php }}
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
 
       - name: Setup PHP with composer v2
         uses: shivammathur/setup-php@v2
@@ -47,12 +47,20 @@ jobs:
       - name: Install dependencies
         run: composer install --prefer-dist --no-progress --no-suggest
 
+      - uses: ./.github/actions/php-scoper
+        name: Do PHP Scoper if possible
+        with:
+          scoper: ${{ matrix.scoper }}
+
+      - name: Make Binaries Executionable
+        if: matrix.scoper
+        run: chmod +x vendor-prefixed/vendor/bin/*
+
       - name: Start MySQL
         run: |
           sudo systemctl start mysql
           mysql -h 127.0.0.1 --port 3306 -u root --password=root -e "ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'root';"
 
-
       - name: Install WordPress
         run: bash bin/install-wp-tests.sh wordpress root root 127.0.0.1:3306 ${{ matrix.wp }}
 
@@ -66,7 +74,7 @@ jobs:
     name: Check Assets
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
 
       - name: Install Node
         uses: actions/setup-node@v3
@@ -93,7 +101,7 @@ jobs:
     if: contains(github.ref, 'tags/')
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v3
 
       - name: Setup PHP with composer v2
         uses: shivammathur/setup-php@v2
@@ -103,15 +111,13 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Build Package.
+      - name: Build Package
         run: bash bin/build.sh
 
-      - name: Do PHP scoper
-        run: |
-          composer global require humbug/php-scoper
-            ~/.composer/vendor/bin/php-scoper add-prefix --output-dir=vendor-prefixed --force
-          composer dump-autoload --working-dir vendor-prefixed --classmap-authoritative
-          composer help-scoper
+      - uses: ./.github/actions/php-scoper
+        name: Do PHP Scoper
+        with:
+          scoper: true
 
       - name: Clean Unwanted files
         run: bash bin/clean.sh

composer.json

@@ -14,15 +14,20 @@
 		"test": "phpunit",
 		"lint": "phpcs --standard=phpcs.ruleset.xml $(find ./ -name '*.php')",
 		"fix": "phpcbf --standard=phpcs.ruleset.xml $(find ./ -name '*.php')",
-		"scoper": "php-scoper",
-		"prefix": [
-			"composer install --no-dev",
+		"scoper": [
 			"php-scoper add-prefix --output-dir=vendor-prefixed --force",
 			"composer dump-autoload --working-dir vendor-prefixed --classmap-authoritative",
-			"composer install",
-			"@help-scoper"
+			"@scoper-patch"
+		],
+		"scoper-patch": [
+			"php bin/patcher.php",
+			"chmod +x vendor-prefixed/vendor/bin/*"
 		],
-		"help-scoper": "php bin/patcher.php"
+		"prefix": [
+			"composer install --no-dev",
+			"@scoper",
+			"composer install"
+		]
 	},
 	"require": {
 		"php": ">=7.2",

package.json

@@ -9,6 +9,7 @@
 		"update": "wp-env start --update",
 		"stop": "wp-env stop",
 		"test": "wp-env run tests-cli ./wp-content/plugins/ga-communicator/vendor/bin/phpunit -c ./wp-content/plugins/ga-communicator/phpunit.xml.dist",
+		"test:scoper": "wp-env run tests-cli ./wp-content/plugins/ga-communicator/vendor-prefixed/vendor/bin/phpunit -c ./wp-content/plugins/ga-communicator/phpunit.xml.dist",
 		"env": "wp-env",
 		"cli": "wp-env run cli wp",
 		"cli:test": "wp-env run tests-cli wp",

scoper.inc.php

@@ -36,14 +36,6 @@
 		] ),
 	],
 
-	// List of excluded files, i.e. files for which the content will be left untouched.
-	// Paths are relative to the configuration file unless if they are already absolute
-	//
-	// For more see: https://github.com/humbug/php-scoper/blob/master/docs/configuration.md#patchers
-	'exclude-files'           => [
-		'src/a-whitelisted-file.php',
-	],
-
 	// When scoping PHP files, there will be scenarios where some of the code being scoped indirectly references the
 	// original namespace. These will include, for example, strings or string manipulations. PHP-Scoper has limited
 	// support for prefixing such strings. To circumvent that, you can define patchers to manipulate the file to your
@@ -60,14 +52,25 @@ static function ( string $filePath, string $prefix, string $contents ): string {
 
 	// For more information see: https://github.com/humbug/php-scoper/blob/master/docs/configuration.md#excluded-symbols
 	'exclude-namespaces'      => [
+		'/^cli/',
+		'/^Composer/',
+		'/^DeepCopy/',
+		'/^Doctrine/',
 		'/^Kunoichi/',
+		'/^PharIo/',
+		'/^PHP_CodeSniffer/',
+		'/^PHPCompatibility/',
+		'/^PHPCSStandards/',
+		'/^PHPUnit/',
+		'/^Yoast/',
+		'/^SebastianBergmann/',
+		'/^TheSeer/',
 		'/^WP_/',
-		'/^Composer/',
-		'/^cli/'
 	],
 	'exclude-classes'         => [
 		'/^WP_/',
-		'/^Composer/'
+		'/^Composer/',
+		'/^PHPUnit/',
 	],
 	'exclude-functions'       => [
 		// 'mb_str_split',
@@ -80,7 +83,7 @@ static function ( string $filePath, string $prefix, string $contents ): string {
 	//
 	// For more information see: https://github.com/humbug/php-scoper/blob/master/docs/configuration.md#exposed-symbols
 	'expose-global-constants' => true,
-	'expose-global-classes'   => true,
+	'expose-global-classes'   => false,
 	'expose-global-functions' => false,
 	'expose-namespaces'       => [
 	],

tests/bootstrap.php

@@ -19,7 +19,13 @@
 // Give access to tests_add_filter() function.
 require_once $_tests_dir . '/includes/functions.php';
 
-require_once dirname( __DIR__ ) . '/vendor/autoload.php';
+/**
+ * Manually load the plugin being tested.
+ */
+function _manually_load_plugin() {
+	require dirname( dirname( __FILE__ ) ) . '/ga-communicator.php';
+}
+tests_add_filter( 'muplugins_loaded', '_manually_load_plugin' );
 
 // Start up the WP testing environment.
 require $_tests_dir . '/includes/bootstrap.php';