Add more return types

GrahamCampbell · GrahamCampbell · commit b4e4ed7f546a · 2025-02-23T19:46:39.000Z
diff --git a/tests/Api/DeployKeysTest.php b/tests/Api/DeployKeysTest.php
@@ -34,7 +34,7 @@ public function shouldGetAllDeployKeys(): void
         $this->assertEquals($expectedArray, $api->all(['page' => 2, 'per_page' => 5]));
     }
 
-    protected function getMultipleDeployKeysData()
+    protected function getMultipleDeployKeysData(): array
     {
         return [
             [
@@ -52,7 +52,7 @@ protected function getMultipleDeployKeysData()
         ];
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return DeployKeys::class;
     }
diff --git a/tests/Api/DeploymentsTest.php b/tests/Api/DeploymentsTest.php
@@ -16,6 +16,7 @@
 
 use Gitlab\Api\Deployments;
 use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\MockObject\MockObject;
 
 class DeploymentsTest extends TestCase
 {
@@ -107,7 +108,7 @@ public function shouldShowDeployment(): void
         $this->assertEquals($expectedArray, $api->show(1, 42));
     }
 
-    private function getMultipleDeploymentsData()
+    private function getMultipleDeploymentsData(): array
     {
         return [
             [
@@ -241,7 +242,7 @@ private function getMultipleDeploymentsData()
         ];
     }
 
-    protected function getMultipleDeploymentsRequestMock(string $path, array $expectedArray, array $expectedParameters)
+    protected function getMultipleDeploymentsRequestMock(string $path, array $expectedArray, array $expectedParameters): MockObject
     {
         $api = $this->getApiMock();
         $api->expects($this->once())
@@ -269,7 +270,7 @@ public function shouldGetAllDeploymentsSortedByCreatedAt(): void
         );
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Deployments::class;
     }
diff --git a/tests/Api/EnvironmentsTest.php b/tests/Api/EnvironmentsTest.php
@@ -195,7 +195,7 @@ public function shouldStopEnvironment(): void
         $this->assertEquals($expectedBool, $api->stop(1, 3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Environments::class;
     }
diff --git a/tests/Api/EventsTest.php b/tests/Api/EventsTest.php
@@ -18,7 +18,7 @@
 
 class EventsTest extends TestCase
 {
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Events::class;
     }
diff --git a/tests/Api/GroupBoardsTest.php b/tests/Api/GroupBoardsTest.php
@@ -218,7 +218,7 @@ public function shouldDeleteList(): void
         $this->assertEquals($expectedBool, $api->deleteList(1, 2, 3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return GroupsBoards::class;
     }
diff --git a/tests/Api/GroupsEpicsTest.php b/tests/Api/GroupsEpicsTest.php
@@ -114,7 +114,7 @@ public function shouldGetEpicsIssues(): void
         $this->assertEquals($expectedArray, $api->issues(1, 2));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return GroupsEpics::class;
     }
diff --git a/tests/Api/GroupsMilestonesTest.php b/tests/Api/GroupsMilestonesTest.php
@@ -62,7 +62,7 @@ public function shouldGetAllMilestonesWithParameterTwoIidsValues(): void
         $api->all(1, ['iids' => [456, 789]]);
     }
 
-    public static function getAllMilestonesWithParameterStateDataProvider()
+    public static function getAllMilestonesWithParameterStateDataProvider(): array
     {
         return [
             GroupsMilestones::STATE_ACTIVE => [GroupsMilestones::STATE_ACTIVE],
@@ -220,7 +220,7 @@ public function shouldGetMilestonesMergeRequests(): void
         $this->assertEquals($expectedArray, $api->mergeRequests(1, 3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return GroupsMilestones::class;
     }
diff --git a/tests/Api/GroupsTest.php b/tests/Api/GroupsTest.php
@@ -534,7 +534,7 @@ public function shouldRemoveVariable(): void
         $this->assertEquals($expectedBool, $api->removeVariable(1, 'ftp_password'));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Groups::class;
     }
diff --git a/tests/Api/IssueBoardsTest.php b/tests/Api/IssueBoardsTest.php
@@ -218,7 +218,7 @@ public function shouldDeleteList(): void
         $this->assertEquals($expectedBool, $api->deleteList(1, 2, 3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return IssueBoards::class;
     }
diff --git a/tests/Api/IssueLinksTest.php b/tests/Api/IssueLinksTest.php
@@ -22,7 +22,7 @@ class IssueLinksTest extends TestCase
     /**
      * {@inheritdoc}
      */
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return IssueLinks::class;
     }
diff --git a/tests/Api/IssueSubscribeTest.php b/tests/Api/IssueSubscribeTest.php
@@ -45,7 +45,7 @@ public function testUnsubscribeIssue(): void
         $this->assertEquals($expectedValue, $api->unsubscribe(1, 2));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Issues::class;
     }
diff --git a/tests/Api/IssuesStatisticsTest.php b/tests/Api/IssuesStatisticsTest.php
@@ -93,7 +93,7 @@ public function shouldGetGroup(): void
         $this->assertEquals($expectedArray, $api->group(1, []));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return IssuesStatistics::class;
     }
diff --git a/tests/Api/IssuesTest.php b/tests/Api/IssuesTest.php
@@ -595,7 +595,7 @@ public function shouldGetIssueResourceLabelEvent(): void
         $this->assertEquals($expectedArray, $api->showResourceLabelEvent(1, 2, 3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Issues::class;
     }
diff --git a/tests/Api/JobsTest.php b/tests/Api/JobsTest.php
@@ -265,7 +265,7 @@ public function shouldPlay(): void
         $this->assertEquals($expectedArray, $api->play(1, 3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Jobs::class;
     }
diff --git a/tests/Api/KeysTest.php b/tests/Api/KeysTest.php
@@ -32,7 +32,7 @@ public function shouldShowKey(): void
         $this->assertEquals($expectedArray, $api->show(1));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Keys::class;
     }
diff --git a/tests/Api/MergeRequestsTest.php b/tests/Api/MergeRequestsTest.php
@@ -793,15 +793,15 @@ public function shoudDeleteLevelRule(): void
         $this->assertEquals($expectedValue, $api->deleteLevelRule(1, 2, 3));
     }
 
-    protected function getMultipleMergeRequestsData()
+    protected function getMultipleMergeRequestsData(): array
     {
         return [
             ['id' => 1, 'title' => 'A merge request'],
             ['id' => 2, 'title' => 'Another merge request'],
         ];
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return MergeRequests::class;
     }
diff --git a/tests/Api/MilestonesTest.php b/tests/Api/MilestonesTest.php
@@ -132,7 +132,7 @@ public function shouldGetMilestonesMergeRequests(): void
         $this->assertEquals($expectedArray, $api->mergeRequests(1, 3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Milestones::class;
     }
diff --git a/tests/Api/PackagesTest.php b/tests/Api/PackagesTest.php
@@ -109,7 +109,7 @@ public function shouldRemovePackageFile(): void
         $this->assertEquals($expectedBool, $api->removeFile(1, 1, 25));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Packages::class;
     }
diff --git a/tests/Api/ProjectNamespacesTest.php b/tests/Api/ProjectNamespacesTest.php
@@ -52,7 +52,7 @@ public function shouldShowNamespace(): void
         $this->assertEquals($expectedArray, $api->show(1));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return ProjectNamespaces::class;
     }
