Skip to content

Commit e6a922e

Browse files
pavogpavog
authored
Merge pull request #3 from aternosorg/coverage
Add coverage check + add unit tests for paginated lists
2 parents 8850b75 + 87d98ed commit e6a922e

File tree

6 files changed

+515
-3
lines changed

6 files changed

+515
-3
lines changed

‎.github/workflows/tests.yaml‎

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ jobs:
2525
uses: shivammathur/setup-php@v2
2626
with:
2727
php-version: ${{ matrix.php-version }}
28+
extensions: mbstring,
29+
coverage: xdebug, pcov
30+
tools: composer:v2
2831

2932
- name: Set composer cache directory
3033
id: composer-cache
@@ -40,5 +43,11 @@ jobs:
4043
- name: Install composer dependencies
4144
run: composer install --no-interaction --prefer-dist --no-progress
4245

43-
- name: Run phpunit unit tests
44-
run: vendor/bin/phpunit --testsuite=unit --colors=always --testdox
46+
- name: Run phpunit unit tests with coverage
47+
run: vendor/bin/phpunit --testsuite=unit --colors=always --testdox --coverage-clover=coverage.xml
48+
49+
- name: Coverage Check
50+
uses: ericsizemore/[email protected]
51+
with:
52+
clover_file: 'coverage.xml'
53+
threshold: 75

‎phpunit.xml.dist‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
</testsuites>
1919
<source>
2020
<include>
21-
<directory>src</directory>
21+
<directory>src/Client</directory>
2222
</include>
2323
</source>
2424
<php>

