bug #50712 [FrameworkBundle] Fix secrets:list not displaying local vars (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 43c8bdeffdf2 · 2023-06-20T22:46:05.000+02:00
This PR was merged into the 6.3 branch. Discussion ---------- [FrameworkBundle] Fix secrets:list not displaying local vars | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - My patch in #50301 was not correct. Commits ------- a46c659 [FrameworkBundle] Fix secrets:list not displaying local vars
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsListCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsListCommand.php
@@ -86,7 +86,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         foreach ($localSecrets ?? [] as $name => $value) {
-            if (isset($rows[$name]) && !\in_array($value, ['', false, null], true)) {
+            if (isset($rows[$name])) {
                 $rows[$name][] = $dump($value);
             }
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Secrets/DotenvVault.php b/src/Symfony/Bundle/FrameworkBundle/Secrets/DotenvVault.php
@@ -52,9 +52,9 @@ public function reveal(string $name): ?string
     {
         $this->lastMessage = null;
         $this->validateName($name);
-        $v = \is_string($_SERVER[$name] ?? null) && !str_starts_with($name, 'HTTP_') ? $_SERVER[$name] : ($_ENV[$name] ?? null);
+        $v = $_ENV[$name] ?? (str_starts_with($name, 'HTTP_') ? null : ($_SERVER[$name] ?? null));
 
-        if (null === $v) {
+        if ('' === ($v ?? '')) {
             $this->lastMessage = sprintf('Secret "%s" not found in "%s".', $name, $this->getPrettyPath($this->dotenvFile));
 
             return null;
@@ -89,13 +89,13 @@ public function list(bool $reveal = false): array
         $secrets = [];
 
         foreach ($_ENV as $k => $v) {
-            if (preg_match('/^\w+$/D', $k)) {
+            if ('' !== ($v ?? '') && preg_match('/^\w+$/D', $k)) {
                 $secrets[$k] = $reveal ? $v : null;
             }
         }
 
         foreach ($_SERVER as $k => $v) {
-            if (\is_string($v) && preg_match('/^\w+$/D', $k)) {
+            if ('' !== ($v ?? '') && preg_match('/^\w+$/D', $k)) {
                 $secrets[$k] = $reveal ? $v : null;
             }
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/SecretsListCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/SecretsListCommandTest.php
@@ -14,16 +14,22 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\FrameworkBundle\Command\SecretsListCommand;
 use Symfony\Bundle\FrameworkBundle\Secrets\AbstractVault;
+use Symfony\Bundle\FrameworkBundle\Secrets\DotenvVault;
 use Symfony\Component\Console\Tester\CommandTester;
 
 class SecretsListCommandTest extends TestCase
 {
+    /**
+     * @backupGlobals enabled
+     */
     public function testExecute()
     {
         $vault = $this->createMock(AbstractVault::class);
         $vault->method('list')->willReturn(['A' => 'a', 'B' => 'b', 'C' => null, 'D' => null, 'E' => null]);
-        $localVault = $this->createMock(AbstractVault::class);
-        $localVault->method('list')->willReturn(['A' => '', 'B' => 'A', 'C' => '', 'D' => false, 'E' => null]);
+
+        $_ENV = ['A' => '', 'B' => 'A', 'C' => '', 'D' => false, 'E' => null];
+        $localVault = new DotenvVault('/not/a/path');
+
         $command = new SecretsListCommand($vault, $localVault);
         $tester = new CommandTester($command);
         $this->assertSame(0, $tester->execute([]));
@@ -37,9 +43,9 @@ public function testExecute()
               Secret   Value    Local Value
              -------- -------- -------------
               A        "a"
-              B        "b"      "A"
+              B        "b"      ******
               C        ******
-              D        ******
+              D        ******   ******
               E        ******
              -------- -------- -------------
 

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`foreach ($localSecrets ?? [] as $name => $value) {`
`89`		`- if (isset($rows[$name]) && !\in_array($value, ['', false, null], true)) {`
	`89`	`+ if (isset($rows[$name])) {`
`90`	`90`	`$rows[$name][] = $dump($value);`
`91`	`91`	`}`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,9 +52,9 @@ public function reveal(string $name): ?string`
`52`	`52`	`{`
`53`	`53`	`$this->lastMessage = null;`
`54`	`54`	`$this->validateName($name);`
`55`		`- $v = \is_string($_SERVER[$name] ?? null) && !str_starts_with($name, 'HTTP_') ? $_SERVER[$name] : ($_ENV[$name] ?? null);`
	`55`	`+ $v = $_ENV[$name] ?? (str_starts_with($name, 'HTTP_') ? null : ($_SERVER[$name] ?? null));`
`56`	`56`
`57`		`- if (null === $v) {`
	`57`	`+ if ('' === ($v ?? '')) {`
`58`	`58`	`$this->lastMessage = sprintf('Secret "%s" not found in "%s".', $name, $this->getPrettyPath($this->dotenvFile));`
`59`	`59`
`60`	`60`	`return null;`
`@@ -89,13 +89,13 @@ public function list(bool $reveal = false): array`
`89`	`89`	`$secrets = [];`
`90`	`90`
`91`	`91`	`foreach ($_ENV as $k => $v) {`
`92`		`- if (preg_match('/^\w+$/D', $k)) {`
	`92`	`+ if ('' !== ($v ?? '') && preg_match('/^\w+$/D', $k)) {`
`93`	`93`	`$secrets[$k] = $reveal ? $v : null;`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`foreach ($_SERVER as $k => $v) {`
`98`		`- if (\is_string($v) && preg_match('/^\w+$/D', $k)) {`
	`98`	`+ if ('' !== ($v ?? '') && preg_match('/^\w+$/D', $k)) {`
`99`	`99`	`$secrets[$k] = $reveal ? $v : null;`
`100`	`100`	`}`
`101`	`101`	`}`