Merge branch 'release/3.0.7'

Release/3.0.7

.ahoy.yml

@@ -0,0 +1,201 @@
+---
+ahoyapi: v2
+
+commands:
+  build:
+    usage: Build or rebuild project.
+    cmd: |
+      ahoy clean \
+      && if [ "$COMPOSER" != "composer.json" ]; then ahoy composer-merge; fi \
+      && if [ "$COMPOSER" != "composer.json" ]; then ahoy link-package; fi \
+      && (docker network prune -f > /dev/null && docker network inspect amazeeio-network > /dev/null || docker network create amazeeio-network) \
+      && ahoy up -- --build --force-recreate \
+      && ahoy install-dev \
+      && if [ "$COMPOSER" != "composer.json" ] && [ "$DRUPAL_PROFILE" ]; then ahoy init-profile; fi \
+      && ahoy install-site \
+      && if [ "$COMPOSER" != "composer.json" ]; then ahoy init-module; fi \
+      && if [ "$COMPOSER" != "composer.json" ]; then ahoy drush pm-enable tide_test -y; fi \
+      && ahoy line "Build complete" \
+      && ahoy info 1
+
+  info:
+    usage: Print information about this project.
+    cmd: |
+      ahoy line "Site URL              : " ${LOCALDEV_URL}:${LOCAL_PORT:-80}/
+      ahoy line "Path to project       : " ${APP}
+      ahoy line "Path to docroot       : " ${APP}/${WEBROOT}
+      ahoy line "DB port on host       : " $(docker port $(docker-compose ps -q mariadb) 3306 | cut -d : -f 2)
+      ahoy line "Mailhog URL           : " http://mailhog.docker.internal:${LOCAL_PORT:-80}/
+      if [ "$1" ]; then
+        ahoy line "One-time login        : " $(ahoy login -- --no-browser)
+      fi
+
+  up:
+    usage: Build and start Docker containers.
+    cmd: |
+      docker-compose up -d "$@" \
+      && ahoy cli "dockerize -wait tcp://mariadb:3306 -timeout 1m" \
+      && if docker-compose logs | grep -q "\[Error\]"; then docker-compose logs; exit 1; fi \
+      && docker ps -a --filter name=^/${COMPOSE_PROJECT_NAME}_ &&
+      # Add Bay SSH key before fetching DB.
+      # During local development, pygmy injects SSH key from the host, so specifying
+      # key as $BAY_KEY environment variable is not required (the host key of every
+      # developer must be added to Bay during project onboarding).
+      if [ "$BAY_KEY" ]; then
+        ahoy cli "mkdir -p /home/.ssh && echo -e \"$BAY_KEY\" > /home/.ssh/key && chmod 600 /home/.ssh/key;"
+      fi
+
+  down:
+    usage: Stop Docker containers and remove container, images, volumes and networks.
+    cmd: docker-compose down --volumes
+
+  start:
+    usage: Start existing Docker containers.
+    cmd: docker-compose start "$@"
+
+  stop:
+    usage: Stop running Docker containers.
+    cmd: docker-compose stop "$@"
+
+  restart:
+    usage: Restart all stopped and running Docker containers.
+    cmd: docker-compose restart
+
+  logs:
+    usage: Show Docker logs.
+    cmd: docker-compose logs "$@"
+
+  pull:
+    usage: Pull latest docker images.
+    cmd: |
+      docker image ls --format \"{{.Repository}}:{{.Tag}}\" | grep singledigital/ | grep -v none | xargs -n1 docker pull | cat \
+      && docker image ls --format \"{{.Repository}}:{{.Tag}}\" | grep amazeeio/ | grep -v none | xargs -n1 docker pull | cat
+
+  cli:
+    usage: Start a shell inside CLI container or run a command.
+    cmd: if \[ "$@" \]; then docker exec -i $(docker-compose ps -q cli) bash -c "$@"; else docker exec -it $(docker-compose ps -q cli) bash; fi
+
+  drush:
+    usage: Run drush commands in the CLI service container.
+    cmd: docker exec -i $(docker-compose ps -q cli) drush -r ${APP}/${WEBROOT} -l ${LOCALDEV_URL} "$@"
+
+  login:
+    usage: Login to a website.
+    cmd: ahoy drush user:unblock -q "$(ahoy drush user:information --uid=1 --fields=name --format=string)" 2>/dev/null && ahoy drush user:login --no-browser
+
+  doctor:
+    usage: Find problems with current project setup.
+    cmd: scripts/doctor.sh
+
+  # @note: Call this on the host before starting containers.
+  composer-merge:
+    usage: Merge composer files.
+    cmd: scripts/composer-merge.sh
+
+  install-dev:
+    usage: Install dependencies.
+    cmd: ahoy cli "composer install -n --ansi --prefer-dist --no-suggest"
+
+  install-site:
+    usage: Install site.
+    cmd: |
+      ahoy flush-redis
+      if [ "$INSTALL_NEW_SITE" == "1" ]; then
+        ahoy cli -- ./scripts/drupal/install-new-site.sh
+      else
+        ahoy cli -- ./scripts/rebuild-env.sh
+      fi
+
+  db-import:
+    usage: Import the production database.
+    cmd: ahoy cli -- ./scripts/rebuild-env.sh
+
+  fix-bay-token:
+    usage: Fix the bay token by re-importing.
+    cmd: |
+      pygmy stop \
+      && sleep 1 \
+      && pygmy start \
+      && docker ps -a | grep Exit | cut -d ' ' -f 1 | xargs docker rm \
+      && docker-compose up -d --force \
+      && pygmy stop \
+      && sleep 1 \
+      && pygmy start
+
+  link-package:
+    usage: Link package from current repository root.
+    cmd: scripts/link-package.sh
+    hide: true
+
+  init-module:
+    usage: Install a module from current repository root.
+    cmd: ahoy cli "INSTALL_SUGGEST=$INSTALL_SUGGEST scripts/drupal-init-module.sh"
+    hide: true
+
+  init-profile:
+    usage: Install a profile from current repository root.
+    cmd: ahoy cli "INSTALL_SUGGEST=$INSTALL_SUGGEST scripts/drupal-init-profile.sh"
+    hide: true
+
+  clean:
+    usage: Remove all build files.
+    cmd: |
+      ahoy down \
+      && ([ -d .git ] && git ls-files --directory --other -i --exclude-from=.gitignore ${WEBROOT} | grep -v "settings.local.php" | grep -v "services.local.yml" | xargs chmod -Rf 777 || true) \
+      && ([ -d .git ] && git ls-files --directory --other -i --exclude-from=.gitignore ${WEBROOT} | grep -v "settings.local.php" | grep -v "services.local.yml" | xargs rm -Rf || true) \
+      && rm -Rf vendor \
+      && rm -Rf screenshots \
+      && rm -Rf composer.build.*
+
+  clean-full:
+    usage: Remove all development files.
+    cmd: |
+      ahoy clean \
+      && ([ -d .git ] && git ls-files --directory --other . | grep -v ".idea" | xargs chmod -Rf 777 || true) \
+      && ([ -d .git ] && git ls-files --directory --other . | grep -v ".idea" | xargs rm -Rf || true)
+
+  deploy:
+    usage: Deploy or re-deploy a branch in Bay.
+    cmd: ./scripts/bay-deploy.sh "$@"
+
+  lint:
+    usage: Lint code.
+    cmd: ahoy cli "vendor/bin/phpcs ${PHPCS_TARGETS}"
+
+  test-behat:
+    usage: Run Behat tests.
+    cmd: ahoy cli "./vendor/bin/behat --strict --colors ${BEHAT_PROFILE} $@"
+
+  flush-redis:
+    usage: Flush Redis cache.
+    cmd: docker exec -i $(docker-compose ps -q redis) redis-cli flushall > /dev/null
+
+  set-dev-tools-commit:
+    usage: Specify a commit of Dev-Tools to downloaded and commit the result.
+    cmd: sed  -i '' 's/.*GH_COMMIT.*/'"export GH_COMMIT=$1"'/' dev-tools.sh
+
+  # Utilities.
+  line:
+    cmd: printf "$(tput -Txterm setaf 2)${1}$(tput -Txterm sgr0)${2}\n"
+    hide: true
+
+entrypoint:
+- bash
+- "-c"
+- |
+  [ -f .env ] && export $(grep -v '^#' .env | xargs) && [ -f .env.local ] && export $(grep -v '^#' .env.local | xargs)
+  export PROJECT_NAME=${PROJECT_NAME:-$(basename $(pwd))}
+  export APP=${APP:-/app}
+  export WEBROOT=${WEBROOT:-docroot}
+  export MYSQL_HOST=${MYSQL_HOST:-mariadb}
+  export MYSQL_PORT=${MYSQL_PORT:-3306}
+  export COMPOSE_PROJECT_NAME=${COMPOSE_PROJECT_NAME:-$PROJECT_NAME}
+  export LOCALDEV_URL=${LOCALDEV_URL:-http://content-sdp.docker.internal}
+  export COMPOSER=${COMPOSER:-composer.json}
+  export DRUPAL_PROFILE=${DRUPAL_PROFILE:-}
+  export DRUPAL_MODULE_PREFIX=${DRUPAL_MODULE_PREFIX:-mysite}
+  PHPCS_TARGETS=${PHPCS_TARGETS:-.} && export PHPCS_TARGETS=${PHPCS_TARGETS//,/ }
+  if [ "$CI" ]; then export ES_TPL=elasticsearch.ci.yml; fi
+  bash -c "$0" "$@"
+- '{{cmd}}'
+- '{{name}}'

.docker/Caddyfile

@@ -0,0 +1,9 @@
+content-sdp.docker.internal:80 {
+  reverse_proxy nginx:8080
+}
+elasticsearch.docker.internal:80 {
+  reverse_proxy elasticsearch:9200
+}
+mailhog.docker.internal:80 {
+  reverse_proxy mailhog:8025
+}

.docker/Dockerfile.elasticsearch

@@ -1,11 +1,8 @@
-FROM amazeeio/elasticsearch:7-latest
+FROM singledigital/bay-elasticsearch:5.x
 ARG ES_TPL
 
 ENV ES_TPL=${ES_TPL:-elasticsearch.yml}
 
-RUN bin/elasticsearch-plugin install analysis-kuromoji \
-    && bin/elasticsearch-plugin install analysis-icu
-
 COPY .docker/elasticsearch.yml .docker/elasticsearch.* /tmp/elasticsearch/
 
 RUN mkdir -p config \

.docker/elasticsearch.ci.yml

@@ -0,0 +1,14 @@
+cluster.name: "docker-cluster"
+network.host: 0.0.0.0
+transport.host: localhost
+
+discovery.type: single-node
+xpack.license.self_generated.type: basic
+xpack.security.enabled: false
+
+path.repo: ["/usr/share/elasticsearch/data/snapshots"]
+
+http.cors.enabled: true
+http.cors.allow-origin: "*"
+http.cors.allow-methods : OPTIONS, HEAD, GET
+http.cors.allow-headers : X-Requested-With, X-Auth-Token, Content-Type, Content-Length

.docker/elasticsearch.yml

@@ -0,0 +1,13 @@
+cluster.name: "docker-cluster"
+network.host: 0.0.0.0
+
+discovery.type: single-node
+xpack.license.self_generated.type: basic
+xpack.security.enabled: false
+
+path.repo: ["/usr/share/elasticsearch/data/snapshots"]
+
+http.cors.enabled: true
+http.cors.allow-origin: "*"
+http.cors.allow-methods : OPTIONS, HEAD, GET
+http.cors.allow-headers : X-Requested-With, X-Auth-Token, Content-Type, Content-Length

.gitattributes

@@ -1,8 +1,61 @@
-# Ignore files for distribution archives.
-.gitattributes            export-ignore
-.gitignore                export-ignore
-.github                   export-ignore
-.circleci                 export-ignore
-.circleci/config.yml      export-ignore
-.env                      export-ignore
-dev-init.sh               export-ignore
+# Drupal git normalization
+# @see https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+# @see https://www.drupal.org/node/1542048
+
+# Normally these settings would be done with macro attributes for improved
+# readability and easier maintenance. However macros can only be defined at the
+# repository root directory. Drupal avoids making any assumptions about where it
+# is installed.
+
+# Define text file attributes.
+# - Treat them as text.
+# - Ensure no CRLF line-endings, neither on checkout nor on checkin.
+# - Detect whitespace errors.
+#   - Exposed by default in `git diff --color` on the CLI.
+#   - Validate with `git diff --check`.
+#   - Deny applying with `git apply --whitespace=error-all`.
+#   - Fix automatically with `git apply --whitespace=fix`.
+
+*.config  text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.css     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.dist    text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.engine  text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=php
+*.html    text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=html
+*.inc     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=php
+*.install text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=php
+*.js      text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.json    text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.lock    text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.map     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.md      text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.module  text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=php
+*.php     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=php
+*.po      text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.profile text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=php
+*.script  text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.sh      text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=php
+*.sql     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.svg     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.theme   text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2 diff=php
+*.twig    text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.txt     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.xml     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+*.yml     text eol=lf whitespace=blank-at-eol,-blank-at-eof,-space-before-tab,tab-in-indent,tabwidth=2
+
+# Define binary file attributes.
+# - Do not treat them as text.
+# - Include binary diff in patches instead of "binary files differ."
+*.eot     -text diff
+*.exe     -text diff
+*.gif     -text diff
+*.gz      -text diff
+*.ico     -text diff
+*.jpeg    -text diff
+*.jpg     -text diff
+*.otf     -text diff
+*.phar    -text diff
+*.png     -text diff
+*.svgz    -text diff
+*.ttf     -text diff
+*.woff    -text diff
+*.woff2   -text diff

README.md

@@ -18,7 +18,7 @@ your `composer.json`:
 
 ```json
 {
-  "repositories": {        
+  "repositories": {
       "dpc-sdp/tide_search": {
           "type": "vcs",
           "no-api": true,
@@ -30,38 +30,41 @@ your `composer.json`:
 
 Require this package as any other Composer package:
 ```bash
-composer require dpc/tide_search 
-``` 
+composer require dpc/tide_search
+```
 
 ## Support
-[Digital Engagement, Department of Premier and Cabinet, Victoria, Australia](https://github.com/dpc-sdp) 
+[Digital Engagement, Department of Premier and Cabinet, Victoria, Australia](https://github.com/dpc-sdp)
 is a maintainer of this package.
 
 ## Contribute
 [Open an issue](https://github.com/dpc-sdp) on GitHub or submit a pull request with suggested changes.
 
 ## Development and maintenance
-Development is powered by [Dev-Tools](https://github.com/dpc-sdp/dev-tools). Please refer to Dev-Tools' 
+Development is powered by [Dev-Tools](https://github.com/dpc-sdp/dev-tools). Please refer to Dev-Tools'
 page for [system requirements](https://github.com/dpc-sdp/dev-tools/#prerequisites) and other details.
 
 To start local development stack:
-1. Checkout this project 
-2. Run `./dev-tools.sh`
-3. Run `ahoy build`
-
+1. Checkout this project
+2. Ensure other projects using our dev stack are stopped
+3. Run `./dev-tools.sh`
+4. Run `ahoy build`
+5. Use `ahoy login` to gain access to the CMS (or use the one time login link given at end of build)
+6. Use `ahoy lint && ahoy test-behat` to run CI tests
+
 ## Related projects
-- [tide](https://github.com/dpc-sdp/tide)       
-- [tide_api](https://github.com/dpc-sdp/tide_api)         
+- [tide](https://github.com/dpc-sdp/tide)
+- [tide_api](https://github.com/dpc-sdp/tide_api)
 - [tide_core](https://github.com/dpc-sdp/tide_core)
 - [tide_event](https://github.com/dpc-sdp/tide_event)
 - [tide_landing_page](https://github.com/dpc-sdp/tide_landing_page)
-- [tide_media](https://github.com/dpc-sdp/tide_media)     
-- [tide_monsido](https://github.com/dpc-sdp/tide_monsido) 
-- [tide_news](https://github.com/dpc-sdp/tide_news)       
-- [tide_page](https://github.com/dpc-sdp/tide_page)       
-- [tide_site](https://github.com/dpc-sdp/tide_site)       
-- [tide_test](https://github.com/dpc-sdp/tide_test)       
-- [tide_webform](https://github.com/dpc-sdp/tide_webform)  
+- [tide_media](https://github.com/dpc-sdp/tide_media)
+- [tide_monsido](https://github.com/dpc-sdp/tide_monsido)
+- [tide_news](https://github.com/dpc-sdp/tide_news)
+- [tide_page](https://github.com/dpc-sdp/tide_page)
+- [tide_site](https://github.com/dpc-sdp/tide_site)
+- [tide_test](https://github.com/dpc-sdp/tide_test)
+- [tide_webform](https://github.com/dpc-sdp/tide_webform)
 
 ## License
 This project is licensed under [GPL2](https://github.com/dpc-sdp/tide_search/blob/master/LICENSE.txt)