Fix cache tests

supportpal · Oct 25, 2020 · 12ad9d3 · 12ad9d3
1 parent 5775a06
commit 12ad9d3
Show file tree

Hide file tree

Showing 23 changed files with 75 additions and 56 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -40,4 +40,4 @@ jobs:
               run: TESTSUITE=integration MINCOVERAGE=85 ci/test.sh
 
             - name: Execute Cache tests
-              run: ./vendor/bin/phpunit --testsuite=cache --stop-on-fail
+              run: /vendor/bin/phpunit --testsuite=cache --stop-on-fail
diff --git a/test/Cache/CacheableApisTest.php b/test/Cache/CacheableApisTest.php
@@ -10,6 +10,10 @@
 use Kevinrob\GuzzleCache\CacheMiddleware;
 use Kevinrob\GuzzleCache\Strategy\CacheStrategyInterface;
 use SupportPal\ApiClient\ApiClient;
+use SupportPal\ApiClient\ApiClient\CoreApiClient;
+use SupportPal\ApiClient\ApiClient\SelfServiceApiClient;
+use SupportPal\ApiClient\ApiClient\TicketApiClient;
+use SupportPal\ApiClient\ApiClient\UserApiClient;
 use SupportPal\ApiClient\Cache\ApiCacheMap;
 use SupportPal\ApiClient\Cache\CacheStrategyConfigurator;
 use SupportPal\ApiClient\Dictionary\ApiDictionary;
@@ -43,13 +47,18 @@ class CacheableApisTest extends ContainerAwareBaseTestCase
      * @param string $endpoint
      * @param array<mixed> $data
      * @param array<mixed> $parameters
+     * @param class-string $apiClientClass
      * @throws Exception
      * @dataProvider provideCacheableApiCalls
      */
