[#1580] Allow to choose tools in the installer.

Author: AlexSkrypnyk

.ahoy.yml

@@ -80,12 +80,12 @@ commands:
     usage: Show container logs for services.
     cmd: docker compose logs "$@"
 
+  # Drop into a shell if no arguments are supplied, otherwise run the command.
+  # Environment variables are passed from the host and filtered by prefix.
+  # Use \" (slash followed by a double quote) to escape double quotes in
+  # arguments that contain spaces.
   cli:
     usage: Start a shell or run a command inside the CLI service container.
-    # Drop into a shell if no arguments are supplied, otherwise run the command.
-    # Environment variables are passed from the host and filtered by prefix.
-    # Use \" (slash followed by a double quote) to escape double quotes in
-    # arguments that contain spaces.
     cmd: |
       if [ "${#}" -ne 0 ]; then
         docker compose exec $(env | cut -f1 -d= | grep "TERM\|COMPOSE_\|GITHUB_\|PACKAGE_\|DOCKER_\|DRUPAL_\|VORTEX_" | sed 's/^/-e /') cli bash -c "$*"
@@ -122,7 +122,7 @@ commands:
   #;< !PROVISION_TYPE_PROFILE
   download-db:
     usage: Download database. Run with "--no-cache" option to force fresh database backup.
-    aliases: ['fetch-db']
+    aliases: [fetch-db]
     cmd: |
       case " $* " in *" --no-cache "*) export VORTEX_DB_DOWNLOAD_NO_CACHE=1;; esac
       ./scripts/vortex/download-db.sh
@@ -158,7 +158,7 @@ commands:
     cmd: \[ -n "${VORTEX_DB_IMAGE}" \] && docker pull ${VORTEX_DB_IMAGE} || true
 
   reset:
-    usage: "Remove containers, all build files. Use with `hard` to reset repository to the last commit."
+    usage: Remove containers, all build files. Use with `hard` to reset repository to the last commit.
     cmd: |
       ahoy confirm "All containers and build files will be removed. Proceed?" || exit 0
       AHOY_CONFIRM_RESPONSE=y ahoy down
@@ -190,7 +190,10 @@ commands:
 
   lint:
     usage: Lint back-end and front-end code.
-    cmd: ahoy lint-be && ahoy lint-fe && ahoy lint-tests
+    cmd: |
+      ahoy lint-be
+      ahoy lint-fe
+      ahoy lint-tests
 
   lint-be:
     usage: Lint back-end code.
@@ -211,11 +214,14 @@ commands:
 
   lint-tests:
     usage: Lint tests code.
-    cmd: ahoy cli vendor/bin/gherkinlint lint tests/behat/features
+    cmd: |
+      ahoy cli vendor/bin/gherkinlint lint tests/behat/features
 
   lint-fix:
     usage: Fix lint issues of back-end and front-end code.
-    cmd: ahoy lint-be-fix && ahoy lint-fe-fix
+    cmd: |
+      ahoy lint-be-fix
+      ahoy lint-fe-fix
 
   lint-be-fix:
     usage: Fix lint issues of back-end code.
@@ -234,7 +240,11 @@ commands:
 
   test:
     usage: Run all tests.
-    cmd: ahoy test-unit && ahoy test-kernel && ahoy test-functional && ahoy test-bdd
+    cmd: |
+      ahoy test-unit
+      ahoy test-kernel
+      ahoy test-functional
+      ahoy test-bdd
 
   test-unit:
     usage: Run PHPUnit unit tests.
@@ -250,7 +260,7 @@ commands:
 
   test-bdd:
     usage: Run BDD tests.
-    aliases: ['test-behat']
+    aliases: [test-behat]
     cmd: ahoy cli php -d memory_limit=-1 vendor/bin/behat --colors "$@"
 
   debug:
@@ -274,8 +284,7 @@ commands:
   local:
     usage: Custom local commands. See `ahoy local help`.
     optional: true
-    imports:
-      - .ahoy.local.yml
+    imports: [.ahoy.local.yml]
 
   # ----------------------------------------------------------------------------
   # Utilities.
@@ -307,15 +316,14 @@ commands:
     hide: true
 
 # Override entrypoint to alter default behavior of Ahoy.
+# 1. Exit the script if any statement returns a non-true return value.
+# 2. Read variables from .env file (while respecting existing values) to load
+#    and pass updated environment variables' values into already running
+#    containers.
 entrypoint:
   - bash
   - -c
-  # Exit the script if any statement returns a non-true return value.
   - -e
-  # Read variables from .env file, respecting existing values.
-  # - Used to load and pass updated environment variables' values into already
-  #   running containers.
-  # - Use `ahoy up cli` in cases when changes require container restart.
   - |
     t=$(mktemp) && export -p > "$t" && set -a && . ./.env && if [ -f ./.env.local ];then . ./.env.local;fi && set +a && . "$t" && rm "$t" && unset t
     bash -e -c "$0" "$@"

