AUT-3504: code style

emartech · Oct 28, 2024 · 4c14b97 · 4c14b97
1 parent 8a90370
commit 4c14b97
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 37 deletions.
diff --git a/src/Suite/Api/AC/EndPoints.php b/src/Suite/Api/AC/EndPoints.php
@@ -4,7 +4,7 @@
 
 class EndPoints
 {
-    private $apiBaseUrl;
+    private string $apiBaseUrl;
 
     public function __construct(string $apiBaseUrl)
     {

diff --git a/src/Suite/Api/AC/Program.php b/src/Suite/Api/AC/Program.php
@@ -8,36 +8,32 @@
 
 class Program
 {
-    /* @var Client */
-    private $apiClient;
-
-    /* @var EndPoints */
-    private $endPoints;
-
+    private Client $apiClient;
+    private EndPoints $endPoints;
 
     public function __construct(Client $apiClient, EndPoints $endPoints)
     {
         $this->apiClient = $apiClient;
         $this->endPoints = $endPoints;
     }
 
-    public function programCallbackWithUserId(int $customerId, string $triggerId, int $userId)
+    public function programCallbackWithUserId(int $customerId, string $triggerId, int $userId): void
     {
         $this->sendRequest(
             $this->endPoints->programCallbackDoneUrl($customerId, $triggerId),
             $this->createPostData($userId, null)
         );
     }
 
-    public function programCallbackWithListId(int $customerId, string $triggerId, int $listId)
+    public function programCallbackWithListId(int $customerId, string $triggerId, int $listId): void
     {
         $this->sendRequest(
             $this->endPoints->programCallbackDoneUrl($customerId, $triggerId),
             $this->createPostData(null, $listId)
         );
     }
 
-    public function programCallbackCancel(int $customerId, string $triggerId)
+    public function programCallbackCancel(int $customerId, string $triggerId): void
     {
         $this->sendRequest(
             $this->endPoints->programCallbackCancelUrl($customerId, $triggerId),
@@ -78,7 +74,7 @@ public function programBatchCallbackDone(int $customerId, array $triggers): void
         );
     }
 
-    private function sendRequest(string $url, $postData)
+    private function sendRequest(string $url, $postData): void
     {
         try {
             $this->apiClient->post($url, $postData);

diff --git a/test/helper/TestCase.php b/test/helper/TestCase.php
@@ -14,19 +14,17 @@ class TestCase extends \PHPUnit\Framework\TestCase
     const API_FAILURE_TEXT = 'FAIL';
     const API_FAILURE_CODE = 9999;
 
-    protected $customerId = 555;
-    protected $campaignId = 123;
+    protected Client|MockObject $apiClient;
 
-    /** @var EndPoints */
-    protected $endPoints;
-
-    /** @var Client|MockObject */
-    protected $apiClient;
+    protected int $customerId = 555;
+    protected int $campaignId = 123;
 
     protected function expectApiFailure(string $method = 'get')
     {
-        $this->apiClient->expects($this->once())->method($method)
-            ->will($this->throwException(new Error()));
+        $this->apiClient
+            ->expects($this->once())
+            ->method($method)
+            ->willThrowException(new Error());
     }
 
     protected function apiSuccess($data = [])

diff --git a/test/unit/Suite/Api/AC/ProgramTest.php b/test/unit/Suite/Api/AC/ProgramTest.php
@@ -8,15 +8,12 @@
 
 class ProgramTest extends TestCase
 {
-    const TRIGGER_ID = 'trigger_id';
-    const USER_ID = 1;
-    const LIST_ID = 2;
+    private const TRIGGER_ID = 'trigger_id';
+    private const USER_ID = 1;
+    private const LIST_ID = 2;
 
-    /** @var EndPoints */
-    protected $endPoints;
-
-    /** @var Program */
-    private $program;
+    private EndPoints $endPoints;
+    private Program $program;
 
     protected function setUp(): void
     {
@@ -30,7 +27,7 @@ protected function setUp(): void
     /**
      * @test
      */
-    public function programCallbackWithUserId_Perfect_Perfect()
+    public function programCallbackWithUserId_CallEndpointWithCorrectParameters(): void
     {
         $this->expectSuccessfulDoneRequest(
             [
@@ -45,7 +42,7 @@ public function programCallbackWithUserId_Perfect_Perfect()
     /**
      * @test
      */
-    public function programCallbackWithUserId_postThrowsError_ThrowsRequestFailException()
+    public function programCallbackWithUserId_postThrowsError_ThrowsRequestFailException(): void
     {
         $this->expectException(RequestFailed::class);
         $this->expectApiCallFailure();
@@ -56,7 +53,7 @@ public function programCallbackWithUserId_postThrowsError_ThrowsRequestFailExcep
     /**
      * @test
      */
-    public function programCallbackWithListId_Perfect_Perfect()
+    public function programCallbackWithListId_CallEndpointWithCorrectParameters(): void
     {
         $this->expectSuccessfulDoneRequest(
             [
@@ -71,7 +68,7 @@ public function programCallbackWithListId_Perfect_Perfect()
     /**
      * @test
      */
-    public function programCallbackWithListId_postThrowsError_ThrowsRequestFailException()
+    public function programCallbackWithListId_postThrowsError_ThrowsRequestFailException(): void
     {
         $this->expectException(RequestFailed::class);
         $this->expectApiCallFailure();
@@ -82,7 +79,7 @@ public function programCallbackWithListId_postThrowsError_ThrowsRequestFailExcep
     /**
      * @test
      */
-    public function programBatchCallbackDone_CalledWithCorrectParameters()
+    public function programBatchCallbackDone_CalledWithCorrectParameters(): void
     {
         $postParams = [
             'this' => 'is',
@@ -105,14 +102,14 @@ public function programBatchCallbackDone_CalledWithCorrectParameters()
     /**
      * @test
      */
-    public function programCallbackCancel_Perfect_Perfect()
+    public function programCallbackCancel_Perfect_Perfect(): void
     {
         $this->expectSuccessfulCancelRequest();
 
         $this->program->programCallbackCancel($this->customerId, self::TRIGGER_ID);
     }
 
-    private function expectSuccessfulDoneRequest(array $postParams)
+    private function expectSuccessfulDoneRequest(array $postParams): void
     {
         $this->apiClient
             ->expects($this->once())
@@ -124,7 +121,7 @@ private function expectSuccessfulDoneRequest(array $postParams)
             ->willReturn($this->apiSuccess());
     }
 
-    private function expectSuccessfulCancelRequest()
+    private function expectSuccessfulCancelRequest(): void
     {
         $this->apiClient
             ->expects($this->once())
@@ -139,7 +136,7 @@ private function expectSuccessfulCancelRequest()
             ->willReturn($this->apiSuccess());
     }
 
-    private function expectApiCallFailure()
+    private function expectApiCallFailure(): void
     {
         $this->apiClient
             ->expects($this->any())