AutoGuard.gitlab-ci.yml

spec:
  inputs:
    source_dir:
    base_ref:
      type: string 
      default: $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
    head_ref:
      type: string 
      default: $CI_MERGE_REQUEST_SOURCE_BRANCH_NAME
    fail_on_breaking:
      type: string
      default: "true"
      description: "If true, pipeline fails on breaking changes. If false, breaking changes are reported and then passed"
---

.autoGuard:
  image: "docker:latest"
  services:
    - docker:dind
  variables:
    DOCKER_DRIVER: overlay2

  before_script:
    - docker pull alexx882/auto-oas:1.2
    - docker pull djamn/openapi-diff:latest
    - apk add --no-cache git
  script: 
    - git fetch --all

    - mkdir -p autooas-base
    - mkdir -p autooas-head
    - chmod -R 777 autooas-base autooas-head

    - git checkout $[[inputs.base_ref]]
    - echo "Running Base Analysis..."

    - |
      if [ -d "$[[ inputs.source_dir ]]" ]; then
        docker run -v "$(pwd):/project" alexx882/auto-oas:1.2 "/project/$[[ inputs.source_dir ]]" /project/autooas-base/openapi
      else
        echo "Directory '$[[ inputs.source_dir ]]' not found in base ref, treating as new project."
      fi

    - git checkout $[[inputs.head_ref]]
    - echo "Running Head Analysis..."
    - docker run -v "$(pwd):/project" alexx882/auto-oas:1.2 "/project/$[[ inputs.source_dir ]]" /project/autooas-head/openapi

    - |
      OLD_DIR=autooas-base
      NEW_DIR=autooas-head

      EMPTY_OAS='{ "openapi": "3.0.1", "info": { "title": "", "version": "" }, "paths": {}, "components": { "schemas": {} } }'
      echo $EMPTY_OAS > empty.json
      
      OLD_FILES=$(find "$OLD_DIR" -type f | sed "s|$OLD_DIR/||" | sort)
      NEW_FILES=$(find "$NEW_DIR" -type f | sed "s|$NEW_DIR/||" | sort)

      printf "%s\n" $OLD_FILES > old_files
      printf "%s\n" $NEW_FILES > new_files
    
      COMMON_FILES=$(comm -12 old_files new_files)
      OTHER_FILES=$(comm -3 old_files new_files)

      STATUS=0

      mkdir -p oas_diff

      run_diff() {
        local name=$1
        local old_path=$2
        local new_path=$3

        echo "Diffing $name..."

        set +e

        STATE=$(docker run --rm \
          -v "$(pwd):/specs" \
          openapitools/openapi-diff:latest \
          --state \
          --fail-on-incompatible \
          --html "/specs/oas_diff/$name.html" \
          --markdown "/specs/oas_diff/$name.md" \
          "/specs/$old_path" "/specs/$new_path" 2>/dev/null)

        EXIT_CODE=$?

        STATE=$(echo "$STATE" | tr -d '\r')

        if [ "$STATE" == "no_changes" ]; then
             echo "No changes detected. Removing report files."
             rm -f "oas_diff/$name.html"
             rm -f "oas_diff/$name.md"
        fi

        set -e

        if [ $EXIT_CODE -ne 0 ] || [ "$STATE" == "incompatible" ]; then
          echo -e "\e[31mBreaking change detected in $name\e[0m"
          return 1
        fi

        if [ "$STATE" == "compatible" ]; then
           echo -e "\e[33mCompatible changes detected in $name\e[0m"
           return 0
        fi

        return 0
      }
      
      if [ -z "$COMMON_FILES" ] && [ -z "$OTHER_FILES" ]; then
         echo "ERROR: No OpenAPI files were generated. Analysis failed."
         exit 1
      fi

      for p in $COMMON_FILES; do
        run_diff "$p" "$OLD_DIR/$p" $NEW_DIR/$p || STATUS=$((STATUS + 1))
      done

      for p in $OTHER_FILES; do
        if [ -f "$OLD_DIR/$p" ]; then
          run_diff "$p" "$OLD_DIR/$p" "empty.json" || STATUS=$((STATUS + 1))
        else
          run_diff "$p" "empty.json" "$NEW_DIR/$p" || STATUS=$((STATUS + 1))
        fi
      done

      if [ $STATUS -gt 0 ]; then
        if [ "$[[ inputs.fail_on_breaking ]]" = "true" ]; then
          echo "Fail on breaking is ENABLED. Failing job."
          exit 1
        else
          echo "Fail on breaking is DISABLED. Job passes with warnings."
          exit 0
        fi
      else
        echo -e "\e[32mNo breaking changes found.\e[0m"
        exit 0
      fi

  artifacts:
    when: always
    name: "OpenAPI specifications"
    paths:
      - "autooas-base/*.json"
      - "autooas-head/*.json"
      - "oas_diff/*"