packages/sql-faker/tests/Unit/MySql/Generation/SqlGeneratorFactoryTest.php

1<?php
2
3declare(strict_types=1);
4
5namespace Tests\Unit\MySql\Generation;
6
7use Faker\Factory;
8use PHPUnit\Framework\Attributes\CoversClass;
9use PHPUnit\Framework\Attributes\UsesClass;
10use PHPUnit\Framework\TestCase;
11use SqlFaker\Generation\Plan\GenerationPlan;
12use SqlFaker\Grammar\Model\Grammar;
13use SqlFaker\Grammar\Model\Production;
14use SqlFaker\Grammar\Model\ProductionRule;
15use SqlFaker\Grammar\Model\Terminal;
16use SqlFaker\MySql\Generation\SqlGeneratorFactory;
17
18#[CoversClass(SqlGeneratorFactory::class)]
19#[UsesClass(\SqlFaker\Generation\SqlGenerator::class)]
20#[UsesClass(\SqlFaker\Generation\Derivation\Derivation::class)]
21#[UsesClass(GenerationPlan::class)]
22#[UsesClass(\SqlFaker\Generation\Derivation\TerminationAnalyzer::class)]
23#[UsesClass(\SqlFaker\Generation\Derivation\TerminationCost::class)]
24#[UsesClass(Grammar::class)]
25#[UsesClass(\SqlFaker\MySql\Generation\Tokenization\KeywordIndex::class)]
26#[UsesClass(\SqlFaker\Generation\Value\RandomCharacters::class)]
27#[UsesClass(\SqlFaker\MySql\Generation\Value\LiteralGenerator::class)]
28#[UsesClass(\SqlFaker\Grammar\Model\TerminalInventory::class)]
29#[UsesClass(\SqlFaker\Grammar\Model\NonTerminal::class)]
30#[UsesClass(Production::class)]
31#[UsesClass(ProductionRule::class)]
32#[UsesClass(\SqlFaker\Grammar\Resource\SqlVersionRegistry::class)]
33#[UsesClass(\SqlFaker\Grammar\Resource\SqlVersion::class)]
34#[UsesClass(Terminal::class)]
35#[UsesClass(\SqlFaker\MySql\Generation\GenerationContext::class)]
36#[UsesClass(\SqlFaker\MySql\Grammar\MySqlGrammar::class)]
37#[UsesClass(\SqlFaker\MySql\Generation\LexicalGrammar::class)]
38#[UsesClass(\SqlFaker\MySql\Generation\Tokenization\MySqlTokenizer::class)]
39#[UsesClass(\SqlFaker\MySql\Generation\StartRuleResolver::class)]
40#[UsesClass(\SqlFaker\Generation\Derivation\CompletionCosts::class)]
41#[UsesClass(\SqlFaker\Generation\Derivation\DerivationTrace::class)]
42#[UsesClass(\SqlFaker\Generation\Candidate\ChoiceLexemeGenerator::class)]
43#[UsesClass(\SqlFaker\Generation\Candidate\FixedLexemeGenerator::class)]
44#[UsesClass(\SqlFaker\Generation\Candidate\IntegerLexemeGenerator::class)]
45#[UsesClass(\SqlFaker\Generation\Lexeme\Lexeme::class)]
46#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeCandidates::class)]
47#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeInput::class)]
48#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeSequence::class)]
49#[UsesClass(\SqlFaker\Generation\Candidate\MatchingLexemeGenerator::class)]
50#[UsesClass(\SqlFaker\Generation\Candidate\ValueLexemeGenerator::class)]
51#[UsesClass(\SqlFaker\Generation\Candidate\RegisteredLexemeGenerator::class)]
52#[UsesClass(\SqlFaker\Generation\Candidate\SequenceLexemeGenerator::class)]
53#[UsesClass(\SqlFaker\Generation\Output\CandidateResolver::class)]
54#[UsesClass(\SqlFaker\Generation\Lexeme\OutputPart::class)]
55#[UsesClass(\SqlFaker\Generation\Lexeme\ResolvedOutput::class)]
56#[UsesClass(\SqlFaker\Generation\Output\ReverseLexemeGenerator::class)]
57#[UsesClass(\SqlFaker\Generation\Output\SqlSerializer::class)]
58#[UsesClass(\SqlFaker\Generation\Output\CombinedSpacingRule::class)]
59#[UsesClass(\SqlFaker\Generation\Lexeme\SpacingConstraint::class)]
60#[UsesClass(\SqlFaker\Generation\Token\ProductionOccurrence::class)]
61#[UsesClass(\SqlFaker\Generation\Token\TerminalOccurrence::class)]
62#[UsesClass(\SqlFaker\Generation\Token\TerminalSequence::class)]
63#[UsesClass(\SqlFaker\Generation\Derivation\TokenGenerator::class)]
64#[UsesClass(\SqlFaker\Generation\Token\TokenRewriter::class)]
65#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Option\UniqueOptionRule::class)]
66#[UsesClass(\SqlFaker\Generation\Candidate\VersionCase::class)]
67#[UsesClass(\SqlFaker\Generation\Candidate\VersionedLexemeGenerator::class)]
68#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\DefinitionFactory::class)]
69#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\KeywordLexemeGenerator::class)]
70#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\AlterDatabaseRule::class)]
71#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\ConstraintEnforcementRule::class)]
72#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\FlushExportRule::class)]
73#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\InstanceActionRule::class)]
74#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\IntegerContextRule::class)]
75#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\LoadSourceCountRule::class)]
76#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\RequiredAliasRule::class)]
77#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\RewriteDefinitions::class)]
78#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\RoleGrantRule::class)]
79#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\SetNamesRule::class)]
80#[UsesClass(\SqlFaker\Generation\Token\TerminalMappingRule::class)]
81#[UsesClass(\SqlFaker\Generation\Plan\ProductionPattern::class)]
82#[UsesClass(\SqlFaker\Generation\Exception\GenerationException::class)]
83#[UsesClass(\SqlFaker\MySql\Generation\Spacing\KeywordPhraseSpacingRule::class)]
84#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeBoundary::class)]
85#[UsesClass(\SqlFaker\Generation\Exception\LexicalException::class)]
86#[UsesClass(\SqlFaker\MySql\Generation\Spacing\CloneAddressSpacingRule::class)]
87#[UsesClass(\SqlFaker\MySql\Generation\Spacing\FunctionSpacingRule::class)]
88#[UsesClass(\SqlFaker\MySql\Generation\Spacing\QualifiedNameSpacingRule::class)]
89#[UsesClass(\SqlFaker\MySql\Generation\Spacing\VariableSpacingRule::class)]
90#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Expression\ExpressionGroupingRule::class)]
91#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\AlterEventRule::class)]
92#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\SubqueryContextRule::class)]
93#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\IntoClauseRule::class)]
94#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\GeneratedColumnRule::class)]
95#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\TransactionCompletionRule::class)]
96#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Alter\OrderByRule::class)]
97#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\BoundedIntegerLexemeGenerator::class)]
98#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\ReplicationTablePatternLexemeGenerator::class)]
99#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\SizeNumberLexemeGenerator::class)]
100#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Replication\StartRule::class)]
101#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\FieldListRule::class)]
102#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Replication\TablePatternRule::class)]
103#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Expression\QuantifiedComparisonRule::class)]
104#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Expression\TableValueConstructorRule::class)]
105#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Query\QueryContextRule::class)]
106#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Query\JoinGroupingRule::class)]
107#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Query\LegacyDerivedTableRule::class)]
108#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Column\FieldLengthRule::class)]
109#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Routine\ReturnRule::class)]
110#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Routine\BinlogRule::class)]
111#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Name\SystemVariableRule::class)]
112#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Column\AutoIncrementRule::class)]
113#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\DefinitionRule::class)]
114#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\ListValueRule::class)]
115#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Routine\LanguageRule::class)]
116#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\FactorLexemeGenerator::class)]
117#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\PrecisionLexemeGenerator::class)]
118#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\ValueArityRule::class)]
119#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\ValueShape::class)]
120#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Query\WindowFrameRule::class)]
121#[UsesClass(\SqlFaker\Generation\Value\CharacterDomain::class)]
122#[UsesClass(\SqlFaker\Generation\Value\ChoiceDomain::class)]
123#[UsesClass(\SqlFaker\Generation\Value\IntegerDomain::class)]
124#[UsesClass(\SqlFaker\Generation\Value\SequenceDomain::class)]
125#[UsesClass(\SqlFaker\MySql\Generation\Value\DollarQuotedDomain::class)]
126#[UsesClass(\SqlFaker\Generation\Output\BoundaryCompletion::class)]
127#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Expression\ConcatenationRule::class)]
128#[UsesClass(\SqlFaker\Generation\Derivation\CompletionState::class)]
129#[UsesClass(\SqlFaker\Generation\Derivation\CompletionFrontier::class)]
130#[UsesClass(\SqlFaker\Generation\Derivation\ConstrainedCompletion::class)]
131#[UsesClass(\SqlFaker\Generation\Value\ValueChoices::class)]
132#[UsesClass(\SqlFaker\Generation\Derivation\CompletionMemo::class)]
133#[UsesClass(\SqlFaker\Generation\Derivation\CompletionReduction::class)]
134#[UsesClass(\SqlFaker\Generation\Derivation\ConstraintDependencies::class)]
135#[UsesClass(\SqlFaker\Generation\Choice\BytePlanCompiler::class)]
136#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Name\HostNameRule::class)]
137#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\CharsetLexemeGenerator::class)]
138#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\CharsetValueLexemeGenerator::class)]
139#[UsesClass(\SqlFaker\MySql\Generation\Value\IdentifierDomain::class)]
140#[UsesClass(\SqlFaker\MySql\Generation\Value\QuotedDomain::class)]
141#[UsesClass(\SqlFaker\MySql\Generation\Value\RadixDomain::class)]
142#[UsesClass(\SqlFaker\Generation\Value\RepeatDomain::class)]
143#[UsesClass(\SqlFaker\Generation\Value\WordDomain::class)]
144#[UsesClass(\SqlFaker\Generation\Derivation\Completion\PatternProductions::class)]
145#[UsesClass(\SqlFaker\Generation\Derivation\Completion\CompletionWitness::class)]
146#[UsesClass(\SqlFaker\Generation\Value\Utf8::class)]
147#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\LexicalDefinition::class)]
148final class SqlGeneratorFactoryTest extends TestCase
149{
150    public function testCreatePreservesTheGrammarEntryPointAndBindsLexicalDefinitions(): void
151    {
152        $faker = Factory::create();
153        $faker->seed(17);
154        $grammar = new Grammar('entry', [
155            'entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT_SYM')])]),
156        ]);
157        $generator = SqlGeneratorFactory::create($faker, $grammar, 'mysql-8.4.7');
158
159        self::assertMatchesRegularExpression('/SELECT/i', $generator->generate(GenerationPlan::all()));
160        self::assertSame('7', $generator->generate(GenerationPlan::lexical('integer_literal', ['min' => 7, 'max' => 7])));
161    }
162
163    public function testCreateRealizesTheDocumentedSelectExample(): void
164    {
165        $grammar = new Grammar('statement', [
166            'statement' => new ProductionRule('statement', [new Production([
167                new Terminal('SELECT_SYM'),
168                new \SqlFaker\Grammar\Model\NonTerminal('expression'),
169                new Terminal('FROM'),
170                new \SqlFaker\Grammar\Model\NonTerminal('identifier'),
171            ])]),
172            'expression' => new ProductionRule('expression', [
173                new Production([new \SqlFaker\Grammar\Model\NonTerminal('identifier')]),
174                new Production([new \SqlFaker\Grammar\Model\NonTerminal('integer')]),
175                new Production([
176                    new \SqlFaker\Grammar\Model\NonTerminal('expression'),
177                    new Terminal('+'),
178                    new \SqlFaker\Grammar\Model\NonTerminal('expression'),
179                ]),
180            ]),
181            'identifier' => new ProductionRule('identifier', [new Production([new Terminal('IDENT')])]),
182            'integer' => new ProductionRule('integer', [new Production([new Terminal('NUM')])]),
183        ]);
184        $generator = SqlGeneratorFactory::create(Factory::create(), $grammar, 'mysql-8.4.7');
185        $plan = GenerationPlan::constrained('statement', [
186            'expression' => [
187                \SqlFaker\Generation\Plan\ProductionPattern::exactly('expression', '+', 'expression'),
188                \SqlFaker\Generation\Plan\ProductionPattern::exactly('identifier'),
189                \SqlFaker\Generation\Plan\ProductionPattern::exactly('integer'),
190            ],
191        ])->withLexemes(['NUM' => ['1']]);
192
193        self::assertSame('SELECT _sqlfaker_identifier + 1 FROM _sqlfaker_identifier', $generator->generate($plan));
194    }
195}
196