‎tests/Unit/Client/List/PaginatedAuthorProjectListTest.php‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
<?php
2+
3+
namespace Aternos\SpigotApi\Tests\Unit\Client\List;
4+
5+
use Aternos\SpigotApi\Client\List\PaginatedAuthorProjectList;
6+
use Aternos\SpigotApi\Client\Project;
7+
use Aternos\SpigotApi\Client\SpigotAPIClient;
8+
use Aternos\SpigotApi\Model\Resource;
9+
use Aternos\SpigotApi\Model\ResourceAuthor;
10+
use Aternos\SpigotApi\Tests\TestCase;
11+
12+
class PaginatedAuthorProjectListTest extends TestCase
13+
{
14+
protected function createResource(int $id, int $authorId = 1): Resource
15+
{
16+
return new Resource([
17+
'id' => $id,
18+
'author' => new ResourceAuthor(['id' => $authorId, 'username' => 'author-' . $authorId]),
19+
]);
20+
}
21+
22+
public function testConstructionTransformsResourcesToProjects(): void
23+
{
24+
$resources = [
25+
$this->createResource(1),
26+
$this->createResource(2),
27+
$this->createResource(3),
28+
];
29+
30+
$list = new PaginatedAuthorProjectList($this->apiClient, 123, 1, $resources);
31+
32+
$this->assertCount(3, $list);
33+
$this->assertSame(3, $list->getHits());
34+
$this->assertInstanceOf(Project::class, $list[0]);
35+
$this->assertInstanceOf(Project::class, $list[1]);
36+
$this->assertInstanceOf(Project::class, $list[2]);
37+
}
38+
39+
public function testArrayAccessAndIteration(): void
40+
{
41+
$resources = [
42+
$this->createResource(10),
43+
$this->createResource(11),
44+
];
45+
46+
$list = new PaginatedAuthorProjectList($this->apiClient, 5, 2, $resources);
47+
48+
// ArrayAccess
49+
$this->assertTrue(isset($list[0]));
50+
$this->assertTrue(isset($list[1]));
51+
$this->assertFalse(isset($list[2]));
52+
53+
// Iteration
54+
$collected = [];
55+
foreach ($list as $project) {
56+
$collected[] = $project;
57+
}
58+
$this->assertCount(2, $collected);
59+
$this->assertEquals($list[0], $collected[0]);
60+
$this->assertEquals($list[1], $collected[1]);
61+
62+
// Rewind + key/valid
63+
$list->rewind();
64+
$this->assertTrue($list->valid());
65+
$this->assertSame(0, $list->key());
66+
$list->next();
67+
$this->assertSame(1, $list->key());
68+
}
69+
70+
public function testGetNextPageUsesClient(): void
71+
{
72+
$mockedApiClient = $this->createMock(SpigotAPIClient::class);
73+
$authorId = 55;
74+
75+
$page1 = new PaginatedAuthorProjectList($mockedApiClient, $authorId, 1, [
76+
$this->createResource(1, $authorId)
77+
]);
78+
$page2 = new PaginatedAuthorProjectList($mockedApiClient, $authorId, 2, [
79+
$this->createResource(2, $authorId)
80+
]);
81+
82+
$mockedApiClient->expects($this->once())
83+
->method('getAuthorProjects')
84+
->with($authorId, 2)
85+
->willReturn($page2);
86+
87+
$next = $page1->getNextPage();
88+
$this->assertSame($page2, $next);
89+
}
90+
91+
public function testGetPreviousPage(): void
92+
{
93+
$mockedApiClient = $this->createMock(SpigotAPIClient::class);
94+
$authorId = 77;
95+
96+
$page1 = new PaginatedAuthorProjectList($mockedApiClient, $authorId, 1, [$this->createResource(1, $authorId)]);
97+
$this->assertFalse($page1->hasPreviousPage());
98+
$this->assertNull($page1->getPreviousPage());
99+
100+
$page2 = new PaginatedAuthorProjectList($mockedApiClient, $authorId, 2, [$this->createResource(2, $authorId)]);
101+
102+
$mockedApiClient->expects($this->once())
103+
->method('getAuthorProjects')
104+
->with($authorId, 1)
105+
->willReturn($page1);
106+
107+
$previous = $page2->getPreviousPage();
108+
$this->assertSame($page1, $previous);
109+
}
110+
111+
public function testGetResultsFromFollowingPagesAggregatesUntilEmptyPage(): void
112+
{
113+
$mockedApiClient = $this->createMock(SpigotAPIClient::class);
114+
$authorId = 999;
115+
116+
$page1 = new PaginatedAuthorProjectList($mockedApiClient, $authorId, 1, [
117+
$this->createResource(10, $authorId),
118+
]);
119+
$page2 = new PaginatedAuthorProjectList($mockedApiClient, $authorId, 2, [
120+
$this->createResource(20, $authorId),
121+
$this->createResource(21, $authorId),
122+
]);
123+
// Empty page (hits = 0) stops the aggregation loop
124+
$page3 = new PaginatedAuthorProjectList($mockedApiClient, $authorId, 3, []);
125+
126+
$mockedApiClient->expects($this->exactly(2))
127+
->method('getAuthorProjects')
128+
->willReturnOnConsecutiveCalls($page2, $page3);
129+
130+
$all = $page1->getResultsFromFollowingPages();
131+
$this->assertCount(3, $all); // 1 from page1 + 2 from page2
132+
$this->assertContainsOnlyInstancesOf(Project::class, $all);
133+
}
134+
}

