Merge branch '1.x' into feature/add-bats-test-ahoy-operation

Author: AlexSkrypnyk

.ahoy.yml

@@ -45,12 +45,41 @@ commands:
 
   test:
     usage: Run all tests.
-    cmd: ./.devtools/test.sh
+    cmd: |
+      pushd "build" >/dev/null || exit 1
+      vendor/bin/phpunit
+      popd >/dev/null || exit 1
+
+  test-unit:
+    usage: Run unit tests.
+    cmd: |
+      pushd "build" >/dev/null || exit 1
+      vendor/bin/phpunit --testsuite unit
+      popd >/dev/null || exit 1
+
+  test-kernel:
+    usage: Run kernel tests.
+    cmd: |
+      pushd "build" >/dev/null || exit 1
+      vendor/bin/phpunit --testsuite kernel
+      popd >/dev/null || exit 1
+
+  test-functional:
+    usage: Run functional tests.
+    cmd: |
+      pushd "build" >/dev/null || exit 1
+      vendor/bin/phpunit --testsuite functional
+      popd >/dev/null || exit 1
 
 # Override entrypoint to alter default behaviour of Ahoy.
 entrypoint:
   - bash
   - -c
   - -e
+  - |
+    extension="$(basename -s .info.yml -- ./*.info.yml)"
+    export SIMPLETEST_BASE_URL=http://${WEBSERVER_HOST:-localhost}:${WEBSERVER_PORT:-8000}
+    export SIMPLETEST_DB=sqlite://localhost/drupal_test_${extension}.sqlite
+    bash -e -c "$0" "$@"
   - '{{cmd}}'
   - '{{name}}'

.circleci/config.yml

@@ -58,7 +58,8 @@ job-test: &job-test
 
     - run:
         name: Run tests
-        command: .devtools/test.sh || [ "${CI_TEST_IGNORE_FAILURE:-0}" -eq 1 ]
+        command: vendor/bin/phpunit || [ "${CI_TEST_IGNORE_FAILURE:-0}" -eq 1 ]
+        working_directory: build
 
     - run:
         name: Process artifacts

.devtools/build-codebase.sh

@@ -107,7 +107,7 @@ for composer_suggest in $composer_suggests; do
 done
 
 echo "> Copy tools configuration files."
-cp phpcs.xml phpstan.neon phpmd.xml rector.php .twig_cs.php "build/"
+cp phpcs.xml phpstan.neon phpmd.xml rector.php .twig_cs.php phpunit.xml "build/"
 
 echo "> Symlink extension's code."
 rm -rf "build/web/${type}/custom" >/dev/null && mkdir -p "build/web/${type}/custom/${extension}"

.devtools/test.sh

@@ -39,7 +39,7 @@ jobs:
         working-directory: .scaffold/tests
 
       - name: Run tests
-        run: kcov --include-pattern=.sh,.bash --bash-parse-files-in-dir=. --exclude-pattern=vendor,node_modules,.scaffold-coverage-html "$(pwd)"/.scaffold-coverage-html .scaffold/tests/node_modules/.bin/bats .scaffold/tests/bats
+        run: kcov --include-pattern=.sh,.bash --bash-parse-files-in-dir=. --exclude-pattern=vendor,node_modules,.scaffold-coverage-html,.scaffold "$(pwd)"/.scaffold-coverage-html .scaffold/tests/node_modules/.bin/bats .scaffold/tests/bats
 
       - name: Upload coverage report as an artifact
         uses: actions/upload-artifact@v4

.github/workflows/scaffold-test.yml

@@ -94,10 +94,28 @@ jobs:
         run: vendor/bin/twigcs || [ "${CI_TWIGCS_IGNORE_FAILURE:-0}" -eq 1 ]
 
       - name: Run tests
-        run: .devtools/test.sh || [ "${CI_TEST_IGNORE_FAILURE:-0}" -eq 1 ]
+        working-directory: build
+        run: vendor/bin/phpunit || [ "${CI_TEST_IGNORE_FAILURE:-0}" -eq 1 ]
 
       - name: Process artifacts
         uses: actions/upload-artifact@v4
         with:
           name: Artifacts (${{ matrix.name }})
           path: build/web/sites/simpletest/browser_output
