packages/deriver/tests/Unit/Deriver/Evaluator/Execution/Control/ResidualPathsTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Evaluator\Execution\Control;
6
7use Deriver\Deriver\Contributions;
8use Deriver\Deriver\DeriverConfig;
9use Deriver\Deriver\Evaluator\Call\Evaluators;
10use Deriver\Deriver\Evaluator\Call\Extensions;
11use Deriver\Deriver\Evaluator\Call\Registrations;
12use Deriver\Deriver\Evaluator\Call\StateRegistry;
13use Deriver\Deriver\Evaluator\EvaluatorConfig;
14use Deriver\Deriver\Evaluator\Evidence\Frontier;
15use Deriver\Deriver\Evaluator\Execution\Completion\Completion;
16use Deriver\Deriver\Evaluator\Execution\Context;
17use Deriver\Deriver\Evaluator\Execution\Control\ResidualPaths;
18use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
19use Deriver\Deriver\Evaluator\Execution\Havoc;
20use Deriver\Deriver\Evaluator\Execution\Memory\Location;
21use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
22use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
23use Deriver\Deriver\Evaluator\Execution\State;
24use Deriver\Deriver\Evaluator\Request\Budget;
25use Deriver\Deriver\Evaluator\Request\QueryScope;
26use Deriver\Deriver\Evaluator\Request\ReturnQuery;
27use Deriver\Deriver\Evaluator\TargetProfile;
28use Deriver\Deriver\Evaluator\Term;
29use Deriver\Deriver\Evaluator\TermKind;
30use Deriver\Deriver\Execution\QueryExecution;
31use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
32use Deriver\Deriver\Lowerer\Declaration\CallableSource;
33use Deriver\Deriver\Lowerer\Declaration\Index;
34use Deriver\Deriver\Lowerer\Declaration\Indexer;
35use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
36use Deriver\Deriver\MicroEvaluatorConversion;
37use Deriver\Deriver\Parser\Node\File;
38use Deriver\Deriver\Parser\Parser;
39use Deriver\Deriver\Parser\ParserConfig;
40use Deriver\Deriver\Parser\TargetSyntax;
41use Deriver\Deriver\Providers\ProviderExpansion;
42use Deriver\Deriver\Resolver\AssignmentPatterns;
43use Deriver\Deriver\Resolver\ClassScope;
44use Deriver\Deriver\Resolver\ExpressionValidation;
45use Deriver\Deriver\Resolver\MagicContext;
46use Deriver\Deriver\Resolver\Resolver;
47use Deriver\Deriver\SnapshotIdentity;
48use Deriver\Deriver\Sources\LineMap;
49use Deriver\Deriver\Sources\Path;
50use Deriver\Deriver\Sources\Source;
51use Deriver\Deriver\Sources\SourceRef;
52use Deriver\Deriver\Sources\Sources;
53use Deriver\Exception\ParserException;
54use Deriver\Exception\ResolutionException;
55use PHPUnit\Framework\Attributes\CoversClass;
56use PHPUnit\Framework\Attributes\Small;
57use PHPUnit\Framework\Attributes\UsesClass;
58use PHPUnit\Framework\TestCase;
59
60/**
61 * @covers \Deriver\Deriver\Evaluator\Execution\Control\ResidualPaths
62 */
63#[UsesClass(Resolver::class)]
64#[UsesClass(ExpressionValidation::class)]
65#[UsesClass(ResolutionException::class)]
66#[UsesClass(ParserConfig::class)]
67#[UsesClass(ParserException::class)]
68#[CoversClass(ResidualPaths::class)]
69#[UsesClass(CallableIdentity::class)]
70#[UsesClass(Completion::class)]
71#[UsesClass(Context::class)]
72#[UsesClass(Havoc::class)]
73#[UsesClass(State::class)]
74#[UsesClass(Location::class)]
75#[UsesClass(Materialization::class)]
76#[UsesClass(Memory::class)]
77#[UsesClass(Extensions::class)]
78#[UsesClass(Evaluators::class)]
79#[UsesClass(StateRegistry::class)]
80#[UsesClass(DeriverConfig::class)]
81#[UsesClass(Sources::class)]
82#[UsesClass(Path::class)]
83#[UsesClass(Source::class)]
84#[UsesClass(TargetProfile::class)]
85#[UsesClass(Budget::class)]
86#[UsesClass(QueryScope::class)]
87#[UsesClass(ReturnQuery::class)]
88#[UsesClass(SourceRef::class)]
89#[UsesClass(Frontier::class)]
90#[UsesClass(Parser::class)]
91#[UsesClass(File::class)]
92#[UsesClass(CallableSource::class)]
93#[UsesClass(Indexer::class)]
94#[UsesClass(Index::class)]
95#[UsesClass(Composition::class)]
96#[UsesClass(LineMap::class)]
97#[UsesClass(MagicContext::class)]
98#[UsesClass(AssignmentPatterns::class)]
99#[UsesClass(ClassScope::class)]
100#[UsesClass(TargetSyntax::class)]
101#[UsesClass(Term::class)]
102#[Small]
103final class ResidualPathsTest extends TestCase
104{
105    public function testSealKeepsNormalAndExceptionalResidualsAndHavocsState(): void
106    {
107        $source = '<?php function target(){return 1;}';
108        $budget = new Budget();
109        $configuration = new DeriverConfig();
110        $contributions = new Contributions();
111        $input = new Sources([new Source('fixture.php', $source)]);
112        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
113        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
114        $contributions1 = $providers->contributions;
115        $evaluators = new Evaluators(new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision), new Registrations($contributions1->evaluators, $contributions1->providers, $contributions1->domains, $contributions1->intrinsics, $contributions1->stateSlots), $configuration->standardEvaluators);
116        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
117        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
118        $snapshotId = $identity->id;
119        $input1 = $providers->input;
120        $parser = new Parser(new ParserConfig($target->version));
121        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
122        $program1 = new Index($snapshotId, $trees);
123        $execution = new QueryExecution($program1, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program1->diagnostics())));
124        $snapshotId1 = 'test';
125        $input2 = new Sources([new Source('fixture.php', $source)]);
126        $profile = $execution->configuration->target;
127        $parser1 = new Parser(new ParserConfig($profile->version));
128        $trees1 = array_map(static fn (Source $source2): File => (new Resolver())->resolve($parser1->parse(new Source(Path::normalize($source2->path), $source2->contents, $source2->declarationsOnly))), iterator_to_array($input2, false));
129        $program = new Index($snapshotId1, $trees1);
130        $context = new Context($program, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators);
131        $state = new State();
132        $state->memory->write($state->local('x'), Term::constant(1));
133        $paths = (new ResidualPaths($context))->seal($state, new SourceRef('test', 'fixture.php', 0, 1), 'depth');
134        self::assertSame(['return', 'throw'], array_map(static fn (State $state): string => $state->completion->kind->value, $paths));
135        self::assertSame(TermKind::Opaque, $paths[0]->snapshot()['x']->kind);
136        self::assertTrue($paths[1]->completion->value?->attributes['uncertain']);
137        self::assertSame('BUDGET_EXCEEDED', array_values($context->frontiers)[0]->code);
138    }
139    public function testInvocationHavocsOnlyStorageTheCalleeCanReach(): void
140    {
141        $source = '<?php function target(){return 1;}';
142        $budget = new Budget();
143        $configuration = new DeriverConfig();
144        $contributions = new Contributions();
145        $input = new Sources([new Source('fixture.php', $source)]);
146        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
147        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
148        $contributions1 = $providers->contributions;
149        $evaluators = new Evaluators(new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision), new Registrations($contributions1->evaluators, $contributions1->providers, $contributions1->domains, $contributions1->intrinsics, $contributions1->stateSlots), $configuration->standardEvaluators);
150        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
151        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
152        $snapshotId = $identity->id;
153        $input1 = $providers->input;
154        $parser = new Parser(new ParserConfig($target->version));
155        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
156        $program1 = new Index($snapshotId, $trees);
157        $execution = new QueryExecution($program1, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program1->diagnostics())));
158        $snapshotId1 = 'test';
159        $input2 = new Sources([new Source('fixture.php', $source)]);
160        $profile = $execution->configuration->target;
161        $parser1 = new Parser(new ParserConfig($profile->version));
162        $trees1 = array_map(static fn (Source $source2): File => (new Resolver())->resolve($parser1->parse(new Source(Path::normalize($source2->path), $source2->contents, $source2->declarationsOnly))), iterator_to_array($input2, false));
163        $program = new Index($snapshotId1, $trees1);
164        $context = new Context($program, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators);
165        $state = new State();
166        $caller = $state->memory->allocate(Term::constant('caller'));
167        $shared = $state->memory->allocate(Term::constant('shared'));
168        $state->locals['argument'] = $state->memory->allocate(Term::constant('copy'));
169        $state->locals['reference'] = new Location($shared->root);
170        $paths = (new ResidualPaths($context))->invocation($state, new SourceRef('test', 'fixture.php', 0, 1), 'recursive-specialization');
171        self::assertSame(['return', 'throw'], array_map(static fn (State $state): string => $state->completion->kind->value, $paths));
172        self::assertSame('caller', $paths[0]->memory->read($caller)->native());
173        self::assertSame(TermKind::Opaque, $paths[0]->memory->read($shared)->kind);
174        self::assertSame('BUDGET_EXCEEDED', $paths[0]->memory->unknownShared);
175        self::assertSame(['BUDGET_EXCEEDED'], array_column(array_values($context->frontiers), 'code'));
176    }
177    public function testCompleteKeepsTheGivenResidualWithoutRecordingAnotherFrontier(): void
178    {
179        $source = '<?php function target(){return 1;}';
180        $budget = new Budget();
181        $configuration = new DeriverConfig();
182        $contributions = new Contributions();
183        $input = new Sources([new Source('fixture.php', $source)]);
184        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
185        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
186        $contributions1 = $providers->contributions;
187        $evaluators = new Evaluators(new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision), new Registrations($contributions1->evaluators, $contributions1->providers, $contributions1->domains, $contributions1->intrinsics, $contributions1->stateSlots), $configuration->standardEvaluators);
188        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
189        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
190        $snapshotId = $identity->id;
191        $input1 = $providers->input;
192        $parser = new Parser(new ParserConfig($target->version));
193        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
194        $program1 = new Index($snapshotId, $trees);
195        $execution = new QueryExecution($program1, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program1->diagnostics())));
196        $snapshotId1 = 'test';
197        $input2 = new Sources([new Source('fixture.php', $source)]);
198        $profile = $execution->configuration->target;
199        $parser1 = new Parser(new ParserConfig($profile->version));
200        $trees1 = array_map(static fn (Source $source2): File => (new Resolver())->resolve($parser1->parse(new Source(Path::normalize($source2->path), $source2->contents, $source2->declarationsOnly))), iterator_to_array($input2, false));
201        $program = new Index($snapshotId1, $trees1);
202        $context = new Context($program, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators);
203        $state = new State();
204        $state->constraints = ['x' => ['min' => 1, 'max' => null, 'equal' => null, 'excluded' => []]];
205        $paths = (new ResidualPaths($context))->complete($state, Term::opaque('UNSUPPORTED_LANGUAGE_FEATURE'));
206        self::assertSame(['return', 'throw'], array_map(static fn (State $state): string => $state->completion->kind->value, $paths));
207        self::assertSame('UNSUPPORTED_LANGUAGE_FEATURE', $paths[0]->completion->value?->literal);
208        self::assertSame([], $paths[0]->constraints);
209        self::assertSame([], $context->frontiers);
210    }
211    public function testSealPreservesInaccessibleCallerCells(): void
212    {
213        $source = '<?php function target(){return 1;}';
214        $budget = new Budget();
215        $configuration = new DeriverConfig();
216        $contributions = new Contributions();
217        $input = new Sources([new Source('fixture.php', $source)]);
218        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
219        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
220        $contributions1 = $providers->contributions;
221        $evaluators = new Evaluators(new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision), new Registrations($contributions1->evaluators, $contributions1->providers, $contributions1->domains, $contributions1->intrinsics, $contributions1->stateSlots), $configuration->standardEvaluators);
222        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
223        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
224        $snapshotId = $identity->id;
225        $input1 = $providers->input;
226        $parser = new Parser(new ParserConfig($target->version));
227        $trees = array_map(static fn (Source $source1): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source1->path), $source1->contents, $source1->declarationsOnly))), iterator_to_array($input1, false));
228        $program1 = new Index($snapshotId, $trees);
229        $execution = new QueryExecution($program1, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program1->diagnostics())));
230        $snapshotId1 = 'test';
231        $input2 = new Sources([new Source('fixture.php', $source)]);
232        $profile = $execution->configuration->target;
233        $parser1 = new Parser(new ParserConfig($profile->version));
234        $trees1 = array_map(static fn (Source $source2): File => (new Resolver())->resolve($parser1->parse(new Source(Path::normalize($source2->path), $source2->contents, $source2->declarationsOnly))), iterator_to_array($input2, false));
235        $program = new Index($snapshotId1, $trees1);
236        $context = new Context($program, new ReturnQuery('target', budget: $budget), $execution->configuration, $execution->evaluators);
237        $state = new State();
238        $caller = $state->memory->allocate(new Term(TermKind::Object, 'pdo', attributes: ['class' => 'PDO']));
239        $shared = $state->memory->allocate(Term::constant('shared'));
240        $state->locals['reference'] = $shared;
241        $paths = (new ResidualPaths($context))->seal($state, new SourceRef('test', 'fixture.php', 0, 1), 'partition-limit');
242        self::assertSame('PDO', $paths[0]->memory->read($caller)->attributes['class']);
243        self::assertSame(TermKind::Opaque, $paths[0]->memory->read($shared)->kind);
244    }
245}
246