Case 27689; Allow root to be overriden by environment variables

Author: marcelovani

README.md

@@ -77,6 +77,13 @@ e.g. https://raw.githubusercontent.com/dennisinteractive/drupal_console_commands
 - **-h** Show all the available arguments and options
 - **--no-interaction** Will execute the command without asking any optional argument
 
+# Environment variables
+By default, the commands will use parameters from the site.yml, but it is possible to override them using environment variables.
+
+For example, to override the root directory you can set the variable before calling `site:build`
+
+`export site_destination_directory="/directory/"`
+
 # Usage example
 ```
 drupal site:build

chain/chain-site-build.yml

@@ -1,4 +1,4 @@
-# Usage: drupal site:build --placeholder="name:subscriptions" --placeholder="root:/vagrant/repos"
+# Usage: drupal site:build --placeholder="name:subscriptions"
 command:
   name: site:build
   description: 'Builds a new site.'
@@ -14,4 +14,3 @@ commands:
     options:
       placeholder:
         - 'name:%{{name}}'
-        - 'root:%{{root|/vagrant/repos}}'

chain/chain-site-compile-artifact.yml

@@ -1,4 +1,4 @@
-# Usage: drupal site:compile --placeholder="name:subscriptions" --placeholder="root:/vagrant/repos"
+# Usage: drupal site:compile --placeholder="name:subscriptions"
 command:
   name: site:compile
   description: 'Compiles the source, downloading and extracting the packages.'
@@ -8,12 +8,12 @@ commands:
     arguments:
       name: '%{{name}}'
     options:
-      destination-directory: '%{{root|/vagrant/repos}}/%{{name}}'
+      destination-directory: '${{site_destination_directory}}'
 # Run npm
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}/web; find . -type d \( -name node_modules -o -name contrib -o -path ./core \) -prune -o -name package.json -execdir sh -c "npm install" \;'
+      bin: 'cd ${{site_destination_directory}}/web; find . -type d \( -name node_modules -o -name contrib -o -path ./core \) -prune -o -name package.json -execdir sh -c "npm install" \;'
 # Run grunt
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}/web; find . -type d \( -name node_modules -o -name contrib -o -path ./core \) -prune -o -name Gruntfile.js -execdir sh -c "grunt" \;'
+      bin: 'cd ${{site_destination_directory}}/web; find . -type d \( -name node_modules -o -name contrib -o -path ./core \) -prune -o -name Gruntfile.js -execdir sh -c "grunt" \;'

chain/chain-site-compile.yml

@@ -1,25 +1,25 @@
-# Usage: drupal site:construct --placeholder="name:subscriptions" --placeholder="root:/vagrant/repos"
+# Usage: drupal site:construct --placeholder="name:subscriptions"
 command:
   name: site:construct
   description: 'Sets the site up based on current configuration and database.'
 commands:
 # Clear cache
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}/web; drush cr;'
+      bin: 'cd ${{site_destination_directory}}/web; drush cr;'
 # Set default drush alias
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}/web; drush site-set @site;'
+      bin: 'cd ${{site_destination_directory}}/web; drush site-set @site;'
 # Run db updates
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}/web; drush updb -y;'
+      bin: 'cd ${{site_destination_directory}}/web; drush updb -y;'
 # Import configuration twice to fix a problem with config import when new modules are added to core.extensions.yml
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}/web; drush cim -y; drush cim -y'
+      bin: 'cd ${{site_destination_directory}}/web; drush cim -y; drush cim -y'
 # Clear cache
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}/web; drush cr;'
+      bin: 'cd ${{site_destination_directory}}/web; drush cr;'

chain/chain-site-construct.yml

@@ -1,4 +1,4 @@
-# Usage: drupal site:rebuild:prod --placeholder="name:subscriptions" --placeholder="root:/vagrant/repos"
+# Usage: drupal site:rebuild:prod --placeholder="name:subscriptions"
 command:
   name: site:rebuild:prod
   description: 'Peforms necessary steps to build the site from a given source.'
@@ -8,10 +8,8 @@ commands:
     options:
       placeholder:
         - 'name:%{{name}}'
-        - 'root:%{{root|/vagrant/repos}}'
 # Build the site based on existing setup.
   - command: site:construct
     options:
       placeholder:
         - 'name:%{{name}}'
-        - 'root:%{{root|/vagrant/repos}}'

chain/chain-site-rebuild-prod.yml

@@ -1,4 +1,4 @@
-# Usage: drupal site:rebuild --placeholder="name:subscriptions" --placeholder="root:/vagrant/repos"
+# Usage: drupal site:rebuild --placeholder="name:subscriptions"
 command:
   name: site:rebuild
   description: 'Peforms necessary steps to build the site from a given source.'
@@ -8,7 +8,6 @@ commands:
     options:
       placeholder:
         - 'name:%{{name}}'
-        - 'root:%{{root|/vagrant/repos}}'
 # Generate the settings.
   - command: site:configure
     options:
@@ -23,4 +22,3 @@ commands:
     options:
       placeholder:
         - 'name:%{{name}}'
-        - 'root:%{{root|/vagrant/repos}}'

chain/chain-site-rebuild.yml

@@ -1,4 +1,4 @@
-# Usage: drupal site:test --placeholder="name:subscriptions" --placeholder="root:/vagrant/repos" --placeholder="behat_params:--tags=bannerimage"
+# Usage: drupal site:test --placeholder="name:subscriptions" --placeholder="behat_params:--tags=bannerimage"
 command:
   name: site:test
   description: 'Sets the test suites up and then runs them.'
@@ -14,8 +14,8 @@ commands:
 # Run Behat
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}/tests; ./behat %{{behat_params|-n}};'
+      bin: 'cd ${{site_destination_directory}}/tests; ./behat %{{behat_params|-n}};'
 # Run phpunit
   - command: exec
     arguments:
-      bin: 'cd %{{root|/vagrant/repos}}/%{{name}}; ./vendor/bin/phpunit;'
+      bin: 'cd ${{site_destination_directory}}; ./vendor/bin/phpunit;'

chain/chain-site-test.yml

@@ -275,6 +275,15 @@ protected function _validateDestination(InputInterface $input) {
       $this->destination = '/tmp/' . $this->siteName;
     }
 
+    // Allow destination to be overriden by environment variable. i.e.
+    // export site_destination_directory="/directory/"
+    if (!getenv('site_destination_directory')) {
+      putenv("site_destination_directory=$this->destination");
+    }
+    else {
+      $this->destination = getenv('site_destination_directory');
+    }
+
     // Make sure we have a slash at the end.
     if (substr($this->destination, -1) != '/') {
       $this->destination .= '/';