QueryComplexityTest::testQueryWithCustomAndSkipDirective() - Code Metrics - Inspection of "fix query complexity validator on directives" - webonyx/graphql-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#498)

unknown

created 2019-09-15 06:52 UTC

testQueryWithCustomAndSkipDirective() A

↳ Parent: QueryComplexityTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

namespace GraphQL\Tests\Validator;

use GraphQL\Error\Error;
use GraphQL\Language\AST\NodeKind;
use GraphQL\Language\Parser;
use GraphQL\Validator\DocumentValidator;
use GraphQL\Validator\Rules\CustomValidationRule;
use GraphQL\Validator\Rules\QueryComplexity;
use GraphQL\Validator\ValidationContext;
use function count;

class QueryComplexityTest extends QuerySecurityTestCase
{
    /** @var QueryComplexity */
    private static $rule;

    public function testSimpleQueries() : void
    {
        $query = 'query MyQuery { human { firstName } }';

        $this->assertDocumentValidators($query, 2, 3);
    }

    public function testGetQueryComplexity() : void
    {
        $query = 'query MyQuery { human { firstName } }';

        $rule = $this->getRule(5);

        DocumentValidator::validate(
            QuerySecuritySchema::buildSchema(),
            Parser::parse($query),
            [$rule]
        );

        self::assertEquals(2, $rule->getQueryComplexity(), $query);
    }

    private function assertDocumentValidators($query, $queryComplexity, $startComplexity)
    {
        for ($maxComplexity = $startComplexity; $maxComplexity >= 0; --$maxComplexity) {
            $positions = [];

            if ($maxComplexity < $queryComplexity && $maxComplexity !== QueryComplexity::DISABLED) {
                $positions = [$this->createFormattedError($maxComplexity, $queryComplexity)];
            }

            $this->assertDocumentValidator($query, $maxComplexity, $positions);
        }
    }

    public function testInlineFragmentQueries() : void
    {
        $query = 'query MyQuery { human { ... on Human { firstName } } }';

        $this->assertDocumentValidators($query, 2, 3);
    }

    public function testFragmentQueries() : void
    {
        $query = 'query MyQuery { human { ...F1 } } fragment F1 on Human { firstName}';

        $this->assertDocumentValidators($query, 2, 3);
    }

    public function testAliasesQueries() : void
    {
        $query = 'query MyQuery { thomas: human(name: "Thomas") { firstName } jeremy: human(name: "Jeremy") { firstName } }';

        $this->assertDocumentValidators($query, 4, 5);
    }

    public function testCustomComplexityQueries() : void
    {
        $query = 'query MyQuery { human { dogs { name } } }';

        $this->assertDocumentValidators($query, 12, 13);
    }

    public function testCustomComplexityWithArgsQueries() : void
    {
        $query = 'query MyQuery { human { dogs(name: "Root") { name } } }';

        $this->assertDocumentValidators($query, 3, 4);
    }

    public function testCustomComplexityWithVariablesQueries() : void
    {
        $query = 'query MyQuery($dog: String!) { human { dogs(name: $dog) { name } } }';

        $this->getRule()->setRawVariableValues(['dog' => 'Roots']);

        $this->assertDocumentValidators($query, 3, 4);
    }

    /**
     * @param int $maxDepth
     *
     * @return QueryComplexity
     */
    protected function getRule($maxDepth = null)
    {
        if (self::$rule === null) {
            self::$rule = new QueryComplexity($maxDepth);
        } elseif ($maxDepth !== null) {
            self::$rule->setMaxQueryComplexity($maxDepth);
        }

        return self::$rule;
    }

    public function testQueryWithEnabledIncludeDirectives() : void
    {
        $query = 'query MyQuery($withDogs: Boolean!) { human { dogs(name: "Root") @include(if:$withDogs) { name } } }';

        $this->getRule()->setRawVariableValues(['withDogs' => true]);

        $this->assertDocumentValidators($query, 3, 4);
    }

