Convert tests to Bats

Author: ramsey

.gitattributes

@@ -2,6 +2,7 @@
 /.gitattributes             export-ignore
 /.github/                   export-ignore
 /.gitignore                 export-ignore
+/.gitmodules                export-ignore
 /.simplecov                 export-ignore
 /CHANGELOG.md               export-ignore
 /CODE_OF_CONDUCT.md         export-ignore

.github/workflows/continuous-integration.yml

@@ -27,25 +27,17 @@ jobs:
         run: "composer-normalize --dry-run"
 
   test:
-    name: "Expect tests"
+    name: "Bats tests"
     runs-on: "ubuntu-latest"
-    strategy:
-      matrix:
-        composer-version:
-          - "v1"
-          - "v2"
     steps:
       - name: "Checkout repository"
         uses: "actions/checkout@v4"
-      - name: "Install expect"
-        run: |
-          sudo apt-get update
-          sudo apt-get -y install expect
+        with:
+          submodules: "recursive"
       - name: "Set up PHP"
         uses: "shivammathur/setup-php@v2"
         with:
           php-version: "latest"
-          tools: "composer:${{ matrix.composer-version }}"
           coverage: "none"
         env:
           fail-fast: true
@@ -60,10 +52,8 @@ jobs:
     steps:
       - name: "Checkout repository"
         uses: "actions/checkout@v4"
-      - name: "Install expect"
-        run: |
-          sudo apt-get update
-          sudo apt-get -y install expect
+        with:
+          submodules: "recursive"
       - name: "Set up Ruby"
         uses: "ruby/setup-ruby@v1"
         with:
@@ -79,9 +69,9 @@ jobs:
           tools: "composer:v2"
           coverage: "none"
       - name: "Run expect tests"
-        run: "bashcov --root ./bin -- ./tests/bash-test.sh tests/tests.sh"
+        run: "bashcov --root ./bin -- ./tests/test_helper/bats/bin/bats tests/"
       - name: "Publish coverage report to Codecov"
-        uses: "codecov/codecov-action@v4"
+        uses: "codecov/codecov-action@v5"
         with:
           files: "./bin/coverage/codecov-result.json"
 
@@ -92,7 +82,7 @@ jobs:
       - name: "Checkout repository"
         uses: "actions/checkout@v4"
       - name: "Run shellcheck"
-        run: "shellcheck --exclude=SC2230 bin/*.sh tests/*.sh"
+        run: "shellcheck --exclude=SC2230 bin/*.sh tests/*.bats"
 
   run:
     needs: test
@@ -107,9 +97,6 @@ jobs:
           - "lowest"
           - "highest"
           - "locked"
-        composer-version:
-          - "v1"
-          - "v2"
         working-directory:
           - "tests/fixtures/with-lock-file"
           - "tests/fixtures/no-lock-file"
@@ -122,7 +109,6 @@ jobs:
         uses: "shivammathur/setup-php@v2"
         with:
           php-version: "latest"
-          tools: "composer:${{ matrix.composer-version }}"
           coverage: "none"
         env:
           fail-fast: true
@@ -243,17 +229,13 @@ jobs:
         operating-system:
           - "ubuntu-latest"
           - "windows-latest"
-        composer-version:
-          - "v1"
-          - "v2"
     steps:
       - name: "Checkout repository"
         uses: "actions/checkout@v4"
       - name: "Set up PHP"
         uses: "shivammathur/setup-php@v2"
         with:
           php-version: "latest"
-          tools: "composer:${{ matrix.composer-version }}"
           coverage: "none"
         env:
           fail-fast: true

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "tests/test_helper/bats-assert"]
+	path = tests/test_helper/bats-assert
+	url = https://github.com/bats-core/bats-assert.git
+[submodule "tests/test_helper/bats-support"]
+	path = tests/test_helper/bats-support
+	url = https://github.com/bats-core/bats-support.git
+[submodule "tests/test_helper/bats-file"]
+	path = tests/test_helper/bats-file
+	url = https://github.com/bats-core/bats-file.git
+[submodule "tests/test_helper/bats"]
+	path = tests/test_helper/bats
+	url = https://github.com/bats-core/bats-core.git

CONTRIBUTING.md

