phpstan-dba/tests/rules/QueryPlanAnalyzerRuleTest.php at f1739353646a4d4833569b8526bb91e6f5e9c5d3 · staabm/phpstan-dba · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php

namespace staabm\PHPStanDba\Tests;

use PHPStan\Rules\Rule;
use PHPStan\Testing\RuleTestCase;
use staabm\PHPStanDba\Analyzer\QueryPlanResult;
use staabm\PHPStanDba\QueryReflection\QueryReflection;
use staabm\PHPStanDba\Rules\QueryPlanAnalyzerRule;

/**
 * @extends RuleTestCase<QueryPlanAnalyzerRule>
 */
class QueryPlanAnalyzerRuleTest extends RuleTestCase
{
    /**
     * @var bool|0|positive-int
     */
    private $numberOfAllowedUnindexedReads;
    /**
     * @var positive-int
     */
    private $numberOfRowsNotRequiringIndex;
    /**
     * @var bool
     */
    private $debugMode = false;

    protected function tearDown(): void
    {
        QueryReflection::getRuntimeConfiguration()->debugMode(false);
        QueryReflection::getRuntimeConfiguration()->analyzeQueryPlans(false);
    }

    protected function getRule(): Rule
    {
        QueryReflection::getRuntimeConfiguration()->debugMode($this->debugMode);
        QueryReflection::getRuntimeConfiguration()->analyzeQueryPlans($this->numberOfAllowedUnindexedReads, $this->numberOfRowsNotRequiringIndex);

        return self::getContainer()->getByType(QueryPlanAnalyzerRule::class);
    }

    public static function getAdditionalConfigFiles(): array
    {
        return [
            __DIR__.'/../../config/dba.neon',
        ];
    }

    public function testNotUsingIndex(): void
    {
        if ('recording' !== getenv('DBA_MODE')) {
            $this->markTestSkipped('query plan analyzer requires a active database connection');
        }

        $this->numberOfAllowedUnindexedReads = true;
        $this->numberOfRowsNotRequiringIndex = 2;

        $proposal = "\n\nConsider optimizing the query.\nIn some cases this is not a problem and this error should be ignored.";
        $tip = 'pdo-pgsql' === getenv('DBA_REFLECTOR')
            ? QueryPlanResult::PGSQL_TIP
            : 'see Mysql Docs https://dev.mysql.com/doc/refman/8.0/en/select-optimization.html';

        $this->analyse([__DIR__.'/data/query-plan-analyzer.php'], [
            [
                "Query is not using an index on table 'ada'.".$proposal,
                12,
                $tip,
            ],
            [
                "Query is not using an index on table 'ada'.".$proposal,
                17,
                $tip,
            ],
            [
                "Query is not using an index on table 'ada'.".$proposal,
                22,
                $tip,
            ],
            [
                "Query is not using an index on table 'ada'.".$proposal,
                23,
                $tip,
            ],
            [
                "Query is not using an index on table 'ada'.".$proposal,
                28,
                $tip,
            ],
        ]);
    }

    public function testNotUsingIndexInDebugMode(): void
    {
        if ('recording' !== getenv('DBA_MODE')) {
            $this->markTestSkipped('query plan analyzer requires a active database connection');
        }

        $this->debugMode = true;
        $this->numberOfAllowedUnindexedReads = true;
        $this->numberOfRowsNotRequiringIndex = 2;

        $proposal = "\n\nConsider optimizing the query.\nIn some cases this is not a problem and this error should be ignored.";
        if ('pdo-pgsql' === getenv('DBA_REFLECTOR')) {
            $this->analyse([__DIR__.'/data/query-plan-analyzer.php'], [
                [
                    "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN (FORMAT JSON) SELECT * FROM ada WHERE email = 'test@example.com'",
                    12,
                    QueryPlanResult::PGSQL_TIP,
                ],
                [
                    "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN (FORMAT JSON) SELECT *,adaid FROM ada WHERE email = 'test@example.com'",
                    17,
                    QueryPlanResult::PGSQL_TIP,
                ],
                [
                    "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN (FORMAT JSON) SELECT * FROM ada WHERE email = '1970-01-01'",
                    22,
                    QueryPlanResult::PGSQL_TIP,
                ],
                [
                    "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN (FORMAT JSON) SELECT * FROM ada WHERE email = '1970-01-01'",
                    23,
                    QueryPlanResult::PGSQL_TIP,
                ],
                [
                    "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN (FORMAT JSON) SELECT * FROM ada WHERE email = '1970-01-01'",
                    28,
                    QueryPlanResult::PGSQL_TIP,
                ],
                [
                    'Unresolvable Query: Cannot simulate parameter value for type: mixed.',
                    61,
                    'Make sure all variables involved have a non-mixed type and array-types are specified.',
                ],
            ]);

            return;
        }

        $tip = 'see Mysql Docs https://dev.mysql.com/doc/refman/8.0/en/select-optimization.html';

        $this->analyse([__DIR__.'/data/query-plan-analyzer.php'], [
            [
                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT * FROM ada WHERE email = 'test@example.com'",
                12,
                $tip,
            ],
            [
                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT *,adaid FROM ada WHERE email = 'test@example.com'",
                17,
                $tip,
            ],
            [
                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT * FROM ada WHERE email = '1970-01-01'",
                22,
                $tip,
            ],
            [
                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT * FROM ada WHERE email = '1970-01-01'",
                23,
                $tip,
            ],
            [
                "Query is not using an index on table 'ada'.".$proposal."\n\nSimulated query: EXPLAIN SELECT * FROM ada WHERE email = '1970-01-01'",
                28,
                $tip,
            ],
            [
                'Unresolvable Query: Cannot simulate parameter value for type: mixed.',
                61,
                'Make sure all variables involved have a non-mixed type and array-types are specified.',
            ],
        ]);
    }
}