ModuleSpec.php

<?php

namespace ErrorHeroModule\Spec;

use Pdo\Mysql;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Driver\PDO\MySql\Driver;
use Doctrine\ORM\EntityManager;
use ErrorHeroModule\Module;
use Kahlan\Plugin\Double;
use Laminas\Db\Adapter\AdapterInterface;
use Laminas\EventManager\EventManagerInterface;
use Laminas\ModuleManager\Listener\ConfigListener;
use Laminas\ModuleManager\ModuleEvent;
use Laminas\ModuleManager\ModuleManager;
use Laminas\ServiceManager\ServiceManager;
use PDO;

describe('Module', function (): void {

    given('module', fn() : Module => new Module());

    given('config', fn() : array => [
        'log' => [
            'ErrorHeroModuleLogger' => [
                'writers' => [

                    [
                        'name' => 'db',
                        'options' => [
                            'db'     => AdapterInterface::class,
                            'table'  => 'error_log',
                            'column' => [
                                'timestamp' => 'date',
                                'priority'  => 'type',
                                'message'   => 'event',
                                'extra'     => [
                                    'url'  => 'url',
                                    'file' => 'file',
                                    'line' => 'line',
                                    'error_type' => 'error_type',
                                    'trace'      => 'trace',
                                    'request_data' => 'request_data',
                                ],
                            ],
                        ],
                    ],

                ],
            ],
        ],
    ]);

    describe('->getConfig()', function (): void {

        it('return "config" array', function (): void {

            $moduleConfig = include __DIR__.'/../config/module.config.php';

            $actual = $this->module->getConfig();
            expect($actual)->toBe($moduleConfig);

        });

    });

    describe('->init()', function (): void {

        it('receive ModuleManager that get Eventmanager that attach ModuleEvent::EVENT_LOAD_MODULES_POST', function (): void {

            $moduleManager = Double::instance(['extends' => ModuleManager::class, 'methods' => '__construct']);
            $eventManager    = Double::instance(['implements' => EventManagerInterface::class]);

            allow($moduleManager)->toReceive('getEventManager')->andReturn($eventManager);
            expect($eventManager)->toReceive('attach')->with(ModuleEvent::EVENT_LOAD_MODULES_POST, [$this->module, 'doctrineTransform']);
            expect($eventManager)->toReceive('attach')->with(ModuleEvent::EVENT_MERGE_CONFIG, [$this->module, 'errorPreviewPageHandler'], 101);

            $this->module->init($moduleManager);

        });

    });

    describe('->doctrineTransform()', function (): void {

        it('does not has EntityManager service', function (): void {

            $moduleEvent = Double::instance(['extends' => ModuleEvent::class, 'methods' => '__construct']);
            $serviceManager  = Double::instance(['extends' => ServiceManager::class]);
            allow($moduleEvent)->toReceive('getParam')->with('ServiceManager')->andReturn($serviceManager);
            allow($serviceManager)->toReceive('has')->with(EntityManager::class)->andReturn(false);

            $this->module->doctrineTransform($moduleEvent);
            expect($moduleEvent)->not->toReceive('getConfigListener');

        });

        it('has EntityManager service but already has db config', function (): void {

            $moduleEvent = Double::instance(['extends' => ModuleEvent::class, 'methods' => '__construct']);
            $serviceManager  = Double::instance(['extends' => ServiceManager::class]);
            allow($moduleEvent)->toReceive('getParam')->with('ServiceManager')->andReturn($serviceManager);
            allow($serviceManager)->toReceive('has')->with(EntityManager::class)->andReturn(true);
            allow($serviceManager)->toReceive('get')->with('config')->andReturn([
                'db' => [
                    'username' => 'root',
                    'password' => '',
                    'driver'   => 'pdo_mysql',
                    'database' => 'mydb',
                    'host'     => 'localhost',
                ],
            ]);

            $this->module->doctrineTransform($moduleEvent);
            expect($serviceManager)->not->toReceive('get')->with(EntityManager::class);

        });

        it('has EntityManager service but already does not has db config not isset driverOptions', function (): void {

            $moduleEvent = Double::instance(['extends' => ModuleEvent::class, 'methods' => '__construct']);
            $serviceManager  = Double::instance(['extends' => ServiceManager::class]);
            allow($moduleEvent)->toReceive('getParam')->with('ServiceManager')->andReturn($serviceManager);
            allow($serviceManager)->toReceive('has')->with(EntityManager::class)->andReturn(true);
            allow($serviceManager)->toReceive('get')->with('config')->andReturn($this->config);

            $entityManager = Double::instance(['extends' => EntityManager::class, 'methods' => '__construct']);
            $connection    = Double::instance(['extends' => Connection::class, 'methods' => '__construct']);

            $driver = Double::instance(['extends' => Driver::class, 'methods' => '__construct']);
            allow($driver)->toReceive('getName')->andReturn('pdo_mysql');

            $pdoMysqlInitCommandAttr = defined(Mysql::class . '::ATTR_INIT_COMMAND')
                ? Mysql::ATTR_INIT_COMMAND
                : PDO::MYSQL_ATTR_INIT_COMMAND;

            allow($connection)->toReceive('getParams')->andReturn([
                'user'     => 'mysqluser',
                'password' => 'mysqlpassword',
                'dbname'   => 'mysqldbname',
                'host'     => 'mysqlhost',
                'port'     => '3306',
                'driverOptions' => [
                    $pdoMysqlInitCommandAttr => "SET NAMES 'UTF8'",
                ],
                'driverClass' => Driver::class,
            ]);
            allow($connection)->toReceive('getUsername')->andReturn('root');
            allow($connection)->toReceive('getPassword')->andReturn('');
            allow($connection)->toReceive('getDriver')->andReturn($driver);
            allow($connection)->toReceive('getDatabase')->andReturn('mydb');
            allow($connection)->toReceive('getHost')->andReturn('localhost');
            allow($connection)->toReceive('getPort')->andReturn('3306');

            allow($entityManager)->toReceive('getConnection')->andReturn($connection);
            allow($serviceManager)->toReceive('get')->with(EntityManager::class)->andReturn($entityManager);

            expect($moduleEvent)->toReceive('getParam')->with('ServiceManager');
            $this->module->doctrineTransform($moduleEvent);

        });

        it('has EntityManager service but already does not has db config with isset driverOptions', function (): void {

            $moduleEvent = Double::instance(['extends' => ModuleEvent::class, 'methods' => '__construct']);
            $serviceManager  = Double::instance(['extends' => ServiceManager::class]);
            allow($moduleEvent)->toReceive('getParam')->with('ServiceManager')->andReturn($serviceManager);
            allow($serviceManager)->toReceive('has')->with(EntityManager::class)->andReturn(true);
            allow($serviceManager)->toReceive('get')->with('config')->andReturn($this->config);

            $entityManager = Double::instance(['extends' => EntityManager::class, 'methods' => '__construct']);
            $connection    = Double::instance(['extends' => Connection::class, 'methods' => '__construct']);

            $driver = Double::instance(['extends' => Driver::class, 'methods' => '__construct']);
            allow($driver)->toReceive('getName')->andReturn('pdo_mysql');

            $pdoMysqlInitCommandAttr = defined(Mysql::class . '::ATTR_INIT_COMMAND')
                ? Mysql::ATTR_INIT_COMMAND
                : PDO::MYSQL_ATTR_INIT_COMMAND;

            allow($connection)->toReceive('getParams')->andReturn([
                'user'     => 'mysqluser',
                'password' => 'mysqlpassword',
                'dbname'   => 'mysqldbname',
                'host'     => 'mysqlhost',
                'port'     => '3306',
                'driverOptions' => [
                    $pdoMysqlInitCommandAttr => "SET NAMES 'UTF8'",
                ],
                'driverClass' => Driver::class,
            ]);
            allow($connection)->toReceive('getUsername')->andReturn('root');
            allow($connection)->toReceive('getPassword')->andReturn('');
            allow($connection)->toReceive('getDriver')->andReturn($driver);
            allow($connection)->toReceive('getDatabase')->andReturn('mydb');
            allow($connection)->toReceive('getHost')->andReturn('localhost');
            allow($connection)->toReceive('getPort')->andReturn('3306');

            allow($entityManager)->toReceive('getConnection')->andReturn($connection);
            allow($serviceManager)->toReceive('get')->with(EntityManager::class)->andReturn($entityManager);

            expect($moduleEvent)->toReceive('getParam')->with('ServiceManager');
            $this->module->doctrineTransform($moduleEvent);

        });

    });

    describe('->errorPreviewPageHandler()', function (): void {

        it('does not has enable-error-preview-page', function (): void {

            $moduleEvent = Double::instance(['extends' => ModuleEvent::class, 'methods' => '__construct']);

            $configListener = Double::instance(['extends' => ConfigListener::class, 'methods' => '__construct']);
            allow($moduleEvent)->toReceive('getConfigListener')->andReturn($configListener);
            allow($configListener)->toReceive('getMergedConfig')->andReturn([
                'error-hero-module' => [
                    'enable' => true,
                ],
            ]);

            $this->module->errorPreviewPageHandler($moduleEvent);
            expect($configListener)->not->toReceive('setMergedConfig');

        });

        it('has enable-error-preview-page and enabled', function (): void {

            $moduleEvent = Double::instance(['extends' => ModuleEvent::class, 'methods' => '__construct']);
            $serviceManager  = Double::instance(['extends' => ServiceManager::class]);
            allow($moduleEvent)->toReceive('getParam')->with('ServiceManager')->andReturn($serviceManager);

            $configListener = Double::instance(['extends' => ConfigListener::class, 'methods' => '__construct']);
            allow($moduleEvent)->toReceive('getConfigListener')->andReturn($configListener);
            allow($configListener)->toReceive('getMergedConfig')->andReturn([
                'error-hero-module' => [
                    'enable' => true,
                    'enable-error-preview-page' => true,
                ],
            ]);

            $this->module->errorPreviewPageHandler($moduleEvent);
            expect($configListener)->not->toReceive('setMergedConfig');

        });

        it('has enable-error-preview-page and disabled', function (): void {

            $moduleEvent = Double::instance(['extends' => ModuleEvent::class, 'methods' => '__construct']);
            $serviceManager  = Double::instance(['extends' => ServiceManager::class]);
            allow($moduleEvent)->toReceive('getParam')->with('ServiceManager')->andReturn($serviceManager);

            $configListener = Double::instance(['extends' => ConfigListener::class, 'methods' => '__construct']);
            allow($moduleEvent)->toReceive('getConfigListener')->andReturn($configListener);
            allow($configListener)->toReceive('getMergedConfig')->andReturn([
                'error-hero-module' => [
                    'enable' => true,
                    'enable-error-preview-page' => false,
                ],
            ]);

            $this->module->errorPreviewPageHandler($moduleEvent);
            expect($configListener)->toReceive('setMergedConfig');

        });

    });

});