test files: rename xxx_test.sh to xxx.bats, fix shebang (#541)

* test files: rename xxx_test.sh to xxx.bats, fix shebang

* pr.yml: remove md, add bats.

* Fix a help file (thanks to Glenn)

* Also trigger running tests for renamed files

Co-authored-by: Glenn Jackman <[email protected]>

.github/workflows/pr.yml

@@ -22,8 +22,8 @@ jobs:
         run: |
           pr_endpoint=$(jq -r '"repos/\(.repository.full_name)/pulls/\(.pull_request.number)"' "$GITHUB_EVENT_PATH")
           gh api "$pr_endpoint/files" --paginate --jq '
-            .[] | 
-              select(.status == "added" or .status == "modified") |
-              select(.filename | match("\\.(md|sh|bash)$")) |
+            .[] |
+              select(.status == "added" or .status == "modified" or .status == "renamed") |
+              select(.filename | match("\\.(sh|bash|bats)$")) |
               .filename
           ' | xargs -r bash .github/scripts/pr

POLICIES.md

@@ -41,7 +41,7 @@ document, which thoroughly discusses the structure of an exercise.
 
 ### Exercise Test Structure
 
-The tests will not enforce using a specific function, unless the problems are complex or requires it (ex: https://github.com/exercism/bash/blob/main/exercises/practice/list-ops/list_ops_test.sh)
+The tests will not enforce using a specific function, unless the problems are complex or requires it (ex: https://github.com/exercism/bash/blob/main/exercises/practice/list-ops/list_ops.bats)
 
 ```
 run bash exercise.sh "string"

bin/canonical_data_check

@@ -81,7 +81,7 @@ do
     echo "$slug: needs update (v$track_data_version -> v$canonical_data_version)."
   fi
 
-  test_file="$path_to_track/exercises/$slug/${slug//-/_}_test.sh"
+  test_file="$path_to_track/exercises/$slug/${slug//-/_}.bats"
   test_file_version=$( awk '/# local version: / {print $NF}' "$test_file" )
 
   # the test file version number must include the .meta

bin/validate_one_exercise

@@ -18,7 +18,7 @@ exercise_name=${exercise//-/_}  # replace "-" with "_" to follow convention
 solution="./.meta/example.sh"
 
 [[ -f ${exercise_name}.sh      ]] || die "Missing stub file for $exercise"
-[[ -f ${exercise_name}_test.sh ]] || die "Missing tests file for $exercise"
+[[ -f ${exercise_name}.bats    ]] || die "Missing tests file for $exercise"
 [[ -f ${solution}              ]] || die "Missing solution file for $exercise"
 
 echo "Processing $exercise"
@@ -32,4 +32,4 @@ trap cleanup EXIT
 cp "${solution}" "${exercise_name}.sh"
 
 # Run the tests
-bats "${exercise_name}_test.sh"
+bats "${exercise_name}.bats"

config.json

@@ -23,7 +23,7 @@
       "%{snake_slug}.sh"
     ],
     "test": [
-      "%{snake_slug}_test.sh"
+      "%{snake_slug}.bats"
     ],
     "example": [
       ".meta/example.sh"

docs/TESTS.md

@@ -7,7 +7,7 @@ leader in the bash testing area. For these examples we are using
 Run the tests for the hypothetical "whatever" exercise like this:
 ```bash
 cd /path/to/your/exercise_workspace/bash/whatever
-bats whatever_test.sh
+bats whatever.bats
 ```
 
 For help on the meaning of the various `assert*` commands in the

exercises/practice/acronym/.meta/config.json

@@ -19,7 +19,7 @@
       "acronym.sh"
     ],
     "test": [
-      "acronym_test.sh"
+      "acronym.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/acronym/acronym_test.sh → exercises/practice/acronym/acronym.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.7.0.1

exercises/practice/affine-cipher/.meta/config.json

@@ -15,7 +15,7 @@
       "affine_cipher.sh"
     ],
     "test": [
-      "affine_cipher_test.sh"
+      "affine_cipher.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/affine-cipher/affine_cipher_test.sh → exercises/practice/affine-cipher/affine_cipher.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 2.0.0.0

exercises/practice/all-your-base/.meta/config.json

@@ -14,7 +14,7 @@
       "all_your_base.sh"
     ],
     "test": [
-      "all_your_base_test.sh"
+      "all_your_base.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/all-your-base/all_your_base_test.sh → exercises/practice/all-your-base/all_your_base.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 2.3.0.0

exercises/practice/allergies/.meta/config.json

@@ -14,7 +14,7 @@
       "allergies.sh"
     ],
     "test": [
-      "allergies_test.sh"
+      "allergies.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/allergies/allergies_test.sh → exercises/practice/allergies/allergies.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 2.0.0.0

exercises/practice/anagram/.meta/config.json

@@ -19,7 +19,7 @@
       "anagram.sh"
     ],
     "test": [
-      "anagram_test.sh"
+      "anagram.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/anagram/anagram_test.sh → exercises/practice/anagram/anagram.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.5.0.0

exercises/practice/armstrong-numbers/.meta/config.json

@@ -18,7 +18,7 @@
       "armstrong_numbers.sh"
     ],
     "test": [
-      "armstrong_numbers_test.sh"
+      "armstrong_numbers.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/armstrong-numbers/armstrong_numbers_test.sh → exercises/practice/armstrong-numbers/armstrong_numbers.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.1.0.0

exercises/practice/atbash-cipher/.meta/config.json

@@ -18,7 +18,7 @@
       "atbash_cipher.sh"
     ],
     "test": [
-      "atbash_cipher_test.sh"
+      "atbash_cipher.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/atbash-cipher/atbash_cipher_test.sh → exercises/practice/atbash-cipher/atbash_cipher.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.2.0.0

exercises/practice/beer-song/.meta/config.json

@@ -14,7 +14,7 @@
       "beer_song.sh"
     ],
     "test": [
-      "beer_song_test.sh"
+      "beer_song.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/beer-song/beer_song_test.sh → exercises/practice/beer-song/beer_song.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 2.1.0.1

exercises/practice/binary-search/.meta/config.json

@@ -14,7 +14,7 @@
       "binary_search.sh"
     ],
     "test": [
-      "binary_search_test.sh"
+      "binary_search.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/binary-search/binary_search_test.sh → exercises/practice/binary-search/binary_search.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.3.0.0

exercises/practice/bob/.meta/config.json

@@ -22,7 +22,7 @@
       "bob.sh"
     ],
     "test": [
-      "bob_test.sh"
+      "bob.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/bob/bob_test.sh → exercises/practice/bob/bob.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.6.0.0

exercises/practice/bowling/.meta/config.json

@@ -13,7 +13,7 @@
       "bowling.sh"
     ],
     "test": [
-      "bowling_test.sh"
+      "bowling.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/bowling/bowling_test.sh → exercises/practice/bowling/bowling.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.2.0.0

exercises/practice/change/.meta/config.json

@@ -14,7 +14,7 @@
       "change.sh"
     ],
     "test": [
-      "change_test.sh"
+      "change.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/change/change_test.sh → exercises/practice/change/change.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.3.0.0

exercises/practice/clock/.meta/config.json

@@ -12,7 +12,7 @@
       "clock.sh"
     ],
     "test": [
-      "clock_test.sh"
+      "clock.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/clock/clock_test.sh → exercises/practice/clock/clock.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 2.4.0.1

exercises/practice/collatz-conjecture/.meta/config.json

@@ -17,7 +17,7 @@
       "collatz_conjecture.sh"
     ],
     "test": [
-      "collatz_conjecture_test.sh"
+      "collatz_conjecture.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/collatz-conjecture/collatz_conjecture_test.sh → exercises/practice/collatz-conjecture/collatz_conjecture.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.2.1.0

exercises/practice/crypto-square/.meta/config.json

@@ -12,7 +12,7 @@
       "crypto_square.sh"
     ],
     "test": [
-      "crypto_square_test.sh"
+      "crypto_square.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/crypto-square/crypto_square_test.sh → exercises/practice/crypto-square/crypto_square.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 3.2.0.0

exercises/practice/darts/.meta/config.json

@@ -12,7 +12,7 @@
       "darts.sh"
     ],
     "test": [
-      "darts_test.sh"
+      "darts.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/darts/darts_test.sh → exercises/practice/darts/darts.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 2.2.0.1

exercises/practice/diamond/.meta/config.json

@@ -15,7 +15,7 @@
       "diamond.sh"
     ],
     "test": [
-      "diamond_test.sh"
+      "diamond.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/diamond/diamond_test.sh → exercises/practice/diamond/diamond.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.1.0.0

exercises/practice/difference-of-squares/.meta/config.json

@@ -20,7 +20,7 @@
       "difference_of_squares.sh"
     ],
     "test": [
-      "difference_of_squares_test.sh"
+      "difference_of_squares.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/difference-of-squares/difference_of_squares_test.sh → exercises/practice/difference-of-squares/difference_of_squares.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.2.0.0

exercises/practice/diffie-hellman/.meta/config.json

@@ -14,7 +14,7 @@
       "diffie_hellman.sh"
     ],
     "test": [
-      "diffie_hellman_test.sh"
+      "diffie_hellman.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/diffie-hellman/diffie_hellman_test.sh → exercises/practice/diffie-hellman/diffie_hellman.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.0.0.0

exercises/practice/dnd-character/.meta/config.json

@@ -12,7 +12,7 @@
       "dnd_character.sh"
     ],
     "test": [
-      "dnd_character_test.sh"
+      "dnd_character.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/dnd-character/dnd_character_test.sh → exercises/practice/dnd-character/dnd_character.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 1.1.0.0

exercises/practice/error-handling/.meta/config.json

@@ -21,7 +21,7 @@
       "error_handling.sh"
     ],
     "test": [
-      "error_handling_test.sh"
+      "error_handling.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/error-handling/error_handling_test.sh → exercises/practice/error-handling/error_handling.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 0.0.1

exercises/practice/food-chain/.meta/config.json

@@ -14,7 +14,7 @@
       "food_chain.sh"
     ],
     "test": [
-      "food_chain_test.sh"
+      "food_chain.bats"
     ],
     "example": [
       ".meta/example.sh"

exercises/practice/food-chain/food_chain_test.sh → exercises/practice/food-chain/food_chain.bats

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/usr/bin/env bats
 load bats-extra
 
 # local version: 2.1.0.0