Fixes #1472: Execute Tests inside the VM where possible. (#1475)

* Fixes #1472: Execute Tests inside the VM where possible.

* Removing superfluous function.

* Fixing recursive command execution.

* Fixing PHPCS

Author: grasmash

src/Robo/BltTasks.php

@@ -15,6 +15,7 @@
 use Robo\Contract\BuilderAwareInterface;
 use Robo\Contract\ConfigAwareInterface;
 use Robo\Contract\IOAwareInterface;
+use Robo\Contract\VerbosityThresholdInterface;
 use Robo\LoadAllTasks;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Input\ArrayInput;
@@ -180,10 +181,13 @@ protected function installVagrantPlugin($plugin) {
    *   The command result.
    */
   protected function executeCommandInDrupalVm($command) {
+    $this->say("Executing command <comment>$command</comment> inside of Drupal VM...");
     $this->installVagrantPlugin('vagrant-exec');
-    $result = $this->taskExec("vagrant exec '$command'")
+    $result = $this->taskExecStack()
+      ->exec("vagrant exec --tty '$command'")
       ->dir($this->getConfigValue('repo.root'))
-      ->detectInteractive()
+      ->interactive(TRUE)
+      ->setVerbosityThreshold(VerbosityThresholdInterface::VERBOSITY_VERBOSE)
       ->run();
 
     return $result;

src/Robo/Commands/Drupal/DrupalCommand.php

@@ -28,7 +28,7 @@ public function install() {
       function ($string) {
         return !preg_match('/[^\x{80}-\x{F7} a-z0-9@+_.\'-]/i', $string);
       },
-      'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!#%^&*()_-?/.,+=><'
+      'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890!#%^&*()_?/.,+=><'
     );
 
     $task = $this->taskDrush()

src/Robo/Commands/Frontend/FrontendCommand.php

@@ -13,6 +13,8 @@ class FrontendCommand extends BltTasks {
    * Runs all frontend targets.
    *
    * @command frontend
+   *
+   * @executeInDrupalVm
    */
   public function frontend() {
     $status_code = $this->invokeCommands([
@@ -23,65 +25,37 @@ public function frontend() {
     return $status_code;
   }
 
-  /**
-   * Indicates whether a frontend hook should be invoked inside of Drupal VM.
-   *
-   * @return bool
-   *   TRUE if it should be invoked inside of  Drupal VM.
-   */
-  protected function shouldExecuteInDrupalVm() {
-    return $this->getInspector()->isDrupalVmLocallyInitialized()
-      && $this->getInspector()->isDrupalVmBooted()
-      && !$this->getInspector()->isVmCli();
-  }
-
-  /**
-   * Invokes a frontend hook.
-   *
-   * The hook will be invoked in Drupal VM if is initialized and booted.
-   * Otherwise, it will be invoked on the host machine.
-   *
-   * @param string $hook
-   *   The hook to invoke. E.g., "build" would invoke "frontend-build" hook.
-   *
-   * @return int|\Robo\Result
-   *   The status code or result object.
-   */
-  protected function invokeFrontendHook($hook) {
-    if ($this->shouldExecuteInDrupalVm()) {
-      $this->say("Executing $hook target hook inside of Drupal VM...");
-      return $this->executeCommandInDrupalVm("blt frontend:$hook");
-    }
-    else {
-      return $this->invokeHook("frontend-$hook");
-    }
-  }
-
   /**
    * Executes frontend-build target hook.
    *
    * @command frontend:build
+   *
+   * @executeInDrupalVm
    */
   public function build() {
-    return $this->invokeFrontendHook('build');
+    return $this->invokeHook('frontend-build');
   }
 
   /**
    * Executes frontend-setup target hook.
    *
    * @command frontend:setup
+   *
+   * @executeInDrupalVm
    */
   public function setup() {
-    return $this->invokeFrontendHook('setup');
+    return $this->invokeHook('frontend-setup');
   }
 
   /**
    * Executes frontend-test target hook.
    *
    * @command frontend:test
+   *
+   * @executeInDrupalVm
    */
   public function test() {
-    return $this->invokeFrontendHook('test');
+    return $this->invokeHook('frontend-test');
   }
 
 }

src/Robo/Commands/Setup/BuildCommand.php

@@ -42,7 +42,9 @@ public function setup() {
    * @todo Add a @validateSettingsFilesArePresent
    */
   public function drupalInstall() {
-    $status_code = $this->invokeCommands(['drupal:install']);
+    $status_code = $this->invokeCommands([
+      'drupal:install',
+    ]);
     if ($status_code) {
       return $status_code;
     }

src/Robo/Commands/Tests/AllCommand.php

@@ -13,6 +13,8 @@ class AllCommand extends BltTasks {
    * Runs all tests, including Behat, PHPUnit, and Security Update check.
    *
    * @command tests:all
+   *
+   * @executeInDrupalVm
    */
   public function tests() {
     $status_code = $this->invokeCommands([

src/Robo/Commands/Tests/BehatCommand.php

@@ -60,6 +60,7 @@ public function initialize() {
    * @validateDrupalIsInstalled
    * @validateBehatIsConfigured
    * @validateInsideVm
+   * @executeInDrupalVm
    */
   public function behat() {
     // Log config for debugging purposes.

src/Robo/Hooks/CommandEventHook.php

@@ -3,11 +3,6 @@
 namespace Acquia\Blt\Robo\Hooks;
 
 use Acquia\Blt\Robo\BltTasks;
-use Acquia\Blt\Robo\Config\ConfigAwareTrait;
-use Psr\Log\LoggerAwareInterface;
-use Psr\Log\LoggerAwareTrait;
-use Robo\Contract\ConfigAwareInterface;
-use Robo\Contract\IOAwareInterface;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;
 
 /**
@@ -16,10 +11,7 @@
  * These hooks typically use a Wizard to evaluate the validity of config or
  * state and guide the user toward resolving issues.
  */
-class CommandEventHook extends BltTasks implements IOAwareInterface, ConfigAwareInterface, LoggerAwareInterface {
-
-  use ConfigAwareTrait;
-  use LoggerAwareTrait;
+class CommandEventHook extends BltTasks {
 
   /**
    * Disable any command listed in the `disable-target` config key.
@@ -33,4 +25,33 @@ public function skipDisabledCommands(ConsoleCommandEvent $event) {
     }
   }
 
+  /**
+   * Execute a command inside of Drupal VM.
+   *
+   * @hook command-event *
+   */
+  public function executeInDrupalVm(ConsoleCommandEvent $event) {
+    $command = $event->getCommand();
+    if (method_exists($command, 'getAnnotationData')) {
+      /* @var \Consolidation\AnnotatedCommand\AnnotationData */
+      $annotation_data = $event->getCommand()->getAnnotationData();
+      if ($annotation_data->has('executeInDrupalVm') && $this->shouldExecuteInDrupalVm()) {
+        $event->disableCommand();
+        return $this->executeCommandInDrupalVm("blt " . $event->getCommand()->getName());
+      }
+    }
+  }
+
+  /**
+   * Indicates whether a frontend hook should be invoked inside of Drupal VM.
+   *
+   * @return bool
+   *   TRUE if it should be invoked inside of  Drupal VM.
+   */
+  protected function shouldExecuteInDrupalVm() {
+    return $this->getInspector()->isDrupalVmLocallyInitialized()
+      && $this->getInspector()->isDrupalVmBooted()
+      && !$this->getInspector()->isVmCli();
+  }
+
 }

src/Robo/Wizards/SetupWizard.php

@@ -40,9 +40,10 @@ public function wizardInstallDrupal() {
       $confirm = $this->confirm("Do you want to install Drupal?");
       if ($confirm) {
         $bin = $this->getConfigValue('composer.bin');
-
         $this->executor
-          ->execute("$bin/blt setup:drupal:install")->printOutput(TRUE)->run();
+          ->execute("$bin/blt setup")
+          ->interactive(TRUE)
+          ->run();
       }
     }
   }