packages/deriver/tests/Unit/Deriver/Lowerer/EffectInspectionTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Lowerer;
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\Call\Evaluators;
14use Deriver\Deriver\Evaluator\Call\Extensions;
15use Deriver\Deriver\Evaluator\Call\Registrations;
16use Deriver\Deriver\Evaluator\Call\StateRegistry;
17use Deriver\Deriver\Evaluator\EvaluatorConfig;
18use Deriver\Deriver\Evaluator\Evidence\Frontier;
19use Deriver\Deriver\Evaluator\Execution\Call\ArgumentBinding;
20use Deriver\Deriver\Evaluator\Execution\Call\ArgumentOrder;
21use Deriver\Deriver\Evaluator\Execution\Call\TypeBinding;
22use Deriver\Deriver\Evaluator\Execution\Call\TypeCheck;
23use Deriver\Deriver\Evaluator\Execution\Completion\Alternative;
24use Deriver\Deriver\Evaluator\Execution\Completion\Assessment;
25use Deriver\Deriver\Evaluator\Execution\Completion\Completion;
26use Deriver\Deriver\Evaluator\Execution\Completion\Exceptional;
27use Deriver\Deriver\Evaluator\Execution\Completion\Quality\Coverage;
28use Deriver\Deriver\Evaluator\Execution\Completion\StorageSnapshot;
29use Deriver\Deriver\Evaluator\Execution\Context;
30use Deriver\Deriver\Evaluator\Execution\Control\ExceptionMatch;
31use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
32use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
33use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
34use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
35use Deriver\Deriver\Evaluator\Execution\Dependencies;
36use Deriver\Deriver\Evaluator\Execution\Evaluator;
37use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
38use Deriver\Deriver\Evaluator\Execution\Havoc;
39use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
40use Deriver\Deriver\Evaluator\Execution\Memory\Location;
41use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
42use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
43use Deriver\Deriver\Evaluator\Execution\Memory\ReferenceConstraint;
44use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
45use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
46use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
47use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
48use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
49use Deriver\Deriver\Evaluator\Execution\State;
50use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
51use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
52use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
53use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
54use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
55use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
56use Deriver\Deriver\Evaluator\Request\Budget;
57use Deriver\Deriver\Evaluator\Request\EntryPoint;
58use Deriver\Deriver\Evaluator\Request\QueryScope;
59use Deriver\Deriver\Evaluator\Request\ReturnQuery;
60use Deriver\Deriver\Evaluator\Scalar\Arithmetic;
61use Deriver\Deriver\Evaluator\Scalar\Identity;
62use Deriver\Deriver\Evaluator\Scalar\Increment;
63use Deriver\Deriver\Evaluator\Scalar\Operations;
64use Deriver\Deriver\Evaluator\TargetProfile;
65use Deriver\Deriver\Evaluator\Term;
66use Deriver\Deriver\Execution\DerivationResult;
67use Deriver\Deriver\Execution\QueryExecution;
68use Deriver\Deriver\Execution\ResultAssessment;
69use Deriver\Deriver\Identity\QueryEncoding;
70use Deriver\Deriver\Identity\ValueGraph;
71use Deriver\Deriver\Lowerer\AssignmentLowering;
72use Deriver\Deriver\Lowerer\Control\DestructuringLowering;
73use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
74use Deriver\Deriver\Lowerer\Declaration\CallableSource;
75use Deriver\Deriver\Lowerer\Declaration\Index;
76use Deriver\Deriver\Lowerer\Declaration\Indexer;
77use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
78use Deriver\Deriver\Lowerer\EffectInspection;
79use Deriver\Deriver\Lowerer\ExpressionLowering;
80use Deriver\Deriver\Lowerer\Graph\BasicBlock;
81use Deriver\Deriver\Lowerer\Graph\CallableGraph;
82use Deriver\Deriver\Lowerer\Graph\Instruction;
83use Deriver\Deriver\Lowerer\Graph\Literal;
84use Deriver\Deriver\Lowerer\Graph\Terminator;
85use Deriver\Deriver\Lowerer\Hierarchy\Builtins;
86use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
87use Deriver\Deriver\Lowerer\InstructionEmitter;
88use Deriver\Deriver\Lowerer\Lowerer;
89use Deriver\Deriver\Lowerer\LoweringScope;
90use Deriver\Deriver\Lowerer\StatementLowering;
91use Deriver\Deriver\MicroEvaluatorConversion;
92use Deriver\Deriver\Parser\Node\File;
93use Deriver\Deriver\Parser\Parser;
94use Deriver\Deriver\Parser\ParserConfig;
95use Deriver\Deriver\Parser\TargetSyntax;
96use Deriver\Deriver\Providers\ProviderExpansion;
97use Deriver\Deriver\Resolver\AssignmentPatterns;
98use Deriver\Deriver\Resolver\ClassScope;
99use Deriver\Deriver\Resolver\ExpressionValidation;
100use Deriver\Deriver\Resolver\MagicContext;
101use Deriver\Deriver\Resolver\Resolver;
102use Deriver\Deriver\Selection\QueryValidation;
103use Deriver\Deriver\SnapshotIdentity;
104use Deriver\Deriver\Sources\LineMap;
105use Deriver\Deriver\Sources\Path;
106use Deriver\Deriver\Sources\Source;
107use Deriver\Deriver\Sources\SourceRef;
108use Deriver\Deriver\Sources\Sources;
109use Deriver\Exception\ParserException;
110use Deriver\Exception\ResolutionException;
111use PhpParser\Node\Expr\BinaryOp\Plus;
112use PhpParser\Node\Expr\PostInc;
113use PhpParser\Node\Expr\Variable;
114use PhpParser\Node\Scalar\Int_;
115use PhpParser\Node\Scalar\String_;
116use PHPUnit\Framework\Attributes\CoversClass;
117use PHPUnit\Framework\Attributes\Small;
118use PHPUnit\Framework\Attributes\UsesClass;
119use PHPUnit\Framework\TestCase;
120
121#[UsesClass(Resolver::class)]
122#[UsesClass(ExpressionValidation::class)]
123#[UsesClass(ResolutionException::class)]
124#[UsesClass(ParserConfig::class)]
125#[UsesClass(ParserException::class)]
126#[CoversClass(EffectInspection::class)]
127#[UsesClass(QueryExecution::class)]
128#[UsesClass(QueryValidation::class)]
129#[UsesClass(ResultAssessment::class)]
130#[UsesClass(Deriver::class)]
131#[UsesClass(BasicBlock::class)]
132#[UsesClass(CallableGraph::class)]
133#[UsesClass(CallableIdentity::class)]
134#[UsesClass(Instruction::class)]
135#[UsesClass(Terminator::class)]
136#[UsesClass(ArgumentBinding::class)]
137#[UsesClass(ArgumentOrder::class)]
138#[UsesClass(Builtins::class)]
139#[UsesClass(Dispatch::class)]
140#[UsesClass(TypeBinding::class)]
141#[UsesClass(TypeCheck::class)]
142#[UsesClass(Completion::class)]
143#[UsesClass(Context::class)]
144#[UsesClass(ExceptionMatch::class)]
145#[UsesClass(ObservationLimit::class)]
146#[UsesClass(StateJoin::class)]
147#[UsesClass(Unwinding::class)]
148#[UsesClass(Discovery::class)]
149#[UsesClass(Dependencies::class)]
150#[UsesClass(Havoc::class)]
151#[UsesClass(InstructionTransfer::class)]
152#[UsesClass(Evaluator::class)]
153#[UsesClass(SlotReference::class)]
154#[UsesClass(ObservationCollector::class)]
155#[UsesClass(Conversions::class)]
156#[UsesClass(ScalarErrors::class)]
157#[UsesClass(State::class)]
158#[UsesClass(Evaluation::class)]
159#[UsesClass(Isolation::class)]
160#[UsesClass(MemoryStep::class)]
161#[UsesClass(PureStep::class)]
162#[UsesClass(ReferenceAssignment::class)]
163#[UsesClass(Location::class)]
164#[UsesClass(Materialization::class)]
165#[UsesClass(Memory::class)]
166#[UsesClass(ReferenceConstraint::class)]
167#[UsesClass(StorageCapture::class)]
168#[UsesClass(Extensions::class)]
169#[UsesClass(ProviderExpansion::class)]
170#[UsesClass(Evaluators::class)]
171#[UsesClass(StateRegistry::class)]
172#[UsesClass(DeriverConfig::class)]
173#[UsesClass(EntryPoint::class)]
174#[UsesClass(Sources::class)]
175#[UsesClass(Path::class)]
176#[UsesClass(Snapshot::class)]
177#[UsesClass(Source::class)]
178#[UsesClass(TargetProfile::class)]
179#[UsesClass(Budget::class)]
180#[UsesClass(QueryScope::class)]
181#[UsesClass(ReturnQuery::class)]
182#[UsesClass(ResultRef::class)]
183#[UsesClass(SourceRef::class)]
184#[UsesClass(Alternative::class)]
185#[UsesClass(Assessment::class)]
186#[UsesClass(Derivation::class)]
187#[UsesClass(DerivationResult::class)]
188#[UsesClass(Exceptional::class)]
189#[UsesClass(Frontier::class)]
190#[UsesClass(QueryEncoding::class)]
191#[UsesClass(ValueGraph::class)]
192#[UsesClass(Statistics::class)]
193#[UsesClass(StorageSnapshot::class)]
194#[UsesClass(Parser::class)]
195#[UsesClass(File::class)]
196#[UsesClass(AssignmentLowering::class)]
197#[UsesClass(Lowerer::class)]
198#[UsesClass(DestructuringLowering::class)]
199#[UsesClass(ExpressionLowering::class)]
200#[UsesClass(InstructionEmitter::class)]
201#[UsesClass(LoweringScope::class)]
202#[UsesClass(StatementLowering::class)]
203#[UsesClass(CallableSource::class)]
204#[UsesClass(Indexer::class)]
205#[UsesClass(Index::class)]
206#[UsesClass(Composition::class)]
207#[UsesClass(LineMap::class)]
208#[UsesClass(MagicContext::class)]
209#[UsesClass(AssignmentPatterns::class)]
210#[UsesClass(ClassScope::class)]
211#[UsesClass(TargetSyntax::class)]
212#[UsesClass(Arithmetic::class)]
213#[UsesClass(Identity::class)]
214#[UsesClass(Increment::class)]
215#[UsesClass(Operations::class)]
216#[UsesClass(Literal::class)]
217#[Small]
218final class EffectInspectionTest extends TestCase
219{
220    public function testConflictsPreservesTheSemanticContract(): void
221    {
222        $source = '<?php function target(){$x=1;return $x+$x++;}';
223        $symbol = 'target';
224        $input = new Sources([new Source('fixture.php', $source)]);
225        $configuration = new DeriverConfig();
226        $contributions = new Contributions();
227        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
228        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
229        $contributions1 = $providers->contributions;
230        $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);
231        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
232        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
233        $snapshotId = $identity->id;
234        $input1 = $providers->input;
235        $parser = new Parser(new ParserConfig($target->version));
236        $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));
237        $program = new Index($snapshotId, $trees);
238        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
239        self::assertSame([], $result->frontiers);
240        self::assertSame(Coverage::OverApproximation, $result->assessment->coverage);
241        self::assertEqualsCanonicalizing([2, 3], array_map(static fn ($outcome) => $outcome->values['return']->native(), $result->normalOutcomes));
242    }
243    public function testEffectfulFindsWritesInsideExpressions(): void
244    {
245        $node = new Plus(new Int_(1), new PostInc(new Variable('x')));
246        self::assertTrue((new EffectInspection())->effectful($node));
247        self::assertFalse((new EffectInspection())->effectful(new Int_(1)));
248    }
249    public function testObservesDistinguishesAReadFromALiteral(): void
250    {
251        $inspection = new EffectInspection();
252        self::assertTrue($inspection->observes(new Variable('x')));
253        self::assertFalse($inspection->observes(new String_('x')));
254    }
255    public function testChildrenVisitsOnlyImmediateSyntaxChildren(): void
256    {
257        $left = new Int_(1);
258        $right = new Int_(2);
259        self::assertSame([$left, $right], (new EffectInspection())->children(new Plus($left, $right)));
260    }
261}
262