‎tests/Unit/Client/List/PaginatedCategoryProjectListTest.php‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
<?php
2+
3+
namespace Aternos\SpigotApi\Tests\Unit\Client\List;
4+
5+
use Aternos\SpigotApi\Client\Category;
6+
use Aternos\SpigotApi\Client\List\PaginatedCategoryProjectList;
7+
use Aternos\SpigotApi\Client\Project;
8+
use Aternos\SpigotApi\Client\SpigotAPIClient;
9+
use Aternos\SpigotApi\Model\Resource;
10+
use Aternos\SpigotApi\Model\ResourceCategory;
11+
use Aternos\SpigotApi\Tests\TestCase;
12+
13+
class PaginatedCategoryProjectListTest extends TestCase
14+
{
15+
protected function createResource(int $id, Category $category = Category::SPIGOT): Resource
16+
{
17+
return new Resource([
18+
'id' => $id,
19+
'category' =>
20+
new ResourceCategory([
21+
'id' => $category->value,
22+
'title' => $category->name
23+
])
24+
]);
25+
}
26+
27+
public function testConstructionTransformsResourcesToProjects(): void
28+
{
29+
$resources = [
30+
$this->createResource(1),
31+
$this->createResource(2),
32+
$this->createResource(3),
33+
];
34+
35+
$list = new PaginatedCategoryProjectList($this->apiClient, Category::SPIGOT, 1, $resources);
36+
37+
$this->assertCount(3, $list);
38+
$this->assertSame(3, $list->getHits());
39+
$this->assertInstanceOf(Project::class, $list[0]);
40+
$this->assertInstanceOf(Project::class, $list[1]);
41+
$this->assertInstanceOf(Project::class, $list[2]);
42+
}
43+
44+
public function testArrayAccessAndIteration(): void
45+
{
46+
$resources = [
47+
$this->createResource(10),
48+
$this->createResource(11),
49+
];
50+
51+
$list = new PaginatedCategoryProjectList($this->apiClient, Category::SPIGOT, 2, $resources);
52+
53+
// ArrayAccess
54+
$this->assertTrue(isset($list[0]));
55+
$this->assertTrue(isset($list[1]));
56+
$this->assertFalse(isset($list[2]));
57+
58+
// Iteration
59+
$collected = [];
60+
foreach ($list as $project) {
61+
$collected[] = $project;
62+
}
63+
$this->assertCount(2, $collected);
64+
$this->assertEquals($list[0], $collected[0]);
65+
$this->assertEquals($list[1], $collected[1]);
66+
67+
// Rewind + key/valid
68+
$list->rewind();
69+
$this->assertTrue($list->valid());
70+
$this->assertSame(0, $list->key());
71+
$list->next();
72+
$this->assertSame(1, $list->key());
73+
}
74+
75+
public function testGetNextPageUsesClient(): void
76+
{
77+
$mockedApiClient = $this->createMock(SpigotAPIClient::class);
78+
79+
$page1 = new PaginatedCategoryProjectList($mockedApiClient, Category::SPIGOT, 1, [
80+
$this->createResource(1, Category::SPIGOT)
81+
]);
82+
$page2 = new PaginatedCategoryProjectList($mockedApiClient, Category::SPIGOT, 2, [
83+
$this->createResource(2, Category::SPIGOT)
84+
]);
85+
86+
$mockedApiClient->expects($this->once())
87+
->method('listProjectsForCategory')
88+
->with(Category::SPIGOT, 2)
89+
->willReturn($page2);
90+
91+
$next = $page1->getNextPage();
92+
$this->assertSame($page2, $next);
93+
}
94+
95+
public function testGetPreviousPage(): void
96+
{
97+
$mockedApiClient = $this->createMock(SpigotAPIClient::class);
98+
99+
$page1 = new PaginatedCategoryProjectList($mockedApiClient, Category::SPIGOT, 1, [$this->createResource(1, Category::SPIGOT)]);
100+
$this->assertFalse($page1->hasPreviousPage());
101+
$this->assertNull($page1->getPreviousPage());
102+
103+
$page2 = new PaginatedCategoryProjectList($mockedApiClient, Category::SPIGOT, 2, [$this->createResource(2, Category::SPIGOT)]);
104+
105+
$mockedApiClient->expects($this->once())
106+
->method('listProjectsForCategory')
107+
->with(Category::SPIGOT, 1)
108+
->willReturn($page1);
109+
110+
$previous = $page2->getPreviousPage();
111+
$this->assertSame($page1, $previous);
112+
}
113+
114+
public function testGetResultsFromFollowingPagesAggregatesUntilEmptyPage(): void
115+
{
116+
$mockedApiClient = $this->createMock(SpigotAPIClient::class);
117+
118+
$page1 = new PaginatedCategoryProjectList($mockedApiClient, Category::SPIGOT, 1, [
119+
$this->createResource(10, Category::SPIGOT),
120+
]);
121+
$page2 = new PaginatedCategoryProjectList($mockedApiClient, Category::SPIGOT, 2, [
122+
$this->createResource(20, Category::SPIGOT),
123+
$this->createResource(21, Category::SPIGOT),
124+
]);
125+
// Empty page (hits = 0) stops the aggregation loop
126+
$page3 = new PaginatedCategoryProjectList($mockedApiClient, Category::SPIGOT, 3, []);
127+
128+
$mockedApiClient->expects($this->exactly(2))
129+
->method('listProjectsForCategory')
130+
->willReturnOnConsecutiveCalls($page2, $page3);
131+
132+
$all = $page1->getResultsFromFollowingPages();
133+
$this->assertCount(3, $all); // 1 from page1 + 2 from page2
134+
$this->assertContainsOnlyInstancesOf(Project::class, $all);
135+
}
136+
}

0 commit comments

Comments
 (0)