Merge pull request #31 from dennisinteractive/27689_artifact_tag_checkout

27689 artifact tag checkout

Author: marcelovani

README.md

@@ -17,7 +17,13 @@ e.g. https://raw.githubusercontent.com/dennisinteractive/drupal_console_commands
 - drupal **site:new**
 	Builds a new site using Drupal project as template https://github.com/dennisinteractive/drupal-project
 
-- drupal **site:checkout** *site-name*
+- drupal **site:checkout** *site-name* [--branch|--tag]
+	Performs a git clone and checks out the specified branch or tag
+
+- drupal **site:checkout:tag** *site-name* --tag
+	Performs a git clone and checks out the specified tag/revision
+
+- drupal **site:checkout:branch** *site-name* --branch
 	Performs a git clone and checks out the specified branch
 
 - drupal **site:compose** *site-name*
@@ -38,9 +44,6 @@ e.g. https://raw.githubusercontent.com/dennisinteractive/drupal_console_commands
 - drupal **site:settings:memcache** *site-name*
 	Creates *settings.memcache.php* in the *web/sites/default* folder. This file contains Memcache configuration and should not be committed.
 
-- drupal **site:drush:alias** *site-name*
-	Sets up drush aliases
-
 - drupal **site:phpunit:setup** *site-name*
 	Creates *phpunit.xml* in the root. This file contains PHPUnit configuration and should not be committed.
 
@@ -75,7 +78,6 @@ Chains that can be reused on various environments
     - site:settings:db
     - site:settings:local
     - site:settings:memcache
-    - site:drush:alias
 
 - drupal **site:test:setup** Sets the test suites
     - site:phpunit:setup
@@ -99,11 +101,8 @@ Each environment will have its own chain that executes the relevant commands and
     - site:update
 
 ### Artifact
-- drupal **site:build** Builds a site for artifacts
-    - site:checkout
-    - site:rebuild (chain)
-
 - drupal **site:build:artifact** Prepare artifacts
+    - site:checkout
     - site:compose
     - site:npm
     - site:grunt

chain/chain-site-build-artifact.yml

@@ -3,6 +3,13 @@ command:
   name: site:build:artifact
   description: 'Prepare artifacts.'
 commands:
+# Checkout site
+  - command: site:checkout
+    arguments:
+      name: '%{{name}}'
+    options:
+      tag: '%{{tag}}'
+      destination-directory: '%{{root}}'
 # Run composer.
   - command: site:compose
     arguments:

chain/chain-site-configure.yml

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

console.config.yml

@@ -3,7 +3,11 @@ application:
     commands:
       forced:
         'site:checkout':
-          class: \DennisDigital\Drupal\Console\Command\Site\CheckoutCommand
+          class: \DennisDigital\Drupal\Console\Command\Site\Checkout\CheckoutCommand
+        'site:checkout:tag':
+          class: \DennisDigital\Drupal\Console\Command\Site\Checkout\TagCommand
+        'site:checkout:branch':
+          class: \DennisDigital\Drupal\Console\Command\Site\Checkout\BranchCommand
         'site:compose':
           class: \DennisDigital\Drupal\Console\Command\Site\ComposeCommand
         'site:settings:db':
@@ -12,8 +16,6 @@ application:
           class: \DennisDigital\Drupal\Console\Command\Site\Settings\MemcacheCommand
         'site:settings:local':
           class: \DennisDigital\Drupal\Console\Command\Site\Settings\LocalCommand
-        'site:drush:alias':
-          class: \DennisDigital\Drupal\Console\Command\Site\DrushAliasCommand
         'site:db:import':
           class: \DennisDigital\Drupal\Console\Command\Site\DbImportCommand
         'site:behat:setup':

src/Command/Site/AbstractCommand.php

@@ -18,6 +18,7 @@
 use Drupal\Console\Core\Style\DrupalStyle;
 use Drupal\Console\Core\Command\Shared\CommandTrait;
 use DennisDigital\Drupal\Console\Command\Exception\CommandException;
+use DennisDigital\Drupal\Console\Utils\ShellProcess;
 
 /**
  * Class AbstractCommand
@@ -69,11 +70,29 @@ abstract class AbstractCommand extends Command {
   protected $profile = NULL;
 
   /**
-   * Stores the destination directory.
+   * The root directory.
    *
    * @var string
    */
