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

1<?php
2
3declare(strict_types=1);
4
5namespace Tests\Unit\SqlFaker\MySql\Generation;
6
7use Faker\Factory;
8use PHPUnit\Framework\Attributes\CoversClass;
9use PHPUnit\Framework\Attributes\UsesClass;
10use PHPUnit\Framework\TestCase;
11use SqlFaker\Generation\Exception\GenerationException;
12use SqlFaker\Generation\Exception\LexicalException;
13use SqlFaker\Generation\Plan\GenerationPlan;
14use SqlFaker\Generation\Plan\ProductionPattern;
15use SqlFaker\Generation\SqlGenerator;
16use SqlFaker\Grammar\Model\Grammar;
17use SqlFaker\Grammar\Model\Production;
18use SqlFaker\Grammar\Model\ProductionRule;
19use SqlFaker\Grammar\Model\Terminal;
20use SqlFaker\MySql\Generation\GenerationContext;
21
22#[CoversClass(GenerationContext::class)]
23#[UsesClass(Grammar::class)]
24#[UsesClass(Production::class)]
25#[UsesClass(ProductionRule::class)]
26#[UsesClass(Terminal::class)]
27#[UsesClass(SqlGenerator::class)]
28#[UsesClass(GenerationPlan::class)]
29#[UsesClass(ProductionPattern::class)]
30#[UsesClass(GenerationException::class)]
31#[UsesClass(LexicalException::class)]
32#[UsesClass(\SqlFaker\Generation\Derivation\CompletionCosts::class)]
33#[UsesClass(\SqlFaker\Generation\Derivation\Derivation::class)]
34#[UsesClass(\SqlFaker\Generation\Derivation\DerivationTrace::class)]
35#[UsesClass(\SqlFaker\Generation\Derivation\TerminationAnalyzer::class)]
36#[UsesClass(\SqlFaker\Generation\Derivation\TerminationCost::class)]
37#[UsesClass(\SqlFaker\Generation\Candidate\ChoiceLexemeGenerator::class)]
38#[UsesClass(\SqlFaker\Generation\Candidate\FixedLexemeGenerator::class)]
39#[UsesClass(\SqlFaker\Generation\Candidate\IntegerLexemeGenerator::class)]
40#[UsesClass(\SqlFaker\Generation\Lexeme\Lexeme::class)]
41#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeCandidates::class)]
42#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeInput::class)]
43#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeSequence::class)]
44#[UsesClass(\SqlFaker\Generation\Candidate\MatchingLexemeGenerator::class)]
45#[UsesClass(\SqlFaker\Generation\Candidate\ValueLexemeGenerator::class)]
46#[UsesClass(\SqlFaker\Generation\Candidate\SequenceLexemeGenerator::class)]
47#[UsesClass(\SqlFaker\Generation\Output\CandidateResolver::class)]
48#[UsesClass(\SqlFaker\Generation\Lexeme\OutputPart::class)]
49#[UsesClass(\SqlFaker\Generation\Lexeme\ResolvedOutput::class)]
50#[UsesClass(\SqlFaker\Generation\Output\ReverseLexemeGenerator::class)]
51#[UsesClass(\SqlFaker\Generation\Output\SqlSerializer::class)]
52#[UsesClass(\SqlFaker\Generation\Output\CombinedSpacingRule::class)]
53#[UsesClass(\SqlFaker\Generation\Lexeme\SpacingConstraint::class)]
54#[UsesClass(\SqlFaker\Generation\Token\ProductionOccurrence::class)]
55#[UsesClass(\SqlFaker\Generation\Token\TerminalOccurrence::class)]
56#[UsesClass(\SqlFaker\Generation\Token\TerminalSequence::class)]
57#[UsesClass(\SqlFaker\Generation\Derivation\TokenGenerator::class)]
58#[UsesClass(\SqlFaker\Generation\Token\TokenRewriter::class)]
59#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Option\UniqueOptionRule::class)]
60#[UsesClass(\SqlFaker\Generation\Candidate\VersionCase::class)]
61#[UsesClass(\SqlFaker\Generation\Candidate\VersionedLexemeGenerator::class)]
62#[UsesClass(\SqlFaker\MySql\Generation\Tokenization\KeywordIndex::class)]
63#[UsesClass(\SqlFaker\Generation\Value\RandomCharacters::class)]
64#[UsesClass(\SqlFaker\MySql\Generation\Value\LiteralGenerator::class)]
65#[UsesClass(\SqlFaker\Grammar\Model\NonTerminal::class)]
66#[UsesClass(\SqlFaker\Grammar\Resource\SqlVersionRegistry::class)]
67#[UsesClass(\SqlFaker\Grammar\Resource\SqlVersion::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\MySql\Grammar\MySqlGrammar::class)]
81#[UsesClass(\SqlFaker\MySql\Generation\LexicalGrammar::class)]
82#[UsesClass(\SqlFaker\MySql\Generation\Tokenization\MySqlTokenizer::class)]
83#[UsesClass(\SqlFaker\MySql\Generation\StartRuleResolver::class)]
84#[UsesClass(\SqlFaker\MySql\Generation\Spacing\KeywordPhraseSpacingRule::class)]
85#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeBoundary::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\Column\FieldLengthRule::class)]
108#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Routine\ReturnRule::class)]
109#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Name\SystemVariableRule::class)]
110#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Column\AutoIncrementRule::class)]
111#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\DefinitionRule::class)]
112#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\ListValueRule::class)]
113#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Routine\LanguageRule::class)]
114#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\FactorLexemeGenerator::class)]
115#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\PrecisionLexemeGenerator::class)]
116#[UsesClass(\SqlFaker\Generation\Token\TerminalMappingRule::class)]
117#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\ValueArityRule::class)]
118#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Partition\ValueShape::class)]
119#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Query\WindowFrameRule::class)]
120#[UsesClass(\SqlFaker\Generation\Value\CharacterDomain::class)]
121#[UsesClass(\SqlFaker\Generation\Value\ChoiceDomain::class)]
122#[UsesClass(\SqlFaker\Generation\Value\IntegerDomain::class)]
123#[UsesClass(\SqlFaker\Generation\Value\SequenceDomain::class)]
124#[UsesClass(\SqlFaker\MySql\Generation\Value\DollarQuotedDomain::class)]
125#[UsesClass(\SqlFaker\Generation\Output\BoundaryCompletion::class)]
126#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Expression\ConcatenationRule::class)]
127#[UsesClass(\SqlFaker\Generation\Derivation\CompletionState::class)]
128#[UsesClass(\SqlFaker\Generation\Derivation\CompletionFrontier::class)]
129#[UsesClass(\SqlFaker\Generation\Derivation\ConstrainedCompletion::class)]
130#[UsesClass(\SqlFaker\Generation\Value\ValueChoices::class)]
131#[UsesClass(\SqlFaker\Generation\Derivation\CompletionMemo::class)]
132#[UsesClass(\SqlFaker\Generation\Derivation\CompletionReduction::class)]
133#[UsesClass(\SqlFaker\Generation\Derivation\ConstraintDependencies::class)]
134#[UsesClass(\SqlFaker\Generation\Choice\BytePlanCompiler::class)]
135#[UsesClass(\SqlFaker\MySql\Generation\Rewrite\Name\HostNameRule::class)]
136#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\CharsetLexemeGenerator::class)]
137#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\CharsetValueLexemeGenerator::class)]
138#[UsesClass(\SqlFaker\MySql\Generation\Value\IdentifierDomain::class)]
139#[UsesClass(\SqlFaker\MySql\Generation\Value\QuotedDomain::class)]
140#[UsesClass(\SqlFaker\MySql\Generation\Value\RadixDomain::class)]
141#[UsesClass(\SqlFaker\Generation\Value\WordDomain::class)]
142#[UsesClass(\SqlFaker\Generation\Derivation\Completion\PatternProductions::class)]
143#[UsesClass(\SqlFaker\Generation\Derivation\Completion\CompletionWitness::class)]
144#[UsesClass(\SqlFaker\Generation\Value\Utf8::class)]
145#[UsesClass(\SqlFaker\MySql\Generation\Lexeme\LexicalDefinition::class)]
146final class GenerationContextTest extends TestCase
147{
148    public function testBindsTheRequestedReleaseAndPreservesTheGrammarStart(): void
149    {
150        $grammar = new Grammar('entry', ['entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT_SYM')])])]);
151        $context = new GenerationContext($grammar, Factory::create(), 'mysql-8.4.7');
152        self::assertSame('mysql-8.4.7', $context->lexicalGrammar->version());
153        self::assertSame('entry', $context->grammar->startSymbol);
154        self::assertSame($grammar->ruleMap['entry'], $context->grammar->ruleMap['entry']);
155    }
156
157    public function testUsesTheGrammarStartWhenThePlanDoesNotSpecifyOne(): void
158    {
159        $grammar = new Grammar('entry', [
160            'entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT_SYM')])]),
161            'fragment' => new ProductionRule('fragment', [new Production([])]),
162        ]);
163        $faker = Factory::create();
164        $context = new GenerationContext($grammar, $faker, 'mysql-8.4.7');
165        $generator = new SqlGenerator($context->grammar, $faker, $context->lexicalGrammar, $context->rewriter, $context->startSymbol);
166        self::assertSame('SELECT', $generator->generate(GenerationPlan::all()));
167        self::assertSame('', $generator->generate(GenerationPlan::fromRule('fragment')));
168        self::assertSame('SELECT', $generator->generate(GenerationPlan::all()));
169    }
170
171    public function testLeavesThePlanInControlOfNullableProductionChoices(): void
172    {
173        $grammar = new Grammar('entry', ['entry' => new ProductionRule('entry', [
174            new Production([]), new Production([new Terminal('SELECT_SYM')]),
175        ])]);
176        $faker = Factory::create();
177        $context = new GenerationContext($grammar, $faker, 'mysql-8.4.7');
178        $generator = new SqlGenerator($context->grammar, $faker, $context->lexicalGrammar, $context->rewriter, $context->startSymbol);
179        self::assertSame('SELECT', $generator->generate(GenerationPlan::all()->requiringNonEmpty()->withMaxDepth(1)));
180        self::assertSame('', $generator->generate(GenerationPlan::constrained('entry', ['entry' => [ProductionPattern::exactly()]])));
181    }
182
183    public function testReportsMissingLexicalImplementationWhenTheTerminalIsActuallyGenerated(): void
184    {
185        $grammar = new Grammar('entry', [
186            'entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT_SYM')])]),
187            'missing' => new ProductionRule('missing', [new Production([new Terminal('UNIMPLEMENTED')])]),
188        ]);
189        $faker = Factory::create();
190        $context = new GenerationContext($grammar, $faker, 'mysql-8.4.7');
191        $generator = new SqlGenerator($context->grammar, $faker, $context->lexicalGrammar, $context->rewriter, $context->startSymbol);
192        self::assertSame('SELECT', $generator->generate(GenerationPlan::all()));
193        $this->expectException(LexicalException::class);
194        $this->expectExceptionMessage('UNIMPLEMENTED');
195        $generator->generate(GenerationPlan::fromRule('missing'));
196    }
197
198    public function testReportsAnUnknownNonterminalWithoutTreatingItAsSqlText(): void
199    {
200        $grammar = new Grammar('entry', ['entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT_SYM')])])]);
201        $faker = Factory::create();
202        $context = new GenerationContext($grammar, $faker, 'mysql-8.4.7');
203        $generator = new SqlGenerator($context->grammar, $faker, $context->lexicalGrammar, $context->rewriter, $context->startSymbol);
204        $this->expectException(GenerationException::class);
205        $this->expectExceptionMessage('Unknown grammar rule: missing');
206        $generator->generate(GenerationPlan::fromRule('missing'));
207    }
208}
209