    public function testQueryWithDisabledIncludeDirectives() : void
    {
        $query = 'query MyQuery($withDogs: Boolean!) { human { dogs(name: "Root") @include(if:$withDogs) { name } } }';

        $this->getRule()->setRawVariableValues(['withDogs' => false]);

        $this->assertDocumentValidators($query, 1, 2);
    }

    public function testQueryWithEnabledSkipDirectives() : void
    {
        $query = 'query MyQuery($withoutDogs: Boolean!) { human { dogs(name: "Root") @skip(if:$withoutDogs) { name } } }';

        $this->getRule()->setRawVariableValues(['withoutDogs' => true]);

        $this->assertDocumentValidators($query, 1, 2);
    }

    public function testQueryWithDisabledSkipDirectives() : void
    {
        $query = 'query MyQuery($withoutDogs: Boolean!) { human { dogs(name: "Root") @skip(if:$withoutDogs) { name } } }';

        $this->getRule()->setRawVariableValues(['withoutDogs' => false]);

        $this->assertDocumentValidators($query, 3, 4);
    }

    public function testQueryWithMultipleDirectives() : void
    {
        $query = 'query MyQuery($withDogs: Boolean!, $withoutDogName: Boolean!) { human { dogs(name: "Root") @include(if:$withDogs) { name @skip(if:$withoutDogName) } } }';

        $this->getRule()->setRawVariableValues([
            'withDogs'       => true,
            'withoutDogName' => true,
        ]);

        $this->assertDocumentValidators($query, 2, 3);
    }

    public function testQueryWithCustomDirective() : void
    {
        $query = 'query MyQuery { human { ... on Human { firstName @foo(bar: false) } } }';

        $this->assertDocumentValidators($query, 2, 3);
    }

    public function testQueryWithCustomAndSkipDirective() : void
    {
        $query = 'query MyQuery($withoutDogs: Boolean!) { human { dogs(name: "Root") @skip(if:$withoutDogs) { name @foo(bar: true) } } }';

        $this->getRule()->setRawVariableValues(['withoutDogs' => true]);

        $this->assertDocumentValidators($query, 1, 2);
    }

    public function testComplexityIntrospectionQuery() : void
    {
        $this->assertIntrospectionQuery(181);
    }

    public function testIntrospectionTypeMetaFieldQuery() : void
    {
        $this->assertIntrospectionTypeMetaFieldQuery(2);
    }

    public function testTypeNameMetaFieldQuery() : void
    {
        $this->assertTypeNameMetaFieldQuery(3);
    }

    public function testSkippedWhenThereAreOtherValidationErrors() : void
    {
        $query = 'query MyQuery { human(name: INVALID_VALUE) { dogs {name} } }';

        $reportedError = new Error('OtherValidatorError');
        $otherRule     = new CustomValidationRule(
            'otherRule',
            static function (ValidationContext $context) use ($reportedError) {
                return [
                    NodeKind::OPERATION_DEFINITION => [
                        'leave' => static function () use ($context, $reportedError) {
                            $context->reportError($reportedError);
                        },
                    ],
                ];
            }
        );

        $errors = DocumentValidator::validate(
            QuerySecuritySchema::buildSchema(),
            Parser::parse($query),
            [$otherRule, $this->getRule(1)]
        );

        self::assertEquals(1, count($errors));
        self::assertSame($reportedError, $errors[0]);

        $this->expectException(Error::class);
        DocumentValidator::validate(
            QuerySecuritySchema::buildSchema(),
            Parser::parse($query),
            [$this->getRule(1)]
        );
    }

