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 = 'stringToEncode';

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

    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_decodee_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()],
        ];
    }
}