#!/bin/bash

# Script to check API diffs using oasdiff

# Usage: ./scripts/api-diff/api-diff.sh [--fail-on-breaking] [filename.yaml]

# Assumes you have Docker installed and the repo is checked out with master branch available

set -e # Exit on error

set -o pipefail # Catch errors in pipes

# Change to repo root

cd "$(dirname "$0")/../.."

# Configuration

DOCKER_IMAGE="${OASDIFF_DOCKER_IMAGE:-tufin/oasdiff:latest}"

# Detect base branch from GitHub Actions environment or fallback to local defaults

if [ -n "$GITHUB_BASE_REF" ]; then

# In GitHub Actions PR, use the base ref (e.g., "master")

BASE_BRANCH="${BASE_BRANCH:-origin/$GITHUB_BASE_REF}"

else

# Local development: default to origin/master

BASE_BRANCH="${BASE_BRANCH:-origin/master}"

fi

FAIL_ON_BREAKING=false

TARGET_FILE=""

DRY_RUN=false

detect_breaking_commit_marker() {

local commits="$1"

# Conventional Commits breaking indicators:

# 1) An exclamation mark in the type/scope header, e.g. feat!: ... or feat(api)!: ...

# 2) A BREAKING CHANGE footer in the commit body

if echo "$commits" | grep -Eiq '^[[:space:]]*[a-z]+(\([^)]+\))?!:'; then

return 0

fi

if echo "$commits" | grep -Eiq 'BREAKING[ -]CHANGE:'; then

return 0

fi

return 1

}

get_commit_messages() {

# For tests and local overrides

if [ -n "$COMMIT_MESSAGES" ]; then

echo "$COMMIT_MESSAGES"

return 0

fi

# In GitHub Actions PRs, scan all commit subjects + bodies in the PR range.

if [ -n "$GITHUB_BASE_REF" ]; then

git log --format='%s%n%b%n----' "origin/$GITHUB_BASE_REF..HEAD" 2>/dev/null || true

return 0

fi

# Local default: inspect HEAD commit only.

git log -1 --format='%s%n%b' 2>/dev/null || true

}

# Parse arguments

for arg in "$@"; do

if [ "$arg" = "--fail-on-breaking" ]; then

FAIL_ON_BREAKING=true

elif [ "$arg" = "--dry-run" ]; then

DRY_RUN=true

elif [[ "$arg" == *.yaml ]]; then

TARGET_FILE="$arg"

fi

done

# If --fail-on-breaking not explicitly set, determine based on conventional commit markers.

if [ "$FAIL_ON_BREAKING" = false ]; then

COMMIT_TEXT=$(get_commit_messages)

if detect_breaking_commit_marker "$COMMIT_TEXT"; then

echo "Detected conventional commit breaking marker ('!' in header or 'BREAKING CHANGE:' footer), allowing breaking changes"

FAIL_ON_BREAKING=false

else

echo "No conventional commit breaking marker found, failing on breaking changes"

FAIL_ON_BREAKING=true

fi

fi

if [ "$DRY_RUN" = true ]; then

if [ "$FAIL_ON_BREAKING" = true ]; then

echo "Mode: Failing on breaking changes"

else

echo "Mode: Allowing breaking changes"

fi

echo "Dry run mode, exiting after commit message check"

exit 0

fi

echo "Starting API diff check..."

# Ensure we're in the repo root

if [ ! -f "xero_accounting.yaml" ]; then

echo "Error: Not in repo root or xero_accounting.yaml not found"

exit 1

fi

# Fetch master if not already done

git fetch "${BASE_BRANCH%%/*}" "${BASE_BRANCH##*/}" 2>/dev/null || echo "Warning: Could not fetch ${BASE_BRANCH}"

# Create temp directory for master branch files (outside repo to avoid overlap with /current mount)

TEMP_DIR=$(mktemp -d)

trap "rm -rf $TEMP_DIR" EXIT

