Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes Validator Testcase #1437

Merged
merged 16 commits into from
Jul 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Resources/translations/validators.de.xliff
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
Bitte wählen Sie eine übergeordnete Seite.
</target>
</trans-unit>
<trans-unit id="error.uniq_url.no_site" resname="error.uniq_url.no_site">
<source>error.uniq_url.no_site</source>
<target>Der Seite ist muss eine Webseite zugeordnet sein.</target>
</trans-unit>
</body>
</file>
</xliff>
4 changes: 4 additions & 0 deletions src/Resources/translations/validators.en.xliff
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
<target>The root URL '/' is already associated with another page of this site, please select a parent.
</target>
</trans-unit>
<trans-unit id="error.uniq_url.no_site" resname="error.uniq_url.no_site">
<source>error.uniq_url.no_site</source>
<target>A website must be assigned to the page.</target>
</trans-unit>
</body>
</file>
</xliff>
4 changes: 4 additions & 0 deletions src/Resources/translations/validators.fr.xliff
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@
<target>L'URL racine '/' est déjà associée à une autre page de ce site, veuillez sélectionner
un parent.</target>
</trans-unit>
<trans-unit id="error.uniq_url.no_site" resname="error.uniq_url.no_site">
<source>error.uniq_url.no_site</source>
<target>Un site Web doit être attribué à la page.</target>
</trans-unit>
</body>
</file>
</xliff>
26 changes: 16 additions & 10 deletions src/Validator/UniqueUrlValidator.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,13 @@

use Sonata\PageBundle\Model\PageInterface;
use Sonata\PageBundle\Model\PageManagerInterface;
use Sonata\PageBundle\Model\SiteInterface;
use Sonata\PageBundle\Validator\Constraints\UniqueUrl;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;
use Symfony\Component\Validator\Exception\UnexpectedValueException;

/**
* @final since sonata-project/page-bundle 3.26
*/
class UniqueUrlValidator extends ConstraintValidator
final class UniqueUrlValidator extends ConstraintValidator
{
/**
* @var PageManagerInterface
Expand All @@ -36,14 +35,21 @@ public function __construct(PageManagerInterface $manager)

public function validate($value, Constraint $constraint): void
{
if (!$value instanceof PageInterface) {
$this->context->addViolation('The page is not valid, expected a PageInterface');

if (!$constraint instanceof UniqueUrl) {
throw new UnexpectedTypeException($constraint, UniqueUrl::class);
}
// do not validate on null, use NotNull instead
if (null === $value) {
return;
}
if (!$value instanceof PageInterface) {
throw new UnexpectedValueException($value, PageInterface::class);
}

if (!$value->getSite() instanceof SiteInterface) {
$this->context->addViolation('The page is not linked to a Site');
if (null === $value->getSite()) {
$this->context->buildViolation('error.uniq_url.no_site')
->atPath('site')
->addViolation();

return;
}
Expand Down
110 changes: 54 additions & 56 deletions tests/Validator/UniqueUrlValidatorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,43 @@

namespace Sonata\PageBundle\Tests\Validator;

use PHPUnit\Framework\TestCase;
use Sonata\PageBundle\Model\PageInterface;
use Sonata\PageBundle\Model\PageManagerInterface;
use Sonata\PageBundle\Model\SiteInterface;
use Sonata\PageBundle\Validator\Constraints\UniqueUrl;
use Sonata\PageBundle\Validator\UniqueUrlValidator;
use Symfony\Component\Translation\TranslatorInterface;
use Symfony\Component\Validator\Context\ExecutionContext;
use Symfony\Component\Validator\Validator\ContextualValidatorInterface;
use Symfony\Component\Validator\Validator\ValidatorInterface;
use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;

final class UniqueUrlValidatorTest extends TestCase
final class UniqueUrlValidatorTest extends ConstraintValidatorTestCase
{
/**
* @var PageManagerInterface
*/
protected $manager;

protected function setUp(): void
{
$this->manager = $this->createMock(PageManagerInterface::class);

parent::setUp();
}

public function testValidateWithoutSite(): void
{
$page = $this->createMock(PageInterface::class);
$page->expects(static::exactly(1))->method('getSite')->willReturn(null);
$page->expects(static::never())->method('isError');

$this->manager->expects(static::never())->method('fixUrl');
$this->manager->expects(static::never())->method('findBy');

$this->validator->validate($page, new UniqueUrl());

$this->buildViolation('error.uniq_url.no_site')
->atPath($this->propertyPath.'.site')
->assertRaised();
}

/**
* @group legacy
*/
Expand All @@ -37,40 +61,36 @@ public function testValidateWithNoPageFound(): void
$page->expects(static::exactly(2))->method('getSite')->willReturn($site);
$page->expects(static::exactly(2))->method('isError')->willReturn(false);

$manager = $this->createMock(PageManagerInterface::class);
$manager->expects(static::once())->method('fixUrl');
$manager->expects(static::once())->method('findBy')->willReturn([$page]);

$context = $this->getContext();
$this->manager->expects(static::once())->method('fixUrl');
$this->manager->expects(static::once())->method('findBy')->willReturn([$page]);

$validator = new UniqueUrlValidator($manager);
$validator->initialize($context);
$this->validator->validate($page, new UniqueUrl());

$validator->validate($page, new UniqueUrl());
$this->assertNoViolation();
}

