Skip to content

Commit fad9ade

Browse files
butschsterbutschster
authored
Merge pull request #11 from llm-agents-php/feature/paginator-test
feat: add unit tests for Paginator class
2 parents bb84e0e + 8dbef47 commit fad9ade

File tree

2 files changed

+330
-14
lines changed

2 files changed

+330
-14
lines changed

‎tests/Unit/Dispatcher/PaginatorTest.php‎

Lines changed: 330 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,330 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Mcp\Server\Tests\Unit\Dispatcher;
6+
7+
use Mcp\Server\Dispatcher\Paginator;
8+
use PHPUnit\Framework\MockObject\MockObject;
9+
use PHPUnit\Framework\TestCase;
10+
use Psr\Log\LoggerInterface;
11+
use Psr\Log\NullLogger;
12+
13+
final class PaginatorTest extends TestCase
14+
{
15+
private Paginator $paginator;
16+
private LoggerInterface&MockObject $logger;
17+
18+
public function testPaginateWithNullCursor(): void
19+
{
20+
$items = ['a', 'b', 'c', 'd', 'e', 'f'];
21+
22+
$result = $this->paginator->paginate($items, null);
23+
24+
$this->assertSame(['a', 'b', 'c'], $result['items']);
25+
$this->assertNotNull($result['nextCursor']);
26+
$this->assertSame('offset=3', \base64_decode($result['nextCursor']));
27+
}
28+
29+
public function testPaginateWithValidCursor(): void
30+
{
31+
$items = ['a', 'b', 'c', 'd', 'e', 'f'];
32+
$cursor = \base64_encode('offset=3');
33+
34+
$result = $this->paginator->paginate($items, $cursor);
35+
36+
$this->assertSame(['d', 'e', 'f'], $result['items']);
37+
$this->assertNull($result['nextCursor']);
38+
}
39+
40+
public function testPaginateEmptyItems(): void
41+
{
42+
$items = [];
43+
44+
$result = $this->paginator->paginate($items, null);
45+
46+
$this->assertSame([], $result['items']);
47+
$this->assertNull($result['nextCursor']);
48+
}
49+
50+
public function testPaginateSinglePage(): void
51+
{
52+
$items = ['a', 'b'];
53+
54+
$result = $this->paginator->paginate($items, null);
55+
56+
$this->assertSame(['a', 'b'], $result['items']);
57+
$this->assertNull($result['nextCursor']);
58+
}
59+
60+
public function testPaginateExactPageBoundary(): void
61+
{
62+
$items = ['a', 'b', 'c'];
63+
64+
$result = $this->paginator->paginate($items, null);
65+
66+
$this->assertSame(['a', 'b', 'c'], $result['items']);
67+
$this->assertNull($result['nextCursor']);
68+
}
69+
70+
public function testPaginateWithOffsetBeyondItems(): void
71+
{
72+
$items = ['a', 'b', 'c'];
73+
$cursor = \base64_encode('offset=10');
74+
75+
$result = $this->paginator->paginate($items, $cursor);
76+
77+
$this->assertSame([], $result['items']);
78+
$this->assertNull($result['nextCursor']);
79+
}
80+
81+
public function testPaginateWithPartialLastPage(): void
82+
{
83+
$items = ['a', 'b', 'c', 'd', 'e'];
84+
$cursor = \base64_encode('offset=3');
85+
86+
$result = $this->paginator->paginate($items, $cursor);
87+
88+
$this->assertSame(['d', 'e'], $result['items']);
89+
$this->assertNull($result['nextCursor']);
90+
}
91+
92+
public function testPaginateWithMultiplePages(): void
93+
{
94+
$items = \range('a', 'j'); // 10 items
95+
96+
// First page
97+
$result1 = $this->paginator->paginate($items, null);
98+
$this->assertSame(['a', 'b', 'c'], $result1['items']);
99+
$this->assertNotNull($result1['nextCursor']);
100+
101+
// Second page
102+
$result2 = $this->paginator->paginate($items, $result1['nextCursor']);
103+
$this->assertSame(['d', 'e', 'f'], $result2['items']);
104+
$this->assertNotNull($result2['nextCursor']);
105+
106+
// Third page
107+
$result3 = $this->paginator->paginate($items, $result2['nextCursor']);
108+
$this->assertSame(['g', 'h', 'i'], $result3['items']);
109+
$this->assertNotNull($result3['nextCursor']);
110+
111+
// Last page
112+
$result4 = $this->paginator->paginate($items, $result3['nextCursor']);
113+
$this->assertSame(['j'], $result4['items']);
114+
$this->assertNull($result4['nextCursor']);
115+
}
116+
117+
public function testInvalidBase64Cursor(): void
118+
{
119+
$items = ['a', 'b', 'c', 'd'];
120+
$invalidCursor = 'invalid-base64!@#';
121+
122+
$this->logger
123+
->expects($this->once())
124+
->method('warning')
125+
->with(
126+
'Received invalid pagination cursor (not base64)',
127+
['cursor' => $invalidCursor],
128+
);
129+
130+
$result = $this->paginator->paginate($items, $invalidCursor);
131+
132+
$this->assertSame(['a', 'b', 'c'], $result['items']);
133+
}
134+
135+
public function testInvalidCursorFormat(): void
136+
{
137+
$items = ['a', 'b', 'c', 'd'];
138+
$invalidFormatCursor = \base64_encode('invalid-format');
139+
140+
$this->logger
141+
->expects($this->once())
142+
->method('warning')
143+
->with(
144+
'Received invalid pagination cursor format',
145+
['cursor' => 'invalid-format'],
146+
);
147+
148+
$result = $this->paginator->paginate($items, $invalidFormatCursor);
149+
150+
$this->assertSame(['a', 'b', 'c'], $result['items']);
151+
}
152+
153+
public function testCursorWithNonNumericOffset(): void
154+
{
155+
$items = ['a', 'b', 'c', 'd'];
156+
$invalidOffsetCursor = \base64_encode('offset=abc');
157+
158+
$this->logger
159+
->expects($this->once())
160+
->method('warning')
161+
->with(
162+
'Received invalid pagination cursor format',
163+
['cursor' => 'offset=abc'],
164+
);
165+
166+
$result = $this->paginator->paginate($items, $invalidOffsetCursor);
167+
168+
$this->assertSame(['a', 'b', 'c'], $result['items']);
169+
}
170+
171+
public function testCustomPaginationLimit(): void
172+
{
173+
$customPaginator = new Paginator(paginationLimit: 5, logger: $this->logger);
174+
$items = \range(1, 12);
175+
176+
$result = $customPaginator->paginate($items, null);
177+
178+
$this->assertSame([1, 2, 3, 4, 5], $result['items']);
179+
$this->assertNotNull($result['nextCursor']);
180+
$this->assertSame('offset=5', \base64_decode($result['nextCursor']));
181+
}
182+
183+
public function testDefaultPaginationLimit(): void
184+
{
185+
$defaultPaginator = new Paginator();
186+
$items = \range(1, 100);
187+
188+
$result = $defaultPaginator->paginate($items, null);
189+
190+
$this->assertCount(50, $result['items']); // Default limit is 50
191+
$this->assertSame(\range(1, 50), $result['items']);
192+
$this->assertNotNull($result['nextCursor']);
193+
}
194+
195+
public function testArrayValuesReindexing(): void
196+
{
197+
$items = [
198+
'key1' => 'value1',
199+
'key2' => 'value2',
200+
'key3' => 'value3',
201+
];
202+
203+
$result = $this->paginator->paginate($items, null);
204+
205+
// array_values should reindex the array
206+
$this->assertSame(['value1', 'value2', 'value3'], $result['items']);
207+
$this->assertSame([0, 1, 2], \array_keys($result['items']));
208+
}
209+
210+
public function testZeroOffsetCursor(): void
211+
{
212+
$items = ['a', 'b', 'c', 'd'];
213+
$zeroOffsetCursor = \base64_encode('offset=0');
214+
215+
$result = $this->paginator->paginate($items, $zeroOffsetCursor);
216+
217+
$this->assertSame(['a', 'b', 'c'], $result['items']);
218+
$this->assertNotNull($result['nextCursor']);
219+
}
220+
221+
public function testCursorEncodingDecoding(): void
222+
{
223+
$offset = 42;
224+
$expectedCursorContent = "offset={$offset}";
225+
$cursor = \base64_encode($expectedCursorContent);
226+
227+
// Verify we can decode what we encode
228+
$decoded = \base64_decode($cursor, true);
229+
$this->assertSame($expectedCursorContent, $decoded);
230+
231+
// Test with large offset
232+
$largeOffset = 999999;
233+
$largeCursorContent = "offset={$largeOffset}";
234+
$largeCursor = \base64_encode($largeCursorContent);
235+
$decodedLarge = \base64_decode($largeCursor, true);
236+
$this->assertSame($largeCursorContent, $decodedLarge);
237+
}
238+
239+
public function testEdgeCaseWithSingleItem(): void
240+
{
241+
$items = ['only-item'];
242+
243+
$result = $this->paginator->paginate($items, null);
244+
245+
$this->assertSame(['only-item'], $result['items']);
246+
$this->assertNull($result['nextCursor']);
247+
}
248+
249+
public function testPaginateWithAssociativeArrayPreservesValues(): void
250+
{
251+
$items = [
252+
['id' => 1, 'name' => 'Alice'],
253+
['id' => 2, 'name' => 'Bob'],
254+
['id' => 3, 'name' => 'Charlie'],
255+
['id' => 4, 'name' => 'Diana'],
256+
];
257+
258+
$result = $this->paginator->paginate($items, null);
259+
260+
$this->assertCount(3, $result['items']);
261+
$this->assertSame(['id' => 1, 'name' => 'Alice'], $result['items'][0]);
262+
$this->assertSame(['id' => 2, 'name' => 'Bob'], $result['items'][1]);
263+
$this->assertSame(['id' => 3, 'name' => 'Charlie'], $result['items'][2]);
264+
$this->assertNotNull($result['nextCursor']);
265+
}
266+
267+
public function testPaginateWithNullLogger(): void
268+
{
269+
$paginatorWithNullLogger = new Paginator(paginationLimit: 2, logger: new NullLogger());
270+
$items = ['a', 'b', 'c', 'd'];
271+
$invalidCursor = 'invalid-base64!@#';
272+
273+
// Should not throw any exceptions even with invalid cursor
274+
$result = $paginatorWithNullLogger->paginate($items, $invalidCursor);
275+
276+
$this->assertSame(['a', 'b'], $result['items']);
277+
$this->assertNotNull($result['nextCursor']);
278+
}
279+
280+
public function testPaginateWithLargeOffset(): void
281+
{
282+
$items = ['a', 'b', 'c'];
283+
$cursor = \base64_encode('offset=1000');
284+
285+
$result = $this->paginator->paginate($items, $cursor);
286+
287+
$this->assertSame([], $result['items']);
288+
$this->assertNull($result['nextCursor']);
289+
}
290+
291+
public function testPaginateWithNegativeOffsetInCursor(): void
292+
{
293+
$items = ['a', 'b', 'c', 'd'];
294+
$negativeOffsetCursor = \base64_encode('offset=-5');
295+
296+
$this->logger
297+
->expects($this->once())
298+
->method('warning')
299+
->with(
300+
'Received invalid pagination cursor format',
301+
['cursor' => 'offset=-5'],
302+
);
303+
304+
$result = $this->paginator->paginate($items, $negativeOffsetCursor);
305+
306+
$this->assertSame(['a', 'b', 'c'], $result['items']);
307+
}
308+
309+
public function testPaginateReturnsConsistentStructure(): void
310+
{
311+
$items = ['test'];
312+
313+
$result = $this->paginator->paginate($items, null);
314+
315+
$this->assertIsArray($result);
316+
$this->assertArrayHasKey('items', $result);
317+
$this->assertArrayHasKey('nextCursor', $result);
318+
$this->assertIsArray($result['items']);
319+
$this->assertTrue(\is_string($result['nextCursor']) || \is_null($result['nextCursor']));
320+
}
321+
322+
protected function setUp(): void
323+
{
324+
$this->logger = $this->createMock(LoggerInterface::class);
325+
$this->paginator = new Paginator(
326+
paginationLimit: 3,
327+
logger: $this->logger,
328+
);
329+
}
330+
}

‎tests/Unit/Session/SessionTest.php‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -80,20 +80,6 @@ public function test_retrieve_returns_session_for_valid_data(): void
8080
$this->assertEquals(123, $result->get('user_id'));
8181
}
8282

83-
public function test_save_writes_to_handler(): void
84-
{
85-
$this->session->set('test_key', 'test_value');
86-
87-
$this->handler->shouldReceive('write')
88-
->with($this->sessionId, \Mockery::on(static function ($json) {
89-
$data = \json_decode($json, true);
90-
return $data['test_key'] === 'test_value';
91-
}))
92-
->andReturn(true);
93-
94-
$this->session->save();
95-
}
96-
9783
public function test_get_returns_value_for_existing_key(): void
9884
{
9985
$this->session->set('test_key', 'test_value');

0 commit comments

Comments
 (0)