+
+      - name: Upload coverage report as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{github.job}}-code-coverage-report-${{ matrix.name }}
+          path: ./.logs/coverage/phpunit/.coverage-html
+          if-no-files-found: error
+
+      - name: Upload coverage report to Codecov
+        uses: codecov/codecov-action@v4
+        if: ${{ env.CODECOV_TOKEN != '' }}
+        with:
+          files: ./.logs/coverage/phpunit/cobertura.xml
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/test.yml

@@ -1,2 +1,3 @@
+.logs
 composer.lock
 build

.gitignore

@@ -71,7 +71,6 @@ assert_files_present_common() {
 
   # Assert other things.
   assert_dir_not_contains_string "${dir}" "your_extension"
-  assert_dir_contains_string "${dir}" "YodasHut"
 
   popd >/dev/null || exit 1
 }

.scaffold/tests/bats/_assert_init.bash

@@ -16,7 +16,6 @@ export SCRIPT_FILE="init.sh"
 # bats test_tags=smoke
 @test "Init, defaults - extension module, workflow" {
   answers=(
-    "YodasHut"       # namespace
     "Force Crystal"  # name
     "force_crystal"  # machine_name
     "module"         # type
@@ -38,7 +37,6 @@ export SCRIPT_FILE="init.sh"
 # bats test_tags=smoke
 @test "Init, extension theme, workflow" {
   answers=(
-    "YodasHut"       # namespace
     "Force Crystal"  # name
     "force_crystal"  # machine_name
     "theme"          # type
@@ -60,7 +58,6 @@ export SCRIPT_FILE="init.sh"
 # bats test_tags=smoke
 @test "Init, CircleCI" {
   answers=(
-    "YodasHut"      # namespace
     "Force Crystal" # name
     "force_crystal" # machine_name
     "module"        # type
@@ -80,7 +77,6 @@ export SCRIPT_FILE="init.sh"
 
 @test "Init, do not remove script" {
   answers=(
-    "YodasHut"      # namespace
     "Force Crystal" # name
     "force_crystal" # machine_name
     "module"        # type
@@ -99,7 +95,6 @@ export SCRIPT_FILE="init.sh"
 
 @test "Init, remove script" {
   answers=(
-    "YodasHut"      # namespace
     "Force Crystal" # name
     "force_crystal" # machine_name
     "module"        # type

.scaffold/tests/bats/functional.init.bats

@@ -11,8 +11,18 @@ load "../../../init.sh"
   input="I am a_string-With spaces 13"
 
   TEST_CASES=(
-    "$input" "file_name" "i_am_a_string-with_spaces_13"
-    "$input" "route_path" "i_am_a_string-with_spaces_13"
+    "I am a_string-With spaces 13" "file_name" "i_am_a_string-with_spaces_13"
+    "I am a_string-With spaces 13" "route_path" "i_am_a_string-with_spaces_13"
+    "I am a_string-With spaces 13" "deployment_id" "i_am_a_string-with_spaces_13"
+    "I am a_string-With spaces 13" "domain_name" "i_am_a_stringwith_spaces_13"
+    "I am a_string-With spaces 13" "namespace" "IAmAStringWithSpaces13"
+    "I am a_string-With spaces 13" "package_name" "i-am-a_string-with-spaces-13"
+    "I am a_string-With spaces 13" "function_name" "i_am_a_string-with_spaces_13"
+    "I am a_string-With spaces 13" "ui_id" "i_am_a_string-with_spaces_13"
+    "I am a_string-With spaces 13" "cli_command" "i_am_a_string-with_spaces_13"
+    "I am a_string-With spaces 13" "log_entry" "I am a_string-With spaces 13"
+    "I am a_string-With spaces 13" "code_comment_title" "I am a_string-With spaces 13"
+    "I am a_string-With spaces 13" "dummy_type" "Invalid conversion type"
   )
 
   dataprovider_run "convert_string" 3

.scaffold/tests/bats/unit.init.bats

@@ -3,7 +3,7 @@
   <img width=200px height=200px src="https://placehold.jp/000000/ffffff/200x200.png?text=Your+Extension&css=%7B%22border-radius%22%3A%22%20100px%22%7D" alt="Yourproject logo"></a>
 </p>
 
-<h1 align="center">Your extension</h1>
+<h1 align="center">Your Extension</h1>
 
 <div align="center">
 

README.dist.md

@@ -2,6 +2,7 @@
     "require-dev": {
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
         "friendsoftwig/twigcs": "^6.2",
+        "jangregor/phpstan-prophecy": "^1.0",
         "mglaman/phpstan-drupal": "^1.2",
         "palantirnet/drupal-rector": "^0.18",
         "phpcompatibility/php-compatibility": "^9.3",

composer.dev.json

@@ -6,7 +6,7 @@
     "authors": [
         {
             "name": "Your Name",
-            "email": "yourproject@yournamespace.com",
+            "email": "yourproject@yourusername.com",
             "homepage": "https://www.drupal.org/u/yourusername",
             "role": "Maintainer"
         }

composer.json

@@ -0,0 +1,7 @@
+your_extension.settings:
+  type: config_object
+  label: 'Your Extension settings'
+  mapping:
+    text:
+      type: string
+      label: 'Text for <noscript> Tag'

config/install/user.role.demorole.yml

@@ -7,18 +7,17 @@
 # ./init.sh
 #
 # Silent:
-# ./init.sh yournamespace "Extension Name" extension_machine_name extension_type "CI Provider"
+# ./init.sh "Extension Name" extension_machine_name extension_type "CI Provider"
 #
 # shellcheck disable=SC2162,SC2015
 
 set -euo pipefail
 [ "${SCRIPT_DEBUG-}" = "1" ] && set -x
 
-namespace=${1-}
-extension_name=${2-}
-extension_machine_name=${3-}
-extension_type=${4-}
-ci_provider=${5-}
+extension_name=${1-}
+extension_machine_name=${2-}
+extension_type=${3-}
+ci_provider=${4-}
 
 #-------------------------------------------------------------------------------
 
@@ -34,7 +33,7 @@ convert_string() {
       echo "${input_string}" | tr ' ' '_' | tr '[:upper:]' '[:lower:]' | tr -d '-'
       ;;
     "namespace" | "class_name")
-      echo "${input_string}" | awk -F" " '{for(i=1;i<=NF;i++) $i=toupper(substr($i,1,1)) tolower(substr($i,2));} 1' | tr -d ' -'
+      echo "${input_string}" | tr '-' ' ' | tr '_' ' ' | awk -F" " '{for(i=1;i<=NF;i++) $i=toupper(substr($i,1,1)) tolower(substr($i,2));} 1' | tr -d ' -'
       ;;
     "package_name")
       echo "${input_string}" | tr ' ' '-' | tr '[:upper:]' '[:lower:]'
@@ -154,30 +153,29 @@ process_readme() {
 }
 
 process_internal() {
-  local namespace="${1}"
-  local extension_name="${2}"
-  local extension_machine_name="${3}"
-  local extension_type="${4}"
-  local ci_provider="${5}"
-  local namespace_lowercase
-
-  namespace_lowercase="$(to_lowercase "${namespace}")"
-
-  replace_string_content "YourNamespace" "${namespace}"
-  replace_string_content "yournamespace" "${namespace_lowercase}"
-  replace_string_content "AlexSkrypnyk" "${namespace}"
-  replace_string_content "alexskrypnyk" "${namespace_lowercase}"
+  local extension_name="${1}"
+  local extension_machine_name="${2}"
+  local extension_type="${3}"
+  local ci_provider="${4}"
+
+  extension_machine_name_class="$(convert_string "${extension_machine_name}" "class_name")"
+
+  replace_string_content "YourNamespace" "${extension_machine_name}"
+  replace_string_content "yournamespace" "${extension_machine_name}"
+  replace_string_content "AlexSkrypnyk" "${extension_machine_name}"
+  replace_string_content "alexskrypnyk" "${extension_machine_name}"
   replace_string_content "yourproject" "${extension_machine_name}"
   replace_string_content "Yourproject logo" "${extension_name} logo"
-  replace_string_content "Your extension" "${extension_name}"
+  replace_string_content "Your Extension" "${extension_name}"
   replace_string_content "your extension" "${extension_name}"
   replace_string_content "Your+Extension" "${extension_machine_name}"
   replace_string_content "your_extension" "${extension_machine_name}"
+  replace_string_content "YourExtension" "${extension_machine_name_class}"
   replace_string_content "Provides your_extension functionality." "Provides ${extension_machine_name} functionality."
   replace_string_content "drupal-module" "drupal-${extension_type}"
   replace_string_content "Drupal module scaffold FE example used for template testing" "Provides ${extension_machine_name} functionality."
-  replace_string_content "drupal_extension_scaffold" "${extension_machine_name}"
   replace_string_content "Drupal extension scaffold" "${extension_name}"
+  replace_string_content "drupal_extension_scaffold" "${extension_machine_name}"
   replace_string_content "type: module" "type: ${extension_type}"
   replace_string_content "\[EXTENSION_NAME\]" "${extension_machine_name}"
 
@@ -202,6 +200,17 @@ process_internal() {
   remove_string_content "LICENSE             export-ignore"
 
   mv "your_extension.info.yml" "${extension_machine_name}.info.yml"
+  mv "your_extension.install" "${extension_machine_name}.install"
+  mv "your_extension.links.menu.yml" "${extension_machine_name}.links.menu.yml"
+  mv "your_extension.module" "${extension_machine_name}.module"
+  mv "your_extension.routing.yml" "${extension_machine_name}.routing.yml"
+  mv "your_extension.services.yml" "${extension_machine_name}.services.yml"
+  mv "config/schema/your_extension.schema.yml" "config/schema/${extension_machine_name}.schema.yml"
+  mv "src/Form/YourExtensionForm.php" "src/Form/${extension_machine_name_class}Form.php"
+  mv "src/YourExtensionService.php" "src/${extension_machine_name_class}Service.php"
+  mv "tests/src/Unit/YourExtensionServiceUnitTest.php" "tests/src/Unit/${extension_machine_name_class}ServiceUnitTest.php"
+  mv "tests/src/Kernel/YourExtensionServiceKernelTest.php" "tests/src/Kernel/${extension_machine_name_class}ServiceKernelTest.php"
+  mv "tests/src/Functional/YourExtensionFunctionalTest.php" "tests/src/Functional/${extension_machine_name_class}FunctionalTest.php"
 
   rm -f LICENSE >/dev/null || true
   rm -Rf "tests/scaffold" >/dev/null || true
@@ -229,7 +238,6 @@ main() {
   echo "Please follow the prompts to adjust your extension configuration"
   echo
 
-  [ -z "${namespace}" ] && namespace="$(ask "Namespace")"
   [ -z "${extension_name}" ] && extension_name="$(ask "Name")"
   [ -z "${extension_machine_name}" ] && extension_machine_name="$(ask "Machine name")"
   [ -z "${extension_type}" ] && extension_type="$(ask "Type: module or theme")"
@@ -240,7 +248,6 @@ main() {
   echo
   echo "            Summary"
   echo "---------------------------------"
-  echo "Namespace                        : ${namespace}"
   echo "Name                             : ${extension_name}"
   echo "Machine name                     : ${extension_machine_name}"
   echo "Type                             : ${extension_type}"
@@ -261,15 +268,14 @@ main() {
   # Processing.
   #
 
-  : "${namespace:?namespace is required}"
   : "${extension_name:?name is required}"
   : "${extension_machine_name:?machine_name is required}"
   : "${extension_type:?type is required}"
   : "${ci_provider:?ci_provider is required}"
 
   process_readme "${extension_name}"
 
-  process_internal "${namespace}" "${extension_name}" "${extension_machine_name}" "${extension_type}" "${ci_provider}"
+  process_internal "${extension_name}" "${extension_machine_name}" "${extension_type}" "${ci_provider}"
 
   [ "${remove_self}" != "n" ] && rm -- "$0" || true