public function testValidateWithPageFound(): void
{
$url = '/salut';
$site = $this->createMock(SiteInterface::class);

$page = $this->createMock(PageInterface::class);
$page->expects(static::exactly(2))->method('getSite')->willReturn($site);
$page->expects(static::exactly(2))->method('isError')->willReturn(false);
$page->method('getUrl')->willReturn('/salut');
$page->method('getUrl')->willReturn($url);

$pageFound = $this->createMock(PageInterface::class);
$pageFound->method('getUrl')->willReturn('/salut');

$manager = $this->createMock(PageManagerInterface::class);
$manager->expects(static::once())->method('fixUrl');
$manager->expects(static::once())->method('findBy')->willReturn([$page, $pageFound]);
$pageFound->method('getUrl')->willReturn($url);

$context = $this->getContext();
$this->manager->expects(static::once())->method('fixUrl');
$this->manager->expects(static::once())->method('findBy')->willReturn([$page, $pageFound]);

$validator = new UniqueUrlValidator($manager);
$validator->initialize($context);
$this->validator->validate($page, new UniqueUrl());

$validator->validate($page, new UniqueUrl());
$this->buildViolation('error.uniq_url')
->setParameter('%url%', $url)
->atPath($this->propertyPath.'.url')
->assertRaised();
}

public function testValidateWithRootUrlAndNoParent(): void
Expand All @@ -86,16 +106,14 @@ public function testValidateWithRootUrlAndNoParent(): void
$pageFound = $this->createMock(PageInterface::class);
$pageFound->method('getUrl')->willReturn('/');

$manager = $this->createMock(PageManagerInterface::class);
$manager->expects(static::once())->method('fixUrl');
$manager->expects(static::once())->method('findBy')->willReturn([$page, $pageFound]);

$context = $this->getContext();
$this->manager->expects(static::once())->method('fixUrl');
$this->manager->expects(static::once())->method('findBy')->willReturn([$page, $pageFound]);

$validator = new UniqueUrlValidator($manager);
$validator->initialize($context);
$this->validator->validate($page, new UniqueUrl());

$validator->validate($page, new UniqueUrl());
$this->buildViolation('error.uniq_url.parent_unselect')
->atPath($this->propertyPath.'.parent')
->assertRaised();
}

public function testValidateWithPageDynamic(): void
Expand All @@ -108,32 +126,12 @@ public function testValidateWithPageDynamic(): void
$page->expects(static::once())->method('isDynamic')->willReturn(true);
$page->method('getUrl')->willReturn('/salut');

$manager = $this->createMock(PageManagerInterface::class);

$context = $this->getContext();

$validator = new UniqueUrlValidator($manager);
$validator->initialize($context);

$validator->validate($page, new UniqueUrl());
$this->validator->validate($page, new UniqueUrl());
$this->assertNoViolation();
}

private function getContext(): ExecutionContext
protected function createValidator(): UniqueUrlValidator
{
$translator = $this->createMock(TranslatorInterface::class);
$validator = $this->createMock(ValidatorInterface::class);
$contextualValidator = $this->createMock(ContextualValidatorInterface::class);

$context = new ExecutionContext($validator, 'root', $translator);

$context->setGroup('MyGroup');
$context->setNode('InvalidValue', null, null, 'property.path');
$context->setConstraint(new UniqueUrl());
$validator
->method('inContext')
->with($context)
->willReturn($contextualValidator);

return $context;
return new UniqueUrlValidator($this->manager);
}
}