Fixing VM config property expansion. (acquia#2039)

* Fixing VM config property expansion.

* Fixing composer:require.

Author: grasmash

composer.json

@@ -25,7 +25,7 @@
         "drush/drush":                      "^9.0.0-beta4",
         "grasmash/drupal-security-warning": "^1.0.0",
         "grasmash/yaml-cli":                "^1.0.0",
-        "grasmash/yaml-expander":           "^1.0.5",
+        "grasmash/yaml-expander":           "^1.2.0",
         "php":                              ">=5.6",
         "phpunit/phpunit":                  "^4.8",
         "squizlabs/php_codesniffer":        "^2.7",

composer.lock

@@ -6,7 +6,8 @@ vagrant_machine_name: ${project.machine_name}
 vagrant_ip: ${random.ip}
 
 # Use Ubuntu 16.04 LTS to match Acquia Cloud environments.
-vagrant_box: geerlingguy/ubuntu1604
+vagrant_box: ${base_box}
+workspace: ${workspace}
 
 # Set drupal_site_name to the project's human-readable name.
 drupal_site_name: "${project.human_name}"
@@ -69,14 +70,7 @@ nodejs_npm_global_packages:
   - name: gulp-cli
 nodejs_install_npm_user: "{{ drupalvm_user }}"
 npm_config_prefix: "/home/{{ drupalvm_user }}/.npm-global"
-installed_extras:
-  - adminer
-  - drush
-  - mailhog
-  - memcached
-  - nodejs
-  - selenium
-  - xdebug
+installed_extras: ${installed_extras}
 
 # PHP 7
 php_version: "7.1"

scripts/drupal-vm/config.yml

@@ -14,28 +14,40 @@ class ComposerCommand extends BltTasks {
    * Requires a composer package.
    *
    * @command composer:require
+   *
+   * @option dev Whether package should be added to require-dev.
    */
-  public function requirePackage($package_name, $package_version) {
+  public function requirePackage($package_name, $package_version, $options = ['dev' => FALSE]) {
 
-    $task = "composer require '{$package_name}''";
+    /** @var \Robo\Task\Composer\RequireDependency $task */
+    $task = $this->taskComposerRequire()
+      ->printOutput(TRUE)
+      ->dir($this->getConfigValue('repo.root'));
+    if ($options['dev']) {
+      $task->dev(TRUE);
+    }
     if ($package_version) {
-      $task = "composer require '{$package_name}:{$package_version}'";
+      $task->dependency($package_name, $package_version);
     }
-
-    $result = $this->taskExec($task)
-      ->printOutput(TRUE)
-      ->dir($this->getConfigValue('repo.root'))
-      ->run();
+    else {
+      $task->dependency($package_name);
+    }
+    $result = $task->run();
 
     if (!$result->wasSuccessful()) {
       $this->logger->error("An error occurred while requiring {$package_name}.");
       $this->say("This is likely due to an incompatibility with your existing packages.");
       $confirm = $this->confirm("Should BLT attempt to update all of your Composer packages in order to find a compatible version?");
       if ($confirm) {
-        $result = $this->taskExec("composer require '{$package_name}:{$package_version}' --no-update && composer update")
+        $command = "composer require '{$package_name}:{$package_version}' --no-update ";
+        if ($options['dev']) {
+          $command .= "--dev ";
+        }
+        $command .= "&& composer update";
+        $task = $this->taskExec($command)
           ->printOutput(TRUE)
-          ->dir($this->getConfigValue('repo.root'))
-          ->run();
+          ->dir($this->getConfigValue('repo.root'));
+        $result = $task->run();
         if (!$result->wasSuccessful()) {
           throw new BltException("Unable to install {$package_name} package.");
         }

src/Robo/Commands/Composer/ComposerCommand.php

@@ -4,6 +4,7 @@
 
 use Acquia\Blt\Robo\BltTasks;
 use Acquia\Blt\Robo\Exceptions\BltException;
+use function file_get_contents;
 use Robo\Contract\VerbosityThresholdInterface;
 use Symfony\Component\Yaml\Yaml;
 
@@ -208,6 +209,7 @@ protected function requireDrupalVm() {
     $package_options = [
       'package_name' => 'geerlingguy/drupal-vm',
       'package_version' => $this->drupalVmVersionConstraint,
+      ['dev' => TRUE],
     ];
     return $this->invokeCommand('composer:require', $package_options);
   }
@@ -219,7 +221,7 @@ protected function requireDrupalVm() {
    *   TRUE if it is present already and matches version constraint.
    */
   protected function isDrupalVmRequired() {
-    $composer_json = json_decode($this->getConfigValue('repo.root') . '/composer.json', TRUE);
+    $composer_json = json_decode(file_get_contents($this->getConfigValue('repo.root') . '/composer.json'), TRUE);
     return !empty($composer_json['require-dev']['geerlingguy/drupal-vm'])
       && $composer_json['require-dev']['geerlingguy/drupal-vm'] == $this->drupalVmVersionConstraint;
   }
@@ -249,7 +251,7 @@ protected function checkRequirements() {
    */
   protected function validateConfig($config) {
     if (strstr($config['vagrant_machine_name'], '_')) {
-      $this->logger->warning("vagrant_machine_namefor should not contain an underscore.");
+      $this->logger->warning("vagrant_machine_name should not contain an underscore.");
     }
   }
 
@@ -267,11 +269,27 @@ protected function setBaseBox($config) {
       ],
       'geerlingguy/ubuntu1604');
 
-    if ($base_box == 'beet/box') {
-      $config->set('workspace', '/beetbox/workspace/{{ php_version }}');
-      $config->set('installed_extras', []);
+    switch ($base_box) {
+      case 'beet/box':
+        $config->set('workspace', '/beetbox/workspace/{{ php_version }}');
+        $config->set('installed_extras', ['drush']);
+        break;
+
+      case 'geerlingguy/ubuntu1604':
+        $config->set('workspace', '/root');
+        $config->set('installed_extras', [
+          'adminer',
+          'drush',
+          'mailhog',
+          'memcached',
+          'nodejs',
+          'selenium',
+          'xdebug',
+        ]);
+        break;
     }
-    $config->set('vagrant_box', $base_box);
+
+    $config->set('base_box', $base_box);
   }
 
   /**
@@ -282,7 +300,6 @@ protected function customizeConfigFiles() {
     $config = clone $this->getConfig();
 
     $config->set('drupalvm.config.dir', $this->vmConfigDir);
-    $config->expandFileProperties($this->projectDrupalVmVagrantfile);
 
     // Generate a Random IP address for the new VM.
     $random_local_ip = "192.168." . rand(0, 255) . '.' . rand(0, 255);

src/Robo/Commands/Vm/VmCommand.php

@@ -298,7 +298,8 @@ public function getMySqlAvailable() {
    *   TRUE if Drupal VM configuration exists.
    */
   public function isDrupalVmConfigPresent() {
-    return file_exists($this->getConfigValue('repo.root') . '/Vagrantfile');
+    return file_exists($this->getConfigValue('repo.root') . '/Vagrantfile')
+      && file_exists($this->getConfigValue('vm.config'));
   }
 
   /**