diff --git a/tests/Api/ProjectsTest.php b/tests/Api/ProjectsTest.php
@@ -18,6 +18,7 @@
 use Gitlab\Api\Projects;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\MockObject\MockObject;
 
 class ProjectsTest extends TestCase
 {
@@ -2135,7 +2136,7 @@ public function shouldRemoveVariable(): void
         $this->assertEquals($expectedBool, $api->removeVariable(1, 'ftp_password'));
     }
 
-    protected function getMultipleProjectsRequestMock($path, $expectedArray = [], $expectedParameters = [])
+    protected function getMultipleProjectsRequestMock($path, $expectedArray = [], $expectedParameters = []): MockObject
     {
         $api = $this->getApiMock();
         $api->expects($this->once())
@@ -2237,15 +2238,15 @@ public function shouldGetDeploymentsFiltered(): void
         $this->assertEquals($expectedArray, $api->deployments(1, ['updated_after' => $time]));
     }
 
-    protected function getMultipleProjectsData()
+    protected function getMultipleProjectsData(): array
     {
         return [
             ['id' => 1, 'name' => 'A project'],
             ['id' => 2, 'name' => 'Another project'],
         ];
     }
 
-    protected function getMultipleProjectsDataWithNamespace()
+    protected function getMultipleProjectsDataWithNamespace(): array
     {
         return [
             ['id' => 1, 'name' => 'A project', 'namespace' => ['id' => 4, 'name' => 'A namespace', 'path' => 'a_namespace']],
@@ -2264,7 +2265,7 @@ public static function possibleAccessLevels(): array
         ];
     }
 
-    public function getBadgeExpectedArray()
+    public function getBadgeExpectedArray(): array
     {
         return [
             [
@@ -2730,7 +2731,7 @@ public function shouldRemoveProtectedTag(): void
         $this->assertEquals($expectedBool, $api->deleteProtectedTag(1, 'release-*'));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Projects::class;
     }
diff --git a/tests/Api/RepositoriesTest.php b/tests/Api/RepositoriesTest.php
@@ -652,7 +652,7 @@ public function shouldCherryPick(): void
         $this->assertEquals($expectedArray, $api->cherryPick(1, '123456123456', ['branch' => 'feature_branch']));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Repositories::class;
     }
diff --git a/tests/Api/ScheduleTest.php b/tests/Api/ScheduleTest.php
@@ -213,7 +213,7 @@ public function shouldPlay(): void
         $this->assertEquals($expectedBool, $api->play(1, 2));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Schedules::class;
     }
