[Maintenance] Add a more flexible way to load bundles (#11)

Author: GSadee

README.md

@@ -41,13 +41,24 @@ This package solves that problem by:
 
     ```dotenv
     DATABASE_URL=mysql://root@127.0.0.1/test_application_%kernel.environment%
-    BUNDLES_TO_ENABLE="Acme\Plugin\AcmePlugin"
     CONFIGS_TO_IMPORT="@AcmePlugin/tests/TestApplication/config/config.yaml"
     ROUTES_TO_IMPORT="@AcmePlugin/config/routes.yaml"
+    TEST_APP_BUNDLES_PATH="tests/TestApplication/config/bundles.php"
+    # Optional: fall back to a semicolon-separated list of bundles
+    BUNDLES_TO_ENABLE="Acme\Plugin\AcmePlugin"
     ```
 
     > 💡 The values provided above are examples and should be adjusted for your plugin.
 
+1. Optionally, return conditionally enabled bundles from `tests/TestApplication/bundles.php`:
+
+    ```php
+    <?php
+
+    return [
+        Acme\\Plugin\\AcmePlugin::class => ['all' => true],
+    ];
+    ```
 
 1. If needed, place plugin-specific configuration files in the `tests/TestApplication/config` directory
    (e.g. `services.yaml`, `routes.yaml`) and load them by env variables.

bin/console

@@ -39,10 +39,6 @@ if ($_SERVER['APP_DEBUG']) {
     }
 }
 
-if (isset($_ENV['BUNDLES_TO_ENABLE'])) {
-    $_SERVER['BUNDLES_TO_ENABLE'] = $_ENV['BUNDLES_TO_ENABLE'];
-}
-
 if (isset($_ENV['CONFIGS_TO_IMPORT'])) {
     $_SERVER['CONFIGS_TO_IMPORT'] = $_ENV['CONFIGS_TO_IMPORT'];
 }
@@ -51,6 +47,13 @@ if (isset($_ENV['ROUTES_TO_IMPORT'])) {
     $_SERVER['ROUTES_TO_IMPORT'] = $_ENV['ROUTES_TO_IMPORT'];
 }
 
+if (isset($_ENV["BUNDLES_TO_ENABLE"])) {
+    $_SERVER["BUNDLES_TO_ENABLE"] = $_ENV["BUNDLES_TO_ENABLE"];
+}
+
+if (isset($_ENV["TEST_APP_BUNDLES_PATH"])) {
+    $_SERVER["TEST_APP_BUNDLES_PATH"] = $_ENV["TEST_APP_BUNDLES_PATH"];
+}
 
 $kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
 $application = new Application($kernel);

src/Kernel.php

@@ -82,28 +82,26 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
                 }
             }
         });
-
     }
+
     public function registerBundles(): iterable
     {
+        $env = $this->getEnvironment();
+
         if (!is_file($bundlesPath = $this->getBundlesPath())) {
             yield new FrameworkBundle();
-
             return;
         }
 
-        $contents = require $bundlesPath;
+        $contents = $this->loadMainBundles($bundlesPath);
+        $additionalBundlesLoaded = $this->loadAdditionalBundlesFromEnv($contents);
 
-        if (isset($_SERVER['BUNDLES_TO_ENABLE'])) {
-            foreach (explode(';', $_SERVER['BUNDLES_TO_ENABLE']) as $bundleClass) {
-                if (class_exists($bundleClass)) {
-                    $contents[$bundleClass] = ['all' => true];
-                }
-            }
+        if (!$additionalBundlesLoaded) {
+            $this->loadBundlesToEnable($contents);
         }
 
         foreach ($contents as $class => $envs) {
-            if ($envs[$this->environment] ?? $envs['all'] ?? false) {
+            if ($envs[$env] ?? $envs['all'] ?? false) {
                 yield new $class();
             }
         }
@@ -139,4 +137,49 @@ public function loadRoutes(LoaderInterface $loader): RouteCollection
 
         return $collection;
     }
+
+    private function loadMainBundles(string $path): array
+    {
+        return require $path;
+    }
+
+    private function loadAdditionalBundlesFromEnv(array &$contents): bool
+    {
+        if (!isset($_SERVER['TEST_APP_BUNDLES_PATH'])) {
+            return false;
+        }
+
+        $relativePath = $_SERVER['TEST_APP_BUNDLES_PATH'];
+        $absolutePath = \dirname($this->getProjectDir(), 3) . '/' . ltrim($relativePath, '/');
+
+        if (!is_file($absolutePath)) {
+            return false;
+        }
+
+        $additionalBundles = require $absolutePath;
+        if (!\is_array($additionalBundles)) {
+            return false;
+        }
+
+        foreach ($additionalBundles as $bundleClass => $envs) {
+            if (\class_exists($bundleClass)) {
+                $contents[$bundleClass] = $envs;
+            }
+        }
+
+        return true;
+    }
+
+    private function loadBundlesToEnable(array &$contents): void
+    {
+        if (!isset($_SERVER['BUNDLES_TO_ENABLE'])) {
+            return;
+        }
+
+        foreach (explode(';', $_SERVER['BUNDLES_TO_ENABLE']) as $bundleClass) {
+            if (\class_exists($bundleClass)) {
+                $contents[$bundleClass] = ['all' => true];
+            }
+        }
+    }
 }