Use pusher cli in CI to have a subscriber active (#349)

Some of our acceptance tests require a channel to have subscriber. We're now using the pusher cli tool to automate tha t in the CI.

Co-authored-by: Jon Elverkilde <[email protected]>

Author: sonologico

.github/workflows/test.yml

@@ -37,10 +37,24 @@ jobs:
       - name: Run unit tests
         run: composer exec phpunit tests/unit
 
+      - uses: actions/checkout@v2
+        with:
+          repository: pusher/public_actions
+          path: .github/actions
+
+      - uses: ./.github/actions/install-pusher-cli
+
       - name: Run acceptance tests
         env:
           PUSHERAPP_APPID: ${{ secrets.CI_APP_ID }}
           PUSHERAPP_AUTHKEY: ${{ secrets.CI_APP_KEY }}
           PUSHERAPP_SECRET: ${{ secrets.CI_APP_SECRET }}
           PUSHERAPP_CLUSTER: ${{ secrets.CI_APP_CLUSTER }}
-        run: composer exec phpunit tests/acceptance
+          PUSHER_API_KEY: ${{ secrets.CI_API_KEY }}
+        run: |
+          echo "$PUSHER_API_KEY" | pusher login
+          export TEST_CHANNEL="test-${RANDOM}-${RANDOM}"
+          echo $TEST_CHANNEL
+          pusher channels apps subscribe --app-id "$PUSHERAPP_APPID" --channel $TEST_CHANNEL &
+          sleep 5
+          composer exec phpunit tests/acceptance

composer.json

@@ -12,7 +12,7 @@
         "paragonie/sodium_compat": "^1.6"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.5|^9.3",
+        "phpunit/phpunit": "^9.3",
         "overtrue/phplint": "^2.3"
     },
     "autoload": {

tests/acceptance/ChannelQueryTest.php

@@ -53,8 +53,9 @@ public function testFilterByPrefixNoChannels(): void
 
     public function testFilterByPrefixOneChannel(): void
     {
+        $channel_prefix = substr(TEST_CHANNEL, 0, 10);
         $options = [
-            'filter_by_prefix' => 'my-',
+            'filter_by_prefix' => $channel_prefix,
         ];
         $result = $this->pusher->get_channels($options);
 
@@ -88,24 +89,25 @@ public function testChannelListUsingGenericGet(): void
 
         $channels = $result['channels'];
 
-        self::assertCount(1, $channels,
+        self::assertGreaterThanOrEqual(1, $channels,
             'channels have a single my-channel present. For this test to pass you must have the "Getting Started" page open on the dashboard for the app you are testing against');
 
-        $my_channel = $channels['my-channel'];
+        $my_channel = $channels[TEST_CHANNEL];
 
         self::assertCount(0, $my_channel);
     }
 
     public function testChannelListUsingGenericGetAndPrefixParam(): void
     {
-        $result = $this->pusher->get('/channels', ['filter_by_prefix' => 'my-'], true);
+        $channel_prefix = substr(TEST_CHANNEL, 0, 10);
+        $result = $this->pusher->get('/channels', ['filter_by_prefix' => $channel_prefix], true);
 
         $channels = $result['channels'];
 
         self::assertCount(1, $channels,
             'channels have a single my-channel present. For this test to pass you must have the "Getting Started" page open on the dashboard for the app you are testing against');
 
-        $my_channel = $channels['my-channel'];
+        $my_channel = $channels[TEST_CHANNEL];
 
         self::assertCount(0, $my_channel);
     }

tests/acceptance/TriggerAsyncTest.php

@@ -56,11 +56,11 @@ public function testPushWithInfo(): void
         $expectedPresenceMyChannel->subscription_count = 0;
         $expectedResult = new stdClass();
         $expectedResult->channels = [
-            "my-channel" => $expectedMyChannel,
+            TEST_CHANNEL => $expectedMyChannel,
             "presence-my-channel" => $expectedPresenceMyChannel,
         ];
 
-        $result = $this->pusher->triggerAsync(['my-channel', 'presence-my-channel'], 'my_event', ['test' => 1], ['info' => 'user_count,subscription_count'])->wait();
+        $result = $this->pusher->triggerAsync([TEST_CHANNEL, 'presence-my-channel'], 'my_event', ['test' => 1], ['info' => 'user_count,subscription_count'])->wait();
         self::assertEquals($expectedResult, $result);
     }
 

tests/acceptance/TriggerBatchAsyncTest.php

@@ -103,7 +103,7 @@ public function testTriggerBatchWithInfo(): void
         ];
 
         $batch = [];
-        $batch[] = ['channel' => 'my-channel', 'name' => 'my_event', 'data' => 'test-string', 'info' => 'subscription_count'];
+        $batch[] = ['channel' => TEST_CHANNEL, 'name' => 'my_event', 'data' => 'test-string', 'info' => 'subscription_count'];
         $batch[] = ['channel' => 'my-channel-2', 'name' => 'my_event', 'data' => 'test-string'];
         $batch[] = ['channel' => 'presence-my-channel', 'name' => 'my_event', 'data' => 'test-string', 'info' => 'user_count,subscription_count'];
         $result = $pc->triggerBatchAsync($batch)->wait();

tests/acceptance/TriggerBatchTest.php

@@ -104,7 +104,7 @@ public function testTriggerBatchWithInfo(): void
         ];
 
         $batch = [];
-        $batch[] = ['channel' => 'my-channel', 'name' => 'my_event', 'data' => 'test-string', 'info' => 'subscription_count'];
+        $batch[] = ['channel' => TEST_CHANNEL, 'name' => 'my_event', 'data' => 'test-string', 'info' => 'subscription_count'];
         $batch[] = ['channel' => 'my-channel-2', 'name' => 'my_event', 'data' => 'test-string'];
         $batch[] = ['channel' => 'presence-my-channel', 'name' => 'my_event', 'data' => 'test-string', 'info' => 'user_count,subscription_count'];
         $result = $pc->triggerBatch($batch);

tests/acceptance/TriggerTest.php

@@ -58,11 +58,11 @@ public function testPushWithInfo(): void
         $expectedPresenceMyChannel->subscription_count = 0;
         $expectedResult = new stdClass();
         $expectedResult->channels = [
-            "my-channel" => $expectedMyChannel,
+            TEST_CHANNEL => $expectedMyChannel,
             "presence-my-channel" => $expectedPresenceMyChannel,
         ];
 
-        $result = $this->pusher->trigger(['my-channel', 'presence-my-channel'], 'my_event', ['test' => 1], ['info' => 'user_count,subscription_count']);
+        $result = $this->pusher->trigger([TEST_CHANNEL, 'presence-my-channel'], 'my_event', ['test' => 1], ['info' => 'user_count,subscription_count']);
         self::assertEquals($expectedResult, $result);
     }
 

tests/bootstrap.php

@@ -10,4 +10,6 @@
     define('PUSHERAPP_APPID', getenv('PUSHERAPP_APPID'));
 
     define('PUSHERAPP_CLUSTER', getenv('PUSHERAPP_CLUSTER'));
+
+    define('TEST_CHANNEL', getenv('TEST_CHANNEL'));
 }

tests/config.example.php

@@ -4,3 +4,5 @@
 const PUSHERAPP_AUTHKEY = '';
 const PUSHERAPP_SECRET = '';
 const PUSHERAPP_CLUSTER = 'eu';
+const TEST_CHANNEL = 'my-channel';
+const CHANNEL_PREFIX = 'my-';