.circleci/config.yml

@@ -286,41 +286,51 @@ jobs:
             [ "${CIRCLE_NODE_TOTAL:-1}" -gt 1 ] && [ "${CIRCLE_NODE_INDEX:-0}" -ne 0 ] && exit 0
             docker compose exec -T cli composer normalize --dry-run || [ "${VORTEX_CI_COMPOSER_NORMALIZE_IGNORE_FAILURE:-0}" -eq 1 ]
 
+      #;< TOOL_PHPCS
       - run:
           name: Lint code with PHPCS
           command: |
             [ "${CIRCLE_NODE_TOTAL:-1}" -gt 1 ] && [ "${CIRCLE_NODE_INDEX:-0}" -ne 0 ] && exit 0
             docker compose exec -T cli vendor/bin/phpcs || [ "${VORTEX_CI_PHPCS_IGNORE_FAILURE:-0}" -eq 1 ]
+      #;> TOOL_PHPCS
 
+      #;< TOOL_PHPSTAN
       - run:
           name: Lint code with PHPStan
           command: |
             [ "${CIRCLE_NODE_TOTAL:-1}" -gt 1 ] && [ "${CIRCLE_NODE_INDEX:-0}" -ne 0 ] && exit 0
             docker compose exec -T cli vendor/bin/phpstan || [ "${VORTEX_CI_PHPSTAN_IGNORE_FAILURE:-0}" -eq 1 ]
+      #;> TOOL_PHPSTAN
 
+      #;< TOOL_RECTOR
       - run:
           name: Lint code with Rector
           command: |
             [ "${CIRCLE_NODE_TOTAL:-1}" -gt 1 ] && [ "${CIRCLE_NODE_INDEX:-0}" -ne 0 ] && exit 0
             docker compose exec -T cli vendor/bin/rector --clear-cache --dry-run || [ "${VORTEX_CI_RECTOR_IGNORE_FAILURE:-0}" -eq 1 ]
+      #;> TOOL_RECTOR
 
+      #;< TOOL_PHPMD
       - run:
           name: Lint code with PHPMD
           command: |
             [ "${CIRCLE_NODE_TOTAL:-1}" -gt 1 ] && [ "${CIRCLE_NODE_INDEX:-0}" -ne 0 ] && exit 0
             docker compose exec -T cli vendor/bin/phpmd . text phpmd.xml || [ "${VORTEX_CI_PHPMD_IGNORE_FAILURE:-0}" -eq 1 ]
+      #;> TOOL_PHPMD
 
       - run:
           name: Lint code with Twig CS Fixer
           command: |
             [ "${CIRCLE_NODE_TOTAL:-1}" -gt 1 ] && [ "${CIRCLE_NODE_INDEX:-0}" -ne 0 ] && exit 0
             docker compose exec -T cli vendor/bin/twig-cs-fixer || [ "${VORTEX_CI_TWIG_CS_FIXER_IGNORE_FAILURE:-0}" -eq 1 ]
 
+      #;< TOOL_BEHAT
       - run:
           name: Lint code with Gherkin Lint
           command: |
             [ "${CIRCLE_NODE_TOTAL:-1}" -gt 1 ] && [ "${CIRCLE_NODE_INDEX:-0}" -ne 0 ] && exit 0
             docker compose exec -T cli vendor/bin/gherkinlint lint tests/behat/features || [ "${VORTEX_CI_GHERKIN_LINT_IGNORE_FAILURE:-0}" -eq 1 ]
+      #;> TOOL_BEHAT
 
       - run:
           name: Lint module code with NodeJS linters
@@ -346,10 +356,13 @@ jobs:
             docker compose exec $(env | cut -f1 -d= | sed 's/^/-e /') -T cli ./scripts/vortex/provision.sh
           no_output_timeout: 30m
 
+      #;< TOOL_PHPUNIT
       - run:
           name: Test with PHPUnit
           command: docker compose exec -T cli vendor/bin/phpunit || [ "${VORTEX_CI_PHPUNIT_IGNORE_FAILURE:-0}" -eq 1 ]
+      #;> TOOL_PHPUNIT
 
+      #;< TOOL_BEHAT
       - run:
           name: Test with Behat
           command: |
@@ -359,6 +372,7 @@ jobs:
               docker compose exec -T cli php -d memory_limit=-1 vendor/bin/behat --colors --strict --rerun --profile="${VORTEX_CI_BEHAT_PROFILE:-default}" || \
               [ "${VORTEX_CI_BEHAT_IGNORE_FAILURE:-0}" -eq 1 ]
           no_output_timeout: 30m
+      #;> TOOL_BEHAT
 
       - run:
           name: Process test logs and artifacts

.github/workflows/build-test-deploy.yml

@@ -269,35 +269,45 @@ jobs:
         run: docker compose exec -T cli composer normalize --dry-run
         continue-on-error: ${{ vars.VORTEX_CI_COMPOSER_NORMALIZE_IGNORE_FAILURE == '1' }}
 
