WIP WordPress test

dimitriBouteille · Mar 12, 2024 · 1e17256 · 1e17256
1 parent f294c56
commit 1e17256
Show file tree

Hide file tree

Showing 6 changed files with 100 additions and 23 deletions.
diff --git a/config/scripts/install-wp-tests.sh b/config/scripts/install-wp-tests.sh
@@ -26,11 +26,11 @@ WP_TESTS_DIR=${WP_TESTS_DIR-$TMPDIR/wordpress-tests-lib}
 WP_CORE_DIR=${WP_CORE_DIR-$TMPDIR/wordpress}
 
 download() {
-    if [ `which curl` ]; then
-        curl -s "$1" > "$2";
-    elif [ `which wget` ]; then
-        wget -nv -O "$2" "$1"
-    fi
+	if [ `which curl` ]; then
+		curl -s "$1" > "$2";
+	elif [ `which wget` ]; then
+		wget -nv -O "$2" "$1"
+	fi
 }
 
 if [[ $WP_VERSION =~ ^[0-9]+\.[0-9]+\-(beta|RC)[0-9]+$ ]]; then
@@ -186,4 +186,4 @@ install_db() {
 
 install_wp
 install_test_suite
-install_db
+install_db
diff --git a/phpunit-wp.xml b/phpunit-wp.xml
@@ -3,10 +3,10 @@
          cacheResult="false"
          backupGlobals="false"
          stopOnError="false"
-         bootstrap="./tests/Unit/Bootstrap.php"
+         bootstrap="./tests/WordPress/Bootstrap.php"
          processIsolation="true"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
-         cacheDirectory=".phpunit.cache"
+         cacheDirectory="var/cache/phpunit/wordPress"
          backupStaticProperties="false"
          requireCoverageMetadata="true">
     <testsuites>

diff --git a/phpunit.xml b/phpunit.xml
@@ -6,7 +6,7 @@
          bootstrap="./tests/Unit/Bootstrap.php"
          processIsolation="true"
          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
-         cacheDirectory=".phpunit.cache"
+         cacheDirectory="var/cache/phpunit/unit"
          backupStaticProperties="false"
          requireCoverageMetadata="true">
   <testsuites>

diff --git a/tests/Unit/Bootstrap.php b/tests/Unit/Bootstrap.php
@@ -22,15 +22,15 @@ class Bootstrap
 
     public function __construct()
     {
-        $this->wpTestsDir = getenv( 'WP_TESTS_DIR' )
-            ? getenv( 'WP_TESTS_DIR' )
+        $this->wpTestsDir = getenv('WP_TESTS_DIR')
+            ? getenv('WP_TESTS_DIR')
             : sys_get_temp_dir() . '/wordpress-tests-lib';
 
         /**
          * Load PHPUnit Polyfills for the WP testing suite.
          * @see https://github.com/WordPress/wordpress-develop/pull/1563/
          */
-        define( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH', __DIR__ . '/../../vendor/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php' );
+        define('WP_TESTS_PHPUNIT_POLYFILLS_PATH', __DIR__ . '/../../vendor/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php');
 
         /**
          * Load the WP testing environment.

diff --git a/tests/WordPress/Bootstrap.php b/tests/WordPress/Bootstrap.php
@@ -12,31 +12,102 @@ class Bootstrap
 {
     private static ?self $instance = null;
 
-    protected string $wpDirectory = '';
-
     /**
-     * Directory where wordpress-tests-lib is installed.
-     * @var string
+     * @var string|null
      */
-    protected string $wpTestsDir = '';
+    protected ?string $wpTestsDir = null;
 
     public function __construct()
     {
-        $this->wpTestsDir = getenv( 'WP_TESTS_DIR' )
-            ? getenv( 'WP_TESTS_DIR' )
-            : sys_get_temp_dir() . '/wordpress-tests-lib';
+        $this->wpTestsDir = $this->getPathToWpTestDir();
+        $this->initBoostrap();
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    private function normalizePath(string $path): string
+    {
+        return \str_replace('\\', '/', $path);
+    }
+
+    /**
+     * @return string|null
+     */
+    protected function getPathToWpTestDir(): ?string
+    {
+        if (\getenv('WP_TESTS_DIR') !== false) {
+            $testsDir = \getenv('WP_TESTS_DIR');
+            $testsDir = \realpath($testsDir);
+
+            if ($testsDir !== false) {
+                $testsDir = $this->normalizePath($testsDir) . '/';
+                if (\is_dir($testsDir) === true
+                    && @\file_exists($testsDir . 'includes/bootstrap.php')
+                ) {
+                    return $testsDir;
+                }
+            }
+
+            unset($testsDir);
+        }
+
+        if (\getenv('WP_DEVELOP_DIR') !== false) {
+            $devDir = \getenv('WP_DEVELOP_DIR');
+            $devDir = \realpath($devDir);
+            if ($devDir !== false) {
+                $devDir = $this->normalizePath($devDir) . '/';
+                if (\is_dir($devDir) === true
+                    && @\file_exists($devDir . 'tests/phpunit/includes/bootstrap.php')
+                ) {
+                    return $devDir . 'tests/phpunit/';
+                }
+            }
+
+            unset($devDir);
+        }
+
+        /**
+         * Last resort: see if this is a typical WP-CLI scaffold command set-up where a subset of
+         * the WP test files have been put in the system temp directory.
+         */
+        $testsDir = \sys_get_temp_dir() . '/wordpress-tests-lib';
+        $testsDir = \realpath($testsDir);
+        if ($testsDir !== false) {
+            $testsDir = $this->normalizePath($testsDir) . '/';
+            if (\is_dir($testsDir) === true
+                && @\file_exists($testsDir . 'includes/bootstrap.php')
+            ) {
+                return $testsDir;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @return void
+     */
+    protected function initBoostrap(): void
+    {
+        if ($this->wpTestsDir === null) {
+            echo \PHP_EOL, 'ERROR: The WordPress native unit test bootstrap file could not be found. Please set either the WP_TESTS_DIR or the WP_DEVELOP_DIR environment variable, either in your OS or in a custom phpunit.xml file.', \PHP_EOL;
+            exit(1);
+        }
 
         /**
          * Load PHPUnit Polyfills for the WP testing suite.
          * @see https://github.com/WordPress/wordpress-develop/pull/1563/
+         * @todo Maybe check if composer installed
          */
-        define( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH', __DIR__ . '/vendor/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php');
+        require_once __DIR__ . '/vendor/yoast/phpunit-polyfills/phpunitpolyfills-autoload.php';
 
         /**
+         * We can safely load the bootstrap - already verifies it exists.
          * Load the WP testing environment.
          */
-        require_once $this->wpTestsDir . '/includes/bootstrap.php';
-
+        require_once sprintf('%s/includes/bootstrap.php', rtrim($this->wpTestsDir, '/'));
     }
 
     /**

diff --git a/tests/WordPress/DatabaseTest.php b/tests/WordPress/DatabaseTest.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Copyright (c) 2024 Dimitri BOUTEILLE (https://github.com/dimitriBouteille)
+ * See LICENSE.txt for license details.
+ *
+ * Author: Dimitri BOUTEILLE <[email protected]>
+ */
 
 namespace Dbout\WpOrm\Tests\WordPress;