#26082

pending completion

Build # #26082

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/20c7b1c8e2b07994e102630485f492c381149c87">20c7b1c8e<a href="https://github.com/api-platform/core/commit/20c7b1c8e2b07994e102630485f492c381149c87">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/23468aae41724b31b5a7ba00eaf3429182927f68">23468aae4</a>">23468aae4</a><a href="https://github.com/api-platform/core/commit/20c7b1c8e2b07994e102630485f492c381149c87"> into 12f2c21f5">12f2c21f5</a>

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

8031 of 9526 relevant lines covered (84.31%)

14.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.65

/src/Bridge/Symfony/Bundle/Test/Constraint/MatchesJsonSchema.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint;

use JsonSchema\Validator;
use PHPUnit\Framework\Constraint\Constraint;

/**
 * Asserts that a JSON document matches a given JSON Schema.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 *
 * @experimental
 */
final class MatchesJsonSchema extends Constraint
{
    /**
     * @var object|array
     */
    private $schema;
    private $checkMode;

    /**
     * @param object|array|string $schema
     */
    public function __construct($schema, ?int $checkMode = null)
    {
        $this->schema = \is_string($schema) ? json_decode($schema) : $schema;
        $this->checkMode = $checkMode;
        // old phpunit versions
        if (\is_callable('parent::__construct')) {
            parent::__construct(); //@phpstan-ignore-line
        }
    }

    /**
     * {@inheritdoc}
     */
    public function toString(): string
    {
        return 'matches the provided JSON Schema';
    }

    /**
     * {@inheritdoc}
     */
    protected function matches($other): bool
    {
        if (!class_exists(Validator::class)) {
            throw new \LogicException('The "justinrainbow/json-schema" library must be installed to use "assertMatchesJsonSchema()". Try running "composer require --dev justinrainbow/json-schema".');
        }

        $other = $this->normalizeJson($other);

        $validator = new Validator();
        $validator->validate($other, $this->schema, $this->checkMode);

        return $validator->isValid();
    }

    /**
     * {@inheritdoc}
     */
    protected function additionalFailureDescription($other): string
    {
        $other = $this->normalizeJson($other);

        $validator = new Validator();
        $validator->validate($other, $this->schema, $this->checkMode);

        $errors = [];
        foreach ($validator->getErrors() as $error) {
            $property = $error['property'] ? $error['property'].': ' : '';
            $errors[] = $property.$error['message'];
        }

        return implode("\n", $errors);
    }

    /**
     * Normalizes a JSON document.
     *
     * Specifically, we should ensure that:
     * 1. a JSON object is represented as a PHP object, not as an associative array.
     */
    private function normalizeJson($document)
    {
        if (is_scalar($document) || \is_object($document)) {
            return $document;
        }

        if (!\is_array($document)) {
            throw new \InvalidArgumentException('Document must be scalar, array or object.');
        }

        $document = json_encode($document);
        if (!\is_string($document)) {
            throw new \UnexpectedValueException('JSON encode failed.');
        }
        $document = json_decode($document);
        if (!\is_array($document) && !\is_object($document)) {
            throw new \UnexpectedValueException('JSON decode failed.');
        }

        return $document;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Constraint;
15
16	use JsonSchema\Validator;
17	use PHPUnit\Framework\Constraint\Constraint;
18
19	/**
20	* Asserts that a JSON document matches a given JSON Schema.
21	*
22	* @author Kévin Dunglas <dunglas@gmail.com>
23	*
24	* @experimental
25	*/
26	final class MatchesJsonSchema extends Constraint
27	{
28	/**
29	* @var object\|array
30	*/
31	private $schema;
32	private $checkMode;
33
34	/**
35	* @param object\|array\|string $schema
36	*/
37	public function __construct($schema, ?int $checkMode = null)
38	{
39	$this->schema = \is_string($schema) ? json_decode($schema) : $schema;	5✔
40	$this->checkMode = $checkMode;	5✔
41	// old phpunit versions
42	if (\is_callable('parent::__construct')) {	5✔
43	parent::__construct(); //@phpstan-ignore-line	×
44	}
45	}	5✔
46
47	/**
48	* {@inheritdoc}
49	*/
50	public function toString(): string
51	{
52	return 'matches the provided JSON Schema';	1✔
53	}
54
55	/**
56	* {@inheritdoc}
57	*/
58	protected function matches($other): bool
59	{
60	if (!class_exists(Validator::class)) {	5✔
61	throw new \LogicException('The "justinrainbow/json-schema" library must be installed to use "assertMatchesJsonSchema()". Try running "composer require --dev justinrainbow/json-schema".');	×
62	}
63
64	$other = $this->normalizeJson($other);	5✔
65
66	$validator = new Validator();	5✔
67	$validator->validate($other, $this->schema, $this->checkMode);	5✔
68
69	return $validator->isValid();	5✔
70	}
71
72	/**
73	* {@inheritdoc}
74	*/
75	protected function additionalFailureDescription($other): string
76	{
77	$other = $this->normalizeJson($other);	1✔
78
79	$validator = new Validator();	1✔
80	$validator->validate($other, $this->schema, $this->checkMode);	1✔
81
82	$errors = [];	1✔
83	foreach ($validator->getErrors() as $error) {	1✔
84	$property = $error['property'] ? $error['property'].': ' : '';	1✔
85	$errors[] = $property.$error['message'];	1✔
86	}
87
88	return implode("\n", $errors);	1✔
89	}
90
91	/**
92	* Normalizes a JSON document.
93	*
94	* Specifically, we should ensure that:
95	* 1. a JSON object is represented as a PHP object, not as an associative array.
96	*/
97	private function normalizeJson($document)
98	{
99	if (is_scalar($document) \|\| \is_object($document)) {	5✔
100	return $document;	×
101	}
102
103	if (!\is_array($document)) {	5✔
104	throw new \InvalidArgumentException('Document must be scalar, array or object.');	×
105	}
106
107	$document = json_encode($document);	5✔
108	if (!\is_string($document)) {	5✔
109	throw new \UnexpectedValueException('JSON encode failed.');	×
110	}
111	$document = json_decode($document);	5✔
112	if (!\is_array($document) && !\is_object($document)) {	5✔
113	throw new \UnexpectedValueException('JSON decode failed.');	×
114	}
115
116	return $document;	5✔
117	}
118	}

api-platform / core / #26082

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous