Drush for Developers - Second Edition

Juampy Novillo Requena

• Publisher: Packt Publishing
• Year: 2015
• ISBN:
  9781784393786
• Topic: Computer Science
• Subtopic: Web Development
• Index: Computer Science

Drush for Developers Second Edition

---

Table of Contents

Drush for Developers Second Edition

Credits

About the Author

About the Reviewers

www.PacktPub.com

Support files, eBooks, discount offers, and more

Why subscribe?

Free access for Packt account holders

Preface

What this book covers

What you need for this book

Who this book is for

Conventions

Reader feedback

Customer support

Downloading the example code

Errata

Piracy

Questions

1. Introduction, Installation, and Basic Usage

Installation requirements

Operating system

PHP

Installing Composer

Drush installation on Linux and OSX

Manual installation

The Drush command structure

Executing a command

Providing arguments to a command

Altering a command's behavior through options

Structuring command invocations

Command aliases

Understanding Drush's context system

Setting the context manually

Summary

2. Keeping Database Configuration and Code Together

Meeting the update path

Rebuilding the registry

Preparing the trap

Breaking the registry

Rebuilding Drupal's registry

Running database updates

Managing features

Exporting configuration into code

Running the update path on a different environment

Analyzing results

Reverting the feature components programmatically

Summary

3. Running and Monitoring Tasks in Drupal Projects

Running periodic tasks with cron

Disabling Drupal's cron

Verifying the current cron frequency

Overriding cron frequency and exporting it to code

Running cron with Drush

Scheduling cron runs with Jenkins

Installing Jenkins

Creating a job through the web interface

Monitoring cron runs

Running a task outside cron

Example – moving a Feeds importer from Drupal's cron to Drush

Exporting the Feeds importer into code

Writing a Drush command to trigger the Feeds importer

Running long tasks in batches

A sample Drush command using the Batch API

Batch API operations

Running the command and verifying the output

Evaluating code on the fly and running scripts

The php-eval command

The php-script command

A script to create nodes and revisions

Logging messages in Drush

The verbose and quiet modes

Redirecting Drush output into a file

Implementing your own logging mechanism

Running a command in the background

Summary

4. Error Handling and Debugging

Validating input

Validating an argument

Validating options

Ignoring options after the command name

Allowing additional options

Adding custom validation to a command

Rolling back when an error happens

Turning the update path into a single command

Browsing hook implementations

Inspecting the bootstrapping process

Inspecting hook and function implementations

Browsing and navigating hook implementations

Viewing source code of a function or method

Summary

5. Managing Local and Remote Environments

Managing local environments

Managing remote environments

Verifying requirements

Accessing a remote server through a public key

Defining a group of remote site aliases for our project

Using site aliases in commands

Special site aliases

Running a command on all site aliases of a group

Avoiding a Drupal bootstrap with @none

Referencing the current project with @self

Adding site alias support to the update path

Inspecting the command implementation and hooks

Running the update path with a site alias

Copying database and files between environments

Defining Drush shell aliases for a team

Blocking the execution of certain commands

Ignoring tables on sql-sync

Summary

6. Setting Up a Development Workflow

Moving configuration, commands, and site aliases out of Drupal

Installing Drupal Boilerplate

Relocating Drush files

Testing the new setup

Configuring the development database for the team

Configuring Jenkins to sync production to development

Fine-tuning the development database

Recreating the database on sql-sync

Excluding table data from production

Ignoring tables from production

Sanitizing data

Preventing e-mails from being sent

Running post sql-sync tasks in local environments

Summary

Index

Drush for Developers Second Edition

Copyright © 2015 Packt Publishing

All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews.

Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book.

Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information.

First published: April 2012

Second edition: January 2015

Production reference: 1240115

Published by Packt Publishing Ltd.

Livery Place

35 Livery Street

Birmingham B3 2PB, UK.

ISBN 978-1-78439-378-6

www.packtpub.com

Credits

Author

Juampy Novillo Requena

Reviewers

Greg Anderson

Chris Burgess

Jonathan Araña Cruz

Jeremy French

Todd Zebert

Commissioning Editor

Dipika Gaonkar

Acquisition Editor

Meeta Rajani

Content Development Editor

Anila Vincent

Technical Editor

Arvind Koul

Copy Editor

Relin Hedly

Project Coordinator

Neha Bhatnagar

Proofreaders

Bridget Braund

Ameesha Green

Indexer

Tejal Soni

Production Coordinator

Alwin Roy

Cover Work

Alwin Roy

About the Author

Juampy Novillo Requena started working as a web developer in London. After spending a few years developing with plain PHP, Symfony, and Ruby on Rails, he discovered Drupal. Drawn by the Drupal community and the mind-blowing effect of getting a project done 10 times faster than before, Juampy has never looked back.

Since then, he's become more and more involved in the issue queues, which in turn led him to become a maintainer of core and contributed modules. He organizes events, gives sessions at national and international conferences, and has written the book Drush User's Guide, Packt Publishing. He feels privileged to experiment, have fun, and be challenged every day. He is known as juampy on Drupal.org and IRC. His Twitter account is @juampy72.

This book is the result of my two years working at Lullabot. Most of the contents explained here were originated by discussions or contributions within the team. I am very thankful to the team who worked on the MSNBC project, where we collaboratively de...