Added some tests (#1)

* added some tests

* Added some readme and fixed tests

Author: Nyholm

Readme.md

@@ -7,3 +7,56 @@
 [![Quality Score](https://img.shields.io/scrutinizer/g/happyr/entity-exists-validation-constraint.svg?style=flat-square)](https://scrutinizer-ci.com/g/happyr/entity-exists-validation-constraint)
 [![Total Downloads](https://img.shields.io/packagist/dt/happyr/entity-exists-validation-constraint.svg?style=flat-square)](https://packagist.org/packages/happyr/entity-exists-validation-constraint)
 
+A small validator that verifies that an Entity actually exists. This is especially useful if you use Symfony Messenger
+component. Now you can safely validate the message and put it on a queue for processing later.
+
+
+```php
+namespace App\Message\Command;
+
+use Happyr\Validator\Constraint\EntityExist;
+use Symfony\Component\Validator\Constraints as Assert;
+
+final class EmailUser
+{
+    /**
+     * @Assert\NotBlank
+     * @Assert\Uuid
+     * @EntityExist(entity="App\Entity\User")
+     *
+     * @var string UUID to user's id property
+     */
+    private $user;
+
+    /**
+     * @Assert\NotBlank
+     * @EntityExist(entity="App\Entity\Other", property="name")
+     *
+     * @var string The name of "Other". We use its "name" property. 
+     */
+    private $other;
+
+    // ...
+```
+
+## Install
+
+```console
+composer require happyr/entity-exists-validation-constraint
+
+```
+
+Then register the services with:
+
+```yaml
+# config/packages/happyr_entity_exists_validator.yaml
+services:
+  Happyr\Validator\Constraint\EntityExistValidator:
+    arguments: ['@doctrine.orm.entity_manager']
+    tags: [ 'validator.constraint_validator' ]
+```
+
+## Note
+
+The Validator will not produce a violation when value is empty. This means that you should most likely use it in
+combination with `NotBlank`. 

composer.json

@@ -15,7 +15,8 @@
   ],
   "require": {
     "php": "^7.2",
-    "symfony/validator": "^3.4 || ^4.3"
+    "symfony/validator": "^3.4 || ^4.3",
+    "doctrine/orm": "^2.4"
   },
   "require-dev": {
     "symfony/phpunit-bridge": "^4.3"

src/EntityExistValidator.php

@@ -24,16 +24,12 @@ public function __construct(EntityManagerInterface $entityManager)
     public function validate($value, Constraint $constraint): void
     {
         if (!$constraint instanceof EntityExist) {
-            throw new \LengthException(\sprintf(
+            throw new \LogicException(\sprintf(
                 'You can only pass %s constraint to this validator.',
                 EntityExist::class
             ));
         }
 
-        if (empty($value)) {
-            return;
-        }
-
         if (empty($constraint->entity)) {
             throw new \LogicException(\sprintf('Must set "entity" on "%s" validator', EntityExist::class));
         }

tests/EntityExistValidatorTest.php

@@ -0,0 +1,134 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Test\Happyr\Validator\Constraint;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\EntityRepository;
+use Happyr\Validator\Constraint\EntityExist;
+use Happyr\Validator\Constraint\EntityExistValidator;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Validator\Constraints\NotNull;
+use Symfony\Component\Validator\Context\ExecutionContextInterface;
+use Symfony\Component\Validator\Violation\ConstraintViolationBuilderInterface;
+
+class EntityExistValidatorTest extends TestCase
+{
+    /** @var MockObject */
+    private $entityManager;
+
+    /** @var MockObject */
+    private $context;
+
+    /** @var EntityExistValidator */
+    private $validator;
+
+    protected function setUp(): void
+    {
+        $this->entityManager = $this->getMockBuilder(EntityManagerInterface::class)->getMock();
+        $this->context = $this->getMockBuilder(ExecutionContextInterface::class)->getMock();
+
+        $this->validator = new EntityExistValidator($this->entityManager);
+        $this->validator->initialize($this->context);
+    }
+
+    public function testValidateWithWrongConstraint()
+    {
+        $this->expectException(\LogicException::class);
+        $this->validator->validate('foo', new  NotNull());
+    }
+
+    public function testValidateWithNoEntity()
+    {
+        $constraint = new  EntityExist();
+
+        $this->expectException(\LogicException::class);
+        $this->validator->validate('foobar', $constraint);
+    }
+
+    /**
+     * @dataProvider getValidValues
+     */
+    public function testValidateValidEntity($value)
+    {
+        $this->context->expects($this->never())->method('buildViolation');
+        $constraint = new  EntityExist();
+        $constraint->entity = 'App\Entity\User';
+
+        $repository = $this->getMockBuilder(EntityRepository::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $repository
+            ->expects($this->once())
+            ->method('findOneBy')
+            ->with(['id' => $value])
+            ->willReturn('my_user');
+
+        $this->entityManager
+            ->expects($this->once())
+            ->method('getRepository')
+            ->with('App\Entity\User')
+            ->willReturn($repository);
+
+        $this->validator->validate($value, $constraint);
+    }
+
+    public function getValidValues()
+    {
+        yield ['foobar'];
+        yield [''];
+        yield [null];
+    }
+
+    public function testValidateValidEntityWithCustomProperty()
+    {
+        $this->context->expects($this->never())->method('buildViolation');
+        $constraint = new  EntityExist();
+        $constraint->entity = 'App\Entity\User';
+        $constraint->property = 'uuid';
+
+        $repository = $this->getMockBuilder(EntityRepository::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $repository
+            ->expects($this->once())
+            ->method('findOneBy')
+            ->with(['uuid' => 'foobar'])
+            ->willReturn('my_user');
+
+        $this->entityManager
+            ->expects($this->once())
+            ->method('getRepository')
+            ->with('App\Entity\User')
+            ->willReturn($repository);
+
+        $this->validator->validate('foobar', $constraint);
+    }
+
+    public function testValidateInvalidEntity()
+    {
+        $violationBuilder = $this->getMockBuilder(ConstraintViolationBuilderInterface::class)->getMock();
+        $violationBuilder->method('setParameter')->will($this->returnSelf());
+
+        $this->context->expects($this->once())->method('buildViolation')->willReturn($violationBuilder);
+        $constraint = new  EntityExist();
+        $constraint->entity = 'App\Entity\User';
+
+        $repository = $this->getMockBuilder(EntityRepository::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $repository
+            ->expects($this->once())
+            ->method('findOneBy')
+            ->willReturn(null);
+
+        $this->entityManager
+            ->expects($this->once())
+            ->method('getRepository')
+            ->willReturn($repository);
+
+        $this->validator->validate('foobar', $constraint);
+    }
+}