add new console command context check luyadev#1927

core/CHANGELOG.md

@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file. This projec
 
 ## 1.0.19 (in progress)
 
++ [#1927](https://github.com/luyadev/luya/issues/1927) New check whether console command is running in console application context.
 + [#1925](https://github.com/luyadev/luya/issues/1925) Add new actions and controller retrieve options in object helper.
 
 ## 1.0.18 (27. May 2019)

core/console/Controller.php

@@ -4,6 +4,10 @@
 
 use Yii;
 use yii\helpers\Console;
+use yii\console\Controller as BaseController;
+use luya\helpers\ObjectHelper;
+use yii\base\InvalidCallException;
+use yii\console\Application;
 
 /**
  * Console Controller base class.
@@ -14,8 +18,18 @@
  * @author Basil Suter <basil@nadar.io>
  * @since 1.0.0
  */
-abstract class Controller extends \yii\console\Controller
+abstract class Controller extends BaseController
 {
+ public function init()
+ {
+ parent::init();
+
+ // Ensure the console command is running under web application object.
+ if (!ObjectHelper::isInstanceOf(Yii::$app, Application::class, false)) {
+ throw new InvalidCallException("The console controller can only run within a console Application context.");
+ }
+ }
+
  /**
  * Helper method to see if the current Application is muted or not. If the Application is muted, no output
  * will displayed.

tests/core/console/ApplicationTest.php

@@ -6,19 +6,29 @@
 
 use Yii;
 use yii\console\Controller;
+use luyatests\data\commands\TestConsoleCommand;
+use luya\web\Application;
 
 class ApplicationTest extends LuyaConsoleTestCase
 {
  public function testInvalidCommandException()
  {
  $this->expectException('yii\console\Exception');
- Yii::$app->runAction('luya/luya/luya');
+ $this->app->runAction('luya/luya/luya');
  }
 
  public function testInvalidRouteCommand()
  {
- $this->expectException('yii\console\Exception');
- Yii::$app->runAction('consolemodule/test-command/notavailable');
+ $this->expectException('yii\console\UnknownCommandException');
+ $this->app->runAction('consolemodule/test-command/notavailable');
+ }
+
+ public function testInvalidApplicationContext()
+ {
+ $module = new Application(['basePath' => dirname(__DIR__), 'id' => 'barfoo']);
+ $this->expectException("yii\base\InvalidCallException");
+ $command = new TestConsoleCommand('console', $module);
+ $command->actionFoo();
  }
 
  public function testRouting()

tests/data/commands/TestConsoleCommand.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace luyatests\data\commands;
+
+use luya\console\Command;
+
+class TestConsoleCommand extends Command
+{
+ public function actionFoo()
+ {
+ return 'bar';
+ }
+}