2FAuth/tests/Feature/Services/QrCodeServiceTest.php

<?php

namespace Tests\Feature\Services;

use App\Facades\QrCode;
use App\Providers\TwoFAuthServiceProvider;
use App\Services\QrCodeService;
use Exception;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Tests\Classes\LocalFile;
use Tests\FeatureTestCase;
use Zxing\ChecksumException;
use Zxing\FormatException;
use Zxing\NotFoundException;
use Zxing\QrReader;

/**
 * QrCodeServiceTest test class
 */
#[CoversClass(QrCodeService::class)]
#[CoversClass(QrCode::class)]
#[CoversClass(TwoFAuthServiceProvider::class)]
class QrCodeServiceTest extends FeatureTestCase
{
    private const STRING_TO_ENCODE = 'x';

    private const STRING_ENCODED = 'data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGNsYXNzPSJxci1zdmcgcXJjb2RlIiB2aWV3Qm94PSIwIDAgMjUgMjUiIHByZXNlcnZlQXNwZWN0UmF0aW89InhNaWRZTWlkIj4KPHBhdGggY2xhc3M9InFyLWRhdGEgbGlnaHQgcXJjb2RlIiBmaWxsPSIjZmZmIiBkPSJNMTEgMiBoMSB2MSBoLTFaIE0xMyAyIGgxIHYxIGgtMVogTTExIDMgaDEgdjEgaC0xWiBNMTIgMyBoMSB2MSBoLTFaIE0xMyAzIGgxIHYxIGgtMVogTTExIDQgaDEgdjEgaC0xWiBNMTMgNCBoMSB2MSBoLTFaIE0xNCA0IGgxIHYxIGgtMVogTTExIDUgaDEgdjEgaC0xWiBNMTIgNSBoMSB2MSBoLTFaIE0xMyA1IGgxIHYxIGgtMVogTTEyIDYgaDEgdjEgaC0xWiBNMTQgNyBoMSB2MSBoLTFaIE0xMSA5IGgxIHYxIGgtMVogTTEzIDkgaDEgdjEgaC0xWiBNMTQgOSBoMSB2MSBoLTFaIE0xMSAxMCBoMSB2MSBoLTFaIE0xMyAxMCBoMSB2MSBoLTFaIE0yIDExIGgxIHYxIGgtMVogTTYgMTEgaDEgdjEgaC0xWiBNMTEgMTEgaDEgdjEgaC0xWiBNMTIgMTEgaDEgdjEgaC0xWiBNMTQgMTEgaDEgdjEgaC0xWiBNMTYgMTEgaDEgdjEgaC0xWiBNMTggMTEgaDEgdjEgaC0xWiBNMjAgMTEgaDEgdjEgaC0xWiBNMjIgMTEgaDEgdjEgaC0xWiBNMiAxMiBoMSB2MSBoLTFaIE0zIDEyIGgxIHYxIGgtMVogTTQgMTIgaDEgdjEgaC0xWiBNNiAxMiBoMSB2MSBoLTFaIE05IDEyIGgxIHYxIGgtMVogTTExIDEyIGgxIHYxIGgtMVogTTE0IDEyIGgxIHYxIGgtMVogTTE4IDEyIGgxIHYxIGgtMVogTTE5IDEyIGgxIHYxIGgtMVogTTMgMTMgaDEgdjEgaC0xWiBNNCAxMyBoMSB2MSBoLTFaIE05IDEzIGgxIHYxIGgtMVogTTExIDEzIGgxIHYxIGgtMVogTTEyIDEzIGgxIHYxIGgtMVogTTE2IDEzIGgxIHYxIGgtMVogTTIwIDEzIGgxIHYxIGgtMVogTTIyIDEzIGgxIHYxIGgtMVogTTMgMTQgaDEgdjEgaC0xWiBNMTAgMTQgaDEgdjEgaC0xWiBNMTEgMTQgaDEgdjEgaC0xWiBNMTIgMTQgaDEgdjEgaC0xWiBNMTQgMTQgaDEgdjEgaC0xWiBNMTggMTQgaDEgdjEgaC0xWiBNMjEgMTQgaDEgdjEgaC0xWiBNMjIgMTQgaDEgdjEgaC0xWiBNMTMgMTUgaDEgdjEgaC0xWiBNMTQgMTUgaDEgdjEgaC0xWiBNMTUgMTUgaDEgdjEgaC0xWiBNMTcgMTUgaDEgdjEgaC0xWiBNMTggMTUgaDEgdjEgaC0xWiBNMTkgMTUgaDEgdjEgaC0xWiBNMjAgMTUgaDEgdjEgaC0xWiBNMjEgMTUgaDEgdjEgaC0xWiBNMTEgMTYgaDEgdjEgaC0xWiBNMTMgMTYgaDEgdjEgaC0xWiBNMTUgMTYgaDEgdjEgaC0xWiBNMTYgMTYgaDEgdjEgaC0xWiBNMTcgMTYgaDEgdjEgaC0xWiBNMjAgMTYgaDEgdjEgaC0xWiBNMTIgMTcgaDEgdjEgaC0xWiBNMTMgMTcgaDEgdjEgaC0xWiBNMTQgMTcgaDEgdjEgaC0xWiBNMTUgMTcgaDEgdjEgaC0xWiBNMTcgMTcgaDEgdjEgaC0xWiBNMTggMTcgaDEgdjEgaC0xWiBNMjEgMTcgaDEgdjEgaC0xWiBNMjIgMTcgaDEgdjEgaC0xWiBNMTEgMTggaDEgdjEgaC0xWiBNMTIgMTggaDEgdjEgaC0xWiBNMTMgMTggaDEgdjEgaC0xWiBNMTUgMTggaDEgdjEgaC0xWiBNMTcgMTggaDEgdjEgaC0xWiBNMTkgMTggaDEgdjEgaC0xWiBNMjEgMTggaDEgdjEgaC0xWiBNMTEgMTkgaDEgdjEgaC0xWiBNMTQgMTkgaDEgdjEgaC0xWiBNMTYgMTkgaDEgdjEgaC0xWiBNMTggMTkgaDEgdjEgaC0xWiBNMjAgMTkgaDEgdjEgaC0xWiBNMjIgMTkgaDEgdjEgaC0xWiBNMTQgMjAgaDEgdjEgaC0xWiBNMTggMjAgaDEgdjEgaC0xWiBNMTkgMjAgaDEgdjEgaC0xWiBNMjEgMjAgaDEgdjEgaC0xWiBNMTEgMjEgaDEgdjEgaC0xWiBNMTIgMjEgaDEgdjEgaC0xWiBNMTYgMjEgaDEgdjEgaC0xWiBNMjAgMjEgaDEgdjEgaC0xWiBNMjIgMjEgaDEgdjEgaC0xWiBNMTIgMjIgaDEgdjEgaC0xWiBNMTQgMjIgaDEgdjEgaC0xWiBNMTggMjIgaDEgdjEgaC0xWiBNMTkgMjIgaDEgdjEgaC0xWiIvPgo8cGF0aCBjbGFzcz0icXItZmluZGVyIGxpZ2h0IHFyY29kZSIgZmlsbD0iI2ZmZiIgZD0iTTMgMyBoMSB2MSBoLTFaIE00IDMgaDEgdjEgaC0xWiBNNSAzIGgxIHYxIGgtMVogTTYgMyBoMSB2MSBoLTFaIE03IDMgaDEgdjEgaC0xWiBNMTcgMyBoMSB2MSBoLTFaIE0xOCAzIGgxIHYxIGgtMVogTTE5IDMgaDEgdjEgaC0xWiBNMjAgMyBoMSB2MSBoLTFaIE0yMSAzIGgxIHYxIGgtMVogTTMgNCBoMSB2MSBoLTFaIE03IDQgaDEgdjEgaC0xWiBNMTcgNCBoMSB2MSBoLTFaIE0yMSA0IGgxIHYxIGgtMVogTTMgNSBoMSB2MSBoLTFaIE03IDUgaDEgdjEgaC0xWiBNMTcgNSBoMSB2MSBoLTFaIE0yMSA1IGgxIHYxIGgtMVogTTMgNiBoMSB2MSBoLTFaIE03IDYgaDEgdjEgaC0xWiBNMTcgNiBoMSB2MSBoLTFaIE0yMSA2IGgxIHYxIGgtMVogTTMgNyBoMSB2MSBoLTFaIE00IDcgaDEgdjEgaC0xWiBNNSA3IGgxIHYxIGgtMVogTTYgNyBoMSB2MSBoLTFaIE03IDcgaDEgdjEgaC0xWiBNMTcgNyBoMSB2MSBoLTFaIE0xOCA3IGgxIHYxIGgtMVogTTE5IDcgaDEgdjEgaC0xWiBNMjAgNyBoMSB2MSBoLTFaIE0yMSA3IGgxIHYxIGgtMVogTTMgMTcgaDEgdjEgaC0xWiBNNCAxNyBoMSB2MSBoLTFaIE01IDE3IGgxIHYxIGgtMVogTTYgMTcgaDEgdjEgaC0xWiBNNyAxNyBoMSB2MSBoLTFaIE0zIDE4IGgxIHYxIGgtMVogTTcgMTggaDEgdjEgaC0xWiBNMyAxOSBoMSB2MSBoLTFaIE03IDE5IGgxIHYxIGgtMVogTTMgMjAgaDEgdjEgaC0xWiBNNyAyMCBoMSB2MSBoLTFaIE0zIDIxIGgxIHYxIGgtMVogTTQgMjEgaDEgdjEgaC0xWiBNNSAyMSBoMSB2MSBoLTFaIE02IDIxIGgxIHYxIGgtMVogTTcgMjEgaDEgdjEgaC0xWiIvPgo8cGF0aCBjbGFzcz0icXItc2VwYXJhdG9yIGxpZ2h0IHFyY29kZSIgZmlsbD0iI2ZmZiIgZD0iTTkgMiBoMSB2MSBoLTFaIE0xNSAyIGgxIHYxIGgtMVogTTkgMyBoMSB2MSBoLTFaIE0xNSAzIGgxIHYxIGgtMVogTTkgNCBoMSB2MSBoLTFaIE0xNSA0IGgxIHYxIGgtMVogTTkgNSBoMSB2MSBoLTFaIE0xNSA1IGgxIHYxIGgtMVogTTkgN

