Replace docblock with type hints in tests to enforce type checks

sibprogrammer · sibprogrammer · commit bd32dba37e56 · 2021-10-27T11:16:54.000+07:00
diff --git a/tests/AbstractTestCase.php b/tests/AbstractTestCase.php
@@ -3,15 +3,16 @@
 
 namespace PleskXTest;
 
+use PHPUnit\Framework\TestCase;
+use PleskX\Api\Client;
 use PleskXTest\Utility\PasswordProvider;
 
-abstract class AbstractTestCase extends \PHPUnit\Framework\TestCase
+abstract class AbstractTestCase extends TestCase
 {
-    /** @var \PleskX\Api\Client */
-    protected static $client;
+    protected static Client $client;
 
-    private static $webspaces = [];
-    private static $servicePlans = [];
+    private static array $webspaces = [];
+    private static array $servicePlans = [];
 
     public static function setUpBeforeClass(): void
     {
@@ -27,7 +28,7 @@ public static function setUpBeforeClass(): void
             list($host, $port, $scheme) = [$parsedUrl['host'], $parsedUrl['port'], $parsedUrl['scheme']];
         }
 
-        static::$client = new \PleskX\Api\Client($host, $port, $scheme);
+        static::$client = new Client($host, $port, $scheme);
         static::$client->setCredentials($login, $password);
 
         $proxy = getenv('REMOTE_PROXY');
@@ -55,21 +56,15 @@ public static function tearDownAfterClass(): void
         }
     }
 
-    /**
-     * @return string
-     */
-    protected static function getIpAddress()
+    protected static function getIpAddress(): string
     {
         $ips = static::$client->ip()->get();
         $ipInfo = reset($ips);
 
         return $ipInfo->ipAddress;
     }
 
