ldc-crm/tests/CRM/ApiV2/ApiTest.php

<?php

namespace Tests\CRM\ApiV2;

use App\Enums\ApiError;
use App\Enums\ApiStatus;
use App\Models\Service;
use Illuminate\Foundation\Testing\DatabaseTransactions;
use Illuminate\Support\Str;
use Tests\CreatesApplication;

class ApiTest extends ApiBase
{
    use CreatesApplication;
    use DatabaseTransactions;

    /**
     * Test ApiV2 only handle json calls.
     *
     * @return void
     */
    public function testOnlyJsonCallsAreHandled(): void
    {
        $response = $this->call('get', route('apiV2.ping'), [
            'timestamp' => \gmdate('Y-m-d H:i:s')
        ]);
        $response->assertStatus(400);
    }

    /**
     * Test timestamp middleware works as expected.
     *
     * @return void
     */
    public function testTimestampMiddleware(): void
    {
        $response = $this->json('get', route('apiV2.ping'), [
            'timestamp' => \gmdate('Y-m-d H:i:s')
        ]);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::OK);
    }

    /**
     * Timestamp middleware should fail if timestamp parameter is missing.
     *
     * @return void
     */
    public function testTimestampMiddlewareCheckFailMissing(): void
    {
        $response = $this->json('get', route('apiV2.ping'), []);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::KO);
        $json->assertFragment(['data' => [
            'code' => ApiError::wrongTimeStamp->value(),
            'message' => ApiError::wrongTimeStamp->label()
        ]]);
    }

    /**
     * Timestamp middleware should fail if timestamp parameter has wrong format.
     *
     * @return void
     */
    public function testTimestampMiddlewareCheckFailWrongFormat(): void
    {
        $response = $this->json('get', route('apiV2.ping'), ['timestamp' => \gmdate('Y/m/d')]);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::KO);
        $json->assertFragment(['data' => [
            'code' => ApiError::wrongTimeStamp->value(),
            'message' => ApiError::wrongTimeStamp->label()
        ]]);
    }

    /**
     * Timestamp middleware should fail if timestamp is older than "config('api.timestampTimeout', 10)".
     *
     * @return void
     */
    public function testTimestampMiddlewareCheckFailIfTooOld(): void
    {
        $response = $this->json('get', route('apiV2.ping'), [
            'timestamp' => \gmdate('Y-m-d H:i:s', \time() - config('api.timestampTimeout', 10))
        ]);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::KO);
        $json->assertFragment(['data' => [
            'code' => ApiError::wrongTimeStamp->value(),
            'message' => ApiError::wrongTimeStamp->label()
        ]]);
    }

    /**
     * Test api route throttle.
     *
     * ! This has to be the last test of this class.
     *
     * @return void
     */
    public function testApiThrottle(): void
    {
        for ($i = config('api.apiRequestRatePerMinute', 100); $i >= 0; $i--) {
            $this->json('get', route('apiV2.ping'), [
                'timestamp' => \gmdate('Y-m-d H:i:s')
            ]);
        }

        $response = $this->json('get', route('apiV2.ping'), [
            'timestamp' => \gmdate('Y-m-d H:i:s')
        ]);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::KO);
        $response->assertStatus(429);
    }

    /**
     * Test wrong http method call.
     *
     * @return void
     */
    public function testWrongMethodCall(): void
    {
        $response = $this->json('post', route('apiV2.ping'), [
            'timestamp' => \gmdate('Y-m-d H:i:s', \time())
        ]);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::KO);
        $this->assertEquals(ApiError::methodNotAllowed->value(), $json->json('data.code'));
    }

    /**
     * Test Auth fail when no token.
     *
     * @return void
     */
    public function testAuthFailNoToken(): void
    {
        $response = $this->json('get', route('apiV2.customers.show', [
            'serviceCustomer' => Str::uuid()
        ]), [
            'timestamp' => \gmdate('Y-m-d H:i:s', \time())
        ]);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::KO);
        $this->assertEquals(ApiError::apiAuthFailed->value(), $json->json('data.code'));
    }

    /**
     * Test Auth fail when unknown token.
     *
     * @return void
     */
    public function testAuthFailUnknownToken(): void
    {
        $response = $this->json('get', route('apiV2.customers.show', [
            'serviceCustomer' => Str::uuid()
        ]), [
            'bearer_token' => 'qsdqsdqsd',
            'timestamp' => \gmdate('Y-m-d H:i:s', \time())
        ]);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::KO);
        $this->assertEquals(ApiError::apiAuthFailed->value(), $json->json('data.code'));
    }

    /**
     * Test Auth fail when wrong signature.
     *
     * @return void
     */
    public function testAuthFailWrongSignature(): void
    {
        $service  = Service::query()->firstOrFail();
        $response = $this->json('get', route('apiV2.customers.show', [
            'serviceCustomer' => Str::uuid()
        ]), [
            'bearer_token' => $service->bearer_token,
            'timestamp'    => \gmdate('Y-m-d H:i:s', \time()),
            'signature'    => 'sdqdqsdqd'
        ]);
        $json     = $response->decodeResponseJson();
        $this->assertApiResponseStatusIs($json, ApiStatus::KO);
        $this->assertEquals(ApiError::apiAuthFailed->value(), $json->json('data.code'));
    }
}