diff --git a/.vortex/installer/src/Command/InstallCommand.php b/.vortex/installer/src/Command/InstallCommand.php index 0f67813d12..1ed72b4471 100644 --- a/.vortex/installer/src/Command/InstallCommand.php +++ b/.vortex/installer/src/Command/InstallCommand.php @@ -32,8 +32,6 @@ use Symfony\Component\Console\Output\OutputInterface; /** - * Run command. - * * Install command. */ class InstallCommand extends Command implements CommandRunnerAwareInterface, ExecutableFinderAwareInterface { diff --git a/.vortex/installer/src/Prompts/Handlers/CustomModules.php b/.vortex/installer/src/Prompts/Handlers/CustomModules.php index b23df7d988..11440ced3a 100644 --- a/.vortex/installer/src/Prompts/Handlers/CustomModules.php +++ b/.vortex/installer/src/Prompts/Handlers/CustomModules.php @@ -211,8 +211,8 @@ protected function discoverModulePrefix(): ?string { /** * Remove Behat feature files tagged with @demo. * - * Scans the Behat features directory for .feature files whose first line - * contains the @demo tag and removes them. + * Removes every file in the Behat features directory that contains + * the @demo tag anywhere in its contents. * * @param string $dir * The base directory to search in. diff --git a/.vortex/installer/src/Prompts/Handlers/HandlerInterface.php b/.vortex/installer/src/Prompts/Handlers/HandlerInterface.php index f4edf99f5f..b3e19f82f6 100644 --- a/.vortex/installer/src/Prompts/Handlers/HandlerInterface.php +++ b/.vortex/installer/src/Prompts/Handlers/HandlerInterface.php @@ -118,7 +118,7 @@ public function options(array $responses): ?array; * Array of collected responses. * * @return bool - * The condition callback, or null if not conditional. + * TRUE if the handler should run, FALSE otherwise. */ public function shouldRun(array $responses): bool; @@ -134,10 +134,10 @@ public function shouldRun(array $responses): bool; public function default(array $responses): null|string|bool|array; /** - * Discover the value from the environment. + * Discover the value from the existing codebase. * * @return null|string|bool|array - * The value of the environment variable. + * The discovered value, or NULL if it could not be discovered. */ public function discover(): null|string|bool|array; @@ -176,8 +176,7 @@ public function resolvedValue(array $responses): null|string|bool|array; /** * Get a message to display when showing the resolved value. * - * This is used by handlerManager to show an appropriate message (via - * info(), ok(), etc.) when using a resolved value instead of handlering + * The message is shown when a resolved value is used instead of prompting * for input. * * @param array $responses diff --git a/.vortex/installer/src/Prompts/PromptManager.php b/.vortex/installer/src/Prompts/PromptManager.php index 7a2056af6e..0bb66647e2 100644 --- a/.vortex/installer/src/Prompts/PromptManager.php +++ b/.vortex/installer/src/Prompts/PromptManager.php @@ -119,8 +119,8 @@ public function __construct( /** * Run prompts to get responses. * - * If non-interactive mode is used, the values provided by $this->default() - * method, including discovery from the existing codebase, will be used. + * In non-interactive mode, each prompt returns its default, which includes + * values discovered from the existing codebase. */ public function runPrompts(): void { // Quiet the TUI output in non-interactive mode; the original verbosity is @@ -628,9 +628,8 @@ protected function initHandlers(): void { /** * Resolve prompt overrides from --prompts CLI option. * - * Reads the raw prompt array from Config, normalizes keys to handler IDs, - * validates values against handler types and options, and stores the - * validated overrides. + * Reads the raw prompt array from Config, validates values against handler + * types and options, and stores the validated overrides. * * @throws \RuntimeException * If any prompt value is invalid. @@ -650,7 +649,6 @@ protected function resolvePromptOverrides(): void { throw new \RuntimeException(sprintf('Invalid --prompts values: %s.', implode('; ', $messages))); } - // Use the resolved values which include defaults for missing prompts. foreach ($raw as $key => $value) { if (isset($this->handlers[$key])) { $this->promptOverrides[$key] = $value; @@ -682,7 +680,6 @@ protected function prompt(string $handler_class, array $responses = []): mixed { * * @param string $handler_class * The handler class name. - * The handler id. * @param mixed $default_override * Optional override for the default value (for response dependencies). * @param array $responses diff --git a/.vortex/installer/src/Schema/SchemaValidator.php b/.vortex/installer/src/Schema/SchemaValidator.php index 086850de32..ab95818e4b 100644 --- a/.vortex/installer/src/Schema/SchemaValidator.php +++ b/.vortex/installer/src/Schema/SchemaValidator.php @@ -37,10 +37,8 @@ public function validate(array $config): array { $warnings = []; $resolved = []; - $normalized = $this->normalizeConfig($config); - $known_ids = array_keys($this->handlers); - foreach (array_keys($normalized) as $key) { + foreach (array_keys($config) as $key) { if (!in_array($key, $known_ids, TRUE)) { $errors[] = ['prompt' => $key, 'message' => sprintf('Unknown prompt "%s".', $key)]; } @@ -51,8 +49,8 @@ public function validate(array $config): array { continue; } - $has_value = array_key_exists($id, $normalized); - $value = $normalized[$id] ?? NULL; + $has_value = array_key_exists($id, $config); + $value = $config[$id] ?? NULL; if (!$has_value) { continue; @@ -60,7 +58,7 @@ public function validate(array $config): array { $depends_on = $handler->dependsOn(); if ($depends_on !== NULL) { - $dep_result = $this->checkDependency($depends_on, $normalized); + $dep_result = $this->checkDependency($depends_on, $config); if ($dep_result === 'skip') { $type_error = $this->validateType($handler, $value); @@ -109,34 +107,13 @@ public function validate(array $config): array { ]; } - /** - * Normalize config keys to handler IDs. - * - * Supports both env var names (VORTEX_INSTALLER_PROMPT_*) and handler IDs. - * - * @param array $config - * The raw config array. - * - * @return array - * Config keyed by handler IDs. - */ - protected function normalizeConfig(array $config): array { - $normalized = []; - - foreach ($config as $key => $value) { - $normalized[$key] = $value; - } - - return $normalized; - } - /** * Check if dependency conditions are met. * * @param array> $depends_on * The dependency conditions. * @param array $config - * The normalized config. + * The config array, keyed by handler ID. * * @return bool|string * TRUE if met, FALSE if not met, 'skip' for system dependencies. diff --git a/.vortex/installer/src/Utils/FileManager.php b/.vortex/installer/src/Utils/FileManager.php index 89d92022fd..7fea04713e 100644 --- a/.vortex/installer/src/Utils/FileManager.php +++ b/.vortex/installer/src/Utils/FileManager.php @@ -392,8 +392,7 @@ protected function relativePaths(string $directory): array { * Remove obsolete paths from previous Vortex versions. * * Removes paths that previous Vortex versions placed in the destination but - * the current version no longer ships. Runs after copyFiles() so legacy - * artifacts do not linger across upgrades. + * the current version no longer ships. */ public function removeObsoletePaths(): void { $destination = $this->config->getDestination(); diff --git a/.vortex/installer/src/Utils/Git.php b/.vortex/installer/src/Utils/Git.php index 9802446970..5c77322536 100644 --- a/.vortex/installer/src/Utils/Git.php +++ b/.vortex/installer/src/Utils/Git.php @@ -53,7 +53,7 @@ public function listRemotes(): array { continue; // @codeCoverageIgnoreEnd } - // Remove the trailing (fetch) or (push) from the remote name. + // Remove the trailing (fetch) or (push) from the remote URL. $parts[1] = preg_replace('/ \(.*\)$/', '', $parts[1]); $remotes[$parts[0]] = $parts[1]; } diff --git a/.vortex/installer/src/Utils/Normalizer.php b/.vortex/installer/src/Utils/Normalizer.php index 3d12fd9a71..b89965699f 100644 --- a/.vortex/installer/src/Utils/Normalizer.php +++ b/.vortex/installer/src/Utils/Normalizer.php @@ -4,11 +4,6 @@ namespace DrevOps\VortexInstaller\Utils; -/** - * Installer configuration. - * - * Installer config is a config of this installer script. - */ final class Normalizer { /** diff --git a/.vortex/installer/src/Utils/OptionsResolver.php b/.vortex/installer/src/Utils/OptionsResolver.php index 0937014594..f82393c589 100644 --- a/.vortex/installer/src/Utils/OptionsResolver.php +++ b/.vortex/installer/src/Utils/OptionsResolver.php @@ -40,10 +40,9 @@ public static function checkRequirements(ExecutableFinder $finder): void { * * Installer configuration is a set of internal installer variables * prefixed with "VORTEX_INSTALLER_" and used to control the installation. - * They are read from the environment variables with $this->config->get(). - * - * For simplicity of naming, internal installer config variables used in - * $this->config->get() match environment variables names. + * Each is resolved from the CLI options, the --config JSON and the + * environment, and stored in Config under the name of its environment + * variable. * * @param array $options * Array of CLI options. diff --git a/.vortex/installer/src/Utils/Validator.php b/.vortex/installer/src/Utils/Validator.php index 0ba0d1585b..d508eef474 100644 --- a/.vortex/installer/src/Utils/Validator.php +++ b/.vortex/installer/src/Utils/Validator.php @@ -4,11 +4,6 @@ namespace DrevOps\VortexInstaller\Utils; -/** - * Converter. - * - * Convert strings to different formats. - */ class Validator { public static function isContainerImage(string $value): bool { @@ -51,10 +46,11 @@ public static function isGitCommitShaShort(string $value): bool { * - Branch names: "main", "develop", "feature/my-feature" * * Follows git reference naming rules: - * - Can contain alphanumeric, dot, hyphen, underscore, slash + * - Can contain alphanumeric, dot, hyphen, underscore, slash, plus * - Cannot start with dot or hyphen * - Cannot contain: @, ^, ~, :, ?, *, [, space, \, @{ - * - Cannot end with .lock or contain + * - Cannot contain .. or // + * - Cannot end with .lock or / * * @param string $value * The reference string to validate. @@ -73,11 +69,6 @@ public static function isGitRef(string $value): bool { return TRUE; } - // Git ref naming rules (simplified): - // - Can contain alphanumeric, dot, hyphen, underscore, slash, plus. - // - Cannot start with dot or hyphen. - // - Cannot contain .. or end with .lock. - // - Cannot end with / or contain //. $pattern = '/^(?![.\-])(?!.*\.\.)[a-zA-Z0-9._\/+-]+(?, expect_failure: bool, output_assertions: array, requirements_exit_callback?: (\Closure | null), requirements_finder_callback?: (\Closure | null), docker_compose_url?: (string | null), url_service?: string, before?: (\Closure | null)}> */ diff --git a/.vortex/installer/tests/Unit/Utils/EnvTest.php b/.vortex/installer/tests/Unit/Utils/EnvTest.php index 322c4054b5..eb17ffffe2 100644 --- a/.vortex/installer/tests/Unit/Utils/EnvTest.php +++ b/.vortex/installer/tests/Unit/Utils/EnvTest.php @@ -11,11 +11,6 @@ use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; -/** - * Class InstallerDotEnvTest. - * - * InstallerDotEnvTest fixture class. - */ #[CoversClass(Env::class)] #[RunTestsInSeparateProcesses] class EnvTest extends UnitTestCase { diff --git a/.vortex/installer/tests/Unit/Utils/ValidatorTest.php b/.vortex/installer/tests/Unit/Utils/ValidatorTest.php index 9abbc4aa5a..c638d7ae2f 100644 --- a/.vortex/installer/tests/Unit/Utils/ValidatorTest.php +++ b/.vortex/installer/tests/Unit/Utils/ValidatorTest.php @@ -9,9 +9,6 @@ use PHPUnit\Framework\Attributes\CoversClass; use PHPUnit\Framework\Attributes\DataProvider; -/** - * Class InstallerHelpersTest. - */ #[CoversClass(Validator::class)] class ValidatorTest extends UnitTestCase { diff --git a/.vortex/tests/lint.ci.sh b/.vortex/tests/lint.ci.sh index 4e3f743578..1bfb430f17 100755 --- a/.vortex/tests/lint.ci.sh +++ b/.vortex/tests/lint.ci.sh @@ -23,3 +23,5 @@ else echo "Checking that .circleci/vortex-test-common.yml is up to date." php "${ROOT_DIR}/.vortex/tests/generate-vortex-dev-circleci" --check fi + +# LCOV_EXCL_STOP diff --git a/.vortex/tests/lint.dockerfiles.sh b/.vortex/tests/lint.dockerfiles.sh index f4c886f2e7..9696b4d414 100755 --- a/.vortex/tests/lint.dockerfiles.sh +++ b/.vortex/tests/lint.dockerfiles.sh @@ -36,3 +36,5 @@ for file in "${targets[@]}"; do docker run --rm -i hadolint/hadolint:v2.15.1 <"${file}" fi done + +# LCOV_EXCL_STOP diff --git a/.vortex/tests/lint.markdown.sh b/.vortex/tests/lint.markdown.sh index 1043684cb9..b3f5d89566 100755 --- a/.vortex/tests/lint.markdown.sh +++ b/.vortex/tests/lint.markdown.sh @@ -33,3 +33,5 @@ done "${ROOT_DIR}"/README.md \ "${ROOT_DIR}"/README.dist.md \ "${ROOT_DIR}"/SECURITY.md + +# LCOV_EXCL_STOP diff --git a/.vortex/tests/lint.scripts.sh b/.vortex/tests/lint.scripts.sh index d86f32bf21..08735d3651 100755 --- a/.vortex/tests/lint.scripts.sh +++ b/.vortex/tests/lint.scripts.sh @@ -79,3 +79,5 @@ for file in "${targets[@]}"; do fi fi done + +# LCOV_EXCL_STOP diff --git a/.vortex/tests/test.common.sh b/.vortex/tests/test.common.sh index ff9267b308..39dcd5cd2e 100755 --- a/.vortex/tests/test.common.sh +++ b/.vortex/tests/test.common.sh @@ -39,3 +39,5 @@ bats() { } bats "${BATS_DIR}/unit" + +# LCOV_EXCL_STOP diff --git a/.vortex/tooling/src/vortex-doctor b/.vortex/tooling/src/vortex-doctor index d8e34db30f..e5b247c0e2 100755 --- a/.vortex/tooling/src/vortex-doctor +++ b/.vortex/tooling/src/vortex-doctor @@ -2,8 +2,8 @@ # # Check project requirements or print info. # -# doctor.sh - check project requirements. -# doctor.sh info - show system information. +# vortex-doctor - check project requirements. +# vortex-doctor info - show system information. # # IMPORTANT! This script runs outside the container on the host system. # diff --git a/.vortex/tooling/src/vortex-notify-email b/.vortex/tooling/src/vortex-notify-email index ad2245eb75..4ca9399ea9 100755 --- a/.vortex/tooling/src/vortex-notify-email +++ b/.vortex/tooling/src/vortex-notify-email @@ -2,7 +2,8 @@ ## # Notification dispatch to email recipients. # -# Notification dispatch to email recipients. +# Sends deployment notifications by email using the 'sendmail' or 'mail' +# command. # # Usage: # VORTEX_NOTIFY_PROJECT="Site Name" \ @@ -10,7 +11,7 @@ # VORTEX_NOTIFY_EMAIL_RECIPIENTS="to1@example.com|Jane Doe, to2@example.com|John Doe" \ # VORTEX_NOTIFY_LABEL="main" \ # VORTEX_NOTIFY_ENVIRONMENT_URL="https://environment-url-example.com" \ -# ./notify-email +# vortex-notify-email # # shellcheck disable=SC1090,SC1091,SC2016 diff --git a/.vortex/tooling/tests/_helper.bash b/.vortex/tooling/tests/_helper.bash index 69c20ea7fd..4cbded3356 100644 --- a/.vortex/tooling/tests/_helper.bash +++ b/.vortex/tooling/tests/_helper.bash @@ -26,6 +26,7 @@ setup() { # NOTE: If Docker tests fail, re-run with custom temporary directory # (must be pre-created): TMPDIR=${HOME}/.bats-tmp bats ' + # LCOV_EXCL_START if [ -n "${DOCKER_DEFAULT_PLATFORM:-}" ]; then if [ "${BATS_VERBOSE_RUN:-}" = "1" ] || [ "${TEST_VORTEX_DEBUG:-}" = "1" ]; then echo "Using ${DOCKER_DEFAULT_PLATFORM} platform architecture." diff --git a/.vortex/tooling/tests/fixtures/fixture.sh b/.vortex/tooling/tests/fixtures/fixture.sh index 4aaaee3c3c..1e29228b95 100755 --- a/.vortex/tooling/tests/fixtures/fixture.sh +++ b/.vortex/tooling/tests/fixtures/fixture.sh @@ -6,3 +6,5 @@ set -eu curl -L -s -o /dev/null -w "%{http_code}" example.com curl example.com + +# LCOV_EXCL_STOP diff --git a/.vortex/tooling/tests/unit/deploy-artifact.bats b/.vortex/tooling/tests/unit/deploy-artifact.bats index 4e0dbc0bf9..47708d3726 100644 --- a/.vortex/tooling/tests/unit/deploy-artifact.bats +++ b/.vortex/tooling/tests/unit/deploy-artifact.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Test for CircleCI lifecycle. +# Unit tests for the 'vortex-deploy-artifact' script. # # shellcheck disable=SC2030,SC2031,SC2129,SC2155,SC2034 diff --git a/.vortex/tooling/tests/unit/deploy-lagoon.bats b/.vortex/tooling/tests/unit/deploy-lagoon.bats index 4ff60e93de..13f58393db 100644 --- a/.vortex/tooling/tests/unit/deploy-lagoon.bats +++ b/.vortex/tooling/tests/unit/deploy-lagoon.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Tests for .vortex/tooling/src/vortex-deploy-lagoon script. +# Unit tests for the 'vortex-deploy-lagoon' script. # # shellcheck disable=SC2030,SC2031,SC2129,SC2155 diff --git a/.vortex/tooling/tests/unit/deploy-webhook.bats b/.vortex/tooling/tests/unit/deploy-webhook.bats index a4c3da21f9..e841db3901 100644 --- a/.vortex/tooling/tests/unit/deploy-webhook.bats +++ b/.vortex/tooling/tests/unit/deploy-webhook.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Test for webhook deployments. +# Unit tests for the 'vortex-deploy-webhook' script. # # shellcheck disable=SC2030,SC2031,SC2129,SC2155 diff --git a/.vortex/tooling/tests/unit/deploy.bats b/.vortex/tooling/tests/unit/deploy.bats index 8f1b849b18..33146e495d 100644 --- a/.vortex/tooling/tests/unit/deploy.bats +++ b/.vortex/tooling/tests/unit/deploy.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Test for main deployment router script. +# Unit tests for the 'vortex-deploy' script. # # shellcheck disable=SC2030,SC2031,SC2129,SC2155 diff --git a/.vortex/tooling/tests/unit/export-db-file.bats b/.vortex/tooling/tests/unit/export-db-file.bats index 95468179dd..3a856becb8 100644 --- a/.vortex/tooling/tests/unit/export-db-file.bats +++ b/.vortex/tooling/tests/unit/export-db-file.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for export-db-file worker script. +# Unit tests for the 'vortex-export-db-file' script. # # shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/export-db.bats b/.vortex/tooling/tests/unit/export-db.bats index a6176ac670..27ba4f88e0 100644 --- a/.vortex/tooling/tests/unit/export-db.bats +++ b/.vortex/tooling/tests/unit/export-db.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for export-db router script. +# Unit tests for the 'vortex-export-db' script. # # shellcheck disable=SC2030,SC2031 diff --git a/.vortex/tooling/tests/unit/fetch-db-acquia.bats b/.vortex/tooling/tests/unit/fetch-db-acquia.bats index c8b5460628..0d2704eaa4 100644 --- a/.vortex/tooling/tests/unit/fetch-db-acquia.bats +++ b/.vortex/tooling/tests/unit/fetch-db-acquia.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Unit tests for fetch-db-acquia.sh +# Unit tests for the 'vortex-fetch-db-acquia' script. # # shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/fetch-db-container-registry.bats b/.vortex/tooling/tests/unit/fetch-db-container-registry.bats index 4824d177c4..4bf6d4f51c 100644 --- a/.vortex/tooling/tests/unit/fetch-db-container-registry.bats +++ b/.vortex/tooling/tests/unit/fetch-db-container-registry.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for fetch-db-container-registry.sh +# Unit tests for the 'vortex-fetch-db-container-registry' script. # # shellcheck disable=SC2030,SC2031 diff --git a/.vortex/tooling/tests/unit/fetch-db-ftp.bats b/.vortex/tooling/tests/unit/fetch-db-ftp.bats index 207a89ac92..6429706d5b 100644 --- a/.vortex/tooling/tests/unit/fetch-db-ftp.bats +++ b/.vortex/tooling/tests/unit/fetch-db-ftp.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for fetch-db-ftp.sh +# Unit tests for the 'vortex-fetch-db-ftp' script. # # shellcheck disable=SC2030,SC2031 diff --git a/.vortex/tooling/tests/unit/fetch-db-lagoon.bats b/.vortex/tooling/tests/unit/fetch-db-lagoon.bats index bea829b2b7..dd6ec6688b 100644 --- a/.vortex/tooling/tests/unit/fetch-db-lagoon.bats +++ b/.vortex/tooling/tests/unit/fetch-db-lagoon.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Unit tests for fetch-db-lagoon.sh +# Unit tests for the 'vortex-fetch-db-lagoon' script. # # shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/fetch-db-s3.bats b/.vortex/tooling/tests/unit/fetch-db-s3.bats index 76499dbd06..09142a36b8 100644 --- a/.vortex/tooling/tests/unit/fetch-db-s3.bats +++ b/.vortex/tooling/tests/unit/fetch-db-s3.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for fetch-db-s3.sh +# Unit tests for the 'vortex-fetch-db-s3' script. # # shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/fetch-db-url.bats b/.vortex/tooling/tests/unit/fetch-db-url.bats index ab825d854a..f4069f67a8 100644 --- a/.vortex/tooling/tests/unit/fetch-db-url.bats +++ b/.vortex/tooling/tests/unit/fetch-db-url.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for fetch-db-url.sh +# Unit tests for the 'vortex-fetch-db-url' script. # # shellcheck disable=SC2030,SC2031,SC2016 diff --git a/.vortex/tooling/tests/unit/fetch-db.bats b/.vortex/tooling/tests/unit/fetch-db.bats index 1b11803ce5..c8006d960d 100644 --- a/.vortex/tooling/tests/unit/fetch-db.bats +++ b/.vortex/tooling/tests/unit/fetch-db.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for fetch-db.sh +# Unit tests for the 'vortex-fetch-db' script. # # shellcheck disable=SC2030,SC2031,SC2016 diff --git a/.vortex/tooling/tests/unit/helpers.bats b/.vortex/tooling/tests/unit/helpers.bats index 7a8421f8f6..ea0953e418 100644 --- a/.vortex/tooling/tests/unit/helpers.bats +++ b/.vortex/tooling/tests/unit/helpers.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Tests for Vortex Bats helpers. +# Unit tests for the Vortex BATS helpers. # # shellcheck disable=SC2129 diff --git a/.vortex/tooling/tests/unit/import-db-file.bats b/.vortex/tooling/tests/unit/import-db-file.bats index 151719643f..6aa83767f8 100644 --- a/.vortex/tooling/tests/unit/import-db-file.bats +++ b/.vortex/tooling/tests/unit/import-db-file.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for import-db-file worker script. +# Unit tests for the 'vortex-import-db-file' script. # # shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/import-db.bats b/.vortex/tooling/tests/unit/import-db.bats index 47cf6350b3..b5313da083 100644 --- a/.vortex/tooling/tests/unit/import-db.bats +++ b/.vortex/tooling/tests/unit/import-db.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for import-db router script. +# Unit tests for the 'vortex-import-db' script. # # shellcheck disable=SC2030,SC2031 diff --git a/.vortex/tooling/tests/unit/login-container-registry.bats b/.vortex/tooling/tests/unit/login-container-registry.bats index 5f5b7a8d4a..cee26f452b 100644 --- a/.vortex/tooling/tests/unit/login-container-registry.bats +++ b/.vortex/tooling/tests/unit/login-container-registry.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Test for login-container-registry.sh. +# Unit tests for the 'vortex-login-container-registry' script. # # shellcheck disable=SC2030,SC2031,SC2129,SC2155 diff --git a/.vortex/tooling/tests/unit/notify-diffy.bats b/.vortex/tooling/tests/unit/notify-diffy.bats index 12c7d4a324..53f144ce0f 100644 --- a/.vortex/tooling/tests/unit/notify-diffy.bats +++ b/.vortex/tooling/tests/unit/notify-diffy.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for Diffy notifications (notify-diffy). +# Unit tests for the 'vortex-notify-diffy' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/notify-email.bats b/.vortex/tooling/tests/unit/notify-email.bats index 702b5f8177..8796cc5cd0 100644 --- a/.vortex/tooling/tests/unit/notify-email.bats +++ b/.vortex/tooling/tests/unit/notify-email.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for email notifications (notify.sh). +# Unit tests for the 'vortex-notify-email' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/notify-github.bats b/.vortex/tooling/tests/unit/notify-github.bats index c2e84046da..530d71b2b6 100644 --- a/.vortex/tooling/tests/unit/notify-github.bats +++ b/.vortex/tooling/tests/unit/notify-github.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for GitHub notifications (notify.sh). +# Unit tests for the 'vortex-notify-github' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/notify-jira.bats b/.vortex/tooling/tests/unit/notify-jira.bats index 3a15719615..7fa28432b5 100644 --- a/.vortex/tooling/tests/unit/notify-jira.bats +++ b/.vortex/tooling/tests/unit/notify-jira.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for JIRA notifications (notify.sh). +# Unit tests for the 'vortex-notify-jira' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/notify-newrelic.bats b/.vortex/tooling/tests/unit/notify-newrelic.bats index 18848c80e6..9929ba740a 100644 --- a/.vortex/tooling/tests/unit/notify-newrelic.bats +++ b/.vortex/tooling/tests/unit/notify-newrelic.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for NewRelic notifications (notify.sh). +# Unit tests for the 'vortex-notify-newrelic' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/notify-slack.bats b/.vortex/tooling/tests/unit/notify-slack.bats index 9339d98e35..7efae7036d 100644 --- a/.vortex/tooling/tests/unit/notify-slack.bats +++ b/.vortex/tooling/tests/unit/notify-slack.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for Slack notifications (notify.sh). +# Unit tests for the 'vortex-notify-slack' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/notify-webhook.bats b/.vortex/tooling/tests/unit/notify-webhook.bats index 1ffe91f3eb..7e54097265 100644 --- a/.vortex/tooling/tests/unit/notify-webhook.bats +++ b/.vortex/tooling/tests/unit/notify-webhook.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for webhook notifications (notify.sh). +# Unit tests for the 'vortex-notify-webhook' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/notify.bats b/.vortex/tooling/tests/unit/notify.bats index 05e5e77032..d65952bd06 100644 --- a/.vortex/tooling/tests/unit/notify.bats +++ b/.vortex/tooling/tests/unit/notify.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for general notify.sh functionality. +# Unit tests for the 'vortex-notify' script. # # Notification-specific tests are in separate files: # - notify-email.bats diff --git a/.vortex/tooling/tests/unit/post-coverage-comment.bats b/.vortex/tooling/tests/unit/post-coverage-comment.bats index 88b74cee4d..04dac1a841 100644 --- a/.vortex/tooling/tests/unit/post-coverage-comment.bats +++ b/.vortex/tooling/tests/unit/post-coverage-comment.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for .circleci/post-coverage-comment.sh +# Unit tests for the '.circleci/post-coverage-comment.sh' script. # # shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/provision-enable-demo-modules.bats b/.vortex/tooling/tests/unit/provision-enable-demo-modules.bats index a0a0990657..c0fbfb525d 100644 --- a/.vortex/tooling/tests/unit/provision-enable-demo-modules.bats +++ b/.vortex/tooling/tests/unit/provision-enable-demo-modules.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for provision-00-enable-demo-modules.sh +# Unit tests for the 'scripts/provision-00-enable-demo-modules.sh' script. # # The environment-matching branch is covered end-to-end by 'provision.bats'; # this file covers the boundary that those scenarios do not reach. diff --git a/.vortex/tooling/tests/unit/provision-enable-dev-modules.bats b/.vortex/tooling/tests/unit/provision-enable-dev-modules.bats index b3d50746ba..7aaa064b31 100644 --- a/.vortex/tooling/tests/unit/provision-enable-dev-modules.bats +++ b/.vortex/tooling/tests/unit/provision-enable-dev-modules.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for provision-10-enable-dev-modules.sh +# Unit tests for the 'scripts/provision-10-enable-dev-modules.sh' script. # # # The mock side effects expand when the mock runs, not when the step is defined, diff --git a/.vortex/tooling/tests/unit/provision-example.bats b/.vortex/tooling/tests/unit/provision-example.bats index 7c5bd0583f..471f30a2fe 100644 --- a/.vortex/tooling/tests/unit/provision-example.bats +++ b/.vortex/tooling/tests/unit/provision-example.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for provision-40-example.sh +# Unit tests for the 'scripts/provision-40-example.sh' script. # # The environment-matching branch is covered end-to-end by 'provision.bats'; # this file covers the boundary that those scenarios do not reach. diff --git a/.vortex/tooling/tests/unit/provision-migration.bats b/.vortex/tooling/tests/unit/provision-migration.bats index 94f5d6d697..550a1e9348 100644 --- a/.vortex/tooling/tests/unit/provision-migration.bats +++ b/.vortex/tooling/tests/unit/provision-migration.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for provision-20-migration.sh +# Unit tests for the 'scripts/provision-20-migration.sh' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/provision-search-index.bats b/.vortex/tooling/tests/unit/provision-search-index.bats index 595b479b38..b534b37659 100644 --- a/.vortex/tooling/tests/unit/provision-search-index.bats +++ b/.vortex/tooling/tests/unit/provision-search-index.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for provision-30-search-index.sh +# Unit tests for the 'scripts/provision-30-search-index.sh' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/provision.bats b/.vortex/tooling/tests/unit/provision.bats index bf9dfd2823..0923b3ac2b 100644 --- a/.vortex/tooling/tests/unit/provision.bats +++ b/.vortex/tooling/tests/unit/provision.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for provision.sh +# Unit tests for the 'vortex-provision' script. # #shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/push-container-registry.bats b/.vortex/tooling/tests/unit/push-container-registry.bats index 34b373a950..18c85e7c73 100644 --- a/.vortex/tooling/tests/unit/push-container-registry.bats +++ b/.vortex/tooling/tests/unit/push-container-registry.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Tests for .vortex/tooling/src/vortex-push-container-registry script. +# Unit tests for the 'vortex-push-container-registry' script. # # shellcheck disable=SC2030,SC2031,SC2129,SC2155,SC2034 diff --git a/.vortex/tooling/tests/unit/push-db-image.bats b/.vortex/tooling/tests/unit/push-db-image.bats index 0a0a35fedd..08d160a92c 100644 --- a/.vortex/tooling/tests/unit/push-db-image.bats +++ b/.vortex/tooling/tests/unit/push-db-image.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for push-db-image script. +# Unit tests for the 'vortex-push-db-image' script. # # The stub map markers use single quotes on purpose: the `${...}` must reach the # generated stub literally and expand when the stub runs, not when the test diff --git a/.vortex/tooling/tests/unit/push-db-s3.bats b/.vortex/tooling/tests/unit/push-db-s3.bats index f3d85fdd7b..7f8f96d9c5 100644 --- a/.vortex/tooling/tests/unit/push-db-s3.bats +++ b/.vortex/tooling/tests/unit/push-db-s3.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for push-db-s3.sh +# Unit tests for the 'vortex-push-db-s3' script. # # shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/reset.bats b/.vortex/tooling/tests/unit/reset.bats index 77ba1e3c94..2fe8ee4711 100644 --- a/.vortex/tooling/tests/unit/reset.bats +++ b/.vortex/tooling/tests/unit/reset.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for the reset script. +# Unit tests for the 'vortex-reset' script. # # shellcheck disable=SC2030,SC2031 diff --git a/.vortex/tooling/tests/unit/setup-ssh.bats b/.vortex/tooling/tests/unit/setup-ssh.bats index 40efd93c3f..bd181d64b3 100644 --- a/.vortex/tooling/tests/unit/setup-ssh.bats +++ b/.vortex/tooling/tests/unit/setup-ssh.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats # -# Test for setup-ssh.sh script. +# Unit tests for the 'vortex-setup-ssh' script. # # IMPORTANT! This test uses mocks for ssd-add, so do not try to assert # the actual key presence in the agent. diff --git a/.vortex/tooling/tests/unit/task-purge-cache-acquia.bats b/.vortex/tooling/tests/unit/task-purge-cache-acquia.bats index 9b5c6f33eb..57eb29ea89 100644 --- a/.vortex/tooling/tests/unit/task-purge-cache-acquia.bats +++ b/.vortex/tooling/tests/unit/task-purge-cache-acquia.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for the Acquia cache purge task. +# Unit tests for the 'vortex-task-purge-cache-acquia' script. # # shellcheck disable=SC2030,SC2031,SC2034 diff --git a/.vortex/tooling/tests/unit/task.bats b/.vortex/tooling/tests/unit/task.bats index fdb6078aa2..47d8ba4d0c 100644 --- a/.vortex/tooling/tests/unit/task.bats +++ b/.vortex/tooling/tests/unit/task.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for the task router. +# Unit tests for the 'vortex-task' script. # # The router resolves a platform-agnostic operation to the # 'task--' sibling that implements it; these tests cover diff --git a/.vortex/tooling/tests/unit/update-vortex.bats b/.vortex/tooling/tests/unit/update-vortex.bats index 5624315c7b..be3c3aaac4 100644 --- a/.vortex/tooling/tests/unit/update-vortex.bats +++ b/.vortex/tooling/tests/unit/update-vortex.bats @@ -1,6 +1,6 @@ #!/usr/bin/env bats ## -# Unit tests for update-vortex.sh +# Unit tests for the 'vortex-update' script. # # shellcheck disable=SC2030,SC2031,SC2034