Add output for successful operation?

[Herve-M]

Hello Tufin Team,

After using oasdiff breaking check feature during CI, it looks hard to find out if the breaking / diff process was successful or not as no verbose feature is available.

Example:

• nothing breaking between A and A spec.
  • output: nothing
• nothing breaking between A and B spec.
  • output: nothing

Would be nice to have an output to state the operation was successful DX speaking.

Thanks,

[reuvenharrison]

Hi,
You can use the --fail-on flag to get an exit status of 1 if there are breaking changes:

oasdiff breaking data/openapi-test1.yaml data/openapi-test3.yaml --fail-on ERR
oasdiff breaking data/openapi-test1.yaml data/openapi-test3.yaml --fail-on WARN

Then run echo $? to see the return code (0 or 1).

Regards,
Reuven

[Herve-M]

We can suppose that oasdiff has no silent error?

[Herve-M]

At first sight, it doesn't:
oasdiff breaking -c https://httpbun.org/status/404 https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test1.yaml or oasdiff breaking -c https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test1.yaml https://httpbun.org/status/404
return 0
oasdiff diff https://httpbun.org/status/404 https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test1.yaml
return Error: failed to load base spec from "https://httpbun.org/status/404" with error loading "https://httpbun.org/status/404": request returned status code 404 and an errror code 102

[reuvenharrison]

Indeed, there is a bug.
This should return an error message:

oasdiff breaking -c https://httpbun.org/status/404 https://raw.githubusercontent.com/Tufin/oasdiff/main/data/openapi-test1.yaml

[reuvenharrison]

By the way, why are you using the -c?
This flag means: work in 'composed' mode, compare paths in all specs matching base and revision globs
But you are passing URLs, not globs.

[reuvenharrison]

See #369