Case 27689; tidying up handling of directory paths

Author: davidgrayston

chain/chain-site-configure.yml

@@ -15,3 +15,7 @@ commands:
   - command: site:settings:memcache
     arguments:
       name: '%{{name}}'
+# Create the drush alias
+  - command: site:drush:alias
+    arguments:
+      name: '%{{name}}'

src/Command/Site/AbstractCommand.php

@@ -70,11 +70,20 @@ abstract class AbstractCommand extends Command {
   protected $profile = NULL;
 
   /**
-   * The Drupal core directory.
+   * The root directory.
    *
    * @var string
    */
-  protected $drupal_directory = NULL;
+  protected $root = NULL;
+
+  /**
+   * The web root directory.
+   *
+   * This is the web directory within the root.
+   *
+   * @var string
+   */
+  protected $web_root = NULL;
 
   /**
    * Stores the site url.
@@ -180,8 +189,11 @@ protected function validateSiteParams(InputInterface $input, OutputInterface $ou
     // Validate profile.
     $this->validateProfile($input);
 
-    // Validate destination.
-    $this->validateDestination($input);
+    // Validate root.
+    $this->validateRoot($input);
+
+    // Validate web root.
+    $this->validateWebRoot();
 
     // Validate url.
     $this->validateUrl($input);
@@ -253,51 +265,50 @@ protected function validateProfile(InputInterface $input) {
   }
 
   /**
-   * Helper to validate destination parameter.
+   * Validate and set the web root directory.
+   */
+  protected function validateWebRoot() {
+    $this->web_root = $this->root . trim($this->config['web_directory'], '/') . '/';
+  }
+
+  /**
+   * Validate and set the root directory.
    *
    * @param InputInterface $input
-   *
-   * @throws CommandException
-   *
-   * @return string Destination
+   * @return string
    */
-  protected function validateDestination(InputInterface $input) {
+  protected function validateRoot(InputInterface $input) {
     if ($input->hasOption('destination-directory') &&
       !is_null($input->getOption('destination-directory'))
     ) {
       // Use config from parameter.
-      $this->drupal_directory = $input->getOption('destination-directory');
+      $this->root = $input->getOption('destination-directory');
     }
-    elseif (isset($this->config['repo']['directory'])) {
+    elseif (isset($this->config['root'])) {
       // Use config from sites.yml.
-      $this->drupal_directory = $this->config['repo']['directory'];
+      $this->root = $this->config['root'];
     }
     else {
-      $this->drupal_directory = '/tmp/' . $this->siteName;
+      $this->root = '/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->drupal_directory");
+      putenv("site_destination_directory=$this->root");
     }
     else {
-      $this->drupal_directory = getenv('site_destination_directory');
+      $this->root = getenv('site_destination_directory');
     }
 
-    $this->drupal_directory = rtrim($this->drupal_directory, '/') . '/' . trim($this->config['core_directory'], '/') . '/';
-
-    return $this->drupal_directory;
+    $this->root = rtrim($this->root, '/') . '/';
   }
 
   /**
-   * Helper to validate destination parameter.
+   * Helper to validate URL.
    *
    * @param InputInterface $input
-   *
-   * @throws CommandException
-   *
-   * @return string Destination
+   * @return string
    */
   protected function validateUrl(InputInterface $input) {
     $scheme = isset($this->config['scheme']) && !empty($this->config['scheme']) ? $this->config['scheme'] : 'http';
@@ -322,7 +333,7 @@ protected function validateUrl(InputInterface $input) {
    * @return string Path
    */
   public function settingsPhpDirectory() {
-    $webSitesPath = $this->drupal_directory . '/sites/';
+    $webSitesPath = $this->web_root . 'sites/';
     $settingsPath = $webSitesPath . 'default';
 
     $command = sprintf(

src/Command/Site/AbstractConfigCommand.php

@@ -97,8 +97,8 @@ protected function execute(InputInterface $input, OutputInterface $output) {
    * @throws \DennisDigital\Drupal\Console\Exception\CommandException
    */
   protected function generateConfigFile() {
-    $this->template = $this->drupal_directory . $this->template;
-    $this->filename = $this->drupal_directory . $this->filename;
+    $this->template = $this->root . $this->template;
+    $this->filename = $this->root . $this->filename;
 
     // Validation.
     if (!$this->fileExists($this->template)) {

src/Command/Site/Checkout/AbstractRefCommand.php

@@ -73,14 +73,14 @@ protected function execute(InputInterface $input, OutputInterface $output) {
     $this->io->comment(sprintf('Checking out %s (%s) on %s',
       $this->siteName,
       $this->ref,
-      $this->repo['directory']
+      $this->root
     ));
 
     switch ($this->repo['type']) {
       case 'git':
         // Check if repo exists and has any changes.
-        if ($this->fileExists($this->repo['directory']) &&
-          $this->fileExists($this->repo['directory'] . '.' . $this->repo['type'])
+        if ($this->fileExists($this->root) &&
+          $this->fileExists($this->root . '.' . $this->repo['type'])
         ) {
           if ($input->hasOption('force') &&
             !$input->getOption('force')
@@ -111,13 +111,10 @@ protected function execute(InputInterface $input, OutputInterface $output) {
    * @throws CommandException
    *
    * @return string Repo url
-   *
-   * @todo validate for all command that use repo config.
    */
   protected function validateRepo() {
     if (isset($this->config['repo'])) {
       $this->repo = $this->config['repo'];
-      $this->repo['directory'] = rtrim($this->repo['directory'], '/') . '/';
     }
     else {
       throw new CommandException('Repo not found in sites.yml');
@@ -136,7 +133,7 @@ protected function validateRepo() {
   protected function gitDiff() {
     $command = sprintf(
       'cd %s && git diff-files --name-status -r --ignore-submodules',
-      $this->shellPath($this->repo['directory'])
+      $this->shellPath($this->root)
     );
 
     $shellProcess = $this->getShellProcess();
@@ -146,7 +143,7 @@ protected function gitDiff() {
         $message = sprintf('You have uncommitted changes on %s' . PHP_EOL .
           'Please commit or revert your changes before checking out the site.' . PHP_EOL .
           'If you want to wipe your local changes use --force.',
-          $this->repo['directory']
+          $this->root
         );
         throw new CommandException($message);
       }
@@ -168,14 +165,14 @@ protected function gitDiff() {
   protected function gitClone() {
     $command = sprintf('git clone %s %s',
       $this->repo['url'],
-      $this->shellPath($this->repo['directory'])
+      $this->shellPath($this->root)
     );
     $this->io->commentBlock($command);
 
     $shellProcess = $this->getShellProcess();
 
     if ($shellProcess->exec($command, TRUE)) {
-      $this->io->success(sprintf('Repo cloned on %s', $this->repo['directory']));
+      $this->io->success(sprintf('Repo cloned on %s', $this->root));
     }
     else {
       throw new CommandException($shellProcess->getOutput());
@@ -196,10 +193,10 @@ protected function gitClone() {
    */
   protected function gitCheckout() {
     $commands = [
-      sprintf('cd %s', $this->shellPath($this->repo['directory'])),
+      sprintf('cd %s', $this->shellPath($this->root)),
       'git fetch --all',
-      sprintf('chmod 777 %s/sites/default', $this->drupal_directory),
-      sprintf('chmod 777 %s/sites/default/settings.php', $this->drupal_directory),
+      sprintf('chmod 777 %ssites/default', $this->web_root),
+      sprintf('chmod 777 %ssites/default/settings.php', $this->web_root),
       sprintf('git checkout %s --force', $this->ref),
     ];
     $command = implode(' && ', $commands);
@@ -223,10 +220,10 @@ protected function gitCheckout() {
    * @return mixed
    */
   protected function getCurrentRef() {
-    if ($this->fileExists($this->repo['directory'])) {
+    if ($this->fileExists($this->root)) {
       // Get branch from site directory.
       $command = sprintf('cd %s && git branch',
-        $this->shellPath($this->repo['directory'])
+        $this->shellPath($this->root)
       );
 
       $shellProcess = $this->getShellProcess()->printOutput(FALSE);

src/Command/Site/ComposeCommand.php

@@ -44,9 +44,9 @@ protected function interact(InputInterface $input, OutputInterface $output) {
   protected function execute(InputInterface $input, OutputInterface $output) {
     parent::execute($input, $output);
 
-    if (!$this->fileExists(rtrim($this->config['repo']['directory'], '/') . '/composer.json')) {
+    if (!$this->fileExists($this->root . 'composer.json')) {
       $message = sprintf('The file composer.json is missing on %s',
-        $this->config['repo']['directory']
+        $this->root
       );
       throw new CommandException($message);
     }
@@ -67,7 +67,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
   protected function runCommand($command) {
     $command = sprintf(
       'cd %s && composer %s',
-      $this->shellPath(rtrim($this->config['repo']['directory'], '/')),
+      $this->shellPath($this->root),
       $command
     );
     $this->io->commentBlock($command);
@@ -76,7 +76,7 @@ protected function runCommand($command) {
 
     //@todo Show a progress bar.
     if ($shellProcess->exec($command, TRUE)) {
-      $this->io->success(sprintf('Composer installed on %s', rtrim($this->config['repo']['directory'], '/')));
+      $this->io->success(sprintf('Composer installed on %s', $this->root));
     }
     else {
       throw new CommandException($shellProcess->getOutput());

src/Command/Site/DbImportCommand.php

@@ -116,7 +116,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
       $this->filename = $this->unzip($this->filename);
     }
 
-    $this->drupal_directory = $this->settingsPhpDirectory();
+    $this->web_root = $this->settingsPhpDirectory();
 
     // Override default values for these options (if empty).
     $override = array(
@@ -157,7 +157,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
         'chmod 777 settings.php && ' .
         'drush si -y %s %s && ' .
         'drush cset "system.site" uuid "$(drush cget system.site uuid --source=sync --format=list)" -y',
-        $this->shellPath($this->drupal_directory),
+        $this->shellPath($this->web_root),
         $this->profile,
         $options
       );
@@ -171,7 +171,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
         'cd %s; ' .
         'drush sql-create %s -y; ' .
         'drush sql-cli < %s; ',
-        $this->drupal_directory,
+        $this->web_root,
         $input->getOption('db-name'),
         $this->filename
       );
@@ -187,7 +187,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
       $this->io->writeln($shellProcess->getOutput());
       $this->io->success(sprintf(
         "Site installed on %s\nURL %s",
-        $this->drupal_directory,
+        $this->web_root,
         $this->config['host']
       ));
     }

src/Command/Site/DrushAliasCommand.php

@@ -35,7 +35,7 @@ class DrushAliasCommand extends AbstractCommand {
    *
    * @var
    */
-  protected $dir = 'web/sites/all/drush/site-aliases/';
+  protected $dir = 'sites/all/drush/site-aliases/';
 
   /**
    * {@inheritdoc}
@@ -65,7 +65,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
     parent::execute($input, $output);
 
     // Remove existing file.
-    $file = $this->drupal_directory . $this->dir . $this->filename;
+    $file = $this->web_root . $this->dir . $this->filename;
     if ($this->fileExists($file)) {
       $this->fileUnlink($file);
     }
@@ -79,7 +79,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
  * the generic Drush alias.
  */
 \$aliases["site"] = array (
-  'root' => '{$this->drupal_directory}web',		
+  'root' => '{$this->web_root}',
   'uri' => '{$this->url}',
   'user' => 1,
 );

src/Command/Site/GruntCommand.php

@@ -45,13 +45,13 @@ protected function execute(InputInterface $input, OutputInterface $output) {
     parent::execute($input, $output);
 
     $this->io->comment(sprintf('Running Grunt on %s',
-      $this->drupal_directory
+      $this->web_root
     ));
 
     $command = sprintf(
       'cd %s && ' .
       'find . -type d \( -name node_modules -o -name contrib -o -path ./core \) -prune -o -name Gruntfile.js -execdir sh -c "grunt" \;',
-      $this->shellPath($this->drupal_directory)
+      $this->shellPath($this->web_root)
     );
 
     // Run.

src/Command/Site/NPMCommand.php

@@ -45,13 +45,13 @@ protected function execute(InputInterface $input, OutputInterface $output) {
     parent::execute($input, $output);
 
     $this->io->comment(sprintf('Running NPM on %s',
-      $this->drupal_directory
+      $this->web_root
     ));
 
     $command = sprintf(
       'cd %s && ' .
       'find . -type d \( -name node_modules -o -name contrib -o -path ./core \) -prune -o -name package.json -execdir sh -c "npm install" \;',
-      $this->shellPath($this->drupal_directory)
+      $this->shellPath($this->web_root)
     );
 
     // Run.

src/Command/Site/Settings/DbCommand.php

@@ -58,12 +58,12 @@ protected function interact(InputInterface $input, OutputInterface $output) {
   protected function execute(InputInterface $input, OutputInterface $output) {
     parent::execute($input, $output);
 
-    $this->drupal_directory = $this->settingsPhpDirectory();
+    $this->web_root = $this->settingsPhpDirectory();
 
     // Validation.
-    if (!$this->fileExists($this->drupal_directory . 'settings.php')) {
+    if (!$this->fileExists($this->web_root . 'settings.php')) {
       $message = sprintf('Could not find %s',
-        $this->drupal_directory . 'settings.php'
+        $this->web_root . 'settings.php'
       );
       throw new CommandException($message);
     }
@@ -85,7 +85,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
     }
 
     // Remove existing file.
-    $file = $this->drupal_directory . $this->filename;
+    $file = $this->web_root . $this->filename;
     if ($this->fileExists($file)) {
       $this->fileUnlink($file);
     }