Drupal 8.4 compatibility improvements.

Author: grasmash

config/build.yml

@@ -131,9 +131,6 @@ setup:
   strategy: install
   # If setup.strategy is import, this file will be imported.
   dump-file: null
-  drupal:
-    install:
-      import-config: true
 
 sync:
   # By default, files are not synced during sync:refresh.

scripts/blt/ci/internal/run_tests.sh

@@ -8,7 +8,7 @@ yaml-cli update:value blt/project.yml modules.ci.enable.0 views_ui
 # Build codebase, validate, install Drupal, run basic tests.
 yaml-cli update:value blt/project.yml cm.strategy none
 blt validate:all
-blt setup --define environment=ci --yes -vvv
+${BLT_DIR}/scripts/travis/tick-tock.sh blt setup --define environment=ci --yes -vvv
 blt tests:all --define tests.run-server=true --yes -vvv
 blt tests:behat:definitions
 cd docroot

scripts/blt/ignore-existing.txt

@@ -9,12 +9,13 @@ blt/project.yml
 blt/src/Filesets
 composer.json
 composer.lock
-README.md
 drush/site-aliases/aliases.drushrc.php
 drush/drushrc.php
 docroot/sites/default/services.yml
 docroot/sites/default/settings/trusted_host.settings.php
 factory-hooks/pre-settings-php/includes.php
+phpcs.xml.dist
+README.md
 tests/behat/behat.yml
 tests/behat/example.local.yml
 tests/behat/features/bootstrap/Drupal/FeatureContext.php

scripts/drupal-vm/config.yml

@@ -64,10 +64,11 @@ drupal_install_site: false
 configure_drush_aliases: false
 
 # This is required for front-end building tools.
-nodejs_version: "4.x"
+nodejs_version: "6.x"
 nodejs_npm_global_packages:
   - name: bower
   - name: gulp-cli
+  - name: yarn
 nodejs_install_npm_user: "{{ drupalvm_user }}"
 npm_config_prefix: "/home/{{ drupalvm_user }}/.npm-global"
 installed_extras: ${installed_extras}

scripts/travis/run_tests

@@ -6,7 +6,7 @@ set -ev
 yaml-cli update:value blt/project.yml project.local.hostname '127.0.0.1:8888'
 
 blt validate:all
-blt setup --define drush.alias='${drush.aliases.ci}' --define environment=ci --no-interaction --yes -v
+${BLT_DIR}/scripts/travis/tick-tock.sh blt setup --define drush.alias='${drush.aliases.ci}' --define environment=ci --no-interaction --yes -v
 blt tests:all --define drush.alias='${drush.aliases.ci}' --define tests.run-server=true --yes -v
 
 set +v

scripts/travis/tick-tock.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+set -e
+set -u
+
+command=$@
+
+# launch command in the background
+${command} &
+
+# ping every second
+seconds=0
+limit=40*60
+while kill -0 $! >/dev/null 2>&1;
+do
+    echo -n -e " \b" # never leave evidence
+
+    if [ $seconds == $limit ]; then
+        break;
+    fi
+
+    seconds=$((seconds + 1))
+
+    sleep 1
+done

src/Robo/Blt.php

