Add quoting and escaping, fix off settings skipped, fix completely wrong diff if multiple .ini loaded

phpunit.xml

@@ -12,8 +12,12 @@
          failOnWarning="true"
          colors="true">
     <testsuites>
-        <testsuite name="default">
-            <directory>tests</directory>
+        <testsuite name="unit">
+            <directory>tests/unit</directory>
+        </testsuite>
+
+        <testsuite name="end-to-end">
+            <directory suffix=".phpt">tests/end-to-end</directory>
         </testsuite>
     </testsuites>
 

src/Runtime.php

@@ -25,7 +25,9 @@
 use function php_ini_loaded_file;
 use function php_ini_scanned_files;
 use function phpversion;
+use function preg_match;
 use function sprintf;
+use function str_replace;
 use function strrpos;
 use function version_compare;
 use function xdebug_info;
@@ -245,8 +247,9 @@ public function hasPCOV(): bool
      */
     public function getCurrentSettings(array $values): array
     {
-        $diff  = [];
-        $files = [];
+        $diff   = [];
+        $files  = [];
+        $config = [];
 
         $file = php_ini_loaded_file();
 
@@ -267,19 +270,36 @@ public function getCurrentSettings(array $values): array
         }
 
         foreach ($files as $ini) {
-            $config = parse_ini_file($ini, true);
+            $parsed = parse_ini_file($ini, true);
 
-            foreach ($values as $value) {
-                $set = ini_get($value);
+            if ($parsed === false) {
+                continue;
+            }
+
+            $config = array_merge($config, $parsed);
+        }
+
+        foreach ($values as $value) {
+            $set = ini_get($value);
 
-                if ($set === false || $set === '') {
-                    continue;
-                }
+            // any empty values must not be skipped
+            // e.g. off as in xdebug.mode=off is reported as empty string
+            if ($set === false) {
+                continue;
+            }
+
+            if (isset($config[$value]) && $set === $config[$value]) {
+                continue;
+            }
 
-                if ((!isset($config[$value]) || ($set !== $config[$value]))) {
-                    $diff[$value] = sprintf('%s=%s', $value, $set);
-                }
+            // https://www.php.net/manual/en/function.parse-ini-file.php
+            // If a value in the ini file contains any non-alphanumeric characters
+            // it needs to be enclosed in double-quotes
+            if (preg_match('/\W/', $set) === 1) {
+                $set = '"' . str_replace(['\\', '"'], ['\\\\', '\\"'], $set) . '"';
             }
+
+            $diff[$value] = sprintf('%s=%s', $value, $set);
         }
 
         return $diff;

tests/end-to-end/_fixture/first.ini

@@ -0,0 +1,2 @@
+display_errors=0
+log_errors=1

tests/end-to-end/_fixture/second.ini

@@ -0,0 +1,2 @@
+display_errors=0
+error_reporting=32767

tests/end-to-end/getCurrentSettings_backslash_escaped.phpt

@@ -0,0 +1,14 @@
+--TEST--
+getCurrentSettings escapes backslashes in values containing special characters
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+ini_set('error_prepend_string', 'a\\b');
+
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings(['error_prepend_string']);
+
+print $result['error_prepend_string'];
+?>
+--EXPECT--
+error_prepend_string="a\\b"

tests/end-to-end/getCurrentSettings_empty_input.phpt

@@ -0,0 +1,13 @@
+--TEST--
+getCurrentSettings returns empty array when no values are passed
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings([]);
+
+var_dump($result);
+?>
+--EXPECT--
+array(0) {
+}

tests/end-to-end/getCurrentSettings_multiple_ini_files.phpt

@@ -0,0 +1,22 @@
+--TEST--
+getCurrentSettings merges multiple INI files and does not produce duplicates
+--ENV--
+PHP_INI_SCAN_DIR={PWD}/_fixture
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+// display_errors is set to 0 in both INI files and the runtime value
+// matches, so it must not appear in the diff
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings([
+    'display_errors',
+    'log_errors',
+    'error_reporting',
+]);
+
+// None of these should appear because runtime values match file values
+var_dump($result);
+?>
+--EXPECT--
+array(0) {
+}

tests/end-to-end/getCurrentSettings_no_runtime_change.phpt

@@ -0,0 +1,13 @@
+--TEST--
+getCurrentSettings returns empty array when setting is not changed at runtime
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings(['display_errors']);
+
+var_dump($result);
+?>
+--EXPECT--
+array(0) {
+}

tests/end-to-end/getCurrentSettings_off_not_skipped.phpt

@@ -0,0 +1,16 @@
+--TEST--
+getCurrentSettings does not skip settings whose runtime value is an empty string
+--INI--
+display_errors=1
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+ini_set('display_errors', '');
+
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings(['display_errors']);
+
+var_dump(isset($result['display_errors']));
+?>
+--EXPECT--
+bool(true)

tests/end-to-end/getCurrentSettings_plain_value_not_quoted.phpt

@@ -0,0 +1,14 @@
+--TEST--
+getCurrentSettings does not quote plain alphanumeric values
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+ini_set('display_errors', '1');
+
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings(['display_errors']);
+
+var_dump($result['display_errors']);
+?>
+--EXPECT--
+string(16) "display_errors=1"

tests/end-to-end/getCurrentSettings_runtime_override.phpt

@@ -0,0 +1,16 @@
+--TEST--
+getCurrentSettings detects setting changed at runtime via ini_set
+--INI--
+display_errors=0
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+ini_set('display_errors', '1');
+
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings(['display_errors']);
+
+var_dump(isset($result['display_errors']));
+?>
+--EXPECT--
+bool(true)

tests/end-to-end/getCurrentSettings_special_chars_escaped.phpt

@@ -0,0 +1,14 @@
+--TEST--
+getCurrentSettings escapes values containing special characters
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+ini_set('error_prepend_string', '<b>"hello"</b>');
+
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings(['error_prepend_string']);
+
+print $result['error_prepend_string'];
+?>
+--EXPECT--
+error_prepend_string="<b>\"hello\"</b>"

tests/end-to-end/getCurrentSettings_unknown_setting.phpt

@@ -0,0 +1,13 @@
+--TEST--
+getCurrentSettings returns empty array for nonexistent setting
+--FILE--
+<?php declare(strict_types=1);
+require __DIR__ . '/../../vendor/autoload.php';
+
+$result = (new SebastianBergmann\Environment\Runtime)->getCurrentSettings(['nonexistent_setting_xyz']);
+
+var_dump($result);
+?>
+--EXPECT--
+array(0) {
+}

tests/RuntimeTest.php → tests/unit/RuntimeTest.php

@@ -14,7 +14,6 @@
 use function assert;
 use function extension_loaded;
 use function in_array;
-use function ini_get;
 use function is_array;
 use function xdebug_info;
 use PHPUnit\Framework\Attributes\CoversClass;
@@ -137,19 +136,9 @@ public function testGetCurrentSettingsReturnsEmptyDiffIfNoValuesArePassed(): voi
         $this->assertSame([], (new Runtime)->getCurrentSettings([]));
     }
 
-    #[RequiresPhpExtension('xdebug')]
-    public function testGetCurrentSettingsReturnsCorrectDiffIfXdebugValuesArePassed(): void
-    {
-        if (ini_get('xdebug.mode') === '') {
-            $this->markTestSkipped('xdebug.mode must not be set to "off"');
-        }
-
-        $this->assertArrayHasKey('xdebug.mode', (new Runtime)->getCurrentSettings(['xdebug.mode']));
-    }
-
     public function testGetCurrentSettingsWillSkipSettingsThatIsNotSet(): void
     {
-        $this->assertSame([], (new Runtime)->getCurrentSettings(['allow_url_include']));
+        $this->assertSame([], (new Runtime)->getCurrentSettings(['foo_nonexistent_setting']));
     }
 
     private function markTestSkippedWhenPcovIsLoaded(): void