README.md

DDEV Annertech Tools

Highly opinionated set of configs and commands used by Annertech in our DDEV workflow.

Install

1. Get the new addon

Then get the addon:

ddev add-on get annertech/annertech-ddev

2. Commit to project repo

Add add-on files to git (happens automatically)

git add .ddev/commands/host/branch -f
git add .ddev/commands/host/cex -f
git add .ddev/commands/host/cim -f
git add .ddev/commands/host/cr -f
git add .ddev/commands/host/cloudflare -f
git add .ddev/commands/host/devmode -f
git add .ddev/commands/host/githooks -f
git add .ddev/commands/host/login -f
git add .ddev/commands/host/protect -f
git add .ddev/commands/host/remote-db -f
git add .ddev/commands/host/timeslip -f
git add .ddev/commands/web/behat -f
git add .ddev/commands/web/robo -f
git add .ddev/commands/web/platform -f
git add .ddev/commands/web/solr-update-config -f

git add .ddev/nginx/ -f
git add .ddev/scripts/ -f

git add .ddev/config.annertech.yaml -f
git add .ddev/settings.local.*mode.php -f

git add .ddev/.env -f

git add .ddev/addon-metadata/ -f

git add .vscode -f

git commit -m 'Add annertech/annertech-ddev addon' --no-verify

Features

• Provides global commands (available in all projects, project level commands below take priority):
• • branch: Creates an opinionated git branch name from a Teamwork ticket ID
• • cloudflare: Shares the project with the outside world over a Cloudflare tunnel
• • login: Opens a browser and logs you in to Drupal (works on local environments only)
• • open-issue: Opens teamwork issue for current branch
• • timeslip: Generates a timeslip message for FreeAgent. If timewarrior is installed it will also show the sum of time spent today
• • timew: Tags current timewarrior tracking with Teamwork link and project name
• • travel-mode: Removes all DB dumps downloaded via ddev pull, also provides info on how to remove all DDEV projects and their databases
• Provides host commands:
• • branch: Creates an opinionated git branch name from a Teamwork ticket ID
• • cloudflare: Shares the project with the outside world over a Cloudflare tunnel
• • devmode [on|off]: Adds custom settings.local.php file and allows easy toggle between production and development mode
• • githooks: Installs git-hooks (also happens on project start)
• • login: Opens a browser and logs you in to Drupal (works on local environments only)
• • protect [on|off|reset]: Enable or disable basic auth on a nixsal hosted dev project - see file
• • timeslip: Generates a timeslip message for FreeAgent. If timewarrior is installed it will also show the sum of time spent today
• Provides web container commands:
• • behat: Runs behat
• • platform: Runs platform cli
• • robo: Runs robo
• • solr:update-config: Updates SOLR config.zip
• Uses DDEV Hooks to properly instantiate project for development
• Adds git hook to enforce proper commit messages
• Sets to development mode on project start
• Customizes NGINX configuration
• Fixes search_api_solr to communicate with local SOLR by default (special overrides might be needed for Pantheon sites)
• Automatically ignores configuration for development modules

Automatically disabled

• Fastly
• IP blocking modules
• Shield
• TFA

are automatically disabled in local environment to facilitate development.

Automated Testing commands provided

Behat

ddev behat command is provided and expects behat to be under PROJECT_ROOT/tests/behat.

NOTE: Antibot will block Behat! Remember to uninstall it if needed.

BackstopJS

We rely on https://github.com/mmunz/ddev-backstopjs to get BackstopJS commands in DDEV. Go look there.

Cypress

We rely on https://github.com/tyler36/ddev-cypress and, if needed, https://www.drupal.org/project/drush_endpoint for Cypress tests.

ReCaptcha bypass

See https://github.com/Annertech/annertech-ddev/pull/29/files on how to bypass recaptcha when running automated tests.

Tricks

Handy shell aliases to add to your host machine:

# DDEV
alias composer='ddev composer'
alias behat='ddev behat'
alias drush='ddev drush'
alias platform='ddev platform'
alias robo='ddev robo'

alias xe='ddev xdebug enable'
alias xd='ddev xdebug disable'
alias xt='status=$(ddev xdebug status) &&  if [ "$status" == "xdebug enabled" ]; then ddev xdebug off; else ddev xdebug on; fi' 

# If you don't want to have platform cli installed on your host you can rely to the one in DDEV
alias platform='ddev exec platform'

Common Problems and How-To Fix Them

commit-msg hook is ignored

Check git config -l for the value of core.hooksPath and can change it to the local path with

git config --local core.hooksPath .git/hooks