ISAICP-5707 - Hack to improve search bar visibility on search pages.

.dockerignore

@@ -30,8 +30,7 @@ tests/behat.yml
 web/phpunit.xml
 web/sites/default/services.yml
 
-# Ignore compiled CSS and SASS cache.
-.sass-cache/
+# Ignore compiled CSS.
 web/themes/joinup/css
 web/themes/joinup/prototype/css/*.css
 # Ignore theme libraries

.env.dist

@@ -0,0 +1,27 @@
+# Default environment variables for Joinup.
+#
+# Declaring sensitive data in environment variables is an industry standard, as
+# it is a very friendly mechanism for configuring the applications on different
+# environments and in continuous intergartion flows, as well. Depending on the
+# development environment or developer practices, the system environment
+# variables can be assigned in different ways, most simple is declaring them in
+# the `~/.bashrc` or `~/.zshrc` files on Bash respectively Z shells. But some
+# prefer to keep them inside the project's directory tree, as they are project
+# specific variables. In order to do so, just copy the lines from this file that
+# you want to override to an empty file named `.env` and fill in the sensitive
+# values. Note that the `.env` file is not under VCS control and should not be
+# committed.
+
+ASDA_URL=
+ASDA_USER=
+ASDA_PASSWORD=
+
+SPARQL_HOST=virtuoso
+SPARQL_PORT=8890
+SPARQL_USER=dba
+SPARQL_PASSWORD=dba
+
+SOLR_CORE_PUBLISHED_NAME=drupal_published
+SOLR_CORE_PUBLISHED_URL=http://solr_published:8983/solr
+SOLR_CORE_UNPUBLISHED_NAME=drupal_unpublished
+SOLR_CORE_UNPUBLISHED_URL=http://solr_unpublished:8983/solr

.gitignore

@@ -21,19 +21,22 @@
 /web/sites/simpletest/
 
 # Ignore environment specific settings
+/.env
 /build.common.xml
 /build.local.xml
 /build.properties.local
 /drush/drush.yml
+/grumphp.yml
 /phpcs.xml
+/phpunit.xml
+/runner.yml
 /tests/behat.yml
-/web/phpunit.xml
 /web/sites/default/services.yml
 
-# Ignore compiled CSS and SASS cache.
-.sass-cache/
+# Ignore compiled CSS.
 /web/themes/joinup/css
 /web/themes/joinup/prototype/css/*.css
+
 # Ignore theme libraries
 /web/themes/joinup/vendor
 
@@ -43,8 +46,9 @@
 # Ignore the config_readonly killswitch.
 /disable-config-readonly
 
-# Ignore temporary files
+# Ignore temporary and auto-generated files.
 /tmp
+/VERSION
 
 # Ignore local docker-compose file.
 docker-compose.local.yml

.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

@@ -35,10 +35,12 @@ To start with docker, please, check the separated [README file](resources/docker
 
 To run Joinup locally, below is a list of requirements and instructions.
 
+#### On macOS without Docker installation
+To start on macOS without Docker, please, check the separated [README file](resources/mac/README.md).
+
 #### Requirements
 * A regular LAMP stack running PHP 7.1.0 or higher
 * Virtuoso 7 (Triplestore database)
-* SASS compiler
 * Apache Solr
 
 #### Dependency management and builds
@@ -66,12 +68,13 @@ run the Behat test, please refer directly to the documention of
 * Install Solr. If you already have Solr installed you can configure it manually
   by [following the installation
   instructions](http://cgit.drupalcode.org/search_api_solr/plain/INSTALL.txt?h=8.x-1.x)
-  from the Search API Solr module. Or you can execute the following command to
+  from the Search API Solr module. Or you can execute the following commands to
   download and configure a local instance of Solr. It will be installed in the
   folder `./vendor/apache/solr`.
 
     ```
-    $ ./vendor/bin/phing setup-apache-solr
+    $ ./vendor/bin/run solr:download-bin
+    $ ./vendor/bin/run solr:config
     ```
 
 * Install Virtuoso. For basic instructions, see [setting up
@@ -85,13 +88,6 @@ run the Behat test, please refer directly to the documention of
     DirsAllowed = /var/www/joinup/resources/fixtures, /usr/share/virtuoso-opensource-7/vad
     ```
 
-* Install the official [SASS compiler](https://github.com/sass/sass). This
-  depends on Ruby being installed on your system.
-
-    ```
-    $ gem install sass
-    ```
-
 * Install [Selenium](https://github.com/SeleniumHQ/docker-selenium/blob/master/README.md).
   The simplest way of doing this is using Docker to install and run it with a
   single command. This will download all necessary files and start the browser
@@ -111,52 +107,62 @@ 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
 
 # The base URL to use in tests.
 drupal.base_url = http://joinup.local
 
+## Development settings.
+
 # Verbosity of Drush commands. Set to 'yes' for verbose output.
 drush.verbose = yes
+
+# Disable config readonly for local development.
+config_readonly.enabled = FALSE
+
+# Do not redirect emails to disk.
+# Set this to false when you are grabbing the emails using e.g. mailcatcher.
+drupal.redirect.email = no
 ```
 
+#### 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
+`./resources/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 `.env.dist` for
+details.
 
 #### Build the project
 
@@ -204,6 +210,40 @@ $ ../vendor/bin/phpunit
 See the [readme](web/themes/joinup/README.md) in the theme folder.
 
 
+### Upgrade process
+
+Joinup offers only _contiguous upgrades_. For instance, if you project is
+currently on Joinup `v1.39.2`, and the latest stable version is `v1.42.0`, then
+you cannot upgrade directly to the latest version. Instead, you should upgrade
+first to `v1.40.0`, second to `v1.40.1` (if exists) and, finally, to `v1.42.0`.
+
+The Joinup update and post-update scripts naming is following this pattern:
+
+`function mymodule_update_0106100() {...}`
+
+or
+
+`function mymodule_post_update_0207503() {...}`
+
+The (post)updated identifier (the numeric part consists in seven digits with the
+following meaning:
+
+* The first two digits are the Joinup major version.
+* The following three digits are the Joinup minor version.
+* The last two digits are an integer that sets the weight within updates or
+  post updates from the same extension (module or profile). `00` is the first
+  (post)update that applies.
+
+For the above example:
+
+* `function mymodule_update_0106100() {...}`: Was applied in Joinup `v1.61.x` as
+  the first update of the `mymodule` module (`01` major version, `061` minor
+  version, `00` update weight within the module).
+* `function mymodule_post_update_0207503() {...}`: Was applied in Joinup
+  `v2.75.x` as the fourth post update of the `mymodule` module (`02` major
+  version, `075` minor version, `03` update weight within the module).
+
+
 ### Technical details
 
 * In [Rdf draft module](web/modules/custom/rdf_entity/rdf_draft/README.md)

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/"
+              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="Report Solr status" />
-        <exec dir="${project.basedir}"
-              command="sudo /opt/solr/bin/solr status"
-              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,20 +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" >
-        <echo message="Install the SASS compiler" />
-        <exec dir="${project.basedir}"
-              command="gem install sass"
-              checkreturn="true"
-              passthru="true" />
-        <!-- 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" />
@@ -102,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">
@@ -118,4 +60,9 @@ sudo rsync -avz /opt/solr/search_api_solr/solr-conf/6.x/ /opt/solr/server/solr/d
                milliseconds="${sleep.milliseconds}"/>
     </target>
 
+    <!-- Checks to execute during build phase to exit early in case of easily preventable errors. -->
+    <target name="sanity-check">
+        <exec command="./vendor/bin/run dev:check-deprecated-code" checkreturn="true" passthru="true" />
+    </target>
+
 </project>