[Validator] Upgraded constraints to enable named arguments and attributes

Author: derrabus

Tests/Validator/Constraints/UserPasswordTest.php

@@ -0,0 +1,81 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Core\Tests\Validator\Constraints;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Security\Core\Validator\Constraints\UserPassword;
+use Symfony\Component\Validator\Mapping\ClassMetadata;
+use Symfony\Component\Validator\Mapping\Loader\AnnotationLoader;
+
+class UserPasswordTest extends TestCase
+{
+    public function testValidatedByStandardValidator()
+    {
+        $constraint = new UserPassword();
+
+        self::assertSame('security.validator.user_password', $constraint->validatedBy());
+    }
+
+    /**
+     * @dataProvider provideServiceValidatedConstraints
+     */
+    public function testValidatedByService(UserPassword $constraint)
+    {
+        self::assertSame('my_service', $constraint->validatedBy());
+    }
+
+    public function provideServiceValidatedConstraints(): iterable
+    {
+        yield 'Doctrine style' => [new UserPassword(['service' => 'my_service'])];
+
+        if (\PHP_VERSION_ID < 80000) {
+            return;
+        }
+
+        yield 'named arguments' => [eval('return new \Symfony\Component\Security\Core\Validator\Constraints\UserPassword(service: "my_service");')];
+
+        $metadata = new ClassMetadata(UserPasswordDummy::class);
+        self::assertTrue((new AnnotationLoader())->loadClassMetadata($metadata));
+
+        yield 'attribute' => [$metadata->properties['b']->constraints[0]];
+    }
+
+    /**
+     * @requires PHP 8
+     */
+    public function testAttributes()
+    {
+        $metadata = new ClassMetadata(UserPasswordDummy::class);
+        self::assertTrue((new AnnotationLoader())->loadClassMetadata($metadata));
+
+        list($bConstraint) = $metadata->properties['b']->getConstraints();
+        self::assertSame('myMessage', $bConstraint->message);
+        self::assertSame(['Default', 'UserPasswordDummy'], $bConstraint->groups);
+        self::assertNull($bConstraint->payload);
+
+        list($cConstraint) = $metadata->properties['c']->getConstraints();
+        self::assertSame(['my_group'], $cConstraint->groups);
+        self::assertSame('some attached data', $cConstraint->payload);
+    }
+}
+
+class UserPasswordDummy
+{
+    #[UserPassword]
+    private $a;
+
+    #[UserPassword(service: 'my_service', message: 'myMessage')]
+    private $b;
+
+    #[UserPassword(groups: ['my_group'], payload: 'some attached data')]
+    private $c;
+}

Tests/Validator/Constraints/UserPasswordValidatorTest.php

@@ -56,12 +56,11 @@ protected function setUp(): void
         parent::setUp();
     }
 
-    public function testPasswordIsValid()
+    /**
+     * @dataProvider provideConstraints
+     */
+    public function testPasswordIsValid(UserPassword $constraint)
     {
-        $constraint = new UserPassword([
-            'message' => 'myMessage',
-        ]);
-
         $this->encoder->expects($this->once())
             ->method('isPasswordValid')
             ->with(static::PASSWORD, 'secret', static::SALT)
@@ -72,12 +71,11 @@ public function testPasswordIsValid()
         $this->assertNoViolation();
     }
 
-    public function testPasswordIsNotValid()
+    /**
+     * @dataProvider provideConstraints
+     */
+    public function testPasswordIsNotValid(UserPassword $constraint)
     {
-        $constraint = new UserPassword([
-            'message' => 'myMessage',
-        ]);
-
         $this->encoder->expects($this->once())
             ->method('isPasswordValid')
             ->with(static::PASSWORD, 'secret', static::SALT)
@@ -89,6 +87,15 @@ public function testPasswordIsNotValid()
             ->assertRaised();
     }
 
+    public function provideConstraints(): iterable
+    {
+        yield 'Doctrine style' => [new UserPassword(['message' => 'myMessage'])];
+
+        if (\PHP_VERSION_ID >= 80000) {
+            yield 'named arguments' => [eval('return new \Symfony\Component\Security\Core\Validator\Constraints\UserPassword(message: "myMessage");')];
+        }
+    }
+
     /**
      * @dataProvider emptyPasswordData
      */

Validator/Constraints/UserPassword.php

@@ -17,11 +17,20 @@
  * @Annotation
  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  */
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
 class UserPassword extends Constraint
 {
     public $message = 'This value should be the user\'s current password.';
     public $service = 'security.validator.user_password';
 
+    public function __construct(array $options = null, string $message = null, string $service = null, array $groups = null, $payload = null)
+    {
+        parent::__construct($options, $groups, $payload);
+
+        $this->message = $message ?? $this->message;
+        $this->service = $service ?? $this->service;
+    }
+
     /**
      * {@inheritdoc}
      */

composer.json

@@ -28,13 +28,14 @@
         "symfony/expression-language": "^4.4|^5.0",
         "symfony/http-foundation": "^4.4|^5.0",
         "symfony/ldap": "^4.4|^5.0",
-        "symfony/validator": "^4.4|^5.0",
+        "symfony/validator": "^5.2",
         "psr/log": "~1.0"
     },
     "conflict": {
         "symfony/event-dispatcher": "<4.4",
         "symfony/security-guard": "<4.4",
-        "symfony/ldap": "<4.4"
+        "symfony/ldap": "<4.4",
+        "symfony/validator": "<5.2"
     },
     "suggest": {
         "psr/container-implementation": "To instantiate the Security class",