Update sms mock to use request catcher

MSP-Kolkata · Sep 19, 2022 · 6e8a4cc · 6e8a4cc
1 parent 19eb6c7
commit 6e8a4cc
Show file tree

Hide file tree

Showing 7 changed files with 52 additions and 20 deletions.
diff --git a/.env b/.env
@@ -56,7 +56,7 @@ _APP_SMTP_PORT=1025
 _APP_SMTP_SECURE=
 _APP_SMTP_USERNAME=
 _APP_SMTP_PASSWORD=
-_APP_SMS_PROVIDER=sms://mock
+_APP_SMS_PROVIDER=sms://username:password@mock
 _APP_SMS_FROM=+123456789
 _APP_STORAGE_LIMIT=30000000
 _APP_STORAGE_PREVIEW_LIMIT=20000000

diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php
@@ -2,7 +2,6 @@
 
 use Ahc\Jwt\JWT;
 use Appwrite\Auth\Auth;
-use Appwrite\SMS\Adapter\Mock;
 use Appwrite\Auth\Validator\Password;
 use Appwrite\Auth\Validator\Phone;
 use Appwrite\Detector\Detector;
@@ -930,7 +929,7 @@
             ])));
         }
 
-        $secret = (App::getEnv('_APP_SMS_PROVIDER') === 'sms://mock') ? Mock::$digits : Auth::codeGenerator();
+        $secret = Auth::codeGenerator();
         $expire = DateTime::addSeconds(new \DateTime(), Auth::TOKEN_EXPIRATION_PHONE);
 
         $token = new Document([
@@ -2258,7 +2257,7 @@
         $isPrivilegedUser = Auth::isPrivilegedUser($roles);
         $isAppUser = Auth::isAppUser($roles);
         $verificationSecret = Auth::tokenGenerator();
-        $secret = (App::getEnv('_APP_SMS_PROVIDER') === 'sms://mock') ? Mock::$digits : Auth::codeGenerator();
+        $secret = Auth::codeGenerator();
         $expire = DateTime::addSeconds(new \DateTime(), Auth::TOKEN_EXPIRATION_CONFIRM);
 
         $verification = new Document([

diff --git a/app/init.php b/app/init.php
@@ -1028,7 +1028,7 @@ function getDevice($root): Device
     $secret = $dsn->getPassword();
 
     return match ($dsn->getHost()) {
-        'mock' => new Mock('', ''), // used for tests
+        'mock' => new Mock($user, $secret), // used for tests
         'twilio' => new Twilio($user, $secret),
         'text-magic' => new TextMagic($user, $secret),
         'telesign' => new Telesign($user, $secret),

diff --git a/app/workers/messaging.php b/app/workers/messaging.php
@@ -1,6 +1,6 @@
 <?php
 
-use Appwrite\Auth\SMS;
+use Appwrite\SMS\Adapter;
 use Appwrite\SMS\Adapter\Mock;
 use Appwrite\SMS\Adapter\Telesign;
 use Appwrite\SMS\Adapter\TextMagic;
@@ -19,7 +19,7 @@
 
 class MessagingV1 extends Worker
 {
-    protected ?SMS $sms = null;
+    protected ?Adapter $sms = null;
     protected ?string $from = null;
 
     public function getName(): string
@@ -34,7 +34,7 @@ public function init(): void
         $secret = $dsn->getPassword();
 
         $this->sms = match ($dsn->getHost()) {
-            'mock' => new Mock('', ''), // used for tests
+            'mock' => new Mock($user, $secret), // used for tests
             'twilio' => new Twilio($user, $secret),
             'text-magic' => new TextMagic($user, $secret),
             'telesign' => new Telesign($user, $secret),

diff --git a/composer.lock b/composer.lock
diff --git a/src/Appwrite/SMS/Adapter/Mock.php b/src/Appwrite/SMS/Adapter/Mock.php
@@ -4,12 +4,13 @@
 
 use Appwrite\SMS\Adapter;
 
+// Mock adapter used to E2E test worker
 class Mock extends Adapter
 {
     /**
      * @var string
      */
-    public static string $digits = '123456';
+    private string $endpoint = 'http://request-catcher:5000/mock-sms';
 
     /**
      * @param string $from
@@ -19,6 +20,19 @@ class Mock extends Adapter
      */
     public function send(string $from, string $to, string $message): void
     {
-        return;
+        $this->request(
+            method: 'POST',
+            url: $this->endpoint,
+            payload: \json_encode([
+                'message' => $message,
+                'from' => $from,
+                'to' => $to
+            ]),
+            headers: [
+                "content-type: application/json",
+                "x-username: {$this->user}",
+                "x-key: {$this->secret}",
+            ]
+        );
     }
 }
diff --git a/tests/e2e/Services/Account/AccountCustomClientTest.php b/tests/e2e/Services/Account/AccountCustomClientTest.php
@@ -716,7 +716,19 @@ public function testCreatePhone(): array
 
         $this->assertEquals(400, $response['headers']['status-code']);
 
-        $data['token'] = Mock::$digits;
+        \sleep(2);
+
+        $smsRequest = $this->getLastRequest();
+
+        $this->assertEquals('http://request-catcher:5000/mock-sms', $smsRequest['url']);
+        $this->assertEquals('Appwrite Phone Authentication', $smsRequest['headers']['User-Agent']);
+        $this->assertEquals('username', $smsRequest['headers']['X-Username']);
+        $this->assertEquals('password', $smsRequest['headers']['X-Key']);
+        $this->assertEquals('POST', $smsRequest['method']);
+        $this->assertEquals('+123456789', $smsRequest['data']['from']);
+        $this->assertEquals($number, $smsRequest['data']['to']);
+
+        $data['token'] = $smsRequest['data']['message'];
         $data['id'] = $userId;
         $data['number'] = $number;
 
@@ -931,7 +943,13 @@ public function testPhoneVerification(array $data): array
         $this->assertEmpty($response['body']['secret']);
         $this->assertEquals(true, DateTime::isValid($response['body']['expire']));
 
-        return $data;
+        \sleep(2);
+
+        $smsRequest = $this->getLastRequest();
+
+        return \array_merge($data, [
+            'token' => $smsRequest['data']['message']
+        ]);
     }
 
     /**
@@ -941,6 +959,7 @@ public function testUpdatePhoneVerification($data): array
     {
         $id = $data['id'] ?? '';
         $session = $data['session'] ?? '';
+        $secret = $data['token'] ?? '';
 
         /**
          * Test for SUCCESS
@@ -952,7 +971,7 @@ public function testUpdatePhoneVerification($data): array
             'cookie' => 'a_session_' . $this->getProject()['$id'] . '=' . $session,
         ]), [
             'userId' => $id,
-            'secret' => Mock::$digits,
+            'secret' => $secret,
         ]);
 
         $this->assertEquals(200, $response['headers']['status-code']);
@@ -967,7 +986,7 @@ public function testUpdatePhoneVerification($data): array
             'cookie' => 'a_session_' . $this->getProject()['$id'] . '=' . $session,
         ]), [
             'userId' => ID::custom('ewewe'),
-            'secret' => Mock::$digits,
+            'secret' => $secret,
         ]);
 
         $this->assertEquals(404, $response['headers']['status-code']);