How to setup Drush core development environment?

Question

I would like to create a PR against Drush, so one of the core commands has additional options. But I'm not really sure, how should I setup my development environment, so I'm not losing my time moving code between my site-specific Drush and master branch I checked out elsewhere.

I see that Drush contains docker compose file (https://github.com/drush-ops/drush/blob/master/docker-compose.yml), but the wodby/php image apparently doesn't contain Drupal Core. I wasn't able to find any tutorial about this.

Answer 1

a) Start by reading the following material (if you haven't already):

• https://github.com/drush-ops/drush/tree/master/tests/README.md
• https://github.com/drush-ops/drush/blob/master/CONTRIBUTING.md

b) Fork the drush-ops/drush repository, so that you can track your work (and eventually start a PR from your fork back to the original repo).

c) Install the local dev environment provided using docker-compose:

git clone https://github.com/stefanospetrakis/drush.git
cd drush
git checkout -b YOUR_BRANCH
docker-compose up -d
docker-compose exec drupal composer install

At this point you have the source code of drush, equiped with tests. You can do your changes and additions to it and commit/push to your fork, as your project evolves.

d) You can test your changes at any time, against the official drush test suite to make sure you didn't break something:

docker-compose exec drupal composer test

e) Additionally, you can test your work in progress inside your own drupal projects, by replacing the standard drush in composer with your own fork, that would need three things:

• Adding an extra repository in your Drupal's composer.json, e.g.:

  "type": "git",
  "url": "https://github.com/stefanospetrakis/drush"
  

• Aliasing the "drush/drush" package, in order to pull from your current working branch in your repo, based on the exact version number found in composer.lock, e.g.:

  require "drush/drush": "dev-YOUR_BRANCH as 9.5.2",
  

• Use source (git) for your drush package, e.g.

  {
  "config": {
      "preferred-install": {
          "drush/drush": "source",            
          "*": "dist"
      }
  }
  

  }

• Possibly do manual pulls inside the vendor/drush/drush folder in order to get your latest work.

And as @greg_1_anderson mentioned in a separate answer, you will find Drupal Core under the sut directory of drush's source code.

Good luck!

P.S.: Replace https://github.com/stefanospetrakis/drush.git with the URL of your fork of drush-ops/drush repository, this is just an example.

Answer 2

The Drush test suite on the master branch makes its own Drupal 8 site install for you. Drush calls this site the System Under Test, or "SUT".

Copy tests/phpunit.xml.dist to tests/phpunit.xml and enter your database credentials there.

The SUT will be created when you run the tests via composer functional.

You may use the SUT in ad-hoc testing by using the provided aliases, e.g.:

./drush @sut.dev status

UPDATE: phpunit.xml.dist has been moved back to its original location in the tests directory.

*IMPORTANT: The SUT is automatically destroyed at the end of each test run. export UNISH_DIRTY=1 if you'd like Drush to keep it around for ad-hoc testing.

Answer 3

What I would do to start with is to create my drupal 8 site using the drupal-project composer action, as recommended.

Part of that will cause drush to be installed under /vendor. Convert that into a full clone of the repo and make your changes there.

You should be able to test inplace to some degree, but if you want to test the new drush code on your main site, make a softlink from vendor/drush to the new site's vendor/drush. These days drush always prefers to use the installation within a site folder.

Hope that helps.