packages/deriver/tests/Unit/Deriver/Execution/DerivationResultTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Execution;
6
7use Deriver\Deriver;
8use Deriver\Deriver\Candidate\ResultRef;
9use Deriver\Deriver\Candidate\Snapshot;
10use Deriver\Deriver\Candidate\Statistics;
11use Deriver\Deriver\Contributions;
12use Deriver\Deriver\DeriverConfig;
13use Deriver\Deriver\Evaluator\Builtin\Library;
14use Deriver\Deriver\Evaluator\Call\Evaluators;
15use Deriver\Deriver\Evaluator\Call\Extensions;
16use Deriver\Deriver\Evaluator\Call\Registrations;
17use Deriver\Deriver\Evaluator\Call\StateRegistry;
18use Deriver\Deriver\Evaluator\EvaluatorConfig;
19use Deriver\Deriver\Evaluator\Evidence\Frontier;
20use Deriver\Deriver\Evaluator\Execution\Call\Allocation;
21use Deriver\Deriver\Evaluator\Execution\Call\ArgumentBinding;
22use Deriver\Deriver\Evaluator\Execution\Call\ArgumentOrder;
23use Deriver\Deriver\Evaluator\Execution\Call\CallableCheck;
24use Deriver\Deriver\Evaluator\Execution\Call\CallExecutor;
25use Deriver\Deriver\Evaluator\Execution\Call\CallResolution;
26use Deriver\Deriver\Evaluator\Execution\Call\Creation\Access;
27use Deriver\Deriver\Evaluator\Execution\Call\Member\Invocation;
28use Deriver\Deriver\Evaluator\Execution\Call\Native\Invocation as NativeInvocation;
29use Deriver\Deriver\Evaluator\Execution\Call\Native\Properties;
30use Deriver\Deriver\Evaluator\Execution\Call\Native\Signatures;
31use Deriver\Deriver\Evaluator\Execution\Call\ParameterBinding;
32use Deriver\Deriver\Evaluator\Execution\Call\PassedArgument;
33use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Creation;
34use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Resolution;
35use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Target;
36use Deriver\Deriver\Evaluator\Execution\Call\Preparation\Transfer;
37use Deriver\Deriver\Evaluator\Execution\Call\SymbolicEnums;
38use Deriver\Deriver\Evaluator\Execution\Call\TypeBinding;
39use Deriver\Deriver\Evaluator\Execution\Call\TypeCheck;
40use Deriver\Deriver\Evaluator\Execution\Call\UnknownCall;
41use Deriver\Deriver\Evaluator\Execution\Completion\Alternative;
42use Deriver\Deriver\Evaluator\Execution\Completion\Assessment;
43use Deriver\Deriver\Evaluator\Execution\Completion\Completion;
44use Deriver\Deriver\Evaluator\Execution\Completion\Exceptional;
45use Deriver\Deriver\Evaluator\Execution\Completion\StorageSnapshot;
46use Deriver\Deriver\Evaluator\Execution\Constraints;
47use Deriver\Deriver\Evaluator\Execution\Context;
48use Deriver\Deriver\Evaluator\Execution\Control\ExceptionMatch;
49use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
50use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
51use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
52use Deriver\Deriver\Evaluator\Execution\Demand\Cell;
53use Deriver\Deriver\Evaluator\Execution\Demand\Components;
54use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
55use Deriver\Deriver\Evaluator\Execution\Demand\Key;
56use Deriver\Deriver\Evaluator\Execution\Demand\Table;
57use Deriver\Deriver\Evaluator\Execution\Dependencies;
58use Deriver\Deriver\Evaluator\Execution\Evaluator;
59use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
60use Deriver\Deriver\Evaluator\Execution\Havoc;
61use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
62use Deriver\Deriver\Evaluator\Execution\Memory\Location;
63use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
64use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
65use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
66use Deriver\Deriver\Evaluator\Execution\Memory\Slots\StateStorage;
67use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
68use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
69use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
70use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
71use Deriver\Deriver\Evaluator\Execution\State;
72use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
73use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
74use Deriver\Deriver\Evaluator\Execution\Summary\Invocation as SummaryInvocation;
75use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
76use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
77use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
78use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
79use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
80use Deriver\Deriver\Evaluator\Request\Budget;
81use Deriver\Deriver\Evaluator\Request\EntryPoint;
82use Deriver\Deriver\Evaluator\Request\QueryScope;
83use Deriver\Deriver\Evaluator\Request\ReturnQuery;
84use Deriver\Deriver\Evaluator\Scalar\Arithmetic;
85use Deriver\Deriver\Evaluator\Scalar\Arrays;
86use Deriver\Deriver\Evaluator\Scalar\Identity;
87use Deriver\Deriver\Evaluator\Scalar\Operations;
88use Deriver\Deriver\Evaluator\TargetProfile;
89use Deriver\Deriver\Evaluator\Term;
90use Deriver\Deriver\Execution\DerivationResult;
91use Deriver\Deriver\Execution\QueryExecution;
92use Deriver\Deriver\Execution\ResultAssessment;
93use Deriver\Deriver\Identity\QueryEncoding;
94use Deriver\Deriver\Identity\ValueGraph;
95use Deriver\Deriver\Lowerer\AggregateLowering;
96use Deriver\Deriver\Lowerer\CallLowering;
97use Deriver\Deriver\Lowerer\Control\ConditionalLowering;
98use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
99use Deriver\Deriver\Lowerer\Declaration\CallableSource;
100use Deriver\Deriver\Lowerer\Declaration\Index;
101use Deriver\Deriver\Lowerer\Declaration\Indexer;
102use Deriver\Deriver\Lowerer\Declaration\Metadata\PropertyDeclaration;
103use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
104use Deriver\Deriver\Lowerer\EffectInspection;
105use Deriver\Deriver\Lowerer\ExpressionLowering;
106use Deriver\Deriver\Lowerer\Graph\BasicBlock;
107use Deriver\Deriver\Lowerer\Graph\CallableGraph;
108use Deriver\Deriver\Lowerer\Graph\Instruction;
109use Deriver\Deriver\Lowerer\Graph\Parameter;
110use Deriver\Deriver\Lowerer\Graph\Terminator;
111use Deriver\Deriver\Lowerer\Hierarchy\Builtins;
112use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
113use Deriver\Deriver\Lowerer\InstructionEmitter;
114use Deriver\Deriver\Lowerer\Lowerer;
115use Deriver\Deriver\Lowerer\LoweringScope;
116use Deriver\Deriver\Lowerer\StatementLowering;
117use Deriver\Deriver\MicroEvaluatorConversion;
118use Deriver\Deriver\Parser\Node\File;
119use Deriver\Deriver\Parser\Parser;
120use Deriver\Deriver\Parser\ParserConfig;
121use Deriver\Deriver\Parser\TargetSyntax;
122use Deriver\Deriver\Providers\ProviderExpansion;
123use Deriver\Deriver\Resolver\AssignmentPatterns;
124use Deriver\Deriver\Resolver\ClassScope;
125use Deriver\Deriver\Resolver\ExpressionValidation;
126use Deriver\Deriver\Resolver\MagicContext;
127use Deriver\Deriver\Resolver\Resolver;
128use Deriver\Deriver\Selection\QueryValidation;
129use Deriver\Deriver\SnapshotIdentity;
130use Deriver\Deriver\Sources\LineMap;
131use Deriver\Deriver\Sources\Path;
132use Deriver\Deriver\Sources\Source;
133use Deriver\Deriver\Sources\SourceRef;
134use Deriver\Deriver\Sources\Sources;
135use Deriver\Exception\ParserException;
136use Deriver\Exception\ResolutionException;
137use PHPUnit\Framework\Attributes\CoversClass;
138use PHPUnit\Framework\Attributes\DataProvider;
139use PHPUnit\Framework\Attributes\Small;
140use PHPUnit\Framework\Attributes\UsesClass;
141use PHPUnit\Framework\TestCase;
142
143#[UsesClass(Resolver::class)]
144#[UsesClass(ExpressionValidation::class)]
145#[UsesClass(ResolutionException::class)]
146#[UsesClass(ParserConfig::class)]
147#[UsesClass(ParserException::class)]
148#[CoversClass(DerivationResult::class)]
149#[UsesClass(QueryExecution::class)]
150#[UsesClass(QueryValidation::class)]
151#[UsesClass(ResultAssessment::class)]
152#[UsesClass(Deriver::class)]
153#[UsesClass(Constraints::class)]
154#[UsesClass(BasicBlock::class)]
155#[UsesClass(CallableGraph::class)]
156#[UsesClass(CallableIdentity::class)]
157#[UsesClass(Instruction::class)]
158#[UsesClass(Parameter::class)]
159#[UsesClass(PropertyDeclaration::class)]
160#[UsesClass(Terminator::class)]
161#[UsesClass(Allocation::class)]
162#[UsesClass(ArgumentBinding::class)]
163#[UsesClass(ArgumentOrder::class)]
164#[UsesClass(CallExecutor::class)]
165#[UsesClass(CallResolution::class)]
166#[UsesClass(CallableCheck::class)]
167#[UsesClass(Access::class)]
168#[UsesClass(Builtins::class)]
169#[UsesClass(Dispatch::class)]
170#[UsesClass(Invocation::class)]
171#[UsesClass(NativeInvocation::class)]
172#[UsesClass(Properties::class)]
173#[UsesClass(Signatures::class)]
174#[UsesClass(ParameterBinding::class)]
175#[UsesClass(PassedArgument::class)]
176#[UsesClass(Creation::class)]
177#[UsesClass(Resolution::class)]
178#[UsesClass(Target::class)]
179#[UsesClass(Transfer::class)]
180#[UsesClass(SymbolicEnums::class)]
181#[UsesClass(TypeBinding::class)]
182#[UsesClass(TypeCheck::class)]
183#[UsesClass(UnknownCall::class)]
184#[UsesClass(Completion::class)]
185#[UsesClass(Context::class)]
186#[UsesClass(ExceptionMatch::class)]
187#[UsesClass(ObservationLimit::class)]
188#[UsesClass(StateJoin::class)]
189#[UsesClass(Unwinding::class)]
190#[UsesClass(Cell::class)]
191#[UsesClass(Components::class)]
192#[UsesClass(Discovery::class)]
193#[UsesClass(Key::class)]
194#[UsesClass(Table::class)]
195#[UsesClass(Dependencies::class)]
196#[UsesClass(Havoc::class)]
197#[UsesClass(InstructionTransfer::class)]
198#[UsesClass(Evaluator::class)]
199#[UsesClass(SlotReference::class)]
200#[UsesClass(StateStorage::class)]
201#[UsesClass(ObservationCollector::class)]
202#[UsesClass(Conversions::class)]
203#[UsesClass(ScalarErrors::class)]
204#[UsesClass(State::class)]
205#[UsesClass(CompletionRecord::class)]
206#[UsesClass(Evaluation::class)]
207#[UsesClass(SummaryInvocation::class)]
208#[UsesClass(Isolation::class)]
209#[UsesClass(MemoryStep::class)]
210#[UsesClass(PureStep::class)]
211#[UsesClass(ReferenceAssignment::class)]
212#[UsesClass(Location::class)]
213#[UsesClass(Materialization::class)]
214#[UsesClass(Memory::class)]
215#[UsesClass(StorageCapture::class)]
216#[UsesClass(Library::class)]
217#[UsesClass(Extensions::class)]
218#[UsesClass(ProviderExpansion::class)]
219#[UsesClass(Evaluators::class)]
220#[UsesClass(StateRegistry::class)]
221#[UsesClass(DeriverConfig::class)]
222#[UsesClass(EntryPoint::class)]
223#[UsesClass(Sources::class)]
224#[UsesClass(Path::class)]
225#[UsesClass(Snapshot::class)]
226#[UsesClass(Source::class)]
227#[UsesClass(TargetProfile::class)]
228#[UsesClass(Budget::class)]
229#[UsesClass(QueryScope::class)]
230#[UsesClass(ReturnQuery::class)]
231#[UsesClass(ResultRef::class)]
232#[UsesClass(SourceRef::class)]
233#[UsesClass(Alternative::class)]
234#[UsesClass(Assessment::class)]
235#[UsesClass(Derivation::class)]
236#[UsesClass(Exceptional::class)]
237#[UsesClass(Frontier::class)]
238#[UsesClass(QueryEncoding::class)]
239#[UsesClass(ValueGraph::class)]
240#[UsesClass(Statistics::class)]
241#[UsesClass(StorageSnapshot::class)]
242#[UsesClass(Parser::class)]
243#[UsesClass(File::class)]
244#[UsesClass(AggregateLowering::class)]
245#[UsesClass(CallLowering::class)]
246#[UsesClass(Lowerer::class)]
247#[UsesClass(ConditionalLowering::class)]
248#[UsesClass(EffectInspection::class)]
249#[UsesClass(ExpressionLowering::class)]
250#[UsesClass(InstructionEmitter::class)]
251#[UsesClass(LoweringScope::class)]
252#[UsesClass(StatementLowering::class)]
253#[UsesClass(CallableSource::class)]
254#[UsesClass(Indexer::class)]
255#[UsesClass(Index::class)]
256#[UsesClass(Composition::class)]
257#[UsesClass(LineMap::class)]
258#[UsesClass(MagicContext::class)]
259#[UsesClass(AssignmentPatterns::class)]
260#[UsesClass(ClassScope::class)]
261#[UsesClass(TargetSyntax::class)]
262#[UsesClass(Arithmetic::class)]
263#[UsesClass(Arrays::class)]
264#[UsesClass(Identity::class)]
265#[UsesClass(Operations::class)]
266#[UsesClass(Term::class)]
267#[Small]
268final class DerivationResultTest extends TestCase
269{
270    public function testDefiniteSelectsTheOnlyConcreteOutcome(): void
271    {
272        $source = '<?php function target(){return ["a" => 1 + 2];}';
273        $symbol = 'target';
274        $input = new Sources([new Source('fixture.php', $source)]);
275        $configuration = new DeriverConfig();
276        $contributions = new Contributions();
277        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
278        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
279        $contributions1 = $providers->contributions;
280        $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);
281        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
282        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
283        $snapshotId = $identity->id;
284        $input1 = $providers->input;
285        $parser = new Parser(new ParserConfig($target->version));
286        $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));
287        $program = new Index($snapshotId, $trees);
288        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
289        self::assertSame(['a' => 3], $result->definite()?->values['return']->native());
290    }
291    /**
292     * @param string $source Fixture whose closed result still is not one definite value
293     */
294    #[DataProvider('providerIndefiniteResults')]
295    public function testDefiniteRejectsResultsThatDependOnMoreThanTheSource(string $source): void
296    {
297        $symbol = 'target';
298        $input = new Sources([new Source('fixture.php', $source)]);
299        $configuration = new DeriverConfig();
300        $contributions = new Contributions();
301        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
302        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
303        $contributions1 = $providers->contributions;
304        $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);
305        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
306        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
307        $snapshotId = $identity->id;
308        $input1 = $providers->input;
309        $parser = new Parser(new ParserConfig($target->version));
310        $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));
311        $program = new Index($snapshotId, $trees);
312        self::assertNull((new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol))->definite());
313    }
314    /**
315     * @return array<string, array{string}>
316     */
317    public static function providerIndefiniteResults(): array
318    {
319        return ['warning frontier' => ['<?php function target(){return $missing;}'], 'exceptional outcome' => ['<?php function target(bool $flag){if ($flag) {throw new LogicException();} return 1;}'], 'several alternatives' => ['<?php function target(bool $flag){return $flag ? 1 : 2;}'], 'symbolic value' => ['<?php function target(int $id){return $id + 1;}'], 'unresolved dependency' => ['<?php function target(){return remote();}'], 'project diagnostic' => ["<?php function target(){return 1;}\nfunction target(){return 2;}"]];
320    }
321}
322