Skip to content

Commit bd32dba

Browse files
sibprogrammersibprogrammer
committed
Replace docblock with type hints in tests to enforce type checks
1 parent 639560d commit bd32dba

File tree

8 files changed

+28
-62
lines changed

8 files changed

+28
-62
lines changed

‎tests/AbstractTestCase.php

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33

44
namespace PleskXTest;
55

6+
use PHPUnit\Framework\TestCase;
7+
use PleskX\Api\Client;
68
use PleskXTest\Utility\PasswordProvider;
79

8-
abstract class AbstractTestCase extends \PHPUnit\Framework\TestCase
10+
abstract class AbstractTestCase extends TestCase
911
{
10-
/** @var \PleskX\Api\Client */
11-
protected static $client;
12+
protected static Client $client;
1213

13-
private static $webspaces = [];
14-
private static $servicePlans = [];
14+
private static array $webspaces = [];
15+
private static array $servicePlans = [];
1516

1617
public static function setUpBeforeClass(): void
1718
{
@@ -27,7 +28,7 @@ public static function setUpBeforeClass(): void
2728
list($host, $port, $scheme) = [$parsedUrl['host'], $parsedUrl['port'], $parsedUrl['scheme']];
2829
}
2930

30-
static::$client = new \PleskX\Api\Client($host, $port, $scheme);
31+
static::$client = new Client($host, $port, $scheme);
3132
static::$client->setCredentials($login, $password);
3233

3334
$proxy = getenv('REMOTE_PROXY');
@@ -55,21 +56,15 @@ public static function tearDownAfterClass(): void
5556
}
5657
}
5758

58-
/**
59-
* @return string
60-
*/
61-
protected static function getIpAddress()
59+
protected static function getIpAddress(): string
6260
{
6361
$ips = static::$client->ip()->get();
6462
$ipInfo = reset($ips);
6563

6664
return $ipInfo->ipAddress;
6765
}
6866

69-
/**
70-
* @return \PleskX\Api\Struct\Webspace\Info
71-
*/
72-
protected static function createWebspace()
67+
protected static function createWebspace(): \PleskX\Api\Struct\Webspace\Info
7368
{
7469
$id = uniqid();
7570
$webspace = static::$client->webspace()->create(
@@ -87,7 +82,7 @@ protected static function createWebspace()
8782
return $webspace;
8883
}
8984

90-
protected static function createServicePlan()
85+
protected static function createServicePlan(): \PleskX\Api\Struct\ServicePlan\Info
9186
{
9287
$id = uniqid();
9388
$servicePlan = static::$client->servicePlan()->create(['name' => "test{$id}plan"]);

‎tests/DatabaseTest.php

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
class DatabaseTest extends AbstractTestCase
99
{
10-
/** @var \PleskX\Api\Struct\Webspace\Info */
11-
private static $webspace;
10+
private static \PleskX\Api\Struct\Webspace\Info $webspace;
1211

1312
public static function setUpBeforeClass(): void
1413
{
@@ -207,12 +206,7 @@ public function testDeleteUser()
207206
static::$client->database()->delete('id', $database->id);
208207
}
209208

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
216210
{
217211
$database = static::$client->database()->create($params);
218212
$this->assertIsInt($database->id);
@@ -221,12 +215,7 @@ private function createDatabase(array $params)
221215
return $database;
222216
}
223217

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
230219
{
231220
$user = static::$client->database()->createUser($params);
232221
$this->assertIsInt($user->id);

‎tests/DnsTest.php

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@
55

66
class DnsTest extends AbstractTestCase
77
{
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;
1210

1311
public static function setUpBeforeClass(): void
1412
{
@@ -45,9 +43,9 @@ public function testCreate()
4543
}
4644

4745
/**
48-
* @return \PleskX\Api\XmlResponse[]
46+
* @return \SimpleXMLElement[]
4947
*/
50-
public function testBulkCreate()
48+
public function testBulkCreate(): array
5149
{
5250
$response = static::$client->dns()->bulkCreate([
5351
[
@@ -84,7 +82,7 @@ public function testBulkCreate()
8482
/**
8583
* @depends testBulkCreate
8684
*
87-
* @param \PleskX\Api\XmlResponse[] $createdRecords
85+
* @param \SimpleXMLElement[] $createdRecords
8886
*/
8987
public function testBulkDelete(array $createdRecords)
9088
{

‎tests/MailTest.php

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,8 @@
77

88
class MailTest extends AbstractTestCase
99
{
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;
1712

1813
public static function setUpBeforeClass(): void
1914
{

‎tests/ProtectedDirectoryTest.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
class ProtectedDirectoryTest extends AbstractTestCase
99
{
10-
/** @var \PleskX\Api\Struct\Webspace\Info */
11-
private static $webspace;
10+
private static \PleskX\Api\Struct\Webspace\Info $webspace;
1211

1312
public static function setUpBeforeClass(): void
1413
{

‎tests/SiteAliasTest.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,15 @@
55

66
class SiteAliasTest extends AbstractTestCase
77
{
8-
/** @var \PleskX\Api\Struct\Webspace\Info */
9-
private static $webspace;
8+
private static \PleskX\Api\Struct\Webspace\Info $webspace;
109

1110
public static function setUpBeforeClass(): void
1211
{
1312
parent::setUpBeforeClass();
1413
static::$webspace = static::createWebspace();
1514
}
1615

17-
private function createSiteAlias($name, array $properties = [])
16+
private function createSiteAlias($name, array $properties = []): \PleskX\Api\Struct\SiteAlias\Info
1817
{
1918
$properties = array_merge([
2019
'name' => $name,

‎tests/SiteTest.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
class SiteTest extends AbstractTestCase
99
{
10-
/** @var \PleskX\Api\Struct\Webspace\Info */
11-
private static $webspace;
10+
private static \PleskX\Api\Struct\Webspace\Info $webspace;
1211

1312
public static function setUpBeforeClass(): void
1413
{
@@ -27,7 +26,7 @@ protected function setUp(): void
2726
}
2827
}
2928

30-
private function createSite($name, array $properties = [])
29+
private function createSite($name, array $properties = []): \PleskX\Api\Struct\Site\Info
3130
{
3231
$properties = array_merge([
3332
'name' => $name,

‎tests/SubdomainTest.php

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,8 @@
55

66
class SubdomainTest extends AbstractTestCase
77
{
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;
1310

1411
public static function setUpBeforeClass(): void
1512
{
@@ -19,12 +16,7 @@ public static function setUpBeforeClass(): void
1916
static::$webspaceName = $webspaceInfo->name;
2017
}
2118

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
2820
{
2921
return static::$client->subdomain()->create([
3022
'parent' => static::$webspaceName,

0 commit comments

Comments
 (0)