    /**
     * @param int $max
     * @param int $count
     *
     * @return string
     */
    protected function getErrorMessage($max, $count)
    {
        return QueryComplexity::maxQueryComplexityErrorMessage($max, $count);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace GraphQL\Tests\Validator;
6
7			use GraphQL\Error\Error;
8			use GraphQL\Language\AST\NodeKind;
9			use GraphQL\Language\Parser;
10			use GraphQL\Validator\DocumentValidator;
11			use GraphQL\Validator\Rules\CustomValidationRule;
12			use GraphQL\Validator\Rules\QueryComplexity;
13			use GraphQL\Validator\ValidationContext;
14			use function count;
15
16			class QueryComplexityTest extends QuerySecurityTestCase
17			{
18			/** @var QueryComplexity */
19			private static $rule;
20
21			public function testSimpleQueries() : void
22			{
23			$query = 'query MyQuery { human { firstName } }';
24
25			$this->assertDocumentValidators($query, 2, 3);
26			}
27
28			public function testGetQueryComplexity() : void
29			{
30			$query = 'query MyQuery { human { firstName } }';
31
32			$rule = $this->getRule(5);
33
34			DocumentValidator::validate(
35			QuerySecuritySchema::buildSchema(),
36			Parser::parse($query),
37			[$rule]
38			);
39
40			self::assertEquals(2, $rule->getQueryComplexity(), $query);
41			}
42
43			private function assertDocumentValidators($query, $queryComplexity, $startComplexity)
44			{
45			for ($maxComplexity = $startComplexity; $maxComplexity >= 0; --$maxComplexity) {
46			$positions = [];
47
48			if ($maxComplexity < $queryComplexity && $maxComplexity !== QueryComplexity::DISABLED) {
49			$positions = [$this->createFormattedError($maxComplexity, $queryComplexity)];
50			}
51
52			$this->assertDocumentValidator($query, $maxComplexity, $positions);
53			}
54			}
55
56			public function testInlineFragmentQueries() : void
57			{
58			$query = 'query MyQuery { human { ... on Human { firstName } } }';
59
60			$this->assertDocumentValidators($query, 2, 3);
61			}
62
63			public function testFragmentQueries() : void
64			{
65			$query = 'query MyQuery { human { ...F1 } } fragment F1 on Human { firstName}';
66
67			$this->assertDocumentValidators($query, 2, 3);
68			}
69
70			public function testAliasesQueries() : void
71			{
72			$query = 'query MyQuery { thomas: human(name: "Thomas") { firstName } jeremy: human(name: "Jeremy") { firstName } }';
73
74			$this->assertDocumentValidators($query, 4, 5);
75			}
76
77			public function testCustomComplexityQueries() : void
78			{
79			$query = 'query MyQuery { human { dogs { name } } }';
80
81			$this->assertDocumentValidators($query, 12, 13);
82			}
83
84			public function testCustomComplexityWithArgsQueries() : void
85			{
86			$query = 'query MyQuery { human { dogs(name: "Root") { name } } }';
87
88			$this->assertDocumentValidators($query, 3, 4);
89			}
90
91			public function testCustomComplexityWithVariablesQueries() : void
92			{
93			$query = 'query MyQuery($dog: String!) { human { dogs(name: $dog) { name } } }';
94
95			$this->getRule()->setRawVariableValues(['dog' => 'Roots']);
96
97			$this->assertDocumentValidators($query, 3, 4);
98			}
99
100			/**
101			* @param int $maxDepth
102			*
103			* @return QueryComplexity
104			*/
105			protected function getRule($maxDepth = null)
106			{
107			if (self::$rule === null) {
108			self::$rule = new QueryComplexity($maxDepth);
109			} elseif ($maxDepth !== null) {
110			self::$rule->setMaxQueryComplexity($maxDepth);
111			}
112
113			return self::$rule;
114			}
115
116			public function testQueryWithEnabledIncludeDirectives() : void
117			{
118			$query = 'query MyQuery($withDogs: Boolean!) { human { dogs(name: "Root") @include(if:$withDogs) { name } } }';
119
120			$this->getRule()->setRawVariableValues(['withDogs' => true]);
121
122			$this->assertDocumentValidators($query, 3, 4);
123			}
124
125			public function testQueryWithDisabledIncludeDirectives() : void
126			{
127			$query = 'query MyQuery($withDogs: Boolean!) { human { dogs(name: "Root") @include(if:$withDogs) { name } } }';
128
129			$this->getRule()->setRawVariableValues(['withDogs' => false]);
130
131			$this->assertDocumentValidators($query, 1, 2);
132			}
133
134			public function testQueryWithEnabledSkipDirectives() : void
135			{
136			$query = 'query MyQuery($withoutDogs: Boolean!) { human { dogs(name: "Root") @skip(if:$withoutDogs) { name } } }';
137
138			$this->getRule()->setRawVariableValues(['withoutDogs' => true]);
139
140			$this->assertDocumentValidators($query, 1, 2);
141			}
142
143			public function testQueryWithDisabledSkipDirectives() : void
144			{
145			$query = 'query MyQuery($withoutDogs: Boolean!) { human { dogs(name: "Root") @skip(if:$withoutDogs) { name } } }';
146
147			$this->getRule()->setRawVariableValues(['withoutDogs' => false]);
148
149			$this->assertDocumentValidators($query, 3, 4);
150			}
151
152			public function testQueryWithMultipleDirectives() : void
153			{
154			$query = 'query MyQuery($withDogs: Boolean!, $withoutDogName: Boolean!) { human { dogs(name: "Root") @include(if:$withDogs) { name @skip(if:$withoutDogName) } } }';
155
156			$this->getRule()->setRawVariableValues([
157			'withDogs' => true,
158			'withoutDogName' => true,
159			]);
160
161			$this->assertDocumentValidators($query, 2, 3);
162			}
163
164			public function testQueryWithCustomDirective() : void
165			{
166			$query = 'query MyQuery { human { ... on Human { firstName @foo(bar: false) } } }';
167
168			$this->assertDocumentValidators($query, 2, 3);
169			}
170
171			public function testQueryWithCustomAndSkipDirective() : void
172			{
173			$query = 'query MyQuery($withoutDogs: Boolean!) { human { dogs(name: "Root") @skip(if:$withoutDogs) { name @foo(bar: true) } } }';
174
175			$this->getRule()->setRawVariableValues(['withoutDogs' => true]);
176
177			$this->assertDocumentValidators($query, 1, 2);
178			}
179
180			public function testComplexityIntrospectionQuery() : void
181			{
182			$this->assertIntrospectionQuery(181);
183			}
184
185			public function testIntrospectionTypeMetaFieldQuery() : void
186			{
187			$this->assertIntrospectionTypeMetaFieldQuery(2);
188			}
189
190			public function testTypeNameMetaFieldQuery() : void
191			{
192			$this->assertTypeNameMetaFieldQuery(3);
193			}
194
195			public function testSkippedWhenThereAreOtherValidationErrors() : void
196			{
197			$query = 'query MyQuery { human(name: INVALID_VALUE) { dogs {name} } }';
198
199			$reportedError = new Error('OtherValidatorError');
200			$otherRule = new CustomValidationRule(
201			'otherRule',
202			static function (ValidationContext $context) use ($reportedError) {
203			return [
204			NodeKind::OPERATION_DEFINITION => [
205			'leave' => static function () use ($context, $reportedError) {
206			$context->reportError($reportedError);
207			},
208			],
209			];
210			}
211			);
212
213			$errors = DocumentValidator::validate(
214			QuerySecuritySchema::buildSchema(),
215			Parser::parse($query),
216			[$otherRule, $this->getRule(1)]
217			);
218
219			self::assertEquals(1, count($errors));
220			self::assertSame($reportedError, $errors[0]);
221
222			$this->expectException(Error::class);
223			DocumentValidator::validate(
224			QuerySecuritySchema::buildSchema(),
225			Parser::parse($query),
226			[$this->getRule(1)]
227			);
228			}
229
230			/**
231			* @param int $max
232			* @param int $count
233			*
234			* @return string
235			*/
236			protected function getErrorMessage($max, $count)
237			{
238			return QueryComplexity::maxQueryComplexityErrorMessage($max, $count);
239			}
240			}
241

webonyx / graphql-php

Pull Request — master (#498)

testQueryWithCustomAndSkipDirective() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like