feature #45624 [Config] Allow using environment variables in EnumNode (ecourtial)

fabpot · fabpot · commit c7dbcc954366 · 2022-03-09T08:23:33.000+01:00
This PR was squashed before being merged into the 6.1 branch. Discussion ---------- [Config] Allow using environment variables in `EnumNode` | Q | A | ------------- | --- | Branch? | 6.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | | License | MIT | Doc PR | In the _EnumNode_ of the _Config_ component, we see that it does not allow the use of a placeholder: https://github.com/symfony/symfony/blob/5fbd0dc062443d1c5050081a7eba23ef47ba2a25/src/Symfony/Component/Config/Definition/EnumNode.php#L63 This is strange, because we could have some use cases where we would like to be able to define the value with a env variable. A good example is the samesite policy for the session cookie : https://symfony.com/blog/new-in-symfony-4-2-samesite-cookie-configuration. Note: I have not submitted any documentation update so far, I am not even sure it is a "new" feature. Commits ------- 726bc28 [Config] Allow using environment variables in `EnumNode`
diff --git a/src/Symfony/Component/Config/CHANGELOG.md b/src/Symfony/Component/Config/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.1
+---
+
+ * Allow using environment variables in `EnumNode`
+
 6.0
 ---
 
diff --git a/src/Symfony/Component/Config/Definition/EnumNode.php b/src/Symfony/Component/Config/Definition/EnumNode.php
@@ -54,12 +54,4 @@ protected function finalizeValue(mixed $value): mixed
 
         return $value;
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    protected function allowPlaceholders(): bool
-    {
-        return false;
-    }
 }
diff --git a/src/Symfony/Component/Config/Tests/Definition/EnumNodeTest.php b/src/Symfony/Component/Config/Tests/Definition/EnumNodeTest.php
@@ -55,4 +55,20 @@ public function testFinalizeWithInvalidValue()
         $node = new EnumNode('foo', null, ['foo', 'bar']);
         $node->finalize('foobar');
     }
+
+    public function testWithPlaceHolderWithValidValue()
+    {
+        $node = new EnumNode('cookie_samesite', null, ['lax', 'strict', 'none']);
+        EnumNode::setPlaceholder('custom', ['string' => 'lax']);
+        $this->assertSame('custom', $node->finalize('custom'));
+    }
+
+    public function testWithPlaceHolderWithInvalidValue()
+    {
+        $node = new EnumNode('cookie_samesite', null, ['lax', 'strict', 'none']);
+        EnumNode::setPlaceholder('custom', ['string' => 'foo']);
+        $this->expectException(InvalidConfigurationException::class);
+        $this->expectExceptionMessage('The value "foo" is not allowed for path "cookie_samesite". Permissible values: "lax", "strict", "none"');
+        $node->finalize('custom');
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -54,12 +54,4 @@ protected function finalizeValue(mixed $value): mixed`
`54`	`54`
`55`	`55`	`return $value;`
`56`	`56`	`}`
`57`		`-`
`58`		`- /**`
`59`		`- * {@inheritdoc}`
`60`		`- */`
`61`		`- protected function allowPlaceholders(): bool`
`62`		`- {`
`63`		`- return false;`
`64`		`- }`
`65`	`57`	`}`