Merge pull request #2910 from magento-thunder/MAGETWO-93758

[thunder] MAGETWO-93758: [Backport 2.2.x] Make cron:run CLI command react on cron disable configuration

Author: Joan He

app/code/Magento/Cron/Console/Command/CronCommand.php

@@ -10,10 +10,12 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputOption;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\ObjectManagerFactory;
 use Magento\Store\Model\Store;
 use Magento\Store\Model\StoreManager;
 use Magento\Cron\Observer\ProcessCronQueueObserver;
+use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\Console\Cli;
 use Magento\Framework\Shell\ComplexParameter;
 
@@ -35,13 +37,24 @@ class CronCommand extends Command
     private $objectManagerFactory;
 
     /**
-     * Constructor
+     * Application deployment configuration
      *
+     * @var DeploymentConfig
+     */
+    private $deploymentConfig;
+
+    /**
      * @param ObjectManagerFactory $objectManagerFactory
+     * @param DeploymentConfig $deploymentConfig Application deployment configuration
      */
-    public function __construct(ObjectManagerFactory $objectManagerFactory)
-    {
+    public function __construct(
+        ObjectManagerFactory $objectManagerFactory,
+        DeploymentConfig $deploymentConfig = null
+    ) {
         $this->objectManagerFactory = $objectManagerFactory;
+        $this->deploymentConfig = $deploymentConfig ?: ObjectManager::getInstance()->get(
+            DeploymentConfig::class
+        );
         parent::__construct();
     }
 
@@ -71,10 +84,16 @@ protected function configure()
     }
 
     /**
+     * Runs cron jobs if cron is not disabled in Magento configurations
+     *
      * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        if (!$this->deploymentConfig->get('cron/enabled', 1)) {
+            $output->writeln('<info>' . 'Cron is disabled. Jobs were not run.' . '</info>');
+            return;
+        }
         $omParams = $_SERVER;
         $omParams[StoreManager::PARAM_RUN_CODE] = 'admin';
         $omParams[Store::CUSTOM_ENTRY_POINT_PARAM] = true;

app/code/Magento/Cron/Test/Unit/Console/Command/CronCommandTest.php

@@ -6,19 +6,74 @@
 namespace Magento\Cron\Test\Unit\Console\Command;
 
 use Magento\Cron\Console\Command\CronCommand;
+use Magento\Framework\App\DeploymentConfig;
+use Magento\Framework\App\ObjectManagerFactory;
+use PHPUnit_Framework_MockObject_MockObject as MockObject;
 use Symfony\Component\Console\Tester\CommandTester;
 
 class CronCommandTest extends \PHPUnit\Framework\TestCase
 {
+    /**
+     * @var ObjectManagerFactory|MockObject
+     */
+    private $objectManagerFactory;
+
+    /**
+     * @var DeploymentConfig|MockObject
+     */
+    private $deploymentConfigMock;
+
+    protected function setUp()
+    {
+        $this->objectManagerFactory = $this->createMock(ObjectManagerFactory::class);
+        $this->deploymentConfigMock = $this->createMock(DeploymentConfig::class);
+    }
+
+    /**
+     * Test command with disables cron
+     *
+     * @return void
+     */
+    public function testExecuteWithDisabledCrons()
+    {
+        $this->objectManagerFactory->expects($this->never())
+            ->method('create');
+        $this->deploymentConfigMock->expects($this->once())
+            ->method('get')
+            ->with('cron/enabled', 1)
+            ->willReturn(0);
+        $commandTester = new CommandTester(
+            new CronCommand($this->objectManagerFactory, $this->deploymentConfigMock)
+        );
+        $commandTester->execute([]);
+        $expectedMsg = 'Cron is disabled. Jobs were not run.' . PHP_EOL;
+        $this->assertEquals($expectedMsg, $commandTester->getDisplay());
+    }
+
+    /**
+     * Test command with enabled cron
+     *
+     * @return void
+     */
     public function testExecute()
     {
-        $objectManagerFactory = $this->createMock(\Magento\Framework\App\ObjectManagerFactory::class);
         $objectManager = $this->createMock(\Magento\Framework\ObjectManagerInterface::class);
         $cron = $this->createMock(\Magento\Framework\App\Cron::class);
-        $objectManager->expects($this->once())->method('create')->willReturn($cron);
-        $cron->expects($this->once())->method('launch');
-        $objectManagerFactory->expects($this->once())->method('create')->willReturn($objectManager);
-        $commandTester = new CommandTester(new CronCommand($objectManagerFactory));
+        $objectManager->expects($this->once())
+            ->method('create')
+            ->willReturn($cron);
+        $cron->expects($this->once())
+            ->method('launch');
+        $this->objectManagerFactory->expects($this->once())
+            ->method('create')
+            ->willReturn($objectManager);
+        $this->deploymentConfigMock->expects($this->once())
+            ->method('get')
+            ->with('cron/enabled', 1)
+            ->willReturn(1);
+        $commandTester = new CommandTester(
+            new CronCommand($this->objectManagerFactory, $this->deploymentConfigMock)
+        );
         $commandTester->execute([]);
         $expectedMsg = 'Ran jobs by schedule.' . PHP_EOL;
         $this->assertEquals($expectedMsg, $commandTester->getDisplay());