bug #50301 [FrameworkBundle] Ignore vars from dotenv files in secrets:list (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit eb6a1113cd6d · 2023-05-12T09:42:13.000+02:00
This PR was merged into the 6.3 branch. Discussion ---------- [FrameworkBundle] Ignore vars from dotenv files in secrets:list | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | - | License | MIT | Doc PR | - Sidekick of #48705 Commits ------- 8561045 [FrameworkBundle] Ignore vars from dotenv files in secrets:list
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])) {
+            if (isset($rows[$name]) && !\in_array($value, ['', false, null], true)) {
                 $rows[$name][] = $dump($value);
             }
         }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/SecretsListCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/SecretsListCommandTest.php
@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Command;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\Command\SecretsListCommand;
+use Symfony\Bundle\FrameworkBundle\Secrets\AbstractVault;
+use Symfony\Component\Console\Tester\CommandTester;
+
+class SecretsListCommandTest extends TestCase
+{
+    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]);
+        $command = new SecretsListCommand($vault, $localVault);
+        $tester = new CommandTester($command);
+        $this->assertSame(0, $tester->execute([]));
+
+        $expectedOutput = <<<EOTXT
+             // Use "%%env(<name>)%%" to reference a secret in a config file.
+
+             // To reveal the secrets run %s secrets:list --reveal
+
+             -------- -------- -------------
+              Secret   Value    Local Value
+             -------- -------- -------------
+              A        "a"
+              B        "b"      "A"
+              C        ******
+              D        ******
+              E        ******
+             -------- -------- -------------
+
+             // Local values override secret values.
+             // Use secrets:set --local to define them.
+            EOTXT;
+        $this->assertStringMatchesFormat($expectedOutput, trim(preg_replace('/ ++$/m', '', $tester->getDisplay(true)), "\n"));
+    }
+}

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])) {`
	`89`	`+ if (isset($rows[$name]) && !\in_array($value, ['', false, null], true)) {`
`90`	`90`	`$rows[$name][] = $dump($value);`
`91`	`91`	`}`
`92`	`92`	`}`