-  protected $destination = NULL;
+  private $root = NULL;
+
+  /**
+   * The web root directory.
+   *
+   * This is the web directory within the root.
+   *
+   * @var string
+   */
+  private $webRoot = NULL;
+
+  /**
+   * The site root directory.
+   *
+   * This is where we put settings.php
+   *
+   * @var string
+   */
+  private $siteRoot = NULL;
 
   /**
    * Stores the site url.
@@ -179,13 +198,58 @@ 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 settings.php directory.
+    $this->validateSiteRoot();
 
     // Validate url.
     $this->validateUrl($input);
   }
 
+  /**
+   * Getter for the root directory property.
+   */
+  protected function getRoot() {
+    if (is_null($this->root)) {
+      throw new CommandException('Root directory is not available.');
+    }
+    return $this->root;
+  }
+
+  /**
+   * Getter for the web root directory property.
+   */
+  protected function getWebRoot() {
+    if (is_null($this->webRoot)) {
+      throw new CommandException('Web root directory is not available.');
+    }
+    return $this->webRoot;
+  }
+
+  /**
+   * Getter for the site root directory property.
+   */
+  protected function getSiteRoot() {
+    if (is_null($this->siteRoot)) {
+      throw new CommandException('Site root directory is not available.');
+    }
+    return $this->siteRoot;
+  }
+
+  /**
+   * Check if the current build has a site root directory.
+   *
+   * @return bool
+   */
+  protected function hasSiteRoot() {
+    return !is_null($this->siteRoot);
+  }
+
   /**
    * Helper to check that the config file exits and load the configuration.
    *
@@ -252,54 +316,51 @@ protected function validateProfile(InputInterface $input) {
   }
 
   /**
-   * Helper to validate destination parameter.
+   * Validate and set the web root directory.
+   */
+  protected function validateWebRoot() {
+    $web_directory = empty($this->config['web_directory']) ? 'web' : $this->config['web_directory'];
+    $this->webRoot = $this->getRoot() . trim($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->destination = $input->getOption('destination-directory');
+      $this->root = $input->getOption('destination-directory');
     }
     elseif (isset($this->config['root'])) {
       // Use config from sites.yml.
-      $this->destination = $this->config['root'];
+      $this->root = $this->config['root'];
     }
     else {
-      $this->destination = '/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->destination");
+      putenv("site_destination_directory=$this->root");
     }
     else {
-      $this->destination = getenv('site_destination_directory');
-    }
-
-    // Make sure we have a slash at the end.
-    if (substr($this->destination, -1) != '/') {
-      $this->destination .= '/';
+      $this->root = getenv('site_destination_directory');
     }
 
-    return $this->destination;
+    $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';
@@ -317,16 +378,25 @@ protected function validateUrl(InputInterface $input) {
   }
 
   /**
-   * Helper to return the path to settings.php
+   * Helper to set the site root.
+   *
+   * This is where we place settings.php
+   *
    * It will try to match a folder with same name as site name
    * If not found, it will try to match a folder called "default".
    *
    * @return string Path
    */
-  public function settingsPhpDirectory() {
-    $webSitesPath = $this->destination . 'web/sites/';
+  public function validateSiteRoot() {
+    $webSitesPath = $this->getWebRoot() . 'sites/';
     $settingsPath = $webSitesPath . 'default';
 
+    // It's possible that a command is run before the site is available. e.g. checkout
+    // We will skip setting in this situation, but throw an Exception in the site root getter to prevent any unpredictable behaviour.
+    if (!file_exists($settingsPath)) {
+      return;
+    }
+
     $command = sprintf(
       'cd %s && find . -name settings.php',
       $this->shellPath($webSitesPath)
@@ -359,16 +429,36 @@ public function settingsPhpDirectory() {
       $settingsPath .= '/';
     }
 
-    return $settingsPath;
+    // Fix folder permissions.
+    $this->fixSiteFolderPermissions();
+
+    $this->siteRoot = $settingsPath;
+  }
+
+  /**
+   * Fixes the site folder permissions which is often changed by Drupal core.
+   */
+  protected function fixSiteFolderPermissions() {
+    if ($this->hasSiteRoot()) {
+      $commands[] = sprintf('chmod 777 %s', $this->getSiteRoot());
+      $commands[] = sprintf('chmod 777 %ssettings.php', $this->getSiteRoot());
+      $command = implode(' && ', $commands);
+      $this->io->commentBlock($command);
+      $shellProcess = $this->getShellProcess();
+      if (!$shellProcess->exec($command, TRUE)) {
+        throw new CommandException($shellProcess->getOutput());
+      }
+    }
   }
 
   /**
    * Get the shell process.
    *
-   * @return Drupal\Console\Core\Command\Exec\ExecCommand
+   * @return ShellProcess
    */
   protected function getShellProcess() {
-    return $this->container->get('console.shell_process');
+    $app_root = $this->container->get('app.root');
+    return new ShellProcess($app_root);
   }
 
   /**

src/Command/Site/AbstractConfigCommand.php

@@ -79,7 +79,6 @@ protected function configure() {
    */
   protected function interact(InputInterface $input, OutputInterface $output) {
     parent::interact($input, $output);
-
   }
 
   /**
@@ -97,8 +96,8 @@ protected function execute(InputInterface $input, OutputInterface $output) {
    * @throws \DennisDigital\Drupal\Console\Exception\CommandException
    */
   protected function generateConfigFile() {
-    $this->template = $this->destination . $this->template;
-    $this->filename = $this->destination . $this->filename;
+    $this->template = $this->getRoot() . $this->template;
+    $this->filename = $this->getRoot() . $this->filename;
 
     // Validation.
     if (!$this->fileExists($this->template)) {