Add WpTestsStarter::addLivePlugin() #10

Author: dnaber-de

src/WpTestsStarter.php

@@ -15,6 +15,11 @@ class WpTestsStarter
 
     private DbUrlParser $dbUrlParser;
 
+    /**
+     * @var callable[]
+     */
+    private static $livePlugins = [];
+
     /**
      * @var callable[]
      */
@@ -56,6 +61,7 @@ public function bootstrap()
         $this->defineConstants();
         $this->declareGlobals();
         $this->writeConfigFile();
+        $this->installLivePlugin();
 
         $wpBoostrapFile = $this->baseDir . '/tests/phpunit/includes/bootstrap.php';
         require_once $wpBoostrapFile;
@@ -188,11 +194,63 @@ public function addActivePlugin(string $plugin): self
         return $this;
     }
 
+    public function addLivePlugin(callable $plugin): self
+    {
+        self::$livePlugins[] = $plugin;
+
+        return $this;
+    }
+
     public function useTablePrefix(string $prefix): self
     {
         return $this->useGlobalVar('table_prefix', $prefix);
     }
 
+    public static function runLivePlugins(): void
+    {
+        foreach(self::$livePlugins as $livePlugin) {
+            $livePlugin();
+        }
+    }
+
+    private function installLivePlugin(): void
+    {
+        if(!self::$livePlugins) {
+            return;
+        }
+
+        $pluginCode = <<<'PHP'
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Plugin Name: Wp Tests Starter live plugin
+ */
+namespace Inpsyde\WpTestsStarter;
+
+if (!class_exists(\Inpsyde\WpTestsStarter\WpTestsStarter::class)) {
+    return;
+}
+
+add_action(
+    'muplugins_loaded',
+    [\Inpsyde\WpTestsStarter\WpTestsStarter::class, 'runLivePlugins']
+);
+PHP;
+
+        $muPluginDir = $this->muPluginDir();
+        if(!is_dir($muPluginDir)) {
+            mkdir($muPluginDir, 0755, true);
+        }
+
+        $pluginFile = $muPluginDir . '/wp-tests-starter-live-plugin.php';
+        file_put_contents(
+            $pluginFile,
+            $pluginCode
+        );
+    }
+
     private function defineConstants(): void
     {
         foreach ($this->constants as $constant => $value) {
@@ -232,6 +290,27 @@ private function generateSalts()
         }
     }
 
+    private function muPluginDir(): ?string
+    {
+        if(defined('WPMU_PLUGIN_DIR')) {
+            return (string) WPMU_PLUGIN_DIR;
+        }
+
+        if(array_key_exists('WPMU_PLUGIN_DIR', $this->constants)) {
+            return (string) $this->constants['WPMU_PLUGIN_DIR'];
+        }
+
+        if(defined('WP_CONTENT_DIR')) {
+            return WP_CONTENT_DIR . '/mu-plugins';
+        }
+
+        if(array_key_exists('WP_CONTENT_DIR', $this->constants)) {
+            return $this->constants['WP_CONTENT_DIR'] . '/mu-plugins';
+        }
+
+        return $this->baseDir . '/src/wp-content/mu-plugins';
+    }
+
     private function writeConfigFile()
     {
         $configFile = $this->getConfigFile();

tests/WpIntegration/WpTestsStarterTest.php

@@ -30,6 +30,9 @@ public function testBootstrap(): void
         );
         $testee->useWpPluginDir(self::$pluginDir)
             ->addActivePlugin(self::$testPlugin)
+            ->addLivePlugin(static function(): void {
+                defined('WPTS_LIVE_PLUGIN_RUN') or define('WPTS_LIVE_PLUGIN_RUN', true);
+            })
             ->bootstrap();
 
         // test if the environment is available
@@ -41,6 +44,7 @@ class_exists(\WP_UnitTestCase::class),
         $this->wpDbAssertions();
         $this->installedAssertions();
         $this->pluginAssertions();
+        $this->livePluginAssertions();
     }
 
     private function wpDbAssertions(): void
@@ -90,4 +94,14 @@ private function pluginAssertions(): void
             defined('WPTS_TEST_PLUGIN_LOADED')
         );
     }
+
+    private function livePluginAssertions(): void
+    {
+        self::assertFileExists(
+            WPMU_PLUGIN_DIR . '/wp-tests-starter-live-plugin.php'
+        );
+        self::assertTrue(
+            defined('WPTS_LIVE_PLUGIN_RUN')
+        );
+    }
 }