shellspec/shellspec

#shellcheck shell=sh disable=SC2016

shellspec_output_METADATA() {
  shellspec_output_meta "info:$SHELLSPEC_INFO" "shell:$SHELLSPEC_SHELL" \
    "shell_type:$SHELLSPEC_SHELL_TYPE" "shell_version:$SHELLSPEC_SHELL_VERSION"
}

shellspec_output_FINISHED() {
  shellspec_output_finished
}

shellspec_output_BEGIN() {
  shellspec_output_begin "specfile:$SHELLSPEC_SPECFILE"
}

shellspec_output_END() {
  shellspec_output_end "example_count:$SHELLSPEC_EXAMPLE_COUNT"
}

shellspec_output_EXAMPLE() {
  shellspec_output_example "id:$SHELLSPEC_EXAMPLE_ID" \
    "block_no:$SHELLSPEC_BLOCK_NO" "example_no:$SHELLSPEC_EXAMPLE_NO" \
    "focused:$SHELLSPEC_FOCUSED" "description:$SHELLSPEC_DESCRIPTION" \
    "stdout:$SHELLSPEC_STDOUT_FILE" "stderr:$SHELLSPEC_STDERR_FILE"
}

shellspec_output_EVALUATION() {
  shellspec_output_statement "tag:evaluation" "note:" "fail:" \
    "evaluation:$SHELLSPEC_EVALUATION"
}

shellspec_output_SKIP() {
  if shellspec_is_temporary_skip; then
    shellspec_output_statement "tag:skip" "note:SKIPPED" "fail:" \
      "skipid:$SHELLSPEC_SKIP_ID" "temporary:y" \
      "message:${SHELLSPEC_SKIP_REASON:-# Temporarily skipped}"
  else
    shellspec_output_statement "tag:skip" "note:SKIPPED" "fail:" \
      "skipid:$SHELLSPEC_SKIP_ID" "temporary:" \
      "message:$SHELLSPEC_SKIP_REASON"
  fi
}

shellspec_output_PENDING() {
  if shellspec_is_temporary_pending; then
    shellspec_output_statement "tag:pending" "note:PENDING" "fail:" \
      "pending:y" "temporary:y" \
      "message:${SHELLSPEC_PENDING_REASON:-# Temporarily pended}"
  else
    shellspec_output_statement "tag:pending" "note:PENDING" "fail:" \
      "pending:y" "temporary:" \
      "message:$SHELLSPEC_PENDING_REASON"
  fi
}

shellspec_output_NOT_IMPLEMENTED() {
  shellspec_output_statement "tag:pending" "note:PENDING" "fail:" "pending:y" \
    "temporary:" "message:$SHELLSPEC_PENDING_REASON"
}

shellspec_output_NO_EXPECTATION() {
  shellspec_output_statement "tag:warn" "note:WARNING" \
    "fail:${SHELLSPEC_WARNING_AS_FAILURE:+y}" \
    "message:Not found any expectation" "failure_message:"
}

shellspec_output_UNHANDLED_STATUS() {
  SHELLSPEC_LINENO=$SHELLSPEC_LINENO_BEGIN-$SHELLSPEC_LINENO_END
  shellspec_output_statement "tag:warn" "note:WARNING" \
    "fail:${SHELLSPEC_WARNING_AS_FAILURE:+y}" \
    "message:It exits with status non-zero but not found expectation" \
    "failure_message:status:${SHELLSPEC_STATUS}${SHELLSPEC_LF}"
}

shellspec_output_UNHANDLED_STDOUT() {
  SHELLSPEC_LINENO=$SHELLSPEC_LINENO_BEGIN-$SHELLSPEC_LINENO_END
  unset UNHANDLED_STDOUT || :
  if [ -e "$SHELLSPEC_STDOUT_FILE" ]; then
    shellspec_head UNHANDLED_STDOUT < "$SHELLSPEC_STDOUT_FILE"
  fi
  shellspec_output_statement "tag:warn" "note:WARNING" \
    "fail:${SHELLSPEC_WARNING_AS_FAILURE:+y}" \
    "message:There was output to stdout but not found expectation" \
    "failure_message:stdout:${UNHANDLED_STDOUT- <none>}${SHELLSPEC_LF}"
}