+      #;< TOOL_PHPCS
       - name: Lint code with PHPCS
         if: ${{ matrix.instance == 0 || strategy.job-total == 1 }}
         run: docker compose exec -T cli vendor/bin/phpcs
         continue-on-error: ${{ vars.VORTEX_CI_PHPCS_IGNORE_FAILURE == '1' }}
+      #;> TOOL_PHPCS
 
+      #;< TOOL_PHPSTAN
       - name: Lint code with PHPStan
         if: ${{ matrix.instance == 0 || strategy.job-total == 1 }}
         run: docker compose exec -T cli vendor/bin/phpstan
         continue-on-error: ${{ vars.VORTEX_CI_PHPSTAN_IGNORE_FAILURE == '1' }}
+      #;> TOOL_PHPSTAN
 
+      #;< TOOL_RECTOR
       - name: Lint code with Rector
         if: ${{ matrix.instance == 0 || strategy.job-total == 1 }}
         run: docker compose exec -T cli vendor/bin/rector --clear-cache --dry-run
         continue-on-error: ${{ vars.VORTEX_CI_RECTOR_IGNORE_FAILURE == '1' }}
+      #;> TOOL_RECTOR
 
+      #;< TOOL_PHPMD
       - name: Lint code with PHPMD
         if: ${{ matrix.instance == 0 || strategy.job-total == 1 }}
         run: docker compose exec -T cli vendor/bin/phpmd . text phpmd.xml
         continue-on-error: ${{ vars.VORTEX_CI_PHPMD_IGNORE_FAILURE == '1' }}
+      #;> TOOL_PHPMD
 
       - name: Lint code with Twig CS Fixer
         if: ${{ matrix.instance == 0 || strategy.job-total == 1 }}
         run: docker compose exec -T cli vendor/bin/twig-cs-fixer
         continue-on-error: ${{ vars.VORTEX_CI_TWIG_CS_FIXER_IGNORE_FAILURE == '1' }}
 
+      #;< TOOL_BEHAT
       - name: Lint code with Gherkin Lint
         if: ${{ matrix.instance == 0 || strategy.job-total == 1 }}
         run: docker compose exec -T cli vendor/bin/gherkinlint lint tests/behat/features
         continue-on-error: ${{ vars.VORTEX_CI_GHERKIN_LINT_IGNORE_FAILURE == '1' }}
+      #;> TOOL_BEHAT
 
       - name: Lint module code with NodeJS linters
         if: ${{ matrix.instance == 0 || strategy.job-total == 1 }}
@@ -320,10 +330,13 @@ jobs:
           docker compose exec $(env | cut -f1 -d= | sed 's/^/-e /') -T cli ./scripts/vortex/provision.sh
         timeout-minutes: 30
 
+      #;< TOOL_PHPUNIT
       - name: Test with PHPUnit
         run: docker compose exec -T cli vendor/bin/phpunit
         continue-on-error: ${{ vars.VORTEX_CI_PHPUNIT_IGNORE_FAILURE == '1' }}
+      #;> TOOL_PHPUNIT
 
+      #;< TOOL_BEHAT
       - name: Test with Behat
         run: |
           # shellcheck disable=SC2170
@@ -335,6 +348,7 @@ jobs:
           VORTEX_CI_BEHAT_PROFILE: ${{ vars.VORTEX_CI_BEHAT_PROFILE }}
         continue-on-error: ${{ vars.VORTEX_CI_BEHAT_IGNORE_FAILURE == '1' }}
         timeout-minutes: 30
+      #;> TOOL_BEHAT
 
       - name: Process test logs and artifacts
         if: always()

.vortex/installer/composer.json

@@ -18,11 +18,13 @@
     },
     "require": {
         "php": ">=8.2",
-        "alexskrypnyk/file": "^0.8.0",
+        "alexskrypnyk/file": "^0.9",
         "alexskrypnyk/str2name": "^1.4",
+        "composer/composer": "^2.8",
         "cweagans/composer-patches": "^1.7",
         "czproject/git-php": "^4.3",
         "laravel/prompts": "^0.3.5",
+        "nikic/iter": "^2.4",
         "sebastian/diff": "*",
         "symfony/console": "^7.3",
         "symfony/filesystem": "^7.2",
@@ -93,6 +95,7 @@
         "reset": "rm -Rf vendor vendor-bin",
         "test": "phpunit --no-coverage",
         "test-coverage": "php -d pcov.directory=. vendor/bin/phpunit",
-        "test-fixtures": "UPDATE_FIXTURES=1 phpunit --no-coverage --filter=testInstall"
+        "test-fixtures": "UPDATE_FIXTURES=1 phpunit --no-coverage --filter=testInstall",
+        "test-baseline": "UPDATE_FIXTURES=1 phpunit --no-coverage --filter=testInstall@baseline || UPDATE_FIXTURES=1 phpunit --no-coverage --filter=testInstall@baseline"
     }
 }