MaintenanceModeEnablerTest.php

Go to the documentation of this file.

<?php
namespace Magento\Framework\App\Test\Unit\Console;

use Magento\Framework\App\Console\MaintenanceModeEnabler;
use Magento\Framework\App\MaintenanceMode;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Output\OutputInterface;

class MaintenanceModeEnablerTest extends TestCase
{
    public function testSuccessfulTask(bool $maintenanceModeEnabledInitially)
    {
        $maintenanceMode = $this->createMaintenanceMode($maintenanceModeEnabledInitially);
        $enabler = new MaintenanceModeEnabler($maintenanceMode);
        $successTask = function () {
            // do nothing
        };

        $enabler->executeInMaintenanceMode(
            $successTask,
            $this->createOutput(),
            true
        );

        $this->assertEquals(
            $maintenanceModeEnabledInitially,
            $maintenanceMode->isOn(),
            'Initial state is not restored'
        );
    }

    public function testFailedTaskWithMaintenanceModeOnFailure(bool $maintenanceModeEnabledInitially)
    {
        $maintenanceMode = $this->createMaintenanceMode($maintenanceModeEnabledInitially);
        $enabler = new MaintenanceModeEnabler($maintenanceMode);
        $failedTask = function () {
            throw new \Exception('Woops!');
        };

        try {
            $enabler->executeInMaintenanceMode(
                $failedTask,
                $this->createOutput(),
                true
            );
        } catch (\Exception $e) {
            $this->assertEquals(
                true,
                $maintenanceMode->isOn(),
                'Maintenance mode is not active after failure'
            );
        }
    }

    public function testFailedTaskWithRestoredModeOnFailure(bool $maintenanceModeEnabledInitially)
    {
        $maintenanceMode = $this->createMaintenanceMode($maintenanceModeEnabledInitially);
        $enabler = new MaintenanceModeEnabler($maintenanceMode);
        $failedTask = function () {
            throw new \Exception('Woops!');
        };

        try {
            $enabler->executeInMaintenanceMode(
                $failedTask,
                $this->createOutput(),
                false
            );
        } catch (\Exception $e) {
            $this->assertEquals(
                $maintenanceModeEnabledInitially,
                $maintenanceMode->isOn(),
                'Initial state is not restored'
            );
        }
    }

    public function initialAppStateProvider()
    {
        return [
            'Maintenance mode disabled initially' => [false],
            'Maintenance mode enabled initially' => [true],
        ];
    }

    private function createMaintenanceMode(bool $isOn): MaintenanceMode
    {
        $maintenanceMode = $this->getMockBuilder(MaintenanceMode::class)
            ->disableOriginalConstructor()
            ->getMock();

        $maintenanceMode->method('isOn')->willReturnCallback(function () use (&$isOn) {
            return $isOn;
        });
        $maintenanceMode->method('set')->willReturnCallback(function ($newValue) use (&$isOn) {
            $isOn = (bool)$newValue;
            return true;
        });

        return $maintenanceMode;
    }

    private function createOutput(): OutputInterface
    {
        $output = $this->getMockBuilder(OutputInterface::class)
            ->getMockForAbstractClass();
        return $output;
    }
}