Cover validator and form with unit tests

Author: karser

Tests/Form/Recaptcha3TypeTest.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types=1);
+
+namespace Karser\Recaptcha3Bundle\Tests\Form;
+
+use Karser\Recaptcha3Bundle\Form\Recaptcha3Type;
+use Symfony\Component\Form\PreloadedExtension;
+use Symfony\Component\Form\Test\TypeTestCase;
+
+class Recaptcha3TypeTest extends TypeTestCase
+{
+    const SITEKEY = '<sitekey>';
+
+    protected function getExtensions()
+    {
+        $type = new Recaptcha3Type(self::SITEKEY, $enabled = true);
+
+        return [
+            new PreloadedExtension([$type], []),
+        ];
+    }
+
+    public function testDefaultOptions()
+    {
+        $data = '<captcha-token>';
+
+        $form = $this->factory->create(Recaptcha3Type::class);
+        $form->setData($data);
+
+        $this->assertTrue($form->isSynchronized());
+        $this->assertEquals($data, $form->getData());
+
+        $view = $form->createView();
+        $this->assertSame(self::SITEKEY, $view->vars['site_key']);
+        $this->assertSame('homepage', $view->vars['action_name']);
+        $this->assertTrue($view->vars['enabled']);
+    }
+}

Tests/Validator/Constraints/Recaptcha3ValidatorTest.php

@@ -0,0 +1,78 @@
+<?php declare(strict_types=1);
+
+namespace Karser\Recaptcha3Bundle\Tests\Validator\Constraints;
+
+use Karser\Recaptcha3Bundle\Services\IpResolverInterface;
+use Karser\Recaptcha3Bundle\Tests\fixtures\RecaptchaMock;
+use Karser\Recaptcha3Bundle\Validator\Constraints\Recaptcha3;
+use Karser\Recaptcha3Bundle\Validator\Constraints\Recaptcha3Validator;
+use PHPUnit\Framework\MockObject\MockObject;
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+class Recaptcha3ValidatorTest extends ConstraintValidatorTestCase
+{
+    /** @var IpResolverInterface|MockObject */
+    private $resolver;
+    /** @var RecaptchaMock */
+    private $recaptcha;
+
+    public function setUp()
+    {
+        $this->resolver = $this->getMockBuilder(IpResolverInterface::class)->getMock();
+        parent::setUp();
+    }
+
+    protected function createValidator()
+    {
+        $this->recaptcha = new RecaptchaMock();
+        return new Recaptcha3Validator($this->recaptcha, $enabled = true, $this->resolver);
+    }
+
+    public function testNullIsValid()
+    {
+        $this->validator->validate(null, new Recaptcha3());
+        $this->assertNoViolation();
+    }
+
+    public function testEmptyStringIsValid()
+    {
+        $this->validator->validate('', new Recaptcha3());
+        $this->assertNoViolation();
+    }
+
+    public function testValidIfNotEnabled()
+    {
+        $validator = new Recaptcha3Validator($this->recaptcha, $enabled = false, $this->resolver);
+        $this->recaptcha->nextSuccess = false;
+
+        $validator->validate('test', new Recaptcha3());
+        $this->assertNoViolation();
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\UnexpectedTypeException
+     */
+    public function testExpectsStringCompatibleType()
+    {
+        $this->validator->validate(new \stdClass(), new Recaptcha3());
+    }
+
+    public function testValidCase()
+    {
+        $this->recaptcha->nextSuccess = true;
+        $this->validator->validate('test', new Recaptcha3());
+        $this->assertNoViolation();
+    }
+
+    public function testInvalidCase()
+    {
+        $testToken = 'test-token';
+        $this->recaptcha->nextSuccess = false;
+        $this->validator->validate($testToken, new Recaptcha3(['message' => 'myMessage']));
+
+        $this->buildViolation('myMessage')
+            ->setParameter('{{ value }}', '"'.$testToken.'"')
+            ->setCode(Recaptcha3::INVALID_FORMAT_ERROR)
+            ->assertRaised();
+    }
+}

Validator/Constraints/Recaptcha3.php

@@ -9,5 +9,7 @@
  */
 final class Recaptcha3 extends Constraint
 {
+    const INVALID_FORMAT_ERROR = '7147ffdb-0af4-4f7a-bd5e-e9dcfa6d7a2d';
+
     public $message = 'Your computer or network may be sending automated queries';
 }

Validator/Constraints/Recaptcha3Validator.php

@@ -31,6 +31,12 @@ public function validate($value, Constraint $constraint): void
         if (!$constraint instanceof Recaptcha3) {
             throw new UnexpectedTypeException($constraint, Recaptcha3::class);
         }
+        if (null === $value || '' === $value) {
+            return;
+        }
+        if (!is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {
+            throw new UnexpectedTypeException($value, 'string');
+        }
 
         if (!$this->enabled) {
             return;
@@ -40,7 +46,10 @@ public function validate($value, Constraint $constraint): void
 
         $response = $this->recaptcha->verify($value, $ip);
         if (!$response->isSuccess()) {
-            $this->context->addViolation($constraint->message);
+            $this->context->buildViolation($constraint->message)
+                ->setParameter('{{ value }}', $this->formatValue($value))
+                ->setCode(Recaptcha3::INVALID_FORMAT_ERROR)
+                ->addViolation();
         }
     }
 }