shellspec_output_UNHANDLED_STDERR() {
  SHELLSPEC_LINENO=$SHELLSPEC_LINENO_BEGIN-$SHELLSPEC_LINENO_END
  unset UNHANDLED_STDERR || :
  if [ -e "$SHELLSPEC_STDERR_FILE" ]; then
    shellspec_head UNHANDLED_STDERR < "$SHELLSPEC_STDERR_FILE"
  fi
  shellspec_output_statement "tag:warn" "note:WARNING" \
    "fail:${SHELLSPEC_WARNING_AS_FAILURE:+y}" \
    "message:There was output to stderr but not found expectation" \
    "failure_message:stderr:${UNHANDLED_STDERR- <none>}${SHELLSPEC_LF}"
}

shellspec_output_ASSERT_WARN() {
  shellspec_capturefile SHELLSPEC_ASSERT_STDERR "$2"
  set -- "Unexpected output to stderr occurred (exit status: $1)"
  if [ "$SHELLSPEC_ASSERT_STDERR" ]; then
    set -- "$1${SHELLSPEC_LF}${SHELLSPEC_ASSERT_STDERR}${SHELLSPEC_LF}"
  fi
  shellspec_output_statement tag:warn note:WARNING \
    "fail:${SHELLSPEC_WARNING_AS_FAILURE:+y}" \
    "message:$SHELLSPEC_EXPECTATION" "failure_message:$1"
}

shellspec_output_ASSERT_ERROR() {
  shellspec_capturefile SHELLSPEC_ASSERT_STDERR "$2"
  set -- "assertion failure (exit status: $1)"
  if [ "$SHELLSPEC_ASSERT_STDERR" ]; then
    set -- "$1${SHELLSPEC_LF}${SHELLSPEC_ASSERT_STDERR}${SHELLSPEC_LF}"
  fi
  shellspec_output_statement tag:bad note: fail:y \
    "message:$SHELLSPEC_EXPECTATION" "failure_message:$1"
}

shellspec_output_BEFORE_ALL_ERROR() {
  shellspec_capturefile SHELLSPEC_ERROR "$SHELLSPEC_ERROR_FILE"
  set -- "$SHELLSPEC_HOOK" "$SHELLSPEC_HOOK_STATUS"
  shellspec_output_error note:ERROR "lineno:$SHELLSPEC_HOOK_LINENO" \
    "message:An error occurred in before all hook '$1' (exit status: $2)" \
    "failure_message:${SHELLSPEC_ERROR:-<no error>}${SHELLSPEC_LF}"
}

shellspec_output_AFTER_ALL_ERROR() {
  shellspec_capturefile SHELLSPEC_ERROR "$SHELLSPEC_ERROR_FILE"
  set -- "$SHELLSPEC_HOOK" "$SHELLSPEC_HOOK_STATUS"
  shellspec_output_error note:ERROR "lineno:$SHELLSPEC_HOOK_LINENO" \
    "message:An error occurred in after hook '$1' (exit status: $2)" \
    "failure_message:${SHELLSPEC_ERROR:-<no error>}${SHELLSPEC_LF}"
}

shellspec_output_BEFORE_EACH_ERROR() {
  shellspec_capturefile SHELLSPEC_ERROR "$SHELLSPEC_ERROR_FILE"
  set -- "$SHELLSPEC_HOOK" "$SHELLSPEC_HOOK_LINENO" "$SHELLSPEC_HOOK_STATUS"
  SHELLSPEC_LINENO=$SHELLSPEC_LINENO_BEGIN-$SHELLSPEC_LINENO_END
  shellspec_output_statement tag:bad note: fail:y evaluation: \
    "message:An error occurred in before hook '$1' (line: $2, exit status: $3)" \
    "failure_message:${SHELLSPEC_ERROR:-<no error>}${SHELLSPEC_LF}"
}