diff --git a/tests/Api/SearchTest.php b/tests/Api/SearchTest.php
@@ -49,7 +49,7 @@ public function shouldGetAll(): void
         ]));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Search::class;
     }
diff --git a/tests/Api/SnippetsTest.php b/tests/Api/SnippetsTest.php
@@ -219,7 +219,7 @@ public function shouldRevokeSnippetAwardEmoji(): void
         $this->assertEquals(true, $api->removeAwardEmoji(1, 2, 3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Snippets::class;
     }
diff --git a/tests/Api/SystemHooksTest.php b/tests/Api/SystemHooksTest.php
@@ -80,7 +80,7 @@ public function shouldRemoveHook(): void
         $this->assertEquals($expectedBool, $api->remove(3));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return SystemHooks::class;
     }
diff --git a/tests/Api/TagsTest.php b/tests/Api/TagsTest.php
@@ -144,7 +144,7 @@ public static function releaseDataProvider(): array
         ];
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Tags::class;
     }
diff --git a/tests/Api/UsersTest.php b/tests/Api/UsersTest.php
@@ -17,6 +17,7 @@
 use Gitlab\Api\Users;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\MockObject\MockObject;
 
 class UsersTest extends TestCase
 {
@@ -100,7 +101,7 @@ public function shouldShowUser(): void
         $this->assertEquals($expectedArray, $api->show(1));
     }
 
-    protected function getUsersMembershipsData()
+    protected function getUsersMembershipsData(): array
     {
         return [
             [
@@ -118,7 +119,7 @@ protected function getUsersMembershipsData()
         ];
     }
 
-    protected function getUsersMembershipsRequestMock($path, $expectedArray = [], $expectedParameters = [])
+    protected function getUsersMembershipsRequestMock($path, $expectedArray = [], $expectedParameters = []): MockObject
     {
         $api = $this->getApiMock();
         $api->expects($this->once())
@@ -160,15 +161,15 @@ public function shouldShowUsersMembershipsWithTypeNamespace(): void
         $this->assertEquals($expectedArray, $api->usersMemberships(1, ['type' => 'Namespace']));
     }
 
-    protected function getUsersProjectsData()
+    protected function getUsersProjectsData(): array
     {
         return [
             ['id' => 1, 'name' => 'matt-project-1'],
             ['id' => 2, 'name' => 'matt-project-2'],
         ];
     }
 
-    protected function getUsersProjectsRequestMock($path, $expectedArray = [], $expectedParameters = [])
+    protected function getUsersProjectsRequestMock($path, $expectedArray = [], $expectedParameters = []): MockObject
     {
         $api = $this->getApiMock();
         $api->expects($this->once())
@@ -799,7 +800,7 @@ public function shouldGetCurrentUserInactiveImpersonationTokens(): void
         $this->assertEquals($expectedArray, $api->userImpersonationTokens(1, ['state' => 'inactive']));
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Users::class;
     }
diff --git a/tests/Api/VersionTest.php b/tests/Api/VersionTest.php
@@ -35,7 +35,7 @@ public function shouldShowVersion(): void
         $this->assertEquals($expectedArray, $api->show());
     }
 
-    protected function getApiClass()
+    protected function getApiClass(): string
     {
         return Version::class;
     }
