diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 6ffb4a5..11bd8d9 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -85,7 +85,7 @@ jobs: with: base: 'specs/base.yaml' revision: 'specs/revision-breaking.yaml' - fail-on-diff: false + fail-on: 'WARN' output-to-file: 'breaking.txt' - name: Test breaking changes action output run: | @@ -153,9 +153,57 @@ jobs: with: base: specs/base.yaml revision: specs/base-deprecation.yaml - fail-on-diff: true + fail-on: 'WARN' deprecation-days-beta: 14 deprecation-days-stable: 21 + oasdiff_breaking_fail_on_err: + runs-on: ubuntu-latest + name: Test breaking changes fail-on (ERR) + steps: + - name: checkout + uses: actions/checkout@v4 + - name: Running breaking action + id: test_breaking_changes_err + uses: ./breaking + with: + base: 'specs/base.yaml' + revision: 'specs/revision-breaking.yaml' + fail-on: 'ERR' + - name: Test breaking changes action output (ERR) + run: | + delimiter=$(cat /proc/sys/kernel/random/uuid | tr -d '-') + output=$(cat <<-$delimiter + ${{ steps.test_breaking_changes.outputs.breaking }} + $delimiter + ) + if [ "$output" != "1 breaking changes: 1 error, 0 warning" ]; then + echo "Expected output '1 breaking changes: 1 error, 0 warning' but got '$output'" >&2 + exit 1 + fi + oasdiff_breaking_fail_on_warn: + runs-on: ubuntu-latest + name: Test breaking changes fail-on (WARN) + steps: + - name: checkout + uses: actions/checkout@v4 + - name: Running breaking action + id: test_breaking_changes_err + uses: ./breaking + with: + base: 'specs/base.yaml' + revision: 'specs/revision-breaking-warning.yaml' + fail-on: 'ERR' + - name: Test breaking changes action output (WARN) - Expecting No Output + run: | + delimiter=$(cat /proc/sys/kernel/random/uuid | tr -d '-') + output=$(cat <<-$delimiter + ${{ steps.test_breaking_changes.outputs.breaking }} + $delimiter + ) + if [ -n "$output" ]; then + echo "Expected no breaking output as the fail-on level is set to ERR (error) and there should only be warnings' but got '$output'" >&2 + exit 1 + fi oasdiff_changelog: runs-on: ubuntu-latest name: Test generation of changelog diff --git a/README.md b/README.md index fb77e3a..b2ade00 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,8 @@ Copy and paste the following snippet into your build .yml file: Additional arguments: | CLI | Action input | Default | -| ------------------------- | ----------------------- | ------- | -| --fail-on WARN | fail-on-diff | true | +|---------------------------|-------------------------|---------| +| --fail-on | fail-on | 'ERR' | | --include-checks | include-checks | csv | | --include-path-params | include-path-params | false | | --deprecation-days-beta | deprecation-days-beta | 31 | diff --git a/breaking/action.yml b/breaking/action.yml index 8238bd9..0a05347 100644 --- a/breaking/action.yml +++ b/breaking/action.yml @@ -7,10 +7,10 @@ inputs: revision: description: 'Path of revised OpenAPI spec in YAML or JSON format' required: true - fail-on-diff: - description: 'Fail with exit code 1 if any breaking changes are found' + fail-on: + description: 'Fail with exit code 1 if breaking changes are found at a particular status or severity level, e.g. ERR or WARN' required: false - default: 'true' + default: 'ERR' include-checks: description: 'Include any of the defined optional breaking changes checks' required: false @@ -45,7 +45,7 @@ runs: args: - ${{ inputs.base }} - ${{ inputs.revision }} - - ${{ inputs.fail-on-diff }} + - ${{ inputs.fail-on }} - ${{ inputs.include-checks }} - ${{ inputs.include-path-params }} - ${{ inputs.deprecation-days-beta }} diff --git a/breaking/entrypoint.sh b/breaking/entrypoint.sh index e5d885d..6e4af20 100755 --- a/breaking/entrypoint.sh +++ b/breaking/entrypoint.sh @@ -22,7 +22,7 @@ write_output () { readonly base="$1" readonly revision="$2" -readonly fail_on_diff="$3" +readonly fail_on="$3" readonly include_checks="$4" readonly include_path_params="$5" readonly deprecation_days_beta="$6" @@ -31,12 +31,12 @@ readonly exclude_elements="$8" readonly composed="$9" readonly output_to_file="${10}" -echo "running oasdiff breaking... base: $base, revision: $revision, fail_on_diff: $fail_on_diff, include_checks: $include_checks, include_path_params: $include_path_params, deprecation_days_beta: $deprecation_days_beta, deprecation_days_stable: $deprecation_days_stable, exclude_elements: $exclude_elements, composed: $composed, output_to_file: $output_to_file" +echo "running oasdiff breaking... base: $base, revision: $revision, fail_on: $fail_on, include_checks: $include_checks, include_path_params: $include_path_params, deprecation_days_beta: $deprecation_days_beta, deprecation_days_stable: $deprecation_days_stable, exclude_elements: $exclude_elements" # Build flags to pass in command flags="" -if [ "$fail_on_diff" = "true" ]; then - flags="$flags --fail-on WARN" +if [ -z "$fail_on" ]; then + flags="${flags} --fail-on $fail_on" fi if [ "$include_path_params" = "true" ]; then flags="$flags --include-path-params" diff --git a/specs/revision-breaking-warning.yaml b/specs/revision-breaking-warning.yaml new file mode 100644 index 0000000..5a3e5fb --- /dev/null +++ b/specs/revision-breaking-warning.yaml @@ -0,0 +1,103 @@ +openapi: "3.0.0" +info: + version: 1.0.0 + title: Swagger Petstore + license: + name: MIT +servers: + - url: http://petstore.swagger.io/v1 +paths: + /pets: + get: + summary: List all pets + operationId: listPets + tags: + - pets + responses: + '200': + description: A paged array of pets + headers: + x-next: + description: A link to the next page of responses + schema: + type: string + content: + application/json: + schema: + $ref: "#/components/schemas/Pets" + default: + description: unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + post: + summary: Create a pet + operationId: createPets + tags: + - pets + responses: + '201': + description: Null response + default: + description: unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /pets/{petId}: + get: + summary: Info for a specific pet + operationId: showPetById + tags: + - pets + parameters: + - name: petId + in: path + required: true + description: The id of the pet to retrieve + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: "#/components/schemas/Pet" + default: + description: unexpected error + content: + application/json: + schema: + $ref: "#/components/schemas/Error" +components: + schemas: + Pet: + type: object + required: + - id + - name + properties: + id: + type: integer + format: int64 + name: + type: string + tag: + type: string + Pets: + type: array + items: + $ref: "#/components/schemas/Pet" + Error: + type: object + required: + - code + - message + properties: + code: + type: integer + format: int32 + message: + type: string \ No newline at end of file