packages/deriver/tests/Unit/Deriver/Evaluator/Request/BudgetTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Evaluator\Request;
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\DependencyClosure;
28use Deriver\Deriver\Evaluator\Execution\Completion\StorageSnapshot;
29use Deriver\Deriver\Evaluator\Execution\Context;
30use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
31use Deriver\Deriver\Evaluator\Execution\Control\ResidualPaths;
32use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
33use Deriver\Deriver\Evaluator\Execution\Demand\Cell;
34use Deriver\Deriver\Evaluator\Execution\Demand\Components;
35use Deriver\Deriver\Evaluator\Execution\Demand\Discovery;
36use Deriver\Deriver\Evaluator\Execution\Demand\Key;
37use Deriver\Deriver\Evaluator\Execution\Demand\Table;
38use Deriver\Deriver\Evaluator\Execution\Dependencies;
39use Deriver\Deriver\Evaluator\Execution\Evaluator;
40use Deriver\Deriver\Evaluator\Execution\EvaluatorConfig as ExecutionEvaluatorConfig;
41use Deriver\Deriver\Evaluator\Execution\Havoc;
42use Deriver\Deriver\Evaluator\Execution\InstructionTransfer;
43use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
44use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
45use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
46use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
47use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
48use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
49use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
50use Deriver\Deriver\Evaluator\Execution\State;
51use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
52use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
53use Deriver\Deriver\Evaluator\Execution\Summary\Invocation;
54use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
55use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
56use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
57use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
58use Deriver\Deriver\Evaluator\Request\Budget;
59use Deriver\Deriver\Evaluator\Request\EntryPoint;
60use Deriver\Deriver\Evaluator\Request\QueryScope;
61use Deriver\Deriver\Evaluator\Request\ReturnQuery;
62use Deriver\Deriver\Evaluator\Scalar\Identity;
63use Deriver\Deriver\Evaluator\Scalar\Operations;
64use Deriver\Deriver\Evaluator\TargetProfile;
65use Deriver\Deriver\Evaluator\Term;
66use Deriver\Deriver\Evaluator\TermKind;
67use Deriver\Deriver\Execution\DerivationResult;
68use Deriver\Deriver\Execution\QueryExecution;
69use Deriver\Deriver\Execution\ResultAssessment;
70use Deriver\Deriver\Identity\QueryEncoding;
71use Deriver\Deriver\Identity\ValueGraph;
72use Deriver\Deriver\Lowerer\AssignmentLowering;
73use Deriver\Deriver\Lowerer\Control\DestructuringLowering;
74use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
75use Deriver\Deriver\Lowerer\Declaration\CallableSource;
76use Deriver\Deriver\Lowerer\Declaration\Index;
77use Deriver\Deriver\Lowerer\Declaration\Indexer;
78use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
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\Terminator;
84use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
85use Deriver\Deriver\Lowerer\InstructionEmitter;
86use Deriver\Deriver\Lowerer\Lowerer;
87use Deriver\Deriver\Lowerer\LoweringScope;
88use Deriver\Deriver\Lowerer\StatementLowering;
89use Deriver\Deriver\MicroEvaluatorConversion;
90use Deriver\Deriver\Parser\Node\File;
91use Deriver\Deriver\Parser\Parser;
92use Deriver\Deriver\Parser\ParserConfig;
93use Deriver\Deriver\Parser\TargetSyntax;
94use Deriver\Deriver\Providers\ProviderExpansion;
95use Deriver\Deriver\Resolver\AssignmentPatterns;
96use Deriver\Deriver\Resolver\ClassScope;
97use Deriver\Deriver\Resolver\ExpressionValidation;
98use Deriver\Deriver\Resolver\MagicContext;
99use Deriver\Deriver\Resolver\Resolver;
100use Deriver\Deriver\Selection\QueryValidation;
101use Deriver\Deriver\SnapshotIdentity;
102use Deriver\Deriver\Sources\LineMap;
103use Deriver\Deriver\Sources\Path;
104use Deriver\Deriver\Sources\Source;
105use Deriver\Deriver\Sources\SourceRef;
106use Deriver\Deriver\Sources\Sources;
107use Deriver\Exception\InvalidInputException;
108use Deriver\Exception\ParserException;
109use Deriver\Exception\ResolutionException;
110use PHPUnit\Framework\Attributes\CoversClass;
111use PHPUnit\Framework\Attributes\DataProvider;
112use PHPUnit\Framework\Attributes\Small;
113use PHPUnit\Framework\Attributes\UsesClass;
114use PHPUnit\Framework\TestCase;
115
116#[UsesClass(Resolver::class)]
117#[UsesClass(ExpressionValidation::class)]
118#[UsesClass(ResolutionException::class)]
119#[UsesClass(ParserConfig::class)]
120#[UsesClass(ParserException::class)]
121#[CoversClass(Budget::class)]
122#[UsesClass(QueryExecution::class)]
123#[UsesClass(QueryValidation::class)]
124#[UsesClass(ResultAssessment::class)]
125#[UsesClass(Deriver::class)]
126#[UsesClass(BasicBlock::class)]
127#[UsesClass(CallableGraph::class)]
128#[UsesClass(CallableIdentity::class)]
129#[UsesClass(Instruction::class)]
130#[UsesClass(Terminator::class)]
131#[UsesClass(ArgumentBinding::class)]
132#[UsesClass(ArgumentOrder::class)]
133#[UsesClass(Dispatch::class)]
134#[UsesClass(TypeBinding::class)]
135#[UsesClass(TypeCheck::class)]
136#[UsesClass(Completion::class)]
137#[UsesClass(Context::class)]
138#[UsesClass(ObservationLimit::class)]
139#[UsesClass(ResidualPaths::class)]
140#[UsesClass(StateJoin::class)]
141#[UsesClass(Cell::class)]
142#[UsesClass(Components::class)]
143#[UsesClass(Discovery::class)]
144#[UsesClass(Key::class)]
145#[UsesClass(Table::class)]
146#[UsesClass(Dependencies::class)]
147#[UsesClass(Havoc::class)]
148#[UsesClass(InstructionTransfer::class)]
149#[UsesClass(Evaluator::class)]
150#[UsesClass(SlotReference::class)]
151#[UsesClass(ObservationCollector::class)]
152#[UsesClass(Conversions::class)]
153#[UsesClass(ScalarErrors::class)]
154#[UsesClass(State::class)]
155#[UsesClass(CompletionRecord::class)]
156#[UsesClass(Evaluation::class)]
157#[UsesClass(Invocation::class)]
158#[UsesClass(Isolation::class)]
159#[UsesClass(PureStep::class)]
160#[UsesClass(ReferenceAssignment::class)]
161#[UsesClass(Materialization::class)]
162#[UsesClass(Memory::class)]
163#[UsesClass(StorageCapture::class)]
164#[UsesClass(Extensions::class)]
165#[UsesClass(ProviderExpansion::class)]
166#[UsesClass(Evaluators::class)]
167#[UsesClass(StateRegistry::class)]
168#[UsesClass(DeriverConfig::class)]
169#[UsesClass(EntryPoint::class)]
170#[UsesClass(Sources::class)]
171#[UsesClass(Path::class)]
172#[UsesClass(Snapshot::class)]
173#[UsesClass(Source::class)]
174#[UsesClass(TargetProfile::class)]
175#[UsesClass(QueryScope::class)]
176#[UsesClass(ReturnQuery::class)]
177#[UsesClass(ResultRef::class)]
178#[UsesClass(SourceRef::class)]
179#[UsesClass(Alternative::class)]
180#[UsesClass(Assessment::class)]
181#[UsesClass(Derivation::class)]
182#[UsesClass(DerivationResult::class)]
183#[UsesClass(Exceptional::class)]
184#[UsesClass(Frontier::class)]
185#[UsesClass(QueryEncoding::class)]
186#[UsesClass(ValueGraph::class)]
187#[UsesClass(Statistics::class)]
188#[UsesClass(StorageSnapshot::class)]
189#[UsesClass(Parser::class)]
190#[UsesClass(File::class)]
191#[UsesClass(AssignmentLowering::class)]
192#[UsesClass(Lowerer::class)]
193#[UsesClass(DestructuringLowering::class)]
194#[UsesClass(ExpressionLowering::class)]
195#[UsesClass(InstructionEmitter::class)]
196#[UsesClass(LoweringScope::class)]
197#[UsesClass(StatementLowering::class)]
198#[UsesClass(CallableSource::class)]
199#[UsesClass(Indexer::class)]
200#[UsesClass(Index::class)]
201#[UsesClass(Composition::class)]
202#[UsesClass(LineMap::class)]
203#[UsesClass(MagicContext::class)]
204#[UsesClass(AssignmentPatterns::class)]
205#[UsesClass(ClassScope::class)]
206#[UsesClass(TargetSyntax::class)]
207#[UsesClass(Identity::class)]
208#[UsesClass(Operations::class)]
209#[UsesClass(Term::class)]
210#[Small]
211final class BudgetTest extends TestCase
212{
213    public function testPreservesItsSemanticContract(): void
214    {
215        $input = new Sources([new Source('fixture.php', '<?php function target(){ $x=1; $x++; return $x; }')]);
216        $configuration = new DeriverConfig();
217        $contributions = new Contributions();
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 $source): File => (new Resolver())->resolve($parser->parse(new Source(Path::normalize($source->path), $source->contents, $source->declarationsOnly))), iterator_to_array($input1, false));
228        $program = new Index($snapshotId, $trees);
229        $session = new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics())));
230        $result = $session->derive(new ReturnQuery('target', budget: new Budget(transfers: 1)));
231        self::assertSame(DependencyClosure::Open, $result->assessment->closure);
232        self::assertSame('BUDGET_EXCEEDED', $result->frontiers[0]->code);
233        self::assertSame(TermKind::Opaque, $result->normalOutcomes[0]->values['return']->kind);
234    }
235    public function testDefaultsProvideReproducibleLogicalWorkBounds(): void
236    {
237        $budget = new Budget();
238        self::assertSame(100000, $budget->transfers);
239        self::assertSame(32, $budget->partitions);
240        self::assertSame(16, $budget->iterations);
241        self::assertSame(64, $budget->recursion);
242        self::assertSame(20000, $budget->nodes);
243        self::assertSame(4, $budget->symbolicRecursion);
244    }
245    public function testEveryDimensionAcceptsTheMinimumPositiveBudget(): void
246    {
247        $budget = new Budget(1, 1, 1, 1, 1, 1);
248        self::assertSame([1, 1, 1, 1, 1, 1], [$budget->transfers, $budget->partitions, $budget->iterations, $budget->recursion, $budget->nodes, $budget->symbolicRecursion]);
249    }
250    #[DataProvider('providerInvalidBudgets')]
251    public function testEveryDimensionRejectsNonpositiveBudgets(int $transfers, int $partitions, int $iterations, int $recursion, int $nodes, int $symbolicRecursion = 1): void
252    {
253        $this->expectException(InvalidInputException::class);
254        $this->expectExceptionMessage('Every logical budget must be positive.');
255        new Budget($transfers, $partitions, $iterations, $recursion, $nodes, $symbolicRecursion);
256    }
257    /**
258     * @return iterable<string,array{0:int,1:int,2:int,3:int,4:int,5?:int}>
259     */
260    public static function providerInvalidBudgets(): iterable
261    {
262        yield 'zero transfers' => [0, 1, 1, 1, 1];
263        yield 'zero partitions' => [1, 0, 1, 1, 1];
264        yield 'zero iterations' => [1, 1, 0, 1, 1];
265        yield 'zero recursion' => [1, 1, 1, 0, 1];
266        yield 'zero nodes' => [1, 1, 1, 1, 0];
267        yield 'negative transfers' => [-1, 1, 1, 1, 1];
268        yield 'negative partitions' => [1, -1, 1, 1, 1];
269        yield 'negative iterations' => [1, 1, -1, 1, 1];
270        yield 'negative recursion' => [1, 1, 1, -1, 1];
271        yield 'negative nodes' => [1, 1, 1, 1, -1];
272        yield 'zero symbolic recursion' => [1, 1, 1, 1, 1, 0];
273        yield 'negative symbolic recursion' => [1, 1, 1, 1, 1, -1];
274    }
275}
276