diff --git a/tests/Api/WikiTest.php b/tests/Api/WikiTest.php

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function shouldGetAllDeployKeys(): void`
`34`	`34`	`$this->assertEquals($expectedArray, $api->all(['page' => 2, 'per_page' => 5]));`
`35`	`35`	`}`
`36`	`36`
`37`		`- protected function getMultipleDeployKeysData()`
	`37`	`+ protected function getMultipleDeployKeysData(): array`
`38`	`38`	`{`
`39`	`39`	`return [`
`40`	`40`	`[`
`@@ -52,7 +52,7 @@ protected function getMultipleDeployKeysData()`
`52`	`52`	`];`
`53`	`53`	`}`
`54`	`54`
`55`		`- protected function getApiClass()`
	`55`	`+ protected function getApiClass(): string`
`56`	`56`	`{`
`57`	`57`	`return DeployKeys::class;`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`
`17`	`17`	`use Gitlab\Api\Deployments;`
`18`	`18`	`use PHPUnit\Framework\Attributes\Test;`
	`19`	`+use PHPUnit\Framework\MockObject\MockObject;`
`19`	`20`
`20`	`21`	`class DeploymentsTest extends TestCase`
`21`	`22`	`{`
`@@ -107,7 +108,7 @@ public function shouldShowDeployment(): void`
`107`	`108`	`$this->assertEquals($expectedArray, $api->show(1, 42));`
`108`	`109`	`}`
`109`	`110`
`110`		`- private function getMultipleDeploymentsData()`
	`111`	`+ private function getMultipleDeploymentsData(): array`
`111`	`112`	`{`
`112`	`113`	`return [`
`113`	`114`	`[`
`@@ -241,7 +242,7 @@ private function getMultipleDeploymentsData()`
`241`	`242`	`];`
`242`	`243`	`}`
`243`	`244`
`244`		`- protected function getMultipleDeploymentsRequestMock(string $path, array $expectedArray, array $expectedParameters)`
	`245`	`+ protected function getMultipleDeploymentsRequestMock(string $path, array $expectedArray, array $expectedParameters): MockObject`
`245`	`246`	`{`
`246`	`247`	`$api = $this->getApiMock();`
`247`	`248`	`$api->expects($this->once())`
`@@ -269,7 +270,7 @@ public function shouldGetAllDeploymentsSortedByCreatedAt(): void`
`269`	`270`	`);`
`270`	`271`	`}`
`271`	`272`
`272`		`- protected function getApiClass()`
	`273`	`+ protected function getApiClass(): string`
`273`	`274`	`{`
`274`	`275`	`return Deployments::class;`
`275`	`276`	`}`
Original file line number	Diff line number	Diff line change
`@@ -195,7 +195,7 @@ public function shouldStopEnvironment(): void`
`195`	`195`	`$this->assertEquals($expectedBool, $api->stop(1, 3));`
`196`	`196`	`}`
`197`	`197`
`198`		`- protected function getApiClass()`
	`198`	`+ protected function getApiClass(): string`
`199`	`199`	`{`
`200`	`200`	`return Environments::class;`
`201`	`201`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`
`19`	`19`	`class EventsTest extends TestCase`
`20`	`20`	`{`
`21`		`- protected function getApiClass()`
	`21`	`+ protected function getApiClass(): string`
`22`	`22`	`{`
`23`	`23`	`return Events::class;`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -218,7 +218,7 @@ public function shouldDeleteList(): void`
`218`	`218`	`$this->assertEquals($expectedBool, $api->deleteList(1, 2, 3));`
`219`	`219`	`}`
`220`	`220`
`221`		`- protected function getApiClass()`
	`221`	`+ protected function getApiClass(): string`
`222`	`222`	`{`
`223`	`223`	`return GroupsBoards::class;`
`224`	`224`	`}`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ public function shouldGetEpicsIssues(): void`
`114`	`114`	`$this->assertEquals($expectedArray, $api->issues(1, 2));`
`115`	`115`	`}`
`116`	`116`
`117`		`- protected function getApiClass()`
	`117`	`+ protected function getApiClass(): string`
`118`	`118`	`{`
`119`	`119`	`return GroupsEpics::class;`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public function shouldGetAllMilestonesWithParameterTwoIidsValues(): void`
`62`	`62`	`$api->all(1, ['iids' => [456, 789]]);`
`63`	`63`	`}`
`64`	`64`
`65`		`- public static function getAllMilestonesWithParameterStateDataProvider()`
	`65`	`+ public static function getAllMilestonesWithParameterStateDataProvider(): array`
`66`	`66`	`{`
`67`	`67`	`return [`
`68`	`68`	`GroupsMilestones::STATE_ACTIVE => [GroupsMilestones::STATE_ACTIVE],`
`@@ -220,7 +220,7 @@ public function shouldGetMilestonesMergeRequests(): void`
`220`	`220`	`$this->assertEquals($expectedArray, $api->mergeRequests(1, 3));`
`221`	`221`	`}`
`222`	`222`
`223`		`- protected function getApiClass()`
	`223`	`+ protected function getApiClass(): string`
`224`	`224`	`{`
`225`	`225`	`return GroupsMilestones::class;`
`226`	`226`	`}`
Original file line number	Diff line number	Diff line change
`@@ -534,7 +534,7 @@ public function shouldRemoveVariable(): void`
`534`	`534`	`$this->assertEquals($expectedBool, $api->removeVariable(1, 'ftp_password'));`
`535`	`535`	`}`
`536`	`536`
`537`		`- protected function getApiClass()`
	`537`	`+ protected function getApiClass(): string`
`538`	`538`	`{`
`539`	`539`	`return Groups::class;`
`540`	`540`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class IssueLinksTest extends TestCase`
`22`	`22`	`/**`
`23`	`23`	`* {@inheritdoc}`
`24`	`24`	`*/`
`25`		`- protected function getApiClass()`
	`25`	`+ protected function getApiClass(): string`
`26`	`26`	`{`
`27`	`27`	`return IssueLinks::class;`
`28`	`28`	`}`