Add a core-version command. (#133)

* Add a core-version command.

* Add generated/provided comments

* Switch to using .env.

* Switch to .env.web for better scoping.

* Apply suggestions from code review

Co-authored-by: Moshe Weitzman <[email protected]>

* Test short-hand and invalid version constraints.

* mention new command list of comamnds in the in readme

---------

Co-authored-by: Moshe Weitzman <[email protected]>

Author: andrewbelcher

README.md

@@ -15,7 +15,7 @@ DDEV integration for developing Drupal contrib projects. As a general philosophy
 3. cd [contrib module directory]
 4. Configure DDEV for Drupal using `ddev config --project-type=drupal --docroot=web --php-version=8.3 --corepack-enable --project-name=[module]` or select these options when prompted using `ddev config`
    - Remove underscores in the project name, or replace with hyphens. (DDEV will do this for you.)
-   - See [Misc](#misc) for help on using alternate versions of Drupal core.
+   - See [Changing the Drupal core version](#changing-the-drupal-core-version) to update your  version of Drupal core.
 5. Run `ddev add-on get ddev/ddev-selenium-standalone-chrome && ddev add-on get ddev/ddev-drupal-contrib`
 6. Run `ddev start`
 7. Run `ddev poser`
@@ -42,17 +42,14 @@ This project provides the following DDEV container commands.
   - Runs `composer install` AND `yarn install` so that dependencies are available. Additional arguments to `ddev poser` like --prefer-source are passed along to `composer install`
   - Note: it is perfectly acceptable to skip this command and edit the require-dev of composer.json by hand.
 - [ddev symlink-project](https://github.com/ddev/ddev-drupal-contrib/blob/main/commands/web/symlink-project). Symlinks your project files into the configured location (defaults to `web/modules/custom`) so Drupal can find your module. This command runs automatically on every `ddev start` _as long as Composer has generated `vendor/autoload.php`_ which occurs during `composer install/update`. See codebase image below.
-
-Run tests on your project code (defaults to `web/modules/custom`, [configurable](#changing-the-symlink-location)):
-
 - `ddev phpunit` Run [PHPUnit](https://github.com/sebastianbergmann/phpunit) tests.
 - `ddev nightwatch` Run Nightwatch tests, requires [DDEV Selenium Standalone Chrome](https://github.com/ddev/ddev-selenium-standalone-chrome).
 - `ddev phpcs` Run [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer).
 - `ddev phpcbf` Fix phpcs findings.
 - `ddev phpstan`. Run [phpstan](https://phpstan.org) on project files.
 - `ddev eslint` Run [ESLint](https://github.com/eslint/eslint) on JavaScript files.
 - `ddev stylelint` Run [Stylelint](https://github.com/stylelint/stylelint) on CSS files.
-
+- `ddev core-version`. Update your codebase to newer or older version of Drupal core. [More info](#changing-the-drupal-core-version).
 
 ## Codebase layout
 
@@ -76,11 +73,16 @@ Override any environment variable value from [.ddev/config.contrib.yaml](config.
 
 ### Changing the Drupal core version
 
-In `.ddev/config.local.yaml` set the Drupal core version:
+Use the `ddev core-version` command to set the core version environment variable and update the dependencies, for example:
 
-```yaml
-web_environment:
-  - DRUPAL_CORE=^11
+```shell
+ddev core-version ^11
+```
+
+You can also do this manually by setting a version in `.ddev/.env.web`:
+
+```ini
+DRUPAL_CORE=^11
 ```
 
 Then run `ddev restart` and then `ddev poser` to update the Drupal core version.

commands/host/core-version

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+#ddev-generated
+## Command provided by https://github.com/ddev/ddev-drupal-contrib
+## Description: Switch the core version and rebuild.
+## Usage: core-version [version]
+## Example: "ddev core-version ^11" or "ddev core-version ~11.1.0"
+
+set -eu -o pipefail
+
+# Handle default values.
+DRUPAL_CORE=${1:-default}
+if [ "$DRUPAL_CORE" == "default" ]; then
+  DRUPAL_CORE=""
+fi
+
+# Set/clear the env.
+ddev dotenv set .ddev/.env.web --drupal-core "${DRUPAL_CORE}"
+
+# Restart and rebuild.
+ddev restart
+ddev poser

commands/web/expand-composer-json

@@ -10,6 +10,9 @@
 
 set -eu -o pipefail
 
+# Set the default core version.
+export DRUPAL_CORE=${DRUPAL_CORE:-^11}
+
 export _WEB_ROOT=$DDEV_DOCROOT
 cd "$DDEV_COMPOSER_ROOT" || exit
 curl -OL https://git.drupalcode.org/project/gitlab_templates/-/raw/default-ref/scripts/expand_composer_json.php

config.contrib.yaml

@@ -5,8 +5,7 @@
 web_environment:
   # To change the Drupal core version, see the README:
   # https://github.com/ddev/ddev-drupal-contrib/blob/main/README.md#changing-the-drupal-core-version
-  - DRUPAL_CORE=^11
-  - # https://git.drupalcode.org/project/gitlab_templates/-/blob/1.9.6/scripts/expand_composer_json.php?ref_type=tags#L15
+  # https://git.drupalcode.org/project/gitlab_templates/-/blob/1.9.6/scripts/expand_composer_json.php?ref_type=tags#L15
   - IGNORE_PROJECT_DRUPAL_CORE_VERSION=1
   # To change the location of your project code, see the README:
   # https://github.com/ddev/ddev-drupal-contrib/blob/main/README.md#changing-the-symlink-location

install.yaml

@@ -1,6 +1,7 @@
 name: ddev-drupal-contrib
 
 project_files:
+  - commands/host/core-version
   - commands/web/eslint
   - commands/web/expand-composer-json
   - commands/web/nightwatch

tests/_common.bash

@@ -13,7 +13,7 @@ _common_setup() {
   cd ${TESTDIR}
   ddev config --project-name=${PROJNAME} --project-type=drupal --docroot=web --php-version=8.3 --corepack-enable
   if [ -n "$TEST_DRUPAL_CORE" ] && [ "$TEST_DRUPAL_CORE" != "default" ]; then
-    echo -e "web_environment:\n    - DRUPAL_CORE=^${TEST_DRUPAL_CORE}" > .ddev/config.~overrides.yaml
+    ddev dotenv set .ddev/.env.web --drupal-core "^${TEST_DRUPAL_CORE}"
   fi
   ddev add-on get ddev/ddev-selenium-standalone-chrome
   ddev add-on get ${DIR}

tests/core-version.bats

@@ -0,0 +1,52 @@
+load helpers/bats-support/load.bash
+load helpers/bats-assert/load.bash
+
+setup_file() {
+  if [ -n "$TEST_DRUPAL_CORE" ] && [ "$TEST_DRUPAL_CORE" != "default" ]; then
+    skip "TEST_DRUPAL_CORE=$TEST_DRUPAL_CORE not handled by this test suite" >&2
+  fi
+  load '_common.bash'
+  _common_setup
+  ddev start
+  _common_test_poser
+}
+
+teardown_file() {
+  load '_common.bash'
+  _common_teardown
+}
+
+@test "ddev core-version ^10" {
+  ddev core-version ^10
+  run -0 ddev exec 'drush st --fields=drupal-version --format=string | cut -d. -f1'
+  assert_output "10"
+}
+
+@test "ddev core-version ^11" {
+  ddev core-version ^11
+  run -0 ddev exec 'drush st --fields=drupal-version --format=string | cut -d. -f1'
+  assert_output "11"
+}
+
+@test "ddev core-version default" {
+  ddev core-version default
+  run -0 ddev exec 'drush st --fields=drupal-version --format=string | cut -d. -f1'
+  assert_output "11"
+}
+
+@test "ddev core-version <none>" {
+  ddev core-version
+  run -0 ddev exec 'drush st --fields=drupal-version --format=string | cut -d. -f1'
+  assert_output "11"
+}
+
+@test "ddev core-version short-major" {
+  ddev core-version 11
+  run -0 ddev exec 'drush st --fields=drupal-version --format=string'
+  assert_output "11.0.0"
+}
+
+@test "ddev core-version invalid" {
+  run ! ddev core-version test
+  assert_output --partial 'Could not parse version constraint test: Invalid version string "test"'
+}

tests/full.bats

@@ -38,12 +38,8 @@ teardown_file() {
 
 @test "drupal core version" {
   run -0 ddev exec 'drush st --fields=drupal-version --format=string | cut -d. -f1'
-  if [ -n "${TEST_DRUPAL_CORE}" ]; then
-    assert_output "${TEST_DRUPAL_CORE}"
-  else
-    DDEV_DRUPAL_CORE=$(ddev exec 'echo "${DRUPAL_CORE/^/}"')
-    assert_output "$DDEV_DRUPAL_CORE"
-  fi
+  # Default core version is ^11.
+  assert_output "${TEST_DRUPAL_CORE:-11}"
 }
 
 @test "node tools availability" {