tests: Add tests for #119 the optional import feature (and the subcommands feature)

Signed-off-by: Drew Robinson <drew.robinson@gmail.com>

Author: ocean

testdata/missing-imports.ahoy.yml

@@ -1,6 +1,6 @@
 ahoyapi: v2
 commands:
   missing-imports:
-    usage: "This item has imports set, but it doesn't exit."
+    usage: "This item has imports set, but it doesn't exist."
     imports:
       - "bogus.ahoy.yml"

testdata/non-optional-command.ahoy.yml

@@ -0,0 +1,6 @@
+ahoyapi: v2
+commands:
+  non-optional-cmd:
+    usage: This command is not optional
+    imports:
+      - non-existent-file.yml

testdata/optional-command.ahoy.yml

@@ -0,0 +1,10 @@
+ahoyapi: v2
+commands:
+  optional-cmd:
+    usage: These imports are optional
+    imports:
+      - testdata/non-existent-file.yml
+    optional: true
+  regular-cmd:
+    usage: This is a regular command
+    cmd: echo "This is a regular command"

tests/no-ahoy-file.bats

@@ -8,24 +8,24 @@ teardown() {
   mv tmp.ahoy.yml .ahoy.yml
 }
 
-@test "run ahoy without a command and without a .ahoy.yml file" {
+@test "Run ahoy without a command and without an .ahoy.yml file" {
   run ./ahoy
   [ $status -eq 1 ]
   [ "${lines[-2]}" == "[error] No .ahoy.yml found. You can use 'ahoy init' to download an example." ]
-  [ "${lines[-1]}" == "[fatal] Missing flag or argument." ]
+  [ "${lines[-1]}" == "[warn] Missing flag or argument." ]
 }
 
-@test "run an ahoy command without a .ahoy.yml file" {
+@test "Run an ahoy command without an .ahoy.yml file" {
   run ./ahoy something
   [ "$output" == "[fatal] Command not found for 'something'" ]
 }
 
-@test "run ahoy init without a .ahoy.yml file" {
+@test "Run ahoy init without an .ahoy.yml file" {
   run ./ahoy init
   [ "${lines[-1]}" == "Example .ahoy.yml downloaded to the current directory. You can customize it to suit your needs!" ]
 }
 
-@test "run ahoy init with a existing .ahoy.yml file in the current directory" {
+@test "Run ahoy init with an existing .ahoy.yml file in the current directory" {
   cp tmp.ahoy.yml .ahoy.yml
   run ./ahoy init --force
   [ "${lines[0]}" == "Warning: '--force' parameter passed, overwriting .ahoy.yml in current directory." ]

tests/optional-commands.bats

@@ -0,0 +1,42 @@
+#!/usr/bin/env bats
+
+load 'test_helpers/bats-support/load'
+load 'test_helpers/bats-assert/load'
+
+@test "Optional import not found doesn't cause error" {
+  # Run ahoy without arguments (which typically lists available commands)
+  run ./ahoy -f testdata/optional-command.ahoy.yml
+
+    # Check that the optional command is not listed
+  [[ ! "$output" =~ "optional-cmd" ]]
+
+  # Check that the regular command is listed
+  [[ "$output" =~ "regular-cmd" ]]
+
+  # Check that a standard "Missing argument" error is shown
+  [[ "$output" =~ "Missing flag or argument" ]]
+
+  # Check that the command exited with an error
+  [ $status -eq 1 ]
+
+  # Try to run the optional command (it should fail gracefully)
+  run ./ahoy -f testdata/optional-command.ahoy.yml optional-cmd
+  [ $status -eq 1 ]
+  [[ "$output" =~ "Command not found for 'optional-cmd'" ]]
+
+  # Run the regular command (it should work)
+  run ./ahoy -f testdata/optional-command.ahoy.yml regular-cmd
+  [ $status -eq 0 ]
+  [[ "$output" = "This is a regular command" ]]
+}
+
+@test "Non-optional command with missing imports causes error" {
+  # Run ahoy without arguments
+  run ./ahoy -f testdata/non-optional-command.ahoy.yml
+
+  # Check that the command failed
+  [ $status -eq 1 ]
+
+  # Check for the appropriate error message
+  [[ "$output" =~ "Command [non-optional-cmd] has 'imports' set, but no commands were found" ]]
+}

tests/simple.bats

@@ -1,20 +1,20 @@
 #!/usr/bin/env bats
 
-@test "display help text and fatal error when no arguments are passed." {
+@test "Display help text and fatal error when no arguments are passed." {
   run ./ahoy -f testdata/simple.ahoy.yml
   # Should throw an error.
   [ $status -ne 0 ]
   echo "$output"
   [ "${#lines[@]}" -gt 10 ]
-  [ "${lines[-1]}" == "[fatal] Missing flag or argument." ]
+  [ "${lines[-1]}" == "[warn] Missing flag or argument." ]
 }
 
-@test "run a simple ahoy command: echo" {
+@test "Run a simple ahoy command: echo" {
   result="$(./ahoy -f testdata/simple.ahoy.yml echo something)"
   [ "$result" == "something" ]
 }
 
-@test "run a simple ahoy command (ls -a) with an extra parameter (-l)" {
+@test "Run a simple ahoy command (ls -a) with an extra parameter (-l)" {
   run ./ahoy -f testdata/simple.ahoy.yml list -- -l
   [ "${#lines[@]}" -gt 13 ]
 }

tests/sub-commands.bats

@@ -0,0 +1,110 @@
+#!/usr/bin/env bats
+
+load 'test_helpers/bats-support/load'
+load 'test_helpers/bats-assert/load'
+
+setup() {
+  # Create a temporary directory for our test files
+  TEST_DIR="$(mktemp -d)"
+  
+  # Create main .ahoy.yml file
+  cat > "${TEST_DIR}/.ahoy.yml" <<EOF
+ahoyapi: v2
+commands:
+  main-cmd:
+    usage: Main command
+    imports:
+      - sub1.yml
+      - sub2.yml
+      - non-existent.yml
+EOF
+
+  # Create sub1.yml
+  cat > "${TEST_DIR}/sub1.yml" <<EOF
+ahoyapi: v2
+commands:
+  sub1-cmd:
+    usage: Subcommand 1
+    cmd: echo "Subcommand 1"
+EOF
+
+  # Create sub2.yml
+  cat > "${TEST_DIR}/sub2.yml" <<EOF
+ahoyapi: v2
+commands:
+  sub2-cmd:
+    usage: Subcommand 2
+    cmd: echo "Subcommand 2"
+EOF
+
+  # Copy freshly built ahoy binary to the test directory
+  cp ahoy "${TEST_DIR}"
+
+  # Change to the test directory
+  cd "${TEST_DIR}"
+}
+
+teardown() {
+  # Remove the temporary directory
+  rm -rf "${TEST_DIR}"
+}
+
+@test "getSubCommands() loads existing subcommands" {
+  run ./ahoy
+
+  # Check that main-cmd is listed
+  [[ "$output" =~ "Main command" ]]
+
+  # Check that the command executed with an expected error
+  [ "$status" -eq 1 ]
+
+  # Check that sub1-cmd and sub2-cmd are listed under main-cmd
+  run ahoy main-cmd --help
+  [ "$status" -eq 0 ]
+  [[ "$output" =~ "sub1-cmd" ]]
+  [[ "$output" =~ "sub2-cmd" ]]
+
+  # Check that non-existent.yml is ignored without error
+  [[ ! "$output" =~ "non-existent.yml" ]]
+
+  # Check that the command executed successfully
+  [ "$status" -eq 0 ]
+}
+
+@test "getSubCommands() executes subcommands correctly" {
+  # Test sub1-cmd
+  run ./ahoy main-cmd sub1-cmd
+  [ "$status" -eq 0 ]
+  [ "$output" = "Subcommand 1" ]
+
+  # Test sub2-cmd
+  run ./ahoy main-cmd sub2-cmd
+  [ "$status" -eq 0 ]
+  [ "$output" = "Subcommand 2" ]
+}
+
+@test "getSubCommands() handles empty imports" {
+  # Create an empty.ahoy.yml with empty imports
+  cat > empty.ahoy.yml <<EOF
+ahoyapi: v2
+commands:
+  empty-import:
+    usage: Command with empty imports
+    imports: []
+EOF
+
+  run ./ahoy -f empty.ahoy.yml
+  [[ "$output" =~ "empty-import" ]]
+
+  # Check that the command executed with an expected error
+  [ "$status" -eq 1 ]
+
+  run ./ahoy -f empty.ahoy.yml empty-import
+  
+  [[ "$output" =~ "empty-import" ]]
+  
+  [[ "$output" =~ "but it is empty" ]]
+  
+  # Check that the command executed with an expected error
+  [ "$status" -eq 1 ]
+}