utexas/utdk_localdev

Docksal-based local development tooling for the UT Drupal Kit.

3.1.0 2022-07-18 16:53 UTC

Requires

• brianium/paratest: ^6.2
• drupal/coder: ^8.3
• drupal/devel: ^4.0
• drupal/drupal-extension: ^4.1
• drupal/entity_browser: ^2.0
• drupal/page_manager: ^4.0
• drupal/restui: ^1.0
• drush-ops/behat-drush-endpoint: ^9
• drush/drush: ~10
• friendsoftwig/twigcs: ^3.2
• jcalderonzumba/mink-phantomjs-driver: ^0.3.1
• mglaman/drupal-check: ^1.1
• mikey179/vfsstream: ^1.6
• oomphinc/composer-installers-extender: ^2
• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^8.4.1 || ^9
• squizlabs/php_codesniffer: 3.*
• symfony/phpunit-bridge: ^5.0

GPL-2.0-or-later

• Web Content Management Solutions Team, Information Technology Services, The University of Texas at Austin

• drupal
• UT Drupal Kit

README

This repository contains tooling for local development of the UT Drupal Kit. It should not be used for local development with an individual Drupal Kit site. For local development on an individual Drupal Kit site, use one of the options listed at https://drupalkit.its.utexas.edu/docs/getting_started/local_development.html

Install the latest release of the Drupal Kit

composer create-project utexas/utdk-project --no-install && cd utdk-project
git clone [e-mail]:eis1-wcs/utdk_localdev.git .vscode
mv .vscode/.lando.yml .lando.yml
lando start
lando drush si -y
lando drush uli

Use XDebug

This assumes usage with Microsoft Visual Studio Code. You will need to add the extension XDebug.

1. In the .lando.yml file, change xdebug: false to xdebug: true
2. lando rebuild
3. Add a breakpoint to your code. To test that it is working, start with a line in web/index.php, which will always execute, regardless of whether site data is cached or not.
4. Use the VS Code debugging sidebar to "Run and Debug" (CTRL+SHIFT+D).
5. Reload the site in a browser. The load should redirect you back to VS Code, with debugging data in the sidebar.

Run unit tests

lando composer update -W
lando test <path/to/file>
# Example
lando test web/profiles/custom/utexas/tests/src/Functional/BaseInstallationTest.php
lando test web/profiles/custom/utexas/tests/src/FunctionalJavascript/CustomWidgetsTest.php

Access the site's database with phpMyAdmin

1. Run lando info. This will display a URL at which you can access phpMyAdmin, such as:

service: 'pma',
    urls: [ 'http://localhost:33569' ],
    type: 'phpmyadmin',
    healthy: true,
    backends: [ 'database' ],
    config: {},
    version: '5.1',
    meUser: 'www-data',
    hasCerts: false,
    api: 3,
    hostnames: [ 'pma.utdkproject.internal' ] },

Pull data from the Nightly Build site

If you have added utnews, utprof, utevent, and utdk_saas to the codebase, you can pull the database and files from https://live-utdk3-nightly-build.pantheonsite.io with the following:

lando pull

Lando CLI command reference

https://docs.lando.dev/cli/

Trust the Lando local certificate to avoid SSL warnings

https://docs.lando.dev/core/v3/security.html#trusting-the-ca