ACSF support for deploy step (acquia#18)

* ACSF support for deploy step

* Deploy update to include .gitignore files and to use consistent tags.

* ACSF Update for composer.

Use drush as a dev dependency only.
This resolves issues with ACSF.

* Update ACSF related settings in settings.php and readme.

* Update deploy:acsf:init to work without drush.

included `-r ${deploy.dir}/docroot`

* ACSF readme note about factory hooks.

Author: damontgomery

template/build/core/phing/tasks/deploy.xml

@@ -51,6 +51,13 @@
 
   <target name="deploy:artifact:build" description="Generates a deploy-ready build in deploy.dir."
           depends="deploy:artifact:clean, deploy:artifact:copy, deploy:artifact:composer:install, deploy:artifact:profile:make, frontend:build, deploy:artifact:sanitize">
+    <!-- If we are using ACSF, run the ACSF Deploy command. -->
+    <if>
+      <equals arg1="${hosting}" arg2="acsf"/>
+      <then>
+        <phingcall target="deploy:acsf:init"/>
+      </then>
+    </if>
   </target>
 
   <target name="deploy:artifact:clean" description="Deletes the contents of the deploy dir.">
@@ -99,11 +106,13 @@
 
     <!-- Copy required files from docroot. -->
     <copy todir="${deploy.dir}/docroot" overwrite="true">
-      <fileset dir="${docroot}">
+      <fileset dir="${docroot}" defaultexcludes="false">
         <!-- This should be similar to .gitigore. -->
-        <include name="**"></include>
+        <!-- We remove default excludes because they include .gitignore files we need, like the ACSF one. -->
+        <include name="**" />
         <exclude name="**/local.*" />
         <exclude name=".gitkeep" />
+        <exclude name=".DS_STORE" />
         <exclude name="core/**" />
         <exclude name="drush/contrib/**" />
         <exclude name="example.gitignore" />
@@ -113,8 +122,8 @@
         <exclude name="themes/contrib/**" />
         <exclude name="profiles/contrib/**" />
         <exclude name="modules/contrib/**" />
-        <exclude name="**/node_modules/**"></exclude>
-        <exclude name="**/bower_components/**"></exclude>
+        <exclude name="**/node_modules/**" />
+        <exclude name="**/bower_components/**" />
       </fileset>
     </copy>
 
@@ -170,4 +179,9 @@
       </fileset>
     </delete>
   </target>
+
+  <target name="deploy:acsf:init" description="Re-initialize ACSF with the settings.php changes required for artifact.">
+    <chmod file="${deploy.dir}/docroot/sites/default/settings.php" mode="0755" />
+    <exec dir="${deploy.dir}/docroot" command="${drush.bin} --include=${deploy.dir}/docroot/modules/contrib/acsf/acsf_init acsf-init -r ${deploy.dir}/docroot -y" logoutput="true" checkreturn="true"/>
+  </target>
 </project>

template/composer.json

@@ -10,7 +10,6 @@
   ],
   "require": {
     "composer/installers": "^1.0.20",
-    "drush/drush": "dev-master",
     "drupal/acquia_connector": "8.1.*",
     "drupal/acsf": "~8.1",
     "drupal/core": "~8",
@@ -28,6 +27,7 @@
     "behat/mink-goutte-driver":     "*",
     "behat/mink-selenium2-driver":  "*",
     "behat/mink-browserkit-driver": "*",
+    "drush/drush":                  "dev-master",
     "drupal/drupal-extension":      "~3.0",
     "drupal/coder":                 "~8.2",
     "phpunit/phpunit":              "4.6.*",
@@ -54,9 +54,6 @@
     "patches": {
       "drupal/core": {
         "Ignore front end vendor folders to improve directory search performance": "https://www.drupal.org/files/issues/ignore_front_end_vendor-2329453-116.patch"
-      },
-      "drupal/acsf": {
-        "Allow custom settings.php": "https://www.drupal.org/files/issues/acsf-2706365-2.patch"
       }
     }
   },

template/composer.lock

@@ -712,32 +712,13 @@
  * Acquia Cloud settings.
  */
 if ($is_ah_env && file_exists('/var/www/site-php')) {
+  require "/var/www/site-php/{$_ENV['AH_SITE_GROUP']}/{$_ENV['AH_SITE_GROUP']}-settings.inc";
 
-  // This is ACSF. Below copied from acsf_init example settings.
-  if ($is_acsf) {
-    /**
-     * A user who gets here is trying to visit a site that is not yet registered
-     * with either the Site Factory or Hosting.
-     */
-
-    // Don't run any of this code if we are drush or a CLI script.
-    if (function_exists('drush_main') || !\Drupal::hasContainer() || PHP_SAPI === 'cli') {
-      if (!function_exists('drush_main')) {
-        header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
-      }
-      return;
-    }
-  }
-  // This is ACE.
-  else {
-    require "/var/www/site-php/{$_ENV['AH_SITE_GROUP']}/{$_ENV['AH_SITE_GROUP']}-settings.inc";
-
-    // Store API Keys and things outside of version control.
-    // @see settings/sample-secrets.settings.php for sample code.
-    $secrets_file = sprintf('/mnt/gfs/%s.%s/secrets.settings.php', $_ENV['AH_SITE_GROUP'], $_ENV['AH_SITE_ENVIRONMENT']);
-    if (file_exists($secrets_file)) {
-      require $secrets_file;
-    }
+  // Store API Keys and things outside of version control.
+  // @see settings/sample-secrets.settings.php for sample code.
+  $secrets_file = sprintf('/mnt/gfs/%s.%s/secrets.settings.php', $_ENV['AH_SITE_GROUP'], $_ENV['AH_SITE_ENVIRONMENT']);
+  if (file_exists($secrets_file)) {
+    require $secrets_file;
   }
 }
 

template/docroot/sites/default/settings.php

@@ -28,3 +28,8 @@ drush:
     remote: ${acquia_subname}.test
     # The local environment against which all local drush commands are run.
     local: self
+
+# Hosting environment flags.
+# Examples: acsf (Acquia Cloud Site Factory), ac (Acquia Cloud)
+# hosting: "acsf"
+# hosting: "ac"

template/project.yml

@@ -1,6 +1,15 @@
 # ACSF Setup
 
 To configure a project to run on ACSF, perform the following steps after initially setting up Bolt:
- 
+
+1. Add a `hosting` variable set to `acsf` in `project.yml`
 1. Execute `./bolt.sh acsf:init` from the project root.
 1. Add the acsf module as a dependency to your installation profile.
+
+## Factory Hooks and settings.php
+
+Acquia Cloud Site Factory does not allow changes to `settings.php`. In order to make additions normally done with `settings.php`, factory hooks are used.
+
+Please see the documentation below for reference.
+
+[https://docs.acquia.com/site-factory/tiers/paas/workflow/hooks](https://docs.acquia.com/site-factory/tiers/paas/workflow/hooks)