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

1<?php
2
3declare(strict_types=1);
4
5namespace Tests\Unit\SqlFaker\PostgreSql\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\PostgreSql\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\Lexeme\Lexeme::class)]
40#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeCandidates::class)]
41#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeInput::class)]
42#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeSequence::class)]
43#[UsesClass(\SqlFaker\Generation\Candidate\MatchingLexemeGenerator::class)]
44#[UsesClass(\SqlFaker\Generation\Candidate\ValueLexemeGenerator::class)]
45#[UsesClass(\SqlFaker\Generation\Candidate\RegisteredLexemeGenerator::class)]
46#[UsesClass(\SqlFaker\Generation\Output\CandidateResolver::class)]
47#[UsesClass(\SqlFaker\Generation\Lexeme\OutputPart::class)]
48#[UsesClass(\SqlFaker\Generation\Lexeme\ResolvedOutput::class)]
49#[UsesClass(\SqlFaker\Generation\Output\ReverseLexemeGenerator::class)]
50#[UsesClass(\SqlFaker\Generation\Output\SqlSerializer::class)]
51#[UsesClass(\SqlFaker\Generation\Output\CombinedSpacingRule::class)]
52#[UsesClass(\SqlFaker\Generation\Lexeme\SpacingConstraint::class)]
53#[UsesClass(\SqlFaker\Generation\Token\ProductionOccurrence::class)]
54#[UsesClass(\SqlFaker\Generation\Token\TerminalMappingRule::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\PostgreSql\Generation\Rewrite\Option\UniqueOptionRule::class)]
60#[UsesClass(\SqlFaker\Generation\Candidate\VersionCase::class)]
61#[UsesClass(\SqlFaker\Generation\Candidate\VersionedLexemeGenerator::class)]
62#[UsesClass(\SqlFaker\PostgreSql\Generation\Tokenization\KeywordIndex::class)]
63#[UsesClass(\SqlFaker\Generation\Value\RandomCharacters::class)]
64#[UsesClass(\SqlFaker\PostgreSql\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\PostgreSql\Generation\Lexeme\DefinitionFactory::class)]
69#[UsesClass(\SqlFaker\PostgreSql\Generation\Lexeme\HashBoundLexemeGenerator::class)]
70#[UsesClass(\SqlFaker\PostgreSql\Generation\Lexeme\KeywordLexemeGenerator::class)]
71#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\CopySourceRule::class)]
72#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\FetchWithTiesRule::class)]
73#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Name\FunctionNameRule::class)]
74#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\HashPartitionBoundRule::class)]
75#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\LimitOffsetRule::class)]
76#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\LookaheadRule::class)]
77#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\OperatorArgumentsRule::class)]
78#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\OverlapsArgumentsRule::class)]
79#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\PublicationObjectRule::class)]
80#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Name\RelationNameRule::class)]
81#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\RewriteDefinitions::class)]
82#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\TimeZoneIntervalRule::class)]
83#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\WindowFrameRule::class)]
84#[UsesClass(\SqlFaker\PostgreSql\Grammar\PgGrammar::class)]
85#[UsesClass(\SqlFaker\PostgreSql\Generation\LexicalGrammar::class)]
86#[UsesClass(\SqlFaker\PostgreSql\Generation\Lookahead\PgLookahead::class)]
87#[UsesClass(\SqlFaker\PostgreSql\Generation\Tokenization\PgTokenizer::class)]
88#[UsesClass(\SqlFaker\Generation\Lexeme\LexemeBoundary::class)]
89#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Expression\ExpressionGroupingRule::class)]
90#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\ConstraintAttributesRule::class)]
91#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Name\AnyRelationNameRule::class)]
92#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Name\IndirectionStarRule::class)]
93#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\GeneratedColumnRule::class)]
94#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Query\SelectOptionsRule::class)]
95#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Routine\TableFunctionRule::class)]
96#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Routine\TypeModifierRule::class)]
97#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Column\IdentityOptionRule::class)]
98#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Query\IntoClauseRule::class)]
99#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Routine\WithinGroupRule::class)]
100#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Name\ColumnNameRule::class)]
101#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Name\AliasRule::class)]
102#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Routine\SubstringRule::class)]
103#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Routine\RangeFunctionOrdinalityRule::class)]
104#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Routine\JsonOptionsRule::class)]
105#[UsesClass(\SqlFaker\Generation\Value\CharacterDomain::class)]
106#[UsesClass(\SqlFaker\Generation\Value\ChoiceDomain::class)]
107#[UsesClass(\SqlFaker\Generation\Value\IntegerDomain::class)]
108#[UsesClass(\SqlFaker\Generation\Value\SequenceDomain::class)]
109#[UsesClass(\SqlFaker\PostgreSql\Generation\Value\DollarQuotedDomain::class)]
110#[UsesClass(\SqlFaker\Generation\Output\BoundaryCompletion::class)]
111#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Column\ConstraintCapabilitiesRule::class)]
112#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Column\ForeignKeyActionRule::class)]
113#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Query\SchemaElementsRule::class)]
114#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Query\ParserOptionsRule::class)]
115#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Routine\JsonTablePathRule::class)]
116#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Routine\AggregateArgumentRule::class)]
117#[UsesClass(\SqlFaker\Generation\Candidate\IntegerLexemeGenerator::class)]
118#[UsesClass(\SqlFaker\Generation\Derivation\CompletionState::class)]
119#[UsesClass(\SqlFaker\Generation\Derivation\CompletionFrontier::class)]
120#[UsesClass(\SqlFaker\Generation\Derivation\ConstrainedCompletion::class)]
121#[UsesClass(\SqlFaker\Generation\Value\ValueChoices::class)]
122#[UsesClass(\SqlFaker\Generation\Derivation\CompletionMemo::class)]
123#[UsesClass(\SqlFaker\Generation\Derivation\CompletionReduction::class)]
124#[UsesClass(\SqlFaker\Generation\Derivation\ConstraintDependencies::class)]
125#[UsesClass(\SqlFaker\Generation\Choice\BytePlanCompiler::class)]
126#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Name\ParserNameRule::class)]
127#[UsesClass(\SqlFaker\PostgreSql\Generation\Rewrite\Column\NumericContextRule::class)]
128#[UsesClass(\SqlFaker\PostgreSql\Generation\Value\IdentifierDomain::class)]
129#[UsesClass(\SqlFaker\PostgreSql\Generation\Value\OperatorDomain::class)]
130#[UsesClass(\SqlFaker\PostgreSql\Generation\Value\QuotedDomain::class)]
131#[UsesClass(\SqlFaker\Generation\Value\WordDomain::class)]
132#[UsesClass(\SqlFaker\Generation\Derivation\Completion\PatternProductions::class)]
133#[UsesClass(\SqlFaker\Generation\Derivation\Completion\CompletionWitness::class)]
134#[UsesClass(\SqlFaker\PostgreSql\Generation\Lexeme\LexicalDefinition::class)]
135final class GenerationContextTest extends TestCase
136{
137    public function testBindsTheRequestedReleaseAndPreservesTheGrammarStart(): void
138    {
139        $grammar = new Grammar('entry', ['entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT')])])]);
140        $context = new GenerationContext($grammar, Factory::create(), 'pg-17.2');
141        self::assertSame('pg-17.2', $context->lexicalGrammar->version());
142        self::assertSame('entry', $context->grammar->startSymbol);
143        self::assertSame($grammar->ruleMap['entry'], $context->grammar->ruleMap['entry']);
144    }
145
146    public function testUsesTheGrammarStartWhenThePlanDoesNotSpecifyOne(): void
147    {
148        $grammar = new Grammar('entry', [
149            'entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT')])]),
150            'fragment' => new ProductionRule('fragment', [new Production([])]),
151        ]);
152        $faker = Factory::create();
153        $context = new GenerationContext($grammar, $faker, 'pg-17.2');
154        $generator = new SqlGenerator($context->grammar, $faker, $context->lexicalGrammar, $context->rewriter, $context->startSymbol);
155        self::assertSame('SELECT', $generator->generate(GenerationPlan::all()));
156        self::assertSame('', $generator->generate(GenerationPlan::fromRule('fragment')));
157        self::assertSame('SELECT', $generator->generate(GenerationPlan::all()));
158    }
159
160    public function testLeavesThePlanInControlOfNullableProductionChoices(): void
161    {
162        $grammar = new Grammar('entry', ['entry' => new ProductionRule('entry', [
163            new Production([]), new Production([new Terminal('SELECT')]),
164        ])]);
165        $faker = Factory::create();
166        $context = new GenerationContext($grammar, $faker, 'pg-17.2');
167        $generator = new SqlGenerator($context->grammar, $faker, $context->lexicalGrammar, $context->rewriter, $context->startSymbol);
168        self::assertSame('SELECT', $generator->generate(GenerationPlan::all()->requiringNonEmpty()->withMaxDepth(1)));
169        self::assertSame('', $generator->generate(GenerationPlan::constrained('entry', ['entry' => [ProductionPattern::exactly()]])));
170    }
171
172    public function testReportsMissingLexicalImplementationWhenTheTerminalIsActuallyGenerated(): void
173    {
174        $grammar = new Grammar('entry', [
175            'entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT')])]),
176            'missing' => new ProductionRule('missing', [new Production([new Terminal('UNIMPLEMENTED')])]),
177        ]);
178        $faker = Factory::create();
179        $context = new GenerationContext($grammar, $faker, 'pg-17.2');
180        $generator = new SqlGenerator($context->grammar, $faker, $context->lexicalGrammar, $context->rewriter, $context->startSymbol);
181        self::assertSame('SELECT', $generator->generate(GenerationPlan::all()));
182        $this->expectException(LexicalException::class);
183        $this->expectExceptionMessage('UNIMPLEMENTED');
184        $generator->generate(GenerationPlan::fromRule('missing'));
185    }
186
187    public function testReportsAnUnknownNonterminalWithoutTreatingItAsSqlText(): void
188    {
189        $grammar = new Grammar('entry', ['entry' => new ProductionRule('entry', [new Production([new Terminal('SELECT')])])]);
190        $faker = Factory::create();
191        $context = new GenerationContext($grammar, $faker, 'pg-17.2');
192        $generator = new SqlGenerator($context->grammar, $faker, $context->lexicalGrammar, $context->rewriter, $context->startSymbol);
193        $this->expectException(GenerationException::class);
194        $this->expectExceptionMessage('Unknown grammar rule: missing');
195        $generator->generate(GenerationPlan::fromRule('missing'));
196    }
197}
198