functions.yaml

name: "Functions"
cases:
  - name: "Basic function invocation"
    test_files:
      - path: "script.sh"
        contents: |
          myfunc() {
              echo "In myfunc()."
          }
          echo "Calling myfunc()..."
          myfunc
          echo "Returned."
    args: ["./script.sh"]

  - name: "Function invocation with args"
    test_files:
      - path: "script.sh"
        contents: |
          myfunc() {
              echo "In myfunc()"
              echo "1: $1"
              echo "*: $*"
          }
          echo "Calling myfunc()..."
          myfunc a b c
          echo "Returned."
    args: ["./script.sh"]

  - name: "Function invocation with empty arg"
    stdin: |
      myfunc() {
          echo "count: ${#*}"
          echo "\$1: $1"
          echo "\$2: $2"
          echo "\$3: $3"
      }

      myfunc a b c
      myfunc a "" c

  - name: "Return in function"
    test_files:
      - path: "script.sh"
        contents: |
          myfunc() {
              echo "In myfunc()"
              return 5
              echo "Should not get here"
          }
          echo "Calling myfunc()..."
          myfunc
          echo "Returned: $?"
    args: ["./script.sh"]

  - name: "Return in for loop in function"
    stdin: |
      myfunc() {
          for i in 1 2 3; do
              echo "In myfunc: $i"
              return 5
          done
      }

      myfunc
      echo "Returned: $?"

  - name: "Return in arithmetic for loop in function"
    stdin: |
      myfunc() {
          for ((i=0; i < 5; i++)); do
              echo "In myfunc: $i"
              return 5
          done
      }

      myfunc
      echo "Returned: $?"

  - name: "Return in while loop in function"
    stdin: |
      myfunc() {
          i=0
          while [[ $i -lt 5 ]]; do
            echo "In myfunc: $i"
            return 33
            i=$((i+1))
          done
      }

      myfunc
      echo "Returned: $?"

  - name: "Return in case"
    stdin: |
      myfunc() {
        case 1 in
            1)
                echo "In case"
                return 5
                echo "Should not get here"
                ;;
        esac
      }

      myfunc
      echo "Returned: $?"

  - name: "Return in brace group"
    stdin: |
      myfunc() {
        {
          echo "In brace group"
          return 5
          echo "Should not get here"
        }
      }

      myfunc
      echo "Returned: $?"

  - name: "Return in and/or"
    stdin: |
      myfunc() {
        echo "In and/or" && return 5 && echo "Should not get here"
      }

      myfunc
      echo "Returned: $?"

  - name: "Return from nested clauses"
    stdin: |
      myfunc() {
        while (($#)); do
          case $1 in
              *)
                  shift 2 || {
                    echo "Returning"
                    return 5
                  }
                  echo "Shifted and fell through"
          esac
        done
      }

      myfunc a b c

  - name: "Function definition with output redirection"
    stdin: |
      myfunc() {
          echo "In myfunc()"
      } >>./test.txt

      myfunc
      myfunc

  - name: "Function call with env variables"
    stdin: |
      myfunc() {
          echo ${myvar}
      }

      myvar="default"
      myfunc
      myvar="overridden" myfunc
      myfunc

  - name: "Function definition without braces"
    stdin: |
      myfunc()
      if true; then
        echo true
      else
        echo false
      fi

      myfunc

  - name: "Nested function definition"
    stdin: |
      outer() {
        echo "Entered outer"

        inner() {
          echo "In inner"
        }

        echo "Invoking inner"

        inner

        echo "Returning from outer"
      }

      echo "Calling outer from toplevel"
      outer

      echo "Calling inner from toplevel"
      inner