-    /**
-     * @return \PleskX\Api\Struct\Webspace\Info
-     */
-    protected static function createWebspace()
+    protected static function createWebspace(): \PleskX\Api\Struct\Webspace\Info
     {
         $id = uniqid();
         $webspace = static::$client->webspace()->create(
@@ -87,7 +82,7 @@ protected static function createWebspace()
         return $webspace;
     }
 
-    protected static function createServicePlan()
+    protected static function createServicePlan(): \PleskX\Api\Struct\ServicePlan\Info
     {
         $id = uniqid();
         $servicePlan = static::$client->servicePlan()->create(['name' => "test{$id}plan"]);
diff --git a/tests/DatabaseTest.php b/tests/DatabaseTest.php
@@ -7,8 +7,7 @@
 
 class DatabaseTest extends AbstractTestCase
 {
-    /** @var \PleskX\Api\Struct\Webspace\Info */
-    private static $webspace;
+    private static \PleskX\Api\Struct\Webspace\Info $webspace;
 
     public static function setUpBeforeClass(): void
     {
@@ -207,12 +206,7 @@ public function testDeleteUser()
         static::$client->database()->delete('id', $database->id);
     }
 
-    /**
-     * @param array $params
-     *
-     * @return \PleskX\Api\Struct\Database\Info
-     */
-    private function createDatabase(array $params)
+    private function createDatabase(array $params): \PleskX\Api\Struct\Database\Info
     {
         $database = static::$client->database()->create($params);
         $this->assertIsInt($database->id);
@@ -221,12 +215,7 @@ private function createDatabase(array $params)
         return $database;
     }
 
-    /**
-     * @param array $params
-     *
-     * @return \PleskX\Api\Struct\Database\UserInfo
-     */
-    private function createUser(array $params)
+    private function createUser(array $params): \PleskX\Api\Struct\Database\UserInfo
     {
         $user = static::$client->database()->createUser($params);
         $this->assertIsInt($user->id);
diff --git a/tests/DnsTest.php b/tests/DnsTest.php
@@ -5,10 +5,8 @@
 
 class DnsTest extends AbstractTestCase
 {
-    /** @var \PleskX\Api\Struct\Webspace\Info */
-    private static $webspace;
-
-    private static $isDnsSupported;
+    private static \PleskX\Api\Struct\Webspace\Info $webspace;
+    private static bool $isDnsSupported;
 
     public static function setUpBeforeClass(): void
     {
@@ -45,9 +43,9 @@ public function testCreate()
     }
 
     /**
-     * @return \PleskX\Api\XmlResponse[]
+     * @return \SimpleXMLElement[]
      */
-    public function testBulkCreate()
+    public function testBulkCreate(): array
     {
         $response = static::$client->dns()->bulkCreate([
             [
@@ -84,7 +82,7 @@ public function testBulkCreate()
     /**
      * @depends testBulkCreate
      *
-     * @param \PleskX\Api\XmlResponse[] $createdRecords
+     * @param \SimpleXMLElement[] $createdRecords
      */
     public function testBulkDelete(array $createdRecords)
     {
diff --git a/tests/MailTest.php b/tests/MailTest.php
@@ -7,13 +7,8 @@
 
 class MailTest extends AbstractTestCase
 {
-    /** @var \PleskX\Api\Struct\Webspace\Info */
-    private static $webspace;
-
-    /**
-     * @var bool
-     */
-    private static $isMailSupported;
+    private static \PleskX\Api\Struct\Webspace\Info $webspace;
+    private static bool $isMailSupported;
 
     public static function setUpBeforeClass(): void
     {
diff --git a/tests/ProtectedDirectoryTest.php b/tests/ProtectedDirectoryTest.php
@@ -7,8 +7,7 @@
 
 class ProtectedDirectoryTest extends AbstractTestCase
 {
-    /** @var \PleskX\Api\Struct\Webspace\Info */
-    private static $webspace;
+    private static \PleskX\Api\Struct\Webspace\Info $webspace;
 
     public static function setUpBeforeClass(): void
     {
diff --git a/tests/SiteAliasTest.php b/tests/SiteAliasTest.php
@@ -5,16 +5,15 @@
 
 class SiteAliasTest extends AbstractTestCase
 {
-    /** @var \PleskX\Api\Struct\Webspace\Info */
-    private static $webspace;
+    private static \PleskX\Api\Struct\Webspace\Info $webspace;
 
     public static function setUpBeforeClass(): void
     {
         parent::setUpBeforeClass();
         static::$webspace = static::createWebspace();
     }
 
-    private function createSiteAlias($name, array $properties = [])
+    private function createSiteAlias($name, array $properties = []): \PleskX\Api\Struct\SiteAlias\Info
     {
         $properties = array_merge([
             'name' => $name,
diff --git a/tests/SiteTest.php b/tests/SiteTest.php
@@ -7,8 +7,7 @@
 
 class SiteTest extends AbstractTestCase
 {
-    /** @var \PleskX\Api\Struct\Webspace\Info */
-    private static $webspace;
+    private static \PleskX\Api\Struct\Webspace\Info $webspace;
 
     public static function setUpBeforeClass(): void
     {
@@ -27,7 +26,7 @@ protected function setUp(): void
         }
     }
 
-    private function createSite($name, array $properties = [])
+    private function createSite($name, array $properties = []): \PleskX\Api\Struct\Site\Info
     {
         $properties = array_merge([
             'name' => $name,
diff --git a/tests/SubdomainTest.php b/tests/SubdomainTest.php
@@ -5,11 +5,8 @@
 
 class SubdomainTest extends AbstractTestCase
 {
-    /** @var \PleskX\Api\Struct\Webspace\Info */
-    private static $webspace;
-
-    /** @var string */
-    private static $webspaceName;
+    private static \PleskX\Api\Struct\Webspace\Info $webspace;
+    private static string $webspaceName;
 
     public static function setUpBeforeClass(): void
     {
@@ -19,12 +16,7 @@ public static function setUpBeforeClass(): void
         static::$webspaceName = $webspaceInfo->name;
     }
 
-    /**
-     * @param string $name
-     *
-     * @return \PleskX\Api\Struct\Subdomain\Info
-     */
-    private function createSubdomain(string $name)
+    private function createSubdomain(string $name): \PleskX\Api\Struct\Subdomain\Info
     {
         return static::$client->subdomain()->create([
             'parent' => static::$webspaceName,

Original file line number	Diff line number	Diff line change
`@@ -3,15 +3,16 @@`
`3`	`3`
`4`	`4`	`namespace PleskXTest;`
`5`	`5`
	`6`	`+use PHPUnit\Framework\TestCase;`
	`7`	`+use PleskX\Api\Client;`
`6`	`8`	`use PleskXTest\Utility\PasswordProvider;`
`7`	`9`
`8`		`-abstract class AbstractTestCase extends \PHPUnit\Framework\TestCase`
	`10`	`+abstract class AbstractTestCase extends TestCase`
`9`	`11`	`{`
`10`		`- /** @var \PleskX\Api\Client */`
`11`		`- protected static $client;`
	`12`	`+ protected static Client $client;`
`12`	`13`
`13`		`- private static $webspaces = [];`
`14`		`- private static $servicePlans = [];`
	`14`	`+ private static array $webspaces = [];`
	`15`	`+ private static array $servicePlans = [];`
`15`	`16`
`16`	`17`	`public static function setUpBeforeClass(): void`
`17`	`18`	`{`
`@@ -27,7 +28,7 @@ public static function setUpBeforeClass(): void`
`27`	`28`	`list($host, $port, $scheme) = [$parsedUrl['host'], $parsedUrl['port'], $parsedUrl['scheme']];`
`28`	`29`	`}`
`29`	`30`
`30`		`- static::$client = new \PleskX\Api\Client($host, $port, $scheme);`
	`31`	`+ static::$client = new Client($host, $port, $scheme);`
`31`	`32`	`static::$client->setCredentials($login, $password);`
`32`	`33`
`33`	`34`	`$proxy = getenv('REMOTE_PROXY');`
`@@ -55,21 +56,15 @@ public static function tearDownAfterClass(): void`
`55`	`56`	`}`
`56`	`57`	`}`
`57`	`58`
`58`		`- /**`
`59`		`- * @return string`
`60`		`- */`
`61`		`- protected static function getIpAddress()`
	`59`	`+ protected static function getIpAddress(): string`
`62`	`60`	`{`
`63`	`61`	`$ips = static::$client->ip()->get();`
`64`	`62`	`$ipInfo = reset($ips);`
`65`	`63`
`66`	`64`	`return $ipInfo->ipAddress;`
`67`	`65`	`}`
`68`	`66`
`69`		`- /**`
`70`		`- * @return \PleskX\Api\Struct\Webspace\Info`
`71`		`- */`
`72`		`- protected static function createWebspace()`
	`67`	`+ protected static function createWebspace(): \PleskX\Api\Struct\Webspace\Info`
`73`	`68`	`{`
`74`	`69`	`$id = uniqid();`
`75`	`70`	`$webspace = static::$client->webspace()->create(`
`@@ -87,7 +82,7 @@ protected static function createWebspace()`
`87`	`82`	`return $webspace;`
`88`	`83`	`}`
`89`	`84`
`90`		`- protected static function createServicePlan()`
	`85`	`+ protected static function createServicePlan(): \PleskX\Api\Struct\ServicePlan\Info`
`91`	`86`	`{`
`92`	`87`	`$id = uniqid();`
`93`	`88`	`$servicePlan = static::$client->servicePlan()->create(['name' => "test{$id}plan"]);`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,7 @@`
`7`	`7`
`8`	`8`	`class DatabaseTest extends AbstractTestCase`
`9`	`9`	`{`
`10`		`- /** @var \PleskX\Api\Struct\Webspace\Info */`
`11`		`- private static $webspace;`
	`10`	`+ private static \PleskX\Api\Struct\Webspace\Info $webspace;`
`12`	`11`
`13`	`12`	`public static function setUpBeforeClass(): void`
`14`	`13`	`{`
`@@ -207,12 +206,7 @@ public function testDeleteUser()`
`207`	`206`	`static::$client->database()->delete('id', $database->id);`
`208`	`207`	`}`
`209`	`208`
`210`		`- /**`
`211`		`- * @param array $params`
`212`		`- *`
`213`		`- * @return \PleskX\Api\Struct\Database\Info`
`214`		`- */`
`215`		`- private function createDatabase(array $params)`
	`209`	`+ private function createDatabase(array $params): \PleskX\Api\Struct\Database\Info`
`216`	`210`	`{`
`217`	`211`	`$database = static::$client->database()->create($params);`
`218`	`212`	`$this->assertIsInt($database->id);`
`@@ -221,12 +215,7 @@ private function createDatabase(array $params)`
`221`	`215`	`return $database;`
`222`	`216`	`}`
`223`	`217`
`224`		`- /**`
`225`		`- * @param array $params`
`226`		`- *`
`227`		`- * @return \PleskX\Api\Struct\Database\UserInfo`
`228`		`- */`
`229`		`- private function createUser(array $params)`
	`218`	`+ private function createUser(array $params): \PleskX\Api\Struct\Database\UserInfo`
`230`	`219`	`{`
`231`	`220`	`$user = static::$client->database()->createUser($params);`
`232`	`221`	`$this->assertIsInt($user->id);`
Original file line number	Diff line number	Diff line change
`@@ -5,10 +5,8 @@`
`5`	`5`
`6`	`6`	`class DnsTest extends AbstractTestCase`
`7`	`7`	`{`
`8`		`- /** @var \PleskX\Api\Struct\Webspace\Info */`
`9`		`- private static $webspace;`
`10`		`-`
`11`		`- private static $isDnsSupported;`
	`8`	`+ private static \PleskX\Api\Struct\Webspace\Info $webspace;`
	`9`	`+ private static bool $isDnsSupported;`
`12`	`10`
`13`	`11`	`public static function setUpBeforeClass(): void`
`14`	`12`	`{`
`@@ -45,9 +43,9 @@ public function testCreate()`
`45`	`43`	`}`
`46`	`44`
`47`	`45`	`/**`
`48`		`- * @return \PleskX\Api\XmlResponse[]`
	`46`	`+ * @return \SimpleXMLElement[]`
`49`	`47`	`*/`
`50`		`- public function testBulkCreate()`
	`48`	`+ public function testBulkCreate(): array`
`51`	`49`	`{`
`52`	`50`	`$response = static::$client->dns()->bulkCreate([`
`53`	`51`	`[`
`@@ -84,7 +82,7 @@ public function testBulkCreate()`
`84`	`82`	`/**`
`85`	`83`	`* @depends testBulkCreate`
`86`	`84`	`*`
`87`		`- * @param \PleskX\Api\XmlResponse[] $createdRecords`
	`85`	`+ * @param \SimpleXMLElement[] $createdRecords`
`88`	`86`	`*/`
`89`	`87`	`public function testBulkDelete(array $createdRecords)`
`90`	`88`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,13 +7,8 @@`
`7`	`7`
`8`	`8`	`class MailTest extends AbstractTestCase`
`9`	`9`	`{`
`10`		`- /** @var \PleskX\Api\Struct\Webspace\Info */`
`11`		`- private static $webspace;`
`12`		`-`
`13`		`- /**`
`14`		`- * @var bool`
`15`		`- */`
`16`		`- private static $isMailSupported;`
	`10`	`+ private static \PleskX\Api\Struct\Webspace\Info $webspace;`
	`11`	`+ private static bool $isMailSupported;`
`17`	`12`
`18`	`13`	`public static function setUpBeforeClass(): void`
`19`	`14`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,7 @@`
`7`	`7`
`8`	`8`	`class ProtectedDirectoryTest extends AbstractTestCase`
`9`	`9`	`{`
`10`		`- /** @var \PleskX\Api\Struct\Webspace\Info */`
`11`		`- private static $webspace;`
	`10`	`+ private static \PleskX\Api\Struct\Webspace\Info $webspace;`
`12`	`11`
`13`	`12`	`public static function setUpBeforeClass(): void`
`14`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,16 +5,15 @@`
`5`	`5`
`6`	`6`	`class SiteAliasTest extends AbstractTestCase`
`7`	`7`	`{`
`8`		`- /** @var \PleskX\Api\Struct\Webspace\Info */`
`9`		`- private static $webspace;`
	`8`	`+ private static \PleskX\Api\Struct\Webspace\Info $webspace;`
`10`	`9`
`11`	`10`	`public static function setUpBeforeClass(): void`
`12`	`11`	`{`
`13`	`12`	`parent::setUpBeforeClass();`
`14`	`13`	`static::$webspace = static::createWebspace();`
`15`	`14`	`}`
`16`	`15`
`17`		`- private function createSiteAlias($name, array $properties = [])`
	`16`	`+ private function createSiteAlias($name, array $properties = []): \PleskX\Api\Struct\SiteAlias\Info`
`18`	`17`	`{`
`19`	`18`	`$properties = array_merge([`
`20`	`19`	`'name' => $name,`
Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,7 @@`
`7`	`7`
`8`	`8`	`class SiteTest extends AbstractTestCase`
`9`	`9`	`{`
`10`		`- /** @var \PleskX\Api\Struct\Webspace\Info */`
`11`		`- private static $webspace;`
	`10`	`+ private static \PleskX\Api\Struct\Webspace\Info $webspace;`
`12`	`11`
`13`	`12`	`public static function setUpBeforeClass(): void`
`14`	`13`	`{`
`@@ -27,7 +26,7 @@ protected function setUp(): void`
`27`	`26`	`}`
`28`	`27`	`}`
`29`	`28`
`30`		`- private function createSite($name, array $properties = [])`
	`29`	`+ private function createSite($name, array $properties = []): \PleskX\Api\Struct\Site\Info`
`31`	`30`	`{`
`32`	`31`	`$properties = array_merge([`
`33`	`32`	`'name' => $name,`
Original file line number	Diff line number	Diff line change
`@@ -5,11 +5,8 @@`
`5`	`5`
`6`	`6`	`class SubdomainTest extends AbstractTestCase`
`7`	`7`	`{`
`8`		`- /** @var \PleskX\Api\Struct\Webspace\Info */`
`9`		`- private static $webspace;`
`10`		`-`
`11`		`- /** @var string */`
`12`		`- private static $webspaceName;`
	`8`	`+ private static \PleskX\Api\Struct\Webspace\Info $webspace;`
	`9`	`+ private static string $webspaceName;`
`13`	`10`
`14`	`11`	`public static function setUpBeforeClass(): void`
`15`	`12`	`{`
`@@ -19,12 +16,7 @@ public static function setUpBeforeClass(): void`
`19`	`16`	`static::$webspaceName = $webspaceInfo->name;`
`20`	`17`	`}`
`21`	`18`
`22`		`- /**`
`23`		`- * @param string $name`
`24`		`- *`
`25`		`- * @return \PleskX\Api\Struct\Subdomain\Info`
`26`		`- */`
`27`		`- private function createSubdomain(string $name)`
	`19`	`+ private function createSubdomain(string $name): \PleskX\Api\Struct\Subdomain\Info`
`28`	`20`	`{`
`29`	`21`	`return static::$client->subdomain()->create([`
`30`	`22`	`'parent' => static::$webspaceName,`