    private const DECODED_IMAGE = 'otpauth://totp/test@test.com?secret=A4GRFHVIRBGY7UIW';

    public function setUp() : void
    {
        parent::setUp();
    }

    #[Test]
    public function test_encode_returns_correct_value()
    {
        $this->assertEquals(self::STRING_ENCODED, QrCode::encode(self::STRING_TO_ENCODE));
    }

    #[Test]
    public function test_decode_valid_image_returns_correct_value()
    {
        $file = LocalFile::fake()->validQrcode();

        $this->assertEquals(self::DECODED_IMAGE, QrCode::decode($file));
    }

    #[Test]
    public function test_decode_invalid_image_throws_an_exception()
    {
        $this->expectException(\App\Exceptions\InvalidQrCodeException::class);

        QrCode::decode(LocalFile::fake()->invalidQrcode());
    }

    #[Test]
    #[DataProvider('QrReaderExceptionProvider')]
    public function test_decode_throws_an_exception($exception)
    {
        $this->expectException(\App\Exceptions\InvalidQrCodeException::class);

        // QrReader is a final class, so we need to mock it here with a new object instance
        // to then bind it to the container
        $fileContent = LocalFile::fake()->validQrcode()->get();
        $qrReader    = \Mockery::mock(new QrReader($fileContent, QrReader::SOURCE_TYPE_BLOB))->makePartial();
        $qrReader->shouldReceive('text')->andReturn('');
        $qrReader->shouldReceive('getError')->andReturn($exception);

        $this->app->bind(QrReader::class, function () use ($qrReader) {
            return $qrReader;
        });

        QrCode::decode(LocalFile::fake()->validQrcode());
    }

    public static function QrReaderExceptionProvider()
    {
        return [
            'NotFoundException' => [new NotFoundException],
            'FormatException'   => [new FormatException],
            'ChecksumException' => [new ChecksumException],
            'default'           => [new Exception],
        ];
    }
}