✅ Update the tests to use a mock

Author: mcncl

tests/command.bats

@@ -0,0 +1,212 @@
+#!/usr/bin/env bats
+
+setup() {
+  load "${BATS_PLUGIN_PATH}/load.bash"
+
+  # Create a temporary directory for test files
+  export TEMP_DIR=$(mktemp -d)
+
+  # Setup environment
+  export BUILDKITE=true
+  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATOR_SKIP_IF_NO_BEP=false
+
+  # Mock the process_bep function to avoid relying on external tools
+  cat > "$TEMP_DIR/mock-bazel-bep.bash" << 'EOF'
+#!/bin/bash
+# Mock version of bazel-bep.bash that avoids external dependencies
+
+process_bep() {
+  local BEP_FILE="$1"
+  local BAZEL_COMMAND="${2:-}"
+
+  echo "Mock processing BEP file: $BEP_FILE"
+  if [[ -f "$BEP_FILE" ]]; then
+    echo "Mock BEP file exists, processing successful"
+    return 0
+  else
+    echo "Mock BEP file does not exist"
+    return 1
+  fi
+}
+
+create_annotation() {
+  local style="$1"
+  local content="$2"
+  echo "Mock annotation created with style: $style"
+}
+EOF
+
+  # Replace the real lib with our mock
+  export HOOKS_ORIG_DIR="$PWD/lib"
+  mkdir -p "$TEMP_DIR/lib"
+  cp "$TEMP_DIR/mock-bazel-bep.bash" "$TEMP_DIR/lib/bazel-bep.bash"
+
+  # Keep the original plugin.bash file
+  cp "$PWD/lib/plugin.bash" "$TEMP_DIR/lib/plugin.bash"
+
+  # Create a wrapper for the post-command hook
+  mkdir -p "$TEMP_DIR/hooks"
+  cat > "$TEMP_DIR/hooks/post-command" << 'EOF'
+#!/bin/bash
+set -euo pipefail
+
+# Source from the temp directory instead of the original
+DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd)"
+LIB_DIR="$(cd "$DIR/../lib" && pwd)"
+
+# Source the mocked files
+. "$LIB_DIR/plugin.bash"
+. "$LIB_DIR/bazel-bep.bash"
+
+# Get plugin configuration
+BEP_FILE=$(plugin_read_config BEP_FILE "")
+BAZEL_COMMAND=$(plugin_read_config BAZEL_COMMAND "")
+
+# Check if we should skip if no BEP file found
+SKIP_IF_NO_BEP=$(plugin_read_config SKIP_IF_NO_BEP "false")
+
+# Check for automatic BEP file detection based on Bazel command
+if [[ -z "${BEP_FILE}" && -n "${BAZEL_COMMAND}" ]]; then
+  # Try to extract the BEP file from the command if it was specified
+  if [[ "${BAZEL_COMMAND}" =~ --build_event_json_file=([^ ]+) ]]; then
+    BEP_FILE="${BASH_REMATCH[1]}"
+    echo "Detected BEP file from Bazel command: ${BEP_FILE}"
+  else
+    # No BEP file specified in command, check if skip is enabled
+    if [[ "${SKIP_IF_NO_BEP}" == "true" ]]; then
+      echo "No BEP file found in command and skip_if_no_bep is true, skipping annotation"
+      exit 0
+    fi
+    echo "Error: No BEP file found in command"
+    exit 1
+  fi
+fi
+
+# If we still don't have a BEP file, check if it exists at common locations
+if [[ -z "${BEP_FILE}" ]]; then
+  # Try some common locations
+  COMMON_LOCATIONS=(
+    "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bazel-events.json"
+    "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bazel-bep.json"
+    "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bep.json"
+  )
+
+  for location in "${COMMON_LOCATIONS[@]}"; do
+    if [[ -f "$location" ]]; then
+      BEP_FILE="$location"
+      echo "Found BEP file at common location: ${BEP_FILE}"
+      break
+    fi
+  done
+fi
+
+# Check if we have a BEP file
+if [[ -z "${BEP_FILE}" ]]; then
+  if [[ "${SKIP_IF_NO_BEP}" == "true" ]]; then
+    echo "No BEP file specified and skip_if_no_bep is true, skipping annotation"
+    exit 0
+  else
+    echo "Error: No BEP file specified"
+    exit 1
+  fi
+fi
+
+# Check if the BEP file exists
+if [[ ! -f "${BEP_FILE}" ]]; then
+  if [[ "${SKIP_IF_NO_BEP}" == "true" ]]; then
+    echo "BEP file not found at '${BEP_FILE}' and skip_if_no_bep is true, skipping annotation"
+    exit 0
+  else
+    echo "Error: BEP file not found at '${BEP_FILE}'"
+    exit 1
+  fi
+fi
+
+# Process the BEP file and create the annotation
+process_bep "${BEP_FILE}" "${BAZEL_COMMAND}"
+EOF
+  chmod +x "$TEMP_DIR/hooks/post-command"
+}
+
+teardown() {
+  rm -rf "$TEMP_DIR"
+}
+
+@test "Skip when no BEP file and skip option is enabled" {
+  # No BEP file, but we'll enable skip option
+  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATOR_SKIP_IF_NO_BEP=true
+
+  # Ensure no common files exist
+  rm -f "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bazel-events.json" || true
+  rm -f "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bazel-bep.json" || true
+  rm -f "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bep.json" || true
+
+  run "$TEMP_DIR/hooks/post-command"
+
+  assert_success
+  assert_output --partial "skip_if_no_bep is true, skipping annotation"
+}
+
+@test "Fail when no BEP file and skip option is disabled" {
+  # No BEP file, skip option disabled
+  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATOR_SKIP_IF_NO_BEP=false
+
+  # Ensure no common files exist
+  rm -f "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bazel-events.json" || true
+  rm -f "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bazel-bep.json" || true
+  rm -f "${BUILDKITE_BUILD_CHECKOUT_PATH:-$PWD}/bep.json" || true
+
+  run "$TEMP_DIR/hooks/post-command"
+
+  assert_failure
+  assert_output --partial "Error: No BEP file specified"
+}
+
+@test "Process BEP file when explicitly provided" {
+  # Create a sample BEP file
+  touch "$TEMP_DIR/sample.bep"
+  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATOR_BEP_FILE="$TEMP_DIR/sample.bep"
+
+  run "$TEMP_DIR/hooks/post-command"
+
+  assert_success
+  assert_output --partial "Mock processing BEP file: $TEMP_DIR/sample.bep"
+}
+
+@test "Detect BEP file from Bazel command" {
+  # Create a sample BEP file
+  touch "$TEMP_DIR/detected.bep"
+  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATOR_BAZEL_COMMAND="bazel build //... --build_event_json_file=$TEMP_DIR/detected.bep"
+
+  run "$TEMP_DIR/hooks/post-command"
+
+  assert_success
+  assert_output --partial "Detected BEP file from Bazel command: $TEMP_DIR/detected.bep"
+  assert_output --partial "Mock processing BEP file: $TEMP_DIR/detected.bep"
+}
+
+@test "Find BEP file at common location" {
+  # Create sample BEP file at a common location
+  mkdir -p "${BUILDKITE_BUILD_CHECKOUT_PATH:-$TEMP_DIR}"
+  touch "${BUILDKITE_BUILD_CHECKOUT_PATH:-$TEMP_DIR}/bazel-events.json"
+
+  # Make sure we're using the right path for testing
+  export BUILDKITE_BUILD_CHECKOUT_PATH="$TEMP_DIR"
+
+  run "$TEMP_DIR/hooks/post-command"
+
+  assert_success
+  assert_output --partial "Found BEP file at common location: $TEMP_DIR/bazel-events.json"
+  assert_output --partial "Mock processing BEP file: $TEMP_DIR/bazel-events.json"
+}
+
+@test "Skip when BEP file doesn't exist and skip is enabled" {
+  # Reference a non-existent BEP file with skip enabled
+  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATOR_BEP_FILE="$TEMP_DIR/nonexistent.bep"
+  export BUILDKITE_PLUGIN_BAZEL_BEP_ANNOTATOR_SKIP_IF_NO_BEP=true
+
+  run "$TEMP_DIR/hooks/post-command"
+
+  assert_success
+  assert_output --partial "BEP file not found at '$TEMP_DIR/nonexistent.bep' and skip_if_no_bep is true"
+}