validate color (#2072)

tests/Validator/Constraints/HexColorValidatorTest.php

@@ -0,0 +1,97 @@
+<?php
+
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Tests\Validator\Constraints;
+
+use App\Validator\Constraints\HexColor;
+use App\Validator\Constraints\HexColorValidator;
+use Symfony\Component\Validator\Constraints\NotBlank;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+use Symfony\Component\Validator\Test\ConstraintValidatorTestCase;
+
+/**
+ * @covers \App\Validator\Constraints\HexColorValidator
+ */
+class HexColorValidatorTest extends ConstraintValidatorTestCase
+{
+    protected function createValidator()
+    {
+        return new HexColorValidator();
+    }
+
+    public function getValidColors()
+    {
+        yield ['#000'];
+        yield ['#aaa'];
+        yield ['#000000'];
+        yield ['#fff000'];
+        yield ['#000aaa'];
+        yield ['#fffaaa'];
+        yield ['']; // should actually be invalid, but it was allowed in the past :(
+        yield [null];
+    }
+
+    public function testConstraintIsInvalid()
+    {
+        $this->expectException(UnexpectedTypeException::class);
+
+        $this->validator->validate('#000', new NotBlank());
+    }
+
+    /**
+     * @dataProvider getValidColors
+     * @param string $color
+     */
+    public function testConstraintWithValidColor($color)
+    {
+        $constraint = new HexColor();
+        $this->validator->validate($color, $constraint);
+        $this->assertNoViolation();
+    }
+
+    public function getInvalidColors()
+    {
+        yield ['string'];
+        yield ['000'];
+        yield ['aaa'];
+        yield ['000000'];
+        yield ['fff000'];
+        yield ['000aaa'];
+        yield ['fffaaa'];
+        yield ['#f'];
+        yield ['#ff'];
+        yield ['#ffdd'];
+        yield ['#ffddd'];
+        yield ['#ffddddd'];
+        yield [new \stdClass(), 'object'];
+        yield [[], 'array'];
+    }
+
+    /**
+     * @dataProvider getInvalidColors
+     * @param mixed $color
+     */
+    public function testValidationError($color, $parameterType = null)
+    {
+        $constraint = new HexColor();
+
+        $this->validator->validate($color, $constraint);
+
+        if ($parameterType !== null) {
+            $expectedFormat = $parameterType;
+        } else {
+            $expectedFormat = \is_string($color) ? '"' . $color . '"' : $color;
+        }
+
+        $this->buildViolation('The given value is not a valid hexadecimal color.')
+            ->setParameter('{{ value }}', $expectedFormat)
+            ->setCode(HexColor::HEX_COLOR_ERROR)
+            ->assertRaised();
+    }
+}