packages/deriver/tests/Unit/Deriver/Evaluator/Scalar/ArithmeticTest.php

1<?php
2
3declare (strict_types=1);
4
5namespace Tests\Unit\Deriver\Evaluator\Scalar;
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\StorageSnapshot;
27use Deriver\Deriver\Evaluator\Execution\Constraints;
28use Deriver\Deriver\Evaluator\Execution\Context;
29use Deriver\Deriver\Evaluator\Execution\Control\LoopConvergence;
30use Deriver\Deriver\Evaluator\Execution\Control\ObservationLimit;
31use Deriver\Deriver\Evaluator\Execution\Control\StateJoin;
32use Deriver\Deriver\Evaluator\Execution\Control\Unwinding;
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\InstructionTransfer;
42use Deriver\Deriver\Evaluator\Execution\Memory\Location;
43use Deriver\Deriver\Evaluator\Execution\Memory\Materialization;
44use Deriver\Deriver\Evaluator\Execution\Memory\Memory;
45use Deriver\Deriver\Evaluator\Execution\Memory\ReferenceConstraint;
46use Deriver\Deriver\Evaluator\Execution\Memory\Slots\SlotReference;
47use Deriver\Deriver\Evaluator\Execution\Memory\StorageCapture;
48use Deriver\Deriver\Evaluator\Execution\ObservationCollector;
49use Deriver\Deriver\Evaluator\Execution\Operation\Conversions;
50use Deriver\Deriver\Evaluator\Execution\Operation\ScalarErrors;
51use Deriver\Deriver\Evaluator\Execution\State;
52use Deriver\Deriver\Evaluator\Execution\Summary\CompletionRecord;
53use Deriver\Deriver\Evaluator\Execution\Summary\Evaluation;
54use Deriver\Deriver\Evaluator\Execution\Summary\Invocation;
55use Deriver\Deriver\Evaluator\Execution\Summary\Isolation;
56use Deriver\Deriver\Evaluator\Execution\Trace\Derivation;
57use Deriver\Deriver\Evaluator\Execution\Transfer\CompoundAssignment;
58use Deriver\Deriver\Evaluator\Execution\Transfer\MemoryStep;
59use Deriver\Deriver\Evaluator\Execution\Transfer\PureStep;
60use Deriver\Deriver\Evaluator\Execution\Transfer\ReferenceAssignment;
61use Deriver\Deriver\Evaluator\Request\Budget;
62use Deriver\Deriver\Evaluator\Request\EntryPoint;
63use Deriver\Deriver\Evaluator\Request\QueryScope;
64use Deriver\Deriver\Evaluator\Request\ReturnQuery;
65use Deriver\Deriver\Evaluator\Scalar\Arithmetic;
66use Deriver\Deriver\Evaluator\Scalar\Comparison;
67use Deriver\Deriver\Evaluator\Scalar\Identity;
68use Deriver\Deriver\Evaluator\Scalar\Increment;
69use Deriver\Deriver\Evaluator\Scalar\IntegerConversion;
70use Deriver\Deriver\Evaluator\Scalar\NumericString;
71use Deriver\Deriver\Evaluator\Scalar\Operations;
72use Deriver\Deriver\Evaluator\TargetProfile;
73use Deriver\Deriver\Evaluator\Term;
74use Deriver\Deriver\Execution\DerivationResult;
75use Deriver\Deriver\Execution\QueryExecution;
76use Deriver\Deriver\Execution\ResultAssessment;
77use Deriver\Deriver\Identity\QueryEncoding;
78use Deriver\Deriver\Identity\ValueGraph;
79use Deriver\Deriver\Lowerer\AssignmentLowering;
80use Deriver\Deriver\Lowerer\Control\DestructuringLowering;
81use Deriver\Deriver\Lowerer\Control\LoopLowering;
82use Deriver\Deriver\Lowerer\Declaration\CallableIdentity;
83use Deriver\Deriver\Lowerer\Declaration\CallableSource;
84use Deriver\Deriver\Lowerer\Declaration\Index;
85use Deriver\Deriver\Lowerer\Declaration\Indexer;
86use Deriver\Deriver\Lowerer\Declaration\Traits\Composition;
87use Deriver\Deriver\Lowerer\EffectInspection;
88use Deriver\Deriver\Lowerer\ExpressionLowering;
89use Deriver\Deriver\Lowerer\Graph\BasicBlock;
90use Deriver\Deriver\Lowerer\Graph\CallableGraph;
91use Deriver\Deriver\Lowerer\Graph\Instruction;
92use Deriver\Deriver\Lowerer\Graph\Terminator;
93use Deriver\Deriver\Lowerer\Hierarchy\Dispatch;
94use Deriver\Deriver\Lowerer\InstructionEmitter;
95use Deriver\Deriver\Lowerer\Lowerer;
96use Deriver\Deriver\Lowerer\LoweringScope;
97use Deriver\Deriver\Lowerer\StatementLowering;
98use Deriver\Deriver\MicroEvaluatorConversion;
99use Deriver\Deriver\Parser\Node\File;
100use Deriver\Deriver\Parser\Parser;
101use Deriver\Deriver\Parser\ParserConfig;
102use Deriver\Deriver\Parser\TargetSyntax;
103use Deriver\Deriver\Providers\ProviderExpansion;
104use Deriver\Deriver\Resolver\AssignmentPatterns;
105use Deriver\Deriver\Resolver\ClassScope;
106use Deriver\Deriver\Resolver\ExpressionValidation;
107use Deriver\Deriver\Resolver\MagicContext;
108use Deriver\Deriver\Resolver\Resolver;
109use Deriver\Deriver\Selection\QueryValidation;
110use Deriver\Deriver\SnapshotIdentity;
111use Deriver\Deriver\Sources\LineMap;
112use Deriver\Deriver\Sources\Path;
113use Deriver\Deriver\Sources\Source;
114use Deriver\Deriver\Sources\SourceRef;
115use Deriver\Deriver\Sources\Sources;
116use Deriver\Exception\ParserException;
117use Deriver\Exception\ResolutionException;
118use PHPUnit\Framework\Attributes\CoversClass;
119use PHPUnit\Framework\Attributes\DataProvider;
120use PHPUnit\Framework\Attributes\Small;
121use PHPUnit\Framework\Attributes\UsesClass;
122use PHPUnit\Framework\TestCase;
123
124#[UsesClass(Resolver::class)]
125#[UsesClass(ExpressionValidation::class)]
126#[UsesClass(ResolutionException::class)]
127#[UsesClass(ParserConfig::class)]
128#[UsesClass(ParserException::class)]
129#[CoversClass(Arithmetic::class)]
130#[UsesClass(QueryExecution::class)]
131#[UsesClass(QueryValidation::class)]
132#[UsesClass(ResultAssessment::class)]
133#[UsesClass(Deriver::class)]
134#[UsesClass(Constraints::class)]
135#[UsesClass(BasicBlock::class)]
136#[UsesClass(CallableGraph::class)]
137#[UsesClass(CallableIdentity::class)]
138#[UsesClass(Instruction::class)]
139#[UsesClass(Terminator::class)]
140#[UsesClass(ArgumentBinding::class)]
141#[UsesClass(ArgumentOrder::class)]
142#[UsesClass(Dispatch::class)]
143#[UsesClass(TypeBinding::class)]
144#[UsesClass(TypeCheck::class)]
145#[UsesClass(Completion::class)]
146#[UsesClass(Context::class)]
147#[UsesClass(LoopConvergence::class)]
148#[UsesClass(ObservationLimit::class)]
149#[UsesClass(StateJoin::class)]
150#[UsesClass(Unwinding::class)]
151#[UsesClass(Cell::class)]
152#[UsesClass(Components::class)]
153#[UsesClass(Discovery::class)]
154#[UsesClass(Key::class)]
155#[UsesClass(Table::class)]
156#[UsesClass(Dependencies::class)]
157#[UsesClass(InstructionTransfer::class)]
158#[UsesClass(Evaluator::class)]
159#[UsesClass(SlotReference::class)]
160#[UsesClass(ObservationCollector::class)]
161#[UsesClass(Conversions::class)]
162#[UsesClass(ScalarErrors::class)]
163#[UsesClass(State::class)]
164#[UsesClass(CompletionRecord::class)]
165#[UsesClass(Evaluation::class)]
166#[UsesClass(Invocation::class)]
167#[UsesClass(Isolation::class)]
168#[UsesClass(CompoundAssignment::class)]
169#[UsesClass(MemoryStep::class)]
170#[UsesClass(PureStep::class)]
171#[UsesClass(ReferenceAssignment::class)]
172#[UsesClass(Location::class)]
173#[UsesClass(Materialization::class)]
174#[UsesClass(Memory::class)]
175#[UsesClass(ReferenceConstraint::class)]
176#[UsesClass(StorageCapture::class)]
177#[UsesClass(Extensions::class)]
178#[UsesClass(ProviderExpansion::class)]
179#[UsesClass(Evaluators::class)]
180#[UsesClass(StateRegistry::class)]
181#[UsesClass(DeriverConfig::class)]
182#[UsesClass(EntryPoint::class)]
183#[UsesClass(Sources::class)]
184#[UsesClass(Path::class)]
185#[UsesClass(Snapshot::class)]
186#[UsesClass(Source::class)]
187#[UsesClass(TargetProfile::class)]
188#[UsesClass(Budget::class)]
189#[UsesClass(QueryScope::class)]
190#[UsesClass(ReturnQuery::class)]
191#[UsesClass(ResultRef::class)]
192#[UsesClass(SourceRef::class)]
193#[UsesClass(Alternative::class)]
194#[UsesClass(Assessment::class)]
195#[UsesClass(Derivation::class)]
196#[UsesClass(DerivationResult::class)]
197#[UsesClass(QueryEncoding::class)]
198#[UsesClass(ValueGraph::class)]
199#[UsesClass(Statistics::class)]
200#[UsesClass(StorageSnapshot::class)]
201#[UsesClass(Parser::class)]
202#[UsesClass(File::class)]
203#[UsesClass(AssignmentLowering::class)]
204#[UsesClass(Lowerer::class)]
205#[UsesClass(DestructuringLowering::class)]
206#[UsesClass(LoopLowering::class)]
207#[UsesClass(EffectInspection::class)]
208#[UsesClass(ExpressionLowering::class)]
209#[UsesClass(InstructionEmitter::class)]
210#[UsesClass(LoweringScope::class)]
211#[UsesClass(StatementLowering::class)]
212#[UsesClass(CallableSource::class)]
213#[UsesClass(Indexer::class)]
214#[UsesClass(Index::class)]
215#[UsesClass(Composition::class)]
216#[UsesClass(LineMap::class)]
217#[UsesClass(MagicContext::class)]
218#[UsesClass(AssignmentPatterns::class)]
219#[UsesClass(ClassScope::class)]
220#[UsesClass(TargetSyntax::class)]
221#[UsesClass(Comparison::class)]
222#[UsesClass(Identity::class)]
223#[UsesClass(Increment::class)]
224#[UsesClass(IntegerConversion::class)]
225#[UsesClass(NumericString::class)]
226#[UsesClass(Operations::class)]
227#[UsesClass(Term::class)]
228#[Small]
229final class ArithmeticTest extends TestCase
230{
231    public function testApplyPreservesTheSemanticContract(): void
232    {
233        $source = '<?php function target(){$s="";for($i=0;$i<3;$i++){$s.="x";}return $s;}';
234        $symbol = 'target';
235        $input = new Sources([new Source('fixture.php', $source)]);
236        $configuration = new DeriverConfig();
237        $contributions = new Contributions();
238        $target = new TargetProfile($configuration->phpVersion, $configuration->integerBits, $configuration->floatPrecision);
239        $providers = new ProviderExpansion($input, array_map(Term::fromNative(...), $configuration->environment), $contributions);
240        $contributions1 = $providers->contributions;
241        $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);
242        $settings = new EvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators, array_map((new MicroEvaluatorConversion())->convert(...), $configuration->evaluators));
243        $identity = new SnapshotIdentity($providers->input, $settings, $evaluators, $providers->manifest);
244        $snapshotId = $identity->id;
245        $input1 = $providers->input;
246        $parser = new Parser(new ParserConfig($target->version));
247        $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));
248        $program = new Index($snapshotId, $trees);
249        $result = (new QueryExecution($program, new ExecutionEvaluatorConfig($target, $providers->environment, $configuration->standardEvaluators), $evaluators, $identity->snapshot(array_map(Frontier::fromDiagnostic(...), $program->diagnostics()))))->derive(new ReturnQuery($symbol));
250        self::assertSame('xxx', $result->normalOutcomes[0]->values['return']->native());
251        self::assertSame([], $result->frontiers);
252        self::assertSame([], $result->exceptionalOutcomes);
253    }
254    public function testNumberRejectsNonNumericStrings(): void
255    {
256        self::assertNull((new Arithmetic())->number('not numeric'));
257        self::assertSame(42, (new Arithmetic())->number('42'));
258    }
259    public function testCalculateHandlesOversizedShifts(): void
260    {
261        self::assertSame(0, (new Arithmetic())->calculate('<<', 1, 64));
262        self::assertSame(-1, (new Arithmetic())->calculate('>>', -1, 64));
263    }
264    public function testWarningTracksIntegralOperatorsButNotStringBitwiseOperations(): void
265    {
266        $operation = new Arithmetic();
267        self::assertTrue($operation->warning('%', Term::constant(7), Term::constant(1.0E+30)));
268        self::assertFalse($operation->warning('+', Term::constant(7), Term::constant(1.0E+30)));
269        self::assertFalse($operation->warning('&', Term::constant('1.5'), Term::constant('1')));
270    }
271    /**
272     * @param string $operator
273     * @param scalar|null $left
274     * @param scalar|null $right
275     * @param scalar|null $expected
276     */
277    #[DataProvider('providerApplyOperators')]
278    public function testApplyEvaluatesScalarOperators(string $operator, int|float|string|bool|null $left, int|float|string|bool|null $right, int|float|string|bool|null $expected): void
279    {
280        $result = (new Arithmetic())->apply($operator, Term::constant($left), Term::constant($right));
281        self::assertSame($expected, $result->native());
282    }
283    /**
284     * @return list<array{string, scalar|null, scalar|null, scalar|null}>
285     */
286    public static function providerApplyOperators(): array
287    {
288        return [['+', 2, 3, 5], ['-', 2, 3, -1], ['*', 2, 3, 6], ['/', 7, 2, 3.5], ['%', -7, 3, -1], ['**', 2, 3, 8], ['&', 6, 3, 2], ['|', 6, 3, 7], ['^', 6, 3, 5], ['<<', 3, 2, 12], ['>>', 8, 2, 2], ['<<', 1, 63, -9223372036854775807 - 1], ['<<', 1, 64, 0], ['>>', 1, 64, 0], ['>>', -2, 64, -1], ['&', 'ab', 'XY', '@@'], ['|', 'ab', 'XY', 'y{'], ['^', 'ab', 'XY', '9;'], ['xor', 1, 0, true], ['xor', 1, 2, false], ['+', true, null, 1], ['+', 1.5, 2.0, 3.5], ['+', '12', '0.5', 12.5]];
289    }
290    /**
291     * @param string $operator
292     * @param scalar|null $left
293     * @param scalar|null $right
294     * @param string $exception
295     */
296    #[DataProvider('providerApplyErrors')]
297    public function testApplyReturnsTargetExceptionsForInvalidOperands(string $operator, int|float|string|bool|null $left, int|float|string|bool|null $right, string $exception): void
298    {
299        $result = (new Arithmetic())->apply($operator, Term::constant($left), Term::constant($right));
300        self::assertSame(['throwable', $exception], [$result->kind->value, $result->literal]);
301    }
302    /**
303     * @return list<array{string, scalar|null, scalar|null, string}>
304     */
305    public static function providerApplyErrors(): array
306    {
307        return [['+', 'bad', 1, 'TypeError'], ['+', 1, 'bad', 'TypeError'], ['/', 1, 0, 'DivisionByZeroError'], ['%', 1, 0.5, 'DivisionByZeroError'], ['<<', 1, -1, 'ArithmeticError'], ['>>', 1, -1, 'ArithmeticError']];
308    }
309    public function testApplyKeepsAnUnknownOperatorAsAnExplicitBoundary(): void
310    {
311        $left = Term::constant(2);
312        $right = Term::constant(3);
313        $result = (new Arithmetic())->apply('unsupported', $left, $right);
314        self::assertSame(['opaque', 'UNSUPPORTED_LANGUAGE_FEATURE', [$left, $right]], [$result->kind->value, $result->literal, $result->operands]);
315    }
316    public function testNumberDistinguishesValidZeroFromInvalidNumericInput(): void
317    {
318        $arithmetic = new Arithmetic();
319        self::assertSame(0, $arithmetic->number(null));
320        self::assertSame(0, $arithmetic->number(false));
321        self::assertSame(1, $arithmetic->number(true));
322        self::assertSame(2, $arithmetic->number(2));
323        self::assertSame(2.5, $arithmetic->number(2.5));
324        self::assertSame(0, $arithmetic->number('0'));
325        self::assertNull($arithmetic->number(''));
326    }
327    public function testWarningDetectsEitherOperandAndSkipsSymbolicOrInvalidConversions(): void
328    {
329        $arithmetic = new Arithmetic();
330        self::assertTrue($arithmetic->warning('%', Term::constant(1.5), Term::constant(2)));
331        self::assertTrue($arithmetic->warning('<<', Term::constant(2), Term::constant(1.5)));
332        self::assertFalse($arithmetic->warning('^', Term::constant(1), Term::constant(2)));
333        self::assertFalse($arithmetic->warning('%', Term::parameter('n'), Term::constant(2)));
334        self::assertFalse($arithmetic->warning('%', Term::constant(2), Term::parameter('n')));
335        self::assertFalse($arithmetic->warning('%', Term::constant('bad'), Term::constant(2)));
336        self::assertFalse($arithmetic->warning('%', Term::constant(2), Term::constant('bad')));
337    }
338    /**
339     * @param int|float $base
340     * @param int|float $exponent
341     */
342    #[DataProvider('providerZeroBasePowers')]
343    public function testPowerOfZeroToANegativeExponentIsASignedInfinityWithoutHostDiagnostics(int|float $base, int|float $exponent, float $expected): void
344    {
345        self::assertSame($expected, (new Arithmetic())->calculate('**', $base, $exponent));
346    }
347    /**
348     * @return array<string, array{int|float, int|float, float}>
349     */
350    public static function providerZeroBasePowers(): array
351    {
352        return ['integer zero' => [0, -1, INF], 'positive zero with fraction' => [0.0, -0.5, INF], 'negative zero with odd exponent' => [-0.0, -3, -INF], 'negative zero with even exponent' => [-0.0, -2, INF], 'negative zero with fraction' => [-0.0, -2.5, INF], 'negative zero with negative infinity' => [-0.0, -INF, INF], 'negative zero with minimum integer' => [-0.0, PHP_INT_MIN, INF]];
353    }
354    public function testXorTreatsNanAsTrueWithoutHostDiagnostics(): void
355    {
356        self::assertTrue((new Arithmetic())->apply('xor', Term::constant(NAN), Term::constant(0))->native());
357    }
358}
359