-    public function testGetCacheableApiTestCacheHit(string $endpoint, array $data, array $parameters): void
-    {
+    public function testGetCacheableApiTestCacheHit(
+        string $endpoint,
+        array $data,
+        array $parameters,
+        string $apiClientClass
+    ): void {
         /** @var ApiClient $apiClient */
-        $apiClient = $this->getContainer()->get(ApiClient::class);
+        $apiClient = $this->getContainer()->get($apiClientClass);
 
         $response = new Response(200, [], (string) $this->getEncoder()->encode($data, $this->getFormatType()));
         $response2 = new Response(200, [], (string) $this->getEncoder()->encode($data, $this->getFormatType()));
@@ -78,13 +87,18 @@ public function testGetCacheableApiTestCacheHit(string $endpoint, array $data, a
      * @param string $endpoint
      * @param array<mixed> $data
      * @param array<mixed> $parameters
+     * @param class-string $apiClientClass
      * @throws Exception
      * @dataProvider provideCacheableApiCalls
      */
-    public function testGetCacheableApiTestCacheMiss(string $endpoint, array $data, array $parameters): void
-    {
+    public function testGetCacheableApiTestCacheMiss(
+        string $endpoint,
+        array $data,
+        array $parameters,
+        string $apiClientClass
+    ): void {
         /** @var ApiClient $apiClient */
-        $apiClient = $this->getContainer()->get(ApiClient::class);
+        $apiClient = $this->getContainer()->get($apiClientClass);
 
         $response = new Response(200, [], (string) $this->getEncoder()->encode($data, $this->getFormatType()));
         $response2 = new Response(200, [], (string) $this->getEncoder()->encode($data, $this->getFormatType()));
@@ -114,13 +128,18 @@ public function testGetCacheableApiTestCacheMiss(string $endpoint, array $data,
      * @param string $endpoint
      * @param array<mixed> $data
      * @param array<mixed> $parameters
+     * @param class-string $apiClientClass
      * @throws Exception
      * @dataProvider provideNonCacheableApis
      */
-    public function testNonCacheableApisAlwaysMiss(string $endpoint, array $data, array $parameters): void
-    {
+    public function testNonCacheableApisAlwaysMiss(
+        string $endpoint,
+        array $data,
+        array $parameters,
+        string $apiClientClass
+    ): void {
         /** @var ApiClient $apiClient */
-        $apiClient = $this->getContainer()->get(ApiClient::class);
+        $apiClient = $this->getContainer()->get($apiClientClass);
 
         $response = new Response(200, [], (string) $this->getEncoder()->encode($data, $this->getFormatType()));
         $response2 = new Response(200, [], (string) $this->getEncoder()->encode($data, $this->getFormatType()));
@@ -167,15 +186,15 @@ public function provideCacheableApiCalls(): iterable
         $articleData = new ArticleData;
         $tagData = new TagData;
 
-        yield ['getCoreSettings' ,(new CoreSettingsData)->getResponse(), []];
-        yield ['getCategories' ,$categoryData->getAllResponse(), [[]]];
-        yield ['getCategory' ,$categoryData->getResponse(), [1]];
-        yield ['getArticle' ,$articleData->getResponse(), [1, []]];
-        yield ['getTag' ,$tagData->getResponse(), [1]];
-        yield ['getArticles' ,$articleData->getAllResponse(), [[]]];
-        yield ['getSelfServiceSettings' ,$settingsData->getResponse(), []];
-        yield ['getComments' ,$commentData->getAllResponse(), [[]]];
-        yield ['getTypes' ,$typeData->getAllResponse(), [[]]];
+        yield ['getSettings' ,(new CoreSettingsData)->getResponse(), [], CoreApiClient::class];
+        yield ['getCategories' ,$categoryData->getAllResponse(), [[]], SelfServiceApiClient::class];
+        yield ['getCategory' ,$categoryData->getResponse(), [1], SelfServiceApiClient::class];
+        yield ['getArticle' ,$articleData->getResponse(), [1, []], SelfServiceApiClient::class];
+        yield ['getTag' ,$tagData->getResponse(), [1], SelfServiceApiClient::class];
+        yield ['getArticles' ,$articleData->getAllResponse(), [[]], SelfServiceApiClient::class];
+        yield ['getSettings' ,$settingsData->getResponse(), [], SelfServiceApiClient::class];
+        yield ['getComments' ,$commentData->getAllResponse(), [[]], SelfServiceApiClient::class];
+        yield ['getTypes' ,$typeData->getAllResponse(), [[]], SelfServiceApiClient::class];
     }
 
     /**
@@ -194,22 +213,22 @@ public function provideNonCacheableApis(): iterable
         $messageData = new MessageData;
         $userData = new UserData;
 
-        yield ['getDepartments', $departmentData->getAllResponse(), [[]]];
-        yield ['getDepartment', $departmentData->getResponse(), [1]];
-        yield ['getTicketSettings', $settingsData->getResponse(), []];
-        yield ['getChannelSettings', $channelSettingsData->getResponse(), ['web']];
-        yield ['getTicketCustomFields', $ticketCustomFieldData->getAllResponse(), [[]]];
-        yield ['getTicketPriorities', $priorityData->getAllResponse(), [[]]];
-        yield ['getTicketPriority', $statusData->getResponse(), [1]];
-        yield ['getTicketStatuses', $statusData->getAllResponse(), [[]]];
-        yield ['getTicketStatus', $statusData->getResponse(), [1]];
-        yield ['getTicketAttachments', $attachmentData->getAllResponse(), [[]]];
-        yield ['getTicketAttachment', $attachmentData->getResponse(), [1]];
-        yield ['getTickets', $ticketData->getAllResponse(), [[]]];
-        yield ['getTicket', $ticketData->getResponse(), [1]];
-        yield ['getTicketMessage', $messageData->getResponse(), [1]];
-        yield ['getTicketMessages', $messageData->getAllResponse(), [[]]];
-        yield ['getUsers', $userData->getAllResponse(), [[]]];
+        yield ['getDepartments', $departmentData->getAllResponse(), [[]], TicketApiClient::class];
+        yield ['getDepartment', $departmentData->getResponse(), [1], TicketApiClient::class];
+        yield ['getSettings', $settingsData->getResponse(), [], TicketApiClient::class];
+        yield ['getChannelSettings', $channelSettingsData->getResponse(), ['web'], TicketApiClient::class];
+        yield ['getCustomFields', $ticketCustomFieldData->getAllResponse(), [[]], TicketApiClient::class];
+        yield ['getPriorities', $priorityData->getAllResponse(), [[]], TicketApiClient::class];
+        yield ['getPriority', $statusData->getResponse(), [1], TicketApiClient::class];
+        yield ['getStatuses', $statusData->getAllResponse(), [[]], TicketApiClient::class];
+        yield ['getStatus', $statusData->getResponse(), [1], TicketApiClient::class];
+        yield ['getAttachments', $attachmentData->getAllResponse(), [[]], TicketApiClient::class];
+        yield ['getAttachment', $attachmentData->getResponse(), [1], TicketApiClient::class];
+        yield ['getTickets', $ticketData->getAllResponse(), [[]], TicketApiClient::class];
+        yield ['getTicket', $ticketData->getResponse(), [1], TicketApiClient::class];
+        yield ['getMessage', $messageData->getResponse(), [1], TicketApiClient::class];
+        yield ['getMessages', $messageData->getAllResponse(), [[]], TicketApiClient::class];
+        yield ['getUsers', $userData->getAllResponse(), [[]], UserApiClient::class];
     }
 
     /**

diff --git a/test/Unit/Api/Core/BrandApisTest.php b/test/Unit/Api/Core/BrandApisTest.php
@@ -12,7 +12,7 @@
  * Class BrandApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Core
  * @covers \SupportPal\ApiClient\Api\Core\BrandApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class BrandApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Core/SettingsApisTest.php b/test/Unit/Api/Core/SettingsApisTest.php
@@ -12,7 +12,7 @@
  * Class CoreApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api
  * @covers \SupportPal\ApiClient\Api\Core\SettingsApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class SettingsApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/SelfService/ArticleApisTest.php b/test/Unit/Api/SelfService/ArticleApisTest.php
@@ -12,7 +12,7 @@
  * Class ArticleApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\SelfService
  * @covers \SupportPal\ApiClient\Api\SelfService\ArticleApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class ArticleApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/SelfService/CategoryApisTest.php b/test/Unit/Api/SelfService/CategoryApisTest.php
@@ -12,7 +12,7 @@
  * Class CategoryApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\SelfService
  * @covers \SupportPal\ApiClient\Api\SelfService\CategoryApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class CategoryApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/SelfService/CommentApisTest.php b/test/Unit/Api/SelfService/CommentApisTest.php
@@ -13,7 +13,7 @@
  * Class CommentApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\SelfService
  * @covers \SupportPal\ApiClient\Api\SelfService\CommentApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class CommentApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/SelfService/SettingsApisTest.php b/test/Unit/Api/SelfService/SettingsApisTest.php
@@ -12,7 +12,7 @@
  * Class SettingsApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\SelfService
  * @covers \SupportPal\ApiClient\Api\SelfService\SettingsApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class SettingsApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/SelfService/TagApisTest.php b/test/Unit/Api/SelfService/TagApisTest.php
@@ -12,7 +12,7 @@
  * Class TagApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\SelfService
  * @covers \SupportPal\ApiClient\Api\SelfService\TagApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class TagApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/SelfService/TypeApiTest.php b/test/Unit/Api/SelfService/TypeApiTest.php
@@ -12,7 +12,7 @@
  * Class TypeApiTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\SelfService
  * @covers \SupportPal\ApiClient\Api\SelfService\TypeApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class TypeApiTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/AttachmentApisTest.php b/test/Unit/Api/Ticket/AttachmentApisTest.php
@@ -12,7 +12,7 @@
  * Class AttachmentApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\Ticket\AttachmentApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class AttachmentApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/ChannelApisTest.php b/test/Unit/Api/Ticket/ChannelApisTest.php
@@ -12,7 +12,7 @@
  * Class ChannelApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\Ticket\ChannelSettingsApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class ChannelApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/CustomFieldApisTest.php b/test/Unit/Api/Ticket/CustomFieldApisTest.php
@@ -12,7 +12,7 @@
  * Class CustomFieldApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\Ticket\CustomFieldApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class CustomFieldApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/DepartmentApisTest.php b/test/Unit/Api/Ticket/DepartmentApisTest.php
@@ -12,7 +12,7 @@
  * Class DepartmentApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\Ticket\DepartmentApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class DepartmentApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/MessageApisTest.php b/test/Unit/Api/Ticket/MessageApisTest.php
@@ -13,7 +13,7 @@
  * Class MessageApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\Ticket\MessageApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class MessageApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/PriorityApisTest.php b/test/Unit/Api/Ticket/PriorityApisTest.php
@@ -12,7 +12,7 @@
  * Class PriorityApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\Ticket\PriorityApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class PriorityApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/StatusApisTest.php b/test/Unit/Api/Ticket/StatusApisTest.php
@@ -12,7 +12,7 @@
  * Class StatusApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\Ticket\StatusApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class StatusApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/TicketApisTest.php b/test/Unit/Api/Ticket/TicketApisTest.php
@@ -16,7 +16,7 @@
  * Class ApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\TicketApi
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class TicketApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/Ticket/TicketSettingsApisTest.php b/test/Unit/Api/Ticket/TicketSettingsApisTest.php
@@ -12,7 +12,7 @@
  * Class TicketApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\Ticket
  * @covers \SupportPal\ApiClient\Api\Ticket\SettingsApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class TicketSettingsApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/User/UserApisTest.php b/test/Unit/Api/User/UserApisTest.php
@@ -16,7 +16,7 @@
  * Class UserApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api
  * @covers \SupportPal\ApiClient\Api\UserApi
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class UserApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/User/UserCustomFieldApisTest.php b/test/Unit/Api/User/UserCustomFieldApisTest.php
@@ -12,7 +12,7 @@
  * Class UserCustomFieldApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\User
  * @covers \SupportPal\ApiClient\Api\User\CustomFieldApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class UserCustomFieldApisTest extends ApiTest
 {

diff --git a/test/Unit/Api/User/UserGroupApisTest.php b/test/Unit/Api/User/UserGroupApisTest.php
@@ -12,7 +12,7 @@
  * Class UserGroupApisTest
  * @package SupportPal\ApiClient\Tests\Unit\Api\User
  * @covers \SupportPal\ApiClient\Api\User\UserGroupApis
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 class UserGroupApisTest extends ApiTest
 {

diff --git a/test/Unit/ApiTest.php b/test/Unit/ApiTest.php
@@ -24,7 +24,7 @@
 /**
  * Class ApiTest
  * @package SupportPal\ApiClient\Tests\Unit
- * @covers \SupportPal\ApiClient\Api
+ * @covers \SupportPal\ApiClient\Api\Api
  */
 abstract class ApiTest extends TestCase
 {