@@ -37,7 +37,7 @@ class Blt implements ContainerAwareInterface, LoggerAwareInterface {
   /**
    * The BLT version.
    */
-  const VERSION = '8.9.5';
+  const VERSION = '9.0.0';
 
   /**
    * The Robo task runner.

src/Robo/Commands/Setup/DrupalCommand.php

@@ -49,13 +49,6 @@ function ($string) {
       ->assume(TRUE)
       ->printOutput(TRUE);
 
-    $config_strategy = $this->getConfigValue('cm.strategy');
-
-    if (!$config_strategy != 'none' && $this->getConfigValue('setup.drupal.install.import-config')) {
-      $cm_core_key = $this->getConfigValue('cm.core.key');
-      $task->option('config-dir', $this->getConfigValue("cm.core.dirs.$cm_core_key.path"));
-    }
-
     $result = $task->detectInteractive()->run();
     if ($result->wasSuccessful()) {
       $this->getConfig()->set('state.drupal.installed', TRUE);

src/Robo/Commands/Sync/DbCommand.php

@@ -14,6 +14,8 @@ class DbCommand extends BltTasks {
    * Iteratively copies remote db to local db for each multisite.
    *
    * @command sync:db:all
+   *
+   * @executeInDrupalVm
    */
   public function syncDbAll() {
     $exit_code = 0;
@@ -52,6 +54,7 @@ protected function syncDbMultisite($multisite_name) {
    * @command sync:db
    *
    * @validateDrushConfig
+   * @executeInDrupalVm
    */
   public function syncDbDefault() {
 
@@ -70,7 +73,7 @@ public function syncDbDefault() {
       ->assume(TRUE);
 
     if ($this->getConfigValue('drush.sanitize')) {
-      $task->option('sanitize');
+      $task->drush('sql-sanitize');
     }
 
     $task->drush('cache-clear drush');

src/Robo/Commands/Tests/BehatCommand.php

@@ -92,7 +92,7 @@ public function initialize() {
    * @validateMySqlAvailable
    * @validateDrupalIsInstalled
    * @validateBehatIsConfigured
-   * @validateInsideVm
+   * @validateVmConfig
    * @launchWebServer
    * @executeInDrupalVm
    */

src/Robo/Hooks/DrushHook.php

@@ -5,6 +5,7 @@
 use Acquia\Blt\Robo\BltTasks;
 use Acquia\Blt\Robo\Exceptions\BltException;
 use Consolidation\AnnotatedCommand\CommandData;
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
 
 /**
  * Validate Drush configuration for failed commands.
@@ -28,4 +29,18 @@ public function validateDrushConfig(CommandData $commandData) {
     }
   }
 
+  /**
+   * Corrects drush aliases when inside of the VM.
+   *
+   * The VM alias is not available inside the VM.
+   *
+   * @hook command-event *
+   */
+  public function drushVmAlias(ConsoleCommandEvent $commandData) {
+    if ($this->getInspector()->isVmCli()) {
+      $this->getConfig()->set('drush.alias', '');
+      $this->getConfig()->set('drush.aliases.local', 'self');
+    }
+  }
+
 }

src/Robo/Hooks/ValidateHook.php

@@ -124,11 +124,11 @@ public function validateSettingsFilesPresent() {
   /**
    * Validates that current PHP process is being executed inside of the VM.
    *
-   * @hook validate validateInsideVm
+   * @hook validate validateVmConfig
    */
   public function validateInsideVm() {
-    if ($this->getInspector()->isDrupalVmLocallyInitialized() && !$this->getInspector()->isVmCli()) {
-      throw new BltException("You must run this command inside Drupal VM, or else do not use Drupal VM at all. Execute `vagrant ssh` and then execute the command, or else change drush.aliases.local in blt/project.local.yml.");
+    if ($this->getInspector()->isDrupalVmLocallyInitialized() && $this->getInspector()->isDrupalVmBooted() && !$this->getInspector()->isDrupalVmConfigValid()) {
+      throw new BltException("Drupal VM configuration is invalid.");
     }
   }
 

src/Robo/Inspector/Inspector.php

@@ -16,6 +16,7 @@
 use Robo\Common\BuilderAwareTrait;
 use Robo\Contract\BuilderAwareInterface;
 use Robo\Contract\ConfigAwareInterface;
+use function substr;
 use Symfony\Component\Filesystem\Filesystem;
 use Robo\Contract\VerbosityThresholdInterface;
 use Tivie\OS\Detector;
@@ -258,6 +259,26 @@ public function isDrushAliasValid($alias) {
     return $this->executor->drush("site-alias $alias --format=json")->run()->wasSuccessful();
   }
 
+  /**
+   * Gets the major version of drush.
+   *
+   * @return int
+   *   The major version of drush.
+   */
+  public function getDrushMajorVersion() {
+    $version_info = json_decode($this->executor->drush('version --format=json')->run()->getMessage(), TRUE);
+    if (!empty($version_info['drush-version'])) {
+      $version = $version_info['drush-version'];
+    }
+    else {
+      $version = $version_info['drush-version'];
+    }
+
+    $major_version = substr($version, 0, 1);
+
+    return (int) $major_version;
+  }
+
   /**
    * Determines if MySQL is available, caches result.
    *

src/Robo/Tasks/DrushTask.php

@@ -285,6 +285,8 @@ protected function setGlobalOptions() {
     if ($this->include) {
       $this->option('include', $this->include);
     }
+
+    $this->option('config', $this->getConfig()->get('repo.root') . '/drush/drushrc.php');
   }
 
   /**

src/Robo/Wizards/TestsWizard.php

@@ -2,6 +2,7 @@
 
 namespace Acquia\Blt\Robo\Wizards;
 
+use function file_exists;
 use Robo\Contract\VerbosityThresholdInterface;
 
 /**
@@ -32,7 +33,8 @@ public function wizardInstallPhantomJsBinary() {
    * Prompts user to generate valid Behat configuration file.
    */
   public function wizardConfigureBehat() {
-    if (!$this->getInspector()->isBehatConfigured()) {
+    $behat_local_config_file = $this->getConfigValue('repo.root') . '/tests/behat/local.yml';
+    if (!file_exists($behat_local_config_file) || !$this->getInspector()->isBehatConfigured()) {
       $this->logger->warning('Behat is not configured properly.');
       $this->say("BLT can (re)generate tests/behat/local.yml using tests/behat/example.local.yml.");
       $confirm = $this->confirm("Do you want (re)generate local Behat config in <comment>tests/behat/local.yml</comment>?", TRUE);

src/Update/Updates.php

@@ -367,6 +367,23 @@ public function update_8009003() {
     $composer_json['extra']['installer-paths']['docroot/libraries/{$name}'][] = 'type:bower-asset';
     $composer_json['extra']['installer-paths']['docroot/libraries/{$name}'][] = 'type:npm-asset';
 
+    // Add the Asset Packagist repository if it does not already exist.
+    if (isset($composer_json['repositories'])) {
+      $repository_key = NULL;
+      foreach ($composer_json['repositories'] as $key => $repository) {
+        if ($repository['type'] == 'composer' && strpos($repository['url'], 'https://asset-packagist.org') === 0) {
+          $repository_key = $key;
+          break;
+        }
+      }
+      if (is_null($repository_key)) {
+        $composer_json['repositories']['asset-packagist'] = [
+          'type' => 'composer',
+          'url' => 'https://asset-packagist.org',
+        ];
+      }
+    }
+
     $projectAcsfHooks = $this->updater->getRepoRoot() . '/factory-hooks';
     $acsf_inited = file_exists($projectAcsfHooks);
     if ($acsf_inited) {
@@ -384,4 +401,27 @@ public function update_8009003() {
     $this->updater->getOutput()->writeln($formattedBlock);
     $this->updater->getOutput()->writeln("");
   }
+
+  /**
+   * 8.9.7.
+   *
+   * @Update(
+   *    version = "8009007",
+   *    description = "Removing drush files."
+   * )
+   */
+  public function update_8009007() {
+    $this->updater->deleteFile('drush.wrapper');
+    $this->updater->deleteFile('.drush-use');
+
+    // Recommend drush upgrade.
+    $messages = [
+      "You should replace your local global installation of drush with drush launcher:",
+      "https://github.com/drush-ops/drush-launcher",
+    ];
+    $formattedBlock = $this->updater->getFormatter()->formatBlock($messages, 'ice');
+    $this->updater->getOutput()->writeln("");
+    $this->updater->getOutput()->writeln($formattedBlock);
+    $this->updater->getOutput()->writeln("");
+  }
 }

template/phpcs.xml.dist

@@ -1,10 +1,15 @@
 <?xml version="1.0"?>
 <!--
    To override this file, copy it to phpcs.xml and then modify.
+   @see https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml#the-annotated-sample-file
 -->
 <ruleset name="blt">
   <description>BLT PHP_CodeSniffer standards overrides.</description>
 
+  <!-- By default, warnings and errors cause an exception. -->
+  <config name="ignore_warnings_on_exit" value="0" />
+  <config name="ignore_errors_on_exit" value="0" />
+
   <!-- Set ignore extensions. -->
   <!-- @see https://www.drupal.org/node/2867601#comment-12075633 -->
   <arg name="ignore" value="*.css,*.md,*.txt"/>
@@ -16,7 +21,10 @@
 
   <!-- Include existing standards. -->
   <rule ref="Drupal"/>
-  <rule ref="DrupalPractice"/>
+  <rule ref="DrupalPractice">
+    <!-- Ignore specific sniffs. -->
+    <!-- <exclude name="DrupalPractice.CodeAnalysis.VariableAnalysis.UnusedVariable"/> -->
+  </rule>
 
   <file>blt</file>
   <file>docroot/modules/custom</file>