Merge pull request #2107 from cicnavi/feat/returned-config

monkeyiq · web-flow · commit 28555653be20 · 2024-05-28T12:57:06.000+10:00
Add support for returned config array in config files
diff --git a/src/SimpleSAML/Configuration.php b/src/SimpleSAML/Configuration.php
@@ -153,18 +153,23 @@ private static function loadFromFile(string $filename, bool $required): Configur
             ob_start();
             if (interface_exists('Throwable', false)) {
                 try {
-                    require($filename);
+                    $returnedConfig = require($filename);
                 } catch (ParseError $e) {
                     self::$loadedConfigs[$filename] = self::loadFromArray([], '[ARRAY]', 'simplesaml');
                     throw new Error\ConfigurationError($e->getMessage(), $filename, []);
                 }
             } else {
-                require($filename);
+                $returnedConfig = require($filename);
             }
 
             $spurious_output = ob_get_length() > 0;
             ob_end_clean();
 
+            // Check if the config file actually returned an array instead of defining $config variable.
+            if (is_array($returnedConfig)) {
+                $config = $returnedConfig;
+            }
+
             // check that $config exists
             if (!isset($config)) {
                 throw new Error\ConfigurationError(
diff --git a/tests/config/defined_config.php b/tests/config/defined_config.php
@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+$config = [
+    'defined' => 'config',
+];
diff --git a/tests/config/returned_config.php b/tests/config/returned_config.php
@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    'returned' => 'config',
+];
diff --git a/tests/src/SimpleSAML/ConfigurationTest.php b/tests/src/SimpleSAML/ConfigurationTest.php
@@ -1086,6 +1086,26 @@ public function testGetConfigNonexistentFilePreload(): void
     }
 
 
+    public function testCanLoadDefinedConfigFromFile(): void
+    {
+        $testConfigDir = dirname(__FILE__, 3) . DIRECTORY_SEPARATOR . 'config';
+        putenv('SIMPLESAMLPHP_CONFIG_DIR=' .  $testConfigDir);
+
+        $config = Configuration::getConfig('defined_config.php');
+        $this->assertArrayHasKey('defined', $config->toArray());
+    }
+
+
+    public function testCanLoadReturnedConfigFromFile(): void
+    {
+        $testConfigDir = dirname(__FILE__, 3) . DIRECTORY_SEPARATOR . 'config';
+        putenv('SIMPLESAMLPHP_CONFIG_DIR=' .  $testConfigDir);
+
+        $config = Configuration::getConfig('returned_config.php');
+        $this->assertArrayHasKey('returned', $config->toArray());
+    }
+
+
     /**
      * Test that Configuration objects can be initialized from an array.
      *
