ISAICP-5825: Introduce Toolkit

.gitignore

@@ -25,14 +25,18 @@
 /build.local.xml
 /build.properties.local
 /drush/drush.yml
+/grumphp.yml
+/local.env
 /phpcs.xml
-/tests/behat.yml
 /phpunit.xml
+/runner.yml
+/tests/behat.yml
 /web/sites/default/services.yml
 
 # Ignore compiled CSS.
 /web/themes/joinup/css
 /web/themes/joinup/prototype/css/*.css
+
 # Ignore theme libraries
 /web/themes/joinup/vendor
 

.opts.yml

@@ -0,0 +1,10 @@
+upgrade_commands:
+  default:
+    - ${drush.bin} state:set system.maintenance_mode 1 --input-format=integer --yes
+    - ${phing.bin} disable-config-read-only
+    - ${phing.bin} redis-flush
+    - ${drush.bin} updatedb --no-post-updates --yes
+    - ${drush.bin} config:import --yes
+    - ${drush.bin} updatedb --yes
+    - ${phing.bin} enable-config-read-only
+    - ${drush.bin} state:set system.maintenance_mode 0 --input-format=integer --yes

README.md

@@ -73,7 +73,7 @@ run the Behat test, please refer directly to the documention of
   folder `./vendor/apache/solr`.
 
     ```
-    $ ./vendor/bin/phing setup-apache-solr
+    $ ./vendor/bin/run solr:setup
     ```
 
 * Install Virtuoso. For basic instructions, see [setting up
@@ -106,41 +106,29 @@ using your favourite text editor:
 $ vim build.properties.local
 ```
 
-This file will contain configuration which is unique to your development
+This file will contain the configuration which is unique to your development
 machine. This is mainly useful for specifying your database credentials and the
-username and password of the Drupal admin user so they can be used during the
+username and password of the Drupal admin user, so they can be used during the
 installation.
 
 Because these settings are personal they should not be shared with the rest of
 the team. Make sure you never commit this file!
 
-All options you can use can be found in the `build.properties.dist` file. Just
-copy the lines you want to override and change their values. Do not copy the
-entire `build.properties.dist` file, since this would override all options.
+All options you can use can be found in the `build.properties` file. Just copy
+the lines you want to override and change their values. Do not copy the entire
+`build.properties` file, since this would override all options.
 
 Example `build.properties.local`:
 
 ```
 # The location of the Composer binary.
 composer.bin = /usr/bin/composer
 
-# The location of the Virtuoso console (Debian / Ubuntu).
-isql.bin = /usr/bin/virtuoso-isql
-# The location of the Virtuoso console (Arch Linux).
-isql.bin = /usr/bin/virtuoso-isql
-# The location of the Virtuoso console (Redhat / Fedora / OSX with Homebrew).
-isql.bin = /usr/local/bin/isql
-
 # SQL database settings.
 drupal.db.name = my_database
 drupal.db.user = root
 drupal.db.password = hunter2
 
-# SPARQL database settings.
-sparql.dsn = localhost
-sparql.user = my_username
-sparql.password = qwerty123
-
 # Admin user.
 drupal.admin.username = admin
 drupal.admin.password = admin
@@ -152,6 +140,19 @@ drupal.base_url = http://joinup.local
 drush.verbose = yes
 ```
 
+#### Create a local task runner configuration file
+
+In order to override any configuration of the task runner (`./vendor/bin/run`),
+create a `runner.yml` file in the project's top directory. You can override
+there any default runner configuration, or any other declared in `./runner`
+files or in `runner.yml.dist`. Note that the `runner.yml` file is not under VCS
+control.
+
+#### Setup environment variables
+
+Sensitive data will be stored in [environment variables](
+https://en.wikipedia.org/wiki/Environment_variable). See `local.env.dist` for
+details.
 
 #### Build the project
 

build.continuousphp.xml

@@ -2,61 +2,20 @@
 
 <project name="ContinuousPHP" default="help">
 
-    <echo msg="Loading AWS additional tasks." />
-    <import file="./vendor/continuousphp/aws-sdk-phing/tasks.xml" />
-    <property name="aws.profile" value="" />
-
-    <echo msg="Turn environment variable into a phing property" />
-    <taskdef name="env2property" classname="\DrupalProject\Phing\EnvironmentVarAsProperty" />
-
-    <echo msg="Loading infra additional tasks." />
-    <import file="./vendor/ec-europa/infra/infra.xml" />
-
-    <!-- Run Behat tests. -->
-    <!-- Use this target to run tests with increased verbosity on ContinuousPHP to help debugging. -->
-    <target name="run-behat-tests" description="Run Behat tests.">
-        <behat
-            executable="${behat.bin}"
-            config="${behat.yml.path}"
-            strict="${behat.options.strict}"
-            verbose="${behat.options.verbosity}"
-        />
-    </target>
-
-    <target name="setup-continuousphp"
-            depends="check-continuousphp">
+    <target name="setup-continuousphp" depends="check-continuousphp">
         <echo msg="Set the virtuoso checkpoint to -1. Do not use a checkpoint for CPHP testing."/>
         <phingcall target="set-virtuoso-checkpoint">
             <property name="interval" value="-1"/>
         </phingcall>
-        <echo message="Put the odbc configuration file in the home folder where CPHP can find it" />
-        <copy
-            file="./vendor/ec-europa/infra/continuousphp/odbc.ini"
-            tofile="${user.home}/.odbc.ini"
-            overwrite="true" />
+
         <echo message="Create Solr index" />
         <exec dir="${project.basedir}"
-              command="sudo curl -o /opt/solr/search_api_solr.tar.gz https://ftp.drupal.org/files/projects/search_api_solr-8.x-1.0-alpha4.tar.gz;
-sudo tar xvzf /opt/solr/search_api_solr.tar.gz -C /opt/solr;
-sudo /opt/solr/bin/solr create_core -c drupal_published;
-sudo mkdir /opt/solr/server/solr/drupal_published;
-sudo rsync -avz /opt/solr/search_api_solr/solr-conf/6.x/ /opt/solr/server/solr/drupal_published/conf/;
-sudo /opt/solr/bin/solr create_core -c drupal_unpublished;
-sudo mkdir /opt/solr/server/solr/drupal_unpublished;
-sudo rsync -avz /opt/solr/search_api_solr/solr-conf/6.x/ /opt/solr/server/solr/drupal_unpublished/conf/"
-              checkreturn="true"
-              passthru="true" />
-        <echo message="Report Solr status" />
-        <exec dir="${project.basedir}"
-              command="sudo /opt/solr/bin/solr status"
+              command="sudo chmod -R 777 /opt/solr > /dev/null;
+/opt/solr/bin/solr create_core -c drupal_published -d ${project.basedir}/web/modules/contrib/search_api_solr/solr-conf/6.x/;
+/opt/solr/bin/solr create_core -c drupal_unpublished -d ${project.basedir}/web/modules/contrib/search_api_solr/solr-conf/6.x/"
               checkreturn="true"
               passthru="true" />
-        <echo message="Restart Solr" />
-        <exec dir="${project.basedir}"
-              command="sudo /opt/solr/bin/solr restart"
-              checkreturn="true"
-              passthru="true"
-              spawn="true" />
+        <symlink link="${project.basedir}/vendor/bin/solr" target="/opt/solr/bin/solr"/>
     </target>
 
     <target name="check-continuousphp">
@@ -71,15 +30,7 @@ sudo rsync -avz /opt/solr/search_api_solr/solr-conf/6.x/ /opt/solr/server/solr/d
         </if>
     </target>
 
-    <target name="build-continuousphp" >
-        <!-- Set environment variables as extra properties through cloudformation -->
-        <env2property prefix="cphp" phingproperty="cloudformation.properties" />
-        <echo message="Copy CPHP pipeline variables to local properties file" />
-        <echoproperties prefix="cphp." destfile="build.properties.local" />
-        <exec dir="${project.basedir}"
-              command="sed -i 's/^cphp\.//' build.properties.local"
-              checkreturn="true"
-              passthru="true" />
+    <target name="build-continuousphp" depends="check-continuousphp">
         <echo message="Create the Behat configuration files to run in parallel." />
         <phingcall target="setup-behat">
             <property name="behat.yml.path" value="${behat.dir}/behat-only-selenium-cphp.yml" />
@@ -97,12 +48,8 @@ sudo rsync -avz /opt/solr/search_api_solr/solr-conf/6.x/ /opt/solr/server/solr/d
             <property name="behat.yml.path" value="${behat.dir}/behat-remainder-cphp.yml" />
             <property name="behat.yml.template" value="${behat.dir}/behat-remainder-cphp.yml.dist" />
         </phingcall>
-    </target>
 
-    <!-- provision new demo/test stack on AWS -->
-    <target name="provision-stack"
-            description="Provision a stack on AWS"
-            depends="setup-aws, run-stack, setup-deployment-group" />
+    </target>
 
     <!-- Sleeps to allow services to get up and be ready -->
     <target name="sleep">

build.converted.xml

@@ -0,0 +1,149 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<project name="Joinup deprecated" default="help">
+
+    <target name="runner-converted" hidden="true">
+        <fail message="Target has been deprecated. Run './vendor/bin/run ${runner.replacement}'"/>
+    </target>
+
+    <!-- Download & restore -->
+
+    <target name="download-databases">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="dev:download-databases"/>
+        </phingcall>
+    </target>
+
+    <target name="restore-databases">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="dev:restore-databases"/>
+        </phingcall>
+    </target>
+
+    <target name="execute-updates">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="toolkit:run-deploy"/>
+        </phingcall>
+    </target>
+
+    <target name="rebuild-environment">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="dev:rebuild-environment"/>
+        </phingcall>
+    </target>
+
+    <!-- MySQL -->
+
+    <target name="download-sql-database">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="mysql:download-dump"/>
+        </phingcall>
+    </target>
+
+    <target name="restore-mysql-dump">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="mysql:restore"/>
+        </phingcall>
+    </target>
+
+    <!-- Virtuoso -->
+
+    <target name="download-virtuoso-database">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="virtuoso:download-snapshot"/>
+        </phingcall>
+    </target>
+
+    <target name="virtuoso-restore-backup">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="virtuoso:restore"/>
+        </phingcall>
+    </target>
+
+    <target name="virtuoso-start">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="virtuoso:start"/>
+        </phingcall>
+    </target>
+
+    <target name="virtuoso-stop">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="virtuoso:stop"/>
+        </phingcall>
+    </target>
+
+    <target name="virtuoso-setup">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="virtuoso:setup"/>
+        </phingcall>
+    </target>
+
+    <!-- Solr -->
+
+    <target name="start-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:start"/>
+        </phingcall>
+    </target>
+
+    <target name="stop-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:stop"/>
+        </phingcall>
+    </target>
+
+    <target name="restart-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:restart"/>
+        </phingcall>
+    </target>
+
+    <target name="download-apache-solr-snapshot">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:download-snapshot"/>
+        </phingcall>
+    </target>
+
+    <target name="backup-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:backup"/>
+        </phingcall>
+    </target>
+
+    <target name="restore-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:restore"/>
+        </phingcall>
+    </target>
+
+    <target name="purge-solr-backend">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:empty"/>
+        </phingcall>
+    </target>
+
+    <target name="download-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:download-bin"/>
+        </phingcall>
+    </target>
+
+    <target name="configure-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:config"/>
+        </phingcall>
+    </target>
+
+    <target name="setup-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:setup"/>
+        </phingcall>
+    </target>
+
+    <target name="reindex-apache-solr">
+        <phingcall target="runner-converted">
+            <property name="runner.replacement" value="solr:reindex"/>
+        </phingcall>
+    </target>
+
+</project>