# Get list of xero*.yaml files (excluding any master_*.yaml files)

if [ -n "$TARGET_FILE" ]; then

# Single file specified

if [ ! -f "$TARGET_FILE" ]; then

echo "Error: File '$TARGET_FILE' not found"

exit 1

fi

files="$TARGET_FILE"

echo "Running diff for single file: $TARGET_FILE"

else

# All xero*.yaml files

files=$(ls xero*.yaml 2>/dev/null | grep -v "^master_")

if [ -z "$files" ]; then

echo "No xero*.yaml files found"

exit 1

fi

fi

BREAKING_CHANGES_FOUND=false

FILES_WITH_BREAKING_CHANGES=()

TOTAL_FILES=0

PROCESSED_FILES=0

echo "========================================"

echo "API Diff Summary"

echo "Using Docker image: $DOCKER_IMAGE"

echo "Base branch: $BASE_BRANCH"

echo "========================================"

for file in $files; do

TOTAL_FILES=$((TOTAL_FILES + 1))

echo ""

echo "========== $file =========="

# Get the file from master branch

if ! git show "$BASE_BRANCH:$file" > "$TEMP_DIR/$file" 2>/dev/null; then

echo "ℹ️ New file (does not exist in master branch)"

continue

fi

# Verify the temp file was created

if [ ! -f "$TEMP_DIR/$file" ]; then

echo "❌ Failed to create temp file"

continue

fi

# Note: oasdiff has some non-deterministic behavior in change counts due to

# unordered map iteration in Go. Error counts are consistent, but warning

# counts may vary by ~2-3% between runs. This is a known limitation.

# Run oasdiff changelog

echo "--- Changelog ---"

set +e

CHANGELOG_OUTPUT=$(docker run --rm -v "$(pwd)":/current -v "$TEMP_DIR":/base "$DOCKER_IMAGE" changelog --include-path-params /base/"$file" /current/"$file" 2>&1)

CHANGELOG_EXIT=$?

set -e

echo "$CHANGELOG_OUTPUT"

if [ $CHANGELOG_EXIT -eq 0 ]; then

echo "✓ Changelog generated successfully"

else

echo "⚠ Could not generate changelog (exit code: $CHANGELOG_EXIT)"

fi

# Run breaking changes check

echo ""

echo "--- Breaking changes check ---"

set +e

BREAKING_OUTPUT=$(docker run --rm -v "$(pwd)":/current -v "$TEMP_DIR":/base "$DOCKER_IMAGE" breaking --fail-on WARN --include-path-params /base/"$file" /current/"$file" 2>&1)

BREAKING_EXIT=$?

set -e

echo "$BREAKING_OUTPUT"

if [ $BREAKING_EXIT -eq 0 ]; then

echo "✓ No breaking changes detected"

else

echo "⚠ Breaking changes detected (exit code: $BREAKING_EXIT)"

BREAKING_CHANGES_FOUND=true

FILES_WITH_BREAKING_CHANGES+=("$file")

fi

PROCESSED_FILES=$((PROCESSED_FILES + 1))

done

echo ""

echo "========================================"

echo "API Diff check completed"

echo "Processed: $PROCESSED_FILES/$TOTAL_FILES files"

echo "========================================"

# Summary

if [ "$BREAKING_CHANGES_FOUND" = true ]; then

echo ""

echo "❌ Breaking changes detected in the following files:"

for file in "${FILES_WITH_BREAKING_CHANGES[@]}"; do

echo " - $file"

# Output GitHub Actions annotation

if [ -n "$GITHUB_ACTIONS" ]; then

echo "::warning file=${file}::Breaking changes detected in this API spec file"

fi

done

if [ "$FAIL_ON_BREAKING" = true ]; then

echo ""

echo "Exiting with error due to breaking changes"

exit 1

else

echo ""

echo "Note: Not failing build (use --fail-on-breaking to fail on breaking changes)"

fi

else

echo ""

echo "✓ No breaking changes detected across all files"

fi