localgovdrupal/localgov_microsites_project

Project template for the LocalGov Drupal Microsites distribution.

4.0.0 2024-09-10 11:45 UTC

Requires

• composer/installers: ^1.12
• cweagans/composer-patches: ^1.7
• drupal/core-composer-scaffold: ^10.0@stable
• drupal/core-recommended: ^10.0@stable
• drush/drush: ^12.0
• localgovdrupal/localgov_microsites: ^4.0@beta

Requires (Dev)

• brianium/paratest: ^6.3
• drupal/core-dev: ^10.0

Conflicts

• drupal/drupal: *

GPL-2.0-or-later

README

This project template provides a starter kit for managing your LocalGov Drupal Microsites dependencies with Composer.

Usage

First you need to install Composer.

After that you can create the project:

composer create-project --stability stable localgovdrupal/localgov_microsites_project:^4.0 MY_PROJECT  --no-install

Using Lando

If using Lando, you can then boot up Lando and run the site install

cd MY_PROJECT
lando start
lando composer install
lando drush si localgov_microsites -y

Using DDEV

If using ddev, you can then boot up ddev and run the site install

cd MY_PROJECT
ddev start
ddev composer install
ddev drush si localgov_microsites -y

Using host machine

If you're working directly on your host machine, you'll still need to run the composer install.

cd MY_PROJECT
composer install
drush si localgov_microsites -y

Running PHPUnit tests in Lando

The included phpunit.xml.dist file contains configuration for automatically running the LocalGov Drupal test suite.

The default .lando.dist.xml includes environment variables for:

BROWSERTEST_OUTPUT_DIRECTORY: '/app/web/sites/simpletest/browser_output'
BROWSERTEST_OUTPUT_BASE_URL: 'https://localgov-micro.lndo.site'

To allow html output, manually create a directory for browser output.

mkdir web/sites/simpletest/browser_output

To run all LocalGov Drupal tests from Lando:

lando ssh
phpunit

To run all the tests for a specific module:

lando ssh
phpunit web/modules/contrib/localgov_my_module

Tests can be filtered using the --filter option. To only run a specific test:

lando ssh
phpunit --filter=myTestName

Running PHPUnit tests in DDEV

The included phpunit.xml.dist file contains configuration for automatically running the LocalGov Drupal test suite.

The default .ddev/config.yml includes configuration for some extra domains that ddev and phpunit will need to resolve different microsite domains.

When ddev starts, it will attempt to write these to /etc/hosts

If DDEV cannot write to /etc/hosts, you may need to add these manually.

If you are having problems runnign phpunit tests in DDEV, try adding the following to /etc/hosts

127.0.0.1 group-1.web group-2.web group-3.web group-4.web group-5.web

To allow html output, manually create a directory for browser output.

mkdir web/sites/simpletest/browser_output

To run all LocalGov Drupal tests from inside DDEV:

ddev ssh
phpunit

To run all the tests for a specific module:

ddev ssh
phpunit web/modules/contrib/localgov_my_module

Tests can be filtered using the --filter option. To only run a specific test:

ddev ssh
phpunit --filter=myTestName

Maintainers

This project is currently maintained by:

• Ekes: https://www.drupal.org/u/ekes
• Finn Lewis: https://www.drupal.org/u/finn-lewis
• Stephen Cox: https://www.drupal.org/u/stephen-cox