Reach PHPStan level 4, simplify MockClient, do not run PHPStan on PHP…

… 7.4
kbsali · Sep 21, 2023 · 9b36827 · 9b36827
1 parent 23c82bb
commit 9b36827
Show file tree

Hide file tree

Showing 12 changed files with 55 additions and 142 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -41,6 +41,7 @@ jobs:
         run: composer run phpstan -- --error-format=github
 
       - name: Run tests
+        if: ${{ matrix.php-versions >= '8.0' }}
         run: vendor/bin/phpunit --coverage-text
 
       - name: Upload coverage reports to Codecov

diff --git a/.phpstan.neon b/.phpstan.neon
@@ -1,5 +1,5 @@
 parameters:
-    level: 3
+    level: 4
 
     paths:
         - src/

diff --git a/src/Redmine/Client/NativeCurlClient.php b/src/Redmine/Client/NativeCurlClient.php
@@ -245,7 +245,9 @@ private function request(string $method, string $path, string $body = ''): bool
     /**
      * Prepare the request by setting the cURL options.
      *
-     * @return resource|\CurlHandle a cURL handle on success, <b>FALSE</b> on errors
+     * BC for PHP 7.4: Do not add the return type because CurlHandle was introduced in PHP 8.0
+     *
+     * @return \CurlHandle a cURL handle on success, <b>FALSE</b> on errors
      */
     private function createCurl(string $method, string $path, string $body = '')
     {

diff --git a/tests/Fixtures/MockClient.php b/tests/Fixtures/MockClient.php
@@ -12,10 +12,15 @@
  * The runRequest method of this client class just returns the value of
  * the path, method and data or the $runRequestReturnValue value if set.
  */
-class MockClient implements Client
+final class MockClient implements Client
 {
     use ClientApiTrait;
 
+    public static function create()
+    {
+        return new self();
+    }
+
     /**
      * Return value the mocked runRequest method should return.
      *
@@ -34,22 +39,7 @@ class MockClient implements Client
     public $responseCodeMock;
     public $responseContentTypeMock;
 
-    private string $url;
-    private string $apikeyOrUsername;
-    private ?string $password;
-
-    /**
-     * $apikeyOrUsername should be your ApiKey, but it could also be your username.
-     * $password needs to be set if a username is given (not recommended).
-     */
-    public function __construct(
-        string $url,
-        string $apikeyOrUsername,
-        string $password = null
-    ) {
-        $this->url = $url;
-        $this->apikeyOrUsername = $apikeyOrUsername;
-        $this->password = $password;
+    private function __csontruct() {
     }
 
     /**

diff --git a/tests/Integration/GroupXmlTest.php b/tests/Integration/GroupXmlTest.php
@@ -11,20 +11,10 @@
 
 class GroupXmlTest extends TestCase
 {
-    /**
-     * @var MockClient
-     */
-    private $client;
-
-    public function setup(): void
-    {
-        $this->client = new MockClient('http://test.local', 'asdf');
-    }
-
     public function testCreateBlank()
     {
         /** @var \Redmine\Api\Group */
-        $api = $this->client->getApi('group');
+        $api = MockClient::create()->getApi('group');
         $this->assertInstanceOf('Redmine\Api\Group', $api);
 
         $this->expectException(MissingParameterException::class);
@@ -36,7 +26,7 @@ public function testCreateBlank()
     public function testCreateComplex()
     {
         /** @var \Redmine\Api\Group */
-        $api = $this->client->getApi('group');
+        $api = MockClient::create()->getApi('group');
         $res = $api->create([
             'name' => 'Developers',
             'user_ids' => [3, 5],
@@ -58,7 +48,7 @@ public function testCreateComplex()
     public function testUpdateNotImplemented()
     {
         /** @var \Redmine\Api\Group */
-        $api = $this->client->getApi('group');
+        $api = MockClient::create()->getApi('group');
         $this->assertInstanceOf('Redmine\Api\Group', $api);
 
         $this->expectException(Exception::class);

diff --git a/tests/Integration/IssueCategoryXmlTest.php b/tests/Integration/IssueCategoryXmlTest.php
@@ -10,20 +10,10 @@
 
 class IssueCategoryXmlTest extends TestCase
 {
-    /**
-     * @var MockClient
-     */
-    private $client;
-
-    public function setup(): void
-    {
-        $this->client = new MockClient('http://test.local', 'asdf');
-    }
-
     public function testCreateBlank()
     {
         /** @var \Redmine\Api\IssueCategory */
-        $api = $this->client->getApi('issue_category');
+        $api = MockClient::create()->getApi('issue_category');
         $this->assertInstanceOf('Redmine\Api\IssueCategory', $api);
 
         $this->expectException(MissingParameterException::class);
@@ -35,7 +25,7 @@ public function testCreateBlank()
     public function testCreateComplex()
     {
         /** @var \Redmine\Api\IssueCategory */
-        $api = $this->client->getApi('issue_category');
+        $api = MockClient::create()->getApi('issue_category');
         $res = $api->create('otherProject', [
             'name' => 'test category',
         ]);
@@ -51,7 +41,7 @@ public function testCreateComplex()
     public function testUpdate()
     {
         /** @var \Redmine\Api\IssueCategory */
-        $api = $this->client->getApi('issue_category');
+        $api = MockClient::create()->getApi('issue_category');
         $res = $api->update(1, [
             'name' => 'new category name',
         ]);

diff --git a/tests/Integration/IssueXmlTest.php b/tests/Integration/IssueXmlTest.php
@@ -9,20 +9,10 @@
 
 class IssueXmlTest extends TestCase
 {
-    /**
-     * @var MockClient
-     */
-    private $client;
-
-    public function setup(): void
-    {
-        $this->client = new MockClient('http://test.local', 'asdf');
-    }
-
     public function testCreateBlank()
     {
         /** @var \Redmine\Api\Issue */
-        $api = $this->client->getApi('issue');
+        $api = MockClient::create()->getApi('issue');
         $this->assertInstanceOf('Redmine\Api\Issue', $api);
 
         $xml = '<?xml version="1.0"?>
@@ -36,7 +26,7 @@ public function testCreateBlank()
     public function testCreateComplexWithUpload()
     {
         /** @var \Redmine\Api\Issue */
-        $api = $this->client->getApi('issue');
+        $api = MockClient::create()->getApi('issue');
         $res = $api->create([
             'project_id' => 'myproject',
             'subject' => 'A test issue',
@@ -72,7 +62,7 @@ public function testCreateComplexWithUpload()
     public function testCreateComplex()
     {
         /** @var \Redmine\Api\Issue */
-        $api = $this->client->getApi('issue');
+        $api = MockClient::create()->getApi('issue');
         $res = $api->create([
             'project_id' => 'test',
             'subject' => 'test api (xml) 3',
@@ -117,7 +107,7 @@ public function testCreateComplex()
     public function testCreateComplexWithLineBreakInDescription()
     {
         /** @var \Redmine\Api\Issue */
-        $api = $this->client->getApi('issue');
+        $api = MockClient::create()->getApi('issue');
         $res = $api->create([
             'project_id' => 'test',
             'subject' => 'test api (xml) 3',
@@ -163,7 +153,7 @@ public function testCreateComplexWithLineBreakInDescription()
     public function testUpdateIssue()
     {
         /** @var \Redmine\Api\Issue */
-        $api = $this->client->getApi('issue');
+        $api = MockClient::create()->getApi('issue');
         $res = $api->update(1, [
             'subject' => 'test note (xml) 1',
             'notes' => 'test note api',
@@ -193,7 +183,7 @@ public function testUpdateIssue()
     public function testAddNoteToIssue()
     {
         /** @var \Redmine\Api\Issue */
-        $api = $this->client->getApi('issue');
+        $api = MockClient::create()->getApi('issue');
         $res = $api->addNoteToIssue(1, 'some comment');
         $res = json_decode($res, true);
 

diff --git a/tests/Integration/MembershipXmlTest.php b/tests/Integration/MembershipXmlTest.php
@@ -10,20 +10,10 @@
 
 class MembershipXmlTest extends TestCase
 {
-    /**
-     * @var MockClient
-     */
-    private $client;
-
-    public function setup(): void
-    {
-        $this->client = new MockClient('http://test.local', 'asdf');
-    }
-
     public function testCreateBlank()
     {
         /** @var \Redmine\Api\Membership */
-        $api = $this->client->getApi('membership');
+        $api = MockClient::create()->getApi('membership');
         $this->assertInstanceOf('Redmine\Api\Membership', $api);
 
         $this->expectException(MissingParameterException::class);
@@ -35,7 +25,7 @@ public function testCreateBlank()
     public function testCreateComplex()
     {
         /** @var \Redmine\Api\Membership */
-        $api = $this->client->getApi('membership');
+        $api = MockClient::create()->getApi('membership');
         $res = $api->create('otherProject', [
             'user_id' => 1,
             'role_ids' => [1, 2],
@@ -56,7 +46,7 @@ public function testCreateComplex()
     public function testUpdate()
     {
         /** @var \Redmine\Api\Membership */
-        $api = $this->client->getApi('membership');
+        $api = MockClient::create()->getApi('membership');
         $res = $api->update(1, [
             'role_ids' => [1, 2],
         ]);

diff --git a/tests/Integration/ProjectXmlTest.php b/tests/Integration/ProjectXmlTest.php
@@ -10,20 +10,10 @@
 
 class ProjectXmlTest extends TestCase
 {
-    /**
-     * @var MockClient
-     */
-    private $client;
-
-    public function setup(): void
-    {
-        $this->client = new MockClient('http://test.local', 'asdf');
-    }
-
     public function testCreateBlank()
     {
         /** @var \Redmine\Api\Project */
-        $api = $this->client->getApi('project');
+        $api = MockClient::create()->getApi('project');
         $this->assertInstanceOf('Redmine\Api\Project', $api);
 
         $this->expectException(MissingParameterException::class);
@@ -35,7 +25,7 @@ public function testCreateBlank()
     public function testCreateComplex()
     {
         /** @var \Redmine\Api\Project */
-        $api = $this->client->getApi('project');
+        $api = MockClient::create()->getApi('project');
         $res = $api->create([
             'name' => 'some name',
             'identifier' => 'the_identifier',
@@ -70,7 +60,7 @@ public function testCreateComplex()
     public function testCreateComplexWithTrackerIds()
     {
         /** @var \Redmine\Api\Project */
-        $api = $this->client->getApi('project');
+        $api = MockClient::create()->getApi('project');
         $res = $api->create([
             'name' => 'some name',
             'identifier' => 'the_identifier',
@@ -96,7 +86,7 @@ public function testCreateComplexWithTrackerIds()
     public function testUpdate()
     {
         /** @var \Redmine\Api\Project */
-        $api = $this->client->getApi('project');
+        $api = MockClient::create()->getApi('project');
         $res = $api->update(1, [
             'name' => 'different name',
         ]);