shellspec_output_AFTER_EACH_ERROR() {
  shellspec_capturefile SHELLSPEC_ERROR "$SHELLSPEC_ERROR_FILE"
  set -- "$SHELLSPEC_HOOK" "$SHELLSPEC_HOOK_LINENO" "$SHELLSPEC_HOOK_STATUS"
  SHELLSPEC_LINENO=$SHELLSPEC_LINENO_BEGIN-$SHELLSPEC_LINENO_END
  shellspec_output_statement tag:bad note: fail:y evaluation: \
    "message:An error occurred in after hook '$1' (line: $2, exit status: $3)" \
    "failure_message:${SHELLSPEC_ERROR:-<no error>}${SHELLSPEC_LF}"
}

shellspec_output_HOOK_ERROR() {
  shellspec_output_statement tag:bad note: fail:y failure_message: \
    "message:Treat as a failure due to a preceding hook error"
}

shellspec_output_MATCHED() {
  shellspec_if PENDING && shellspec_output_MATCHED_FIXED && return 0
  shellspec_output_statement tag:good note: fail: \
    "message:$SHELLSPEC_EXPECTATION"
}

shellspec_output_MATCHED_FIXED() {
  shellspec_output_statement tag:good note:FIXED fail: \
    "message:$SHELLSPEC_EXPECTATION"
}

shellspec_output_UNMATCHED() {
  shellspec_output_statement "tag:bad" "note:" "fail:y" \
    "message:$SHELLSPEC_EXPECTATION" "failure_message:$1${SHELLSPEC_LF}"
}

shellspec_output_SYNTAX_ERROR() {
  shellspec_output_statement tag:bad note:SYNTAX ERROR fail:y \
    "message:$SHELLSPEC_EXPECTATION" \
    "failure_message:${1:-unknown syntax error}${SHELLSPEC_LF}"
}

shellspec_output_SYNTAX_ERROR_EVALUATION() {
  shellspec_output_statement tag:bad note: fail:y \
    "message:$SHELLSPEC_EVALUATION" \
    "failure_message:${1:-unknown syntax error}${SHELLSPEC_LF}"
}

shellspec_output_SYNTAX_ERROR_EXPECTATION() {
  shellspec_output_statement tag:bad note: fail:y \
    "message:$SHELLSPEC_EXPECTATION" \
    "failure_message:${1:-unknown syntax error}${SHELLSPEC_LF}"
}

shellspec_output_SYNTAX_ERROR_MATCHER_REQUIRED() {
  set -- "A word is required after $(shellspec_syntax_name)" \
    "The correct word is one of the following" \
    "$(shellspec_syntax_following_words "shellspec_matcher")"
  shellspec_output_statement tag:bad note: fail:y \
    "message:$SHELLSPEC_EXPECTATION" \
    "failure_message:$1. $2. ${SHELLSPEC_LF}${SHELLSPEC_LF}$3${SHELLSPEC_LF}"
}

shellspec_output_SYNTAX_ERROR_DISPATCH_FAILED() {
  [ "$1" = modifier ] && set -- "$1/verb" "${2:-}"
  case ${2:-} in
    '') set -- "$1" "Unknown word '$2' after" ;;
    *) set -- "$1" "A word is required after" ;;
  esac
  set -- "$2 $(shellspec_syntax_name)." \
    "The correct word is one of the following." \
    "$(shellspec_syntax_following_words "shellspec_${1%/verb}")"
  shellspec_output_statement tag:bad note: fail:y \
    "message:$SHELLSPEC_EXPECTATION" \
    "failure_message:$1$2${SHELLSPEC_LF}${SHELLSPEC_LF}$3${SHELLSPEC_LF}"
}

shellspec_output_SYNTAX_ERROR_WRONG_PARAMETER_COUNT() {
  set -- "Wrong parameter $1 of $(shellspec_syntax_name)"
  shellspec_output_statement "tag:bad" "note:" "fail:y" \
    "message:$SHELLSPEC_EXPECTATION" "failure_message:$1${SHELLSPEC_LF}"
}

