DebugTest.php

Go to the documentation of this file.

<?php
namespace Magento\Developer\Model\Logger\Handler;

use Magento\Config\Console\Command\ConfigSetCommand;
use Magento\Framework\App\Config;
use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Filesystem;
use Magento\Framework\Filesystem\Directory\WriteInterface;
use Magento\Framework\Logger\Monolog;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\Deploy\Model\Mode;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class DebugTest extends \PHPUnit\Framework\TestCase
{
    private $logger;

    private $mode;

    private $inputMock;

    private $outputMock;

    private $configSetCommand;

    private $etcDirectory;

    private $appConfig;

    public function setUp()
    {
        $filesystem = Bootstrap::getObjectManager()->create(Filesystem::class);
        $this->etcDirectory = $filesystem->getDirectoryWrite(DirectoryList::CONFIG);
        $this->etcDirectory->copyFile('env.php', 'env.base.php');

        $this->inputMock = $this->getMockBuilder(InputInterface::class)
            ->getMockForAbstractClass();
        $this->outputMock = $this->getMockBuilder(OutputInterface::class)
            ->getMockForAbstractClass();
        $this->logger = Bootstrap::getObjectManager()->get(Monolog::class);
        $this->mode = Bootstrap::getObjectManager()->create(
            Mode::class,
            [
                'input' => $this->inputMock,
                'output' => $this->outputMock
            ]
        );
        $this->configSetCommand = Bootstrap::getObjectManager()->create(ConfigSetCommand::class);
        $this->appConfig = Bootstrap::getObjectManager()->create(Config::class);

        // Preconditions
        $this->mode->enableDeveloperMode();
        $this->enableDebugging();
        if (file_exists($this->getDebuggerLogPath())) {
            unlink($this->getDebuggerLogPath());
        }
    }

    public function tearDown()
    {
        $this->etcDirectory->delete('env.php');
        $this->etcDirectory->renameFile('env.base.php', 'env.php');
    }

    private function enableDebugging()
    {
        $this->inputMock = $this->getMockBuilder(InputInterface::class)
            ->getMockForAbstractClass();
        $this->outputMock = $this->getMockBuilder(OutputInterface::class)
            ->getMockForAbstractClass();
        $this->inputMock->expects($this->exactly(4))
            ->method('getOption')
            ->withConsecutive(
                [ConfigSetCommand::OPTION_LOCK_ENV],
                [ConfigSetCommand::OPTION_LOCK_CONFIG],
                [ConfigSetCommand::OPTION_SCOPE],
                [ConfigSetCommand::OPTION_SCOPE_CODE]
            )
            ->willReturnOnConsecutiveCalls(
                true,
                false,
                ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
                null
            );
        $this->inputMock->expects($this->exactly(2))
            ->method('getArgument')
            ->withConsecutive([ConfigSetCommand::ARG_PATH], [ConfigSetCommand::ARG_VALUE])
            ->willReturnOnConsecutiveCalls('dev/debug/debug_logging', 1);
        $this->outputMock->expects($this->once())
            ->method('writeln')
            ->with('<info>Value was saved in app/etc/env.php and locked.</info>');
        $this->assertFalse((bool)$this->configSetCommand->run($this->inputMock, $this->outputMock));
    }

    public function testDebugInProductionMode()
    {
        $message = 'test message';

        $this->mode->enableProductionModeMinimal();
        $this->logger->debug($message);
        $this->assertFileNotExists($this->getDebuggerLogPath());
        $this->assertFalse((bool)$this->appConfig->getValue('dev/debug/debug_logging'));

        $this->enableDebugging();
        $this->logger->debug($message);

        $this->assertFileExists($this->getDebuggerLogPath());
        $this->assertContains($message, file_get_contents($this->getDebuggerLogPath()));
    }

    private function getDebuggerLogPath()
    {
        foreach ($this->logger->getHandlers() as $handler) {
            if ($handler instanceof Debug) {
                return $handler->getUrl();
            }
        }
        return false;
    }
}