oasdiff-action/.github/workflows/test-diff.yaml at main · oasdiff/oasdiff-action · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
name: diff
on:
  push:
    branches: [main]
  pull_request:
concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

jobs:
  oasdiff_diff:
    runs-on: ubuntu-latest
    name: Test diff action
    steps:
      - name: checkout
        uses: actions/checkout@v7
      - name: Running diff action
        id: test_ete
        uses: ./diff
        with:
          base: https://raw.githubusercontent.com/oasdiff/oasdiff/main/data/openapi-test1.yaml
          revision: https://raw.githubusercontent.com/oasdiff/oasdiff/main/data/openapi-test3.yaml
          format: 'text'
          output-to-file: 'diff.txt'
      - name: Test diff action output to file
        run: |
          if [ ! -s diff.txt ]; then
            echo "Diff file doesn't exist or is empty"
            exit 1
          fi
  oasdiff_diff_exclude_elements:
    runs-on: ubuntu-latest
    name: Test diff action with exclude-elements option
    steps:
        - name: checkout
          uses: actions/checkout@v7
        - name: Running diff action with exclude-elements option
          id: test_exclude_elements
          uses: ./diff
          with:
            base: 'specs/base.yaml'
            revision: 'specs/base-exclude-elements.yaml'
            format: 'text'
            exclude-elements: 'description,title,summary'
        - name: Test diff action output
          env:
            ACTUAL_OUTPUT: ${{ steps.test_exclude_elements.outputs.diff }}
          run: |
            output="$ACTUAL_OUTPUT"
            if [ "$output" != "No changes" ]; then
              echo "Expected output 'No changes' but got '$output'" >&2
              exit 1
            fi
  oasdiff_diff_composed:
    runs-on: ubuntu-latest
    name: Test diff action with composed option
    steps:
        - name: checkout
          uses: actions/checkout@v7
        - name: Running diff action with composed option
          id: test_composed
          uses: ./diff
          with:
            base: 'specs/glob/base/*.yaml'
            revision: 'specs/glob/revision/*.yaml'
            format: 'text'
            composed: true
        - name: Test diff action output
          env:
            ACTUAL_OUTPUT: ${{ steps.test_composed.outputs.diff }}
          run: |
            output="$ACTUAL_OUTPUT"
            if [[ "$output" != *"Deleted Endpoints: 1"* ]]; then
              echo "Expected 'Deleted Endpoints: 1' to be modified in diff, instead got '$output'" >&2
              exit 1
            fi
  oasdiff_diff_yaml_config_exclude_elements:
    runs-on: ubuntu-latest
    name: Test diff action picks up exclude-elements from .oasdiff.yaml
    steps:
      - name: checkout
        uses: actions/checkout@v7
      - name: Drop .oasdiff.yaml at repo root
        run: |
          cat > .oasdiff.yaml <<EOF
          exclude-elements:
            - description
            - title
            - summary
          format: text
          EOF
      - name: Running diff action without exclude-elements input
        id: test_yaml_exclude_elements
        uses: ./diff
        with:
          base: 'specs/base.yaml'
          revision: 'specs/base-exclude-elements.yaml'
      - name: Assert diff is empty thanks to exclude-elements from .oasdiff.yaml
        env:
          ACTUAL_OUTPUT: ${{ steps.test_yaml_exclude_elements.outputs.diff }}
        run: |
          output="$ACTUAL_OUTPUT"
          if [ "$output" != "No changes" ]; then
            echo "Expected 'No changes' (exclude-elements from .oasdiff.yaml should filter description/title/summary) but got '$output'" >&2
            exit 1
          fi

  # ---------------------------------------------------------------------
  # pr-comment entrypoint: oasdiff exit-code tolerance.
  #
  # The pr-comment script wraps the oasdiff changelog invocation so a
  # non-zero exit (e.g. fail-on triggered from .oasdiff.yaml) does not
  # abort the script under set -e. Real failures (no output) still
  # abort. These two jobs run pr-comment/entrypoint.sh directly with a
  # stubbed oasdiff on PATH so we don't need a Docker image, an
  # oasdiff-token, or a reachable oasdiff-service.
  # ---------------------------------------------------------------------


  oasdiff_diff_unresolved_ref:
    runs-on: ubuntu-latest
    name: Test a failed comparison is not reported as clean
    steps:
      - name: checkout
        uses: actions/checkout@v7
      - name: Run diff action against a spec that cannot be loaded
        id: test_unresolved_ref
        continue-on-error: true
        uses: ./diff
        with:
          base: 'specs/unresolved-ref.yaml'
          revision: 'specs/unresolved-ref.yaml'
      - name: Assert the step failed and reported no clean result
        run: |
          if [ "${{ steps.test_unresolved_ref.outcome }}" != "failure" ]; then
            echo "Expected the action to fail when the spec cannot be loaded" >&2
            exit 1
          fi
          case "${{ steps.test_unresolved_ref.outputs.diff }}" in
            *"No changes"*)
              echo "A failed comparison must never be reported as 'No changes'" >&2
              exit 1
              ;;
          esac