shellspec_output_SYNTAX_ERROR_PARAM_TYPE() {
  set -- "The parameter #$1 of $(shellspec_syntax_name) is not a $2"
  shellspec_output_statement "tag:bad" "note:" "fail:y" \
    "message:$SHELLSPEC_EXPECTATION" "failure_message:$1${SHELLSPEC_LF}"
}

shellspec_output_RESULT_WARN() {
  shellspec_capturefile SHELLSPEC_RESULT_ERROR "$2"
  set -- "Unexpected output to stderr occurred in result modifier " \
    "(exit status: $1)${SHELLSPEC_LF}${SHELLSPEC_RESULT_ERROR}${SHELLSPEC_LF}"
  shellspec_output_statement "tag:warn" "note:WARNING" \
    "fail:${SHELLSPEC_WARNING_AS_FAILURE:+y}" \
    "message:$SHELLSPEC_EXPECTATION" "failure_message:$1$2"
}

shellspec_output_SATISFY_WARN() {
  shellspec_capturefile SHELLSPEC_SATISFY_WARN "$2"
  set -- "Unexpected output to stderr occurred in satisfy matcher " \
    "(exit status: $1)${SHELLSPEC_LF}${SHELLSPEC_SATISFY_WARN}${SHELLSPEC_LF}"
  shellspec_output_statement "tag:warn" "note:WARNING" \
    "fail:${SHELLSPEC_WARNING_AS_FAILURE:+y}" \
    "message:$SHELLSPEC_EXPECTATION" "failure_message:$1$2"
}

shellspec_output_ABORTED() {
  set -- "$1" "$2" ""
  if [ -e "$2" ]; then
    shellspec_capturefile SHELLSPEC_ABORTED "$2"
    set -- "$1" "$2" "${SHELLSPEC_ABORTED}${SHELLSPEC_ABORTED:+$SHELLSPEC_LF}"
  fi
  SHELLSPEC_LINENO=$SHELLSPEC_LINENO_BEGIN-$SHELLSPEC_LINENO_END
  shellspec_output_statement "tag:bad" "note:" "fail:y" \
    "message:Example aborted (exit status: $1)" "failure_message:$3"
}

shellspec_output_LEAK() {
  shellspec_capturefile SHELLSPEC_LEAK "$1"
  # shellcheck disable=SC2034
  SHELLSPEC_LINENO=$SHELLSPEC_LINENO_BEGIN-$SHELLSPEC_LINENO_END
  shellspec_output_statement "tag:bad" "note:" "fail:y" \
    "message:Unexpected output to stderr occurred" \
    "failure_message:${SHELLSPEC_LEAK}${SHELLSPEC_LF}"
}

shellspec_output_SUCCEEDED() {
  shellspec_output_result tag:succeeded note: fail: quick:
}

shellspec_output_FAILED() {
  shellspec_output_result tag:failed note:FAILED fail:y quick:y
}

shellspec_output_ERROR() {
  shellspec_output_result tag:error note:ERROR fail:y quick:y
}

shellspec_output_WARNED() {
  shellspec_output_result tag:warned note:WARNED \
    fail:${SHELLSPEC_WARNING_AS_FAILURE:+y} \
    quick:${SHELLSPEC_WARNING_AS_FAILURE:+y}
}

shellspec_output_TODO() {
  if shellspec_is_temporary_pending; then
    shellspec_output_result tag:todo note:PENDING fail: quick:y temporary:y
  else
    shellspec_output_result tag:todo note:PENDING fail: quick: temporary:
  fi
}

shellspec_output_FIXED() {
  if shellspec_is_temporary_pending; then
    shellspec_output_result tag:fixed note:FIXED fail:y quick:y temporary:y
  else
    shellspec_output_result tag:fixed note:FIXED fail:y quick: temporary:
  fi
}

shellspec_output_SKIPPED() {
  if shellspec_is_temporary_skip; then
    shellspec_output_result tag:skipped note:SKIPPED fail: quick: temporary:y
  else
    shellspec_output_result tag:skipped note:SKIPPED fail: quick: temporary:
  fi
}

shellspec_output_DSL_ERROR() {
  shellspec_output_statement "tag:bad" "note:ERROR" "fail:y" "failure_message:" \
    "message:$1"
}