@@ -89,38 +89,29 @@ When you do begin working on your feature, here are some guidelines to consider:
 ## Developing
 
 To develop this project, you will need [PHP](https://www.php.net),
-[Composer](https://getcomposer.org), [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)),
-and [Expect](https://en.wikipedia.org/wiki/Expect).
+[Composer](https://getcomposer.org), and [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)).
 
 ### Running Tests
 
-This project includes a suite of tests located in `tests/expect/`. These tests
-use the `expect` command to automate CLI interactions. The tests will run
-automatically as part of continuous integration, or you may run them locally with:
+This project includes a suite of tests located in `tests/`. These tests
+use [Bats](https://bats-core.readthedocs.io/en/stable/) to test command line
+interaction. The tests will run automatically as part of continuous integration,
+and you may also run them locally.
 
-```
-composer test
-```
-
-To run the tests, you must have an up-to-date version of coreutils (8.30 or
-later).
-
-To generate a new test:
+To ensure Bats is set up properly in your local environment, after cloning the
+project, download the Git submodules:
 
+```bash
+cd composer-install/
+git submodule init
+git submodule update
 ```
-cd tests/expect/
-autoexpect ../../bin/path-to-script-to-test.sh
-```
-
-`autoexpect` will save the test to `script.exp`. Rename it with a more
-descriptive name, and run it to ensure it does what you expect: `./script.exp`.
-You may need to edit the test file or add to it, according to your needs.
 
-Expect is an extension to the [Tcl](https://en.wikipedia.org/wiki/Tcl) scripting
-language, so it may be helpful to learn a little about Tcl as you write tests.
+Then run:
 
-When done, `cd ../..` and run `composer test`.
-Your new test should run along with the other tests.
+```bash
+composer test
+```
 
 [github]: https://github.com/ramsey/composer-install
 [issues]: https://github.com/ramsey/composer-install/issues

README.md

@@ -42,8 +42,8 @@ the [Setup PHP](https://github.com/shivammathur/setup-php) action as a step.
 - uses: "ramsey/composer-install@v3"
 ```
 
-:bulb: There is no need to set up a separate caching step since ramsey/composer-install
-handles this for you.
+> [!TIP]
+> There is no need to set up a separate caching step since ramsey/composer-install handles this for you.
 
 ### Input Parameters
 

bin/cache_key.sh

@@ -19,14 +19,14 @@ function make_key {
     tr "[:blank:]" "-" <<<"${non_empties[*]}"
 }
 
-runner_os="${1}"
-php_version="${2}"
-dependency_versions="${3:-locked}"
-composer_options="${4}"
-files_hash="${5}"
-custom_cache_key="${6}"
-custom_cache_suffix="${7}"
-working_directory="${8}"
+runner_os="${1:-}"
+php_version="${2:-}"
+dependency_versions="${3:-}"
+composer_options="${4:-}"
+files_hash="${5:-}"
+custom_cache_key="${6:-}"
+custom_cache_suffix="${7:-}"
+working_directory="${8:-}"
 
 key=()
 restore_key=()

bin/composer_install.sh

@@ -1,12 +1,12 @@
 #!/usr/bin/env bash
 
-dependency_versions="${1:-locked}"
-additional_composer_options="${2}"
-working_directory="${3}"
+dependency_versions="${1:-}"
+additional_composer_options="${2:-}"
+working_directory="${3:-}"
 php_path="${4:-$(which php)}"
 composer_path="${5:-$(which composer)}"
-composer_lock="${6}"
-require_lock_file="${7}"
+composer_lock="${6:-}"
+require_lock_file="${7:-}"
 
 composer_command="update"
 composer_options=("--no-interaction" "--no-progress" "--ansi")

bin/should_cache.sh

@@ -1,13 +1,11 @@
 #!/usr/bin/env bash
 
-ignore_cache="${1}"
-should_cache=1
+ignore_cache="${1:-}"
 will_cache="will cache"
 
 case "${ignore_cache}" in
-    1) should_cache=0 ;;
-    yes) should_cache=0 ;;
-    true) should_cache=0 ;;
+    1 | yes | Yes | y | Y | true | True) should_cache=0 ;;
+    *) should_cache=1 ;;
 esac
 
 if [ $should_cache -eq 0 ]; then

composer.json

@@ -16,7 +16,6 @@
         "allow-plugins": false
     },
     "scripts": {
-        "clean-tests": "git clean -fX tests/",
-        "test": "./tests/bash-test.sh tests/tests.sh"
+        "test": "./tests/test_helper/bats/bin/bats tests/"
     }
 }