master..e71cbde · typeable/compaREST

.github/actions/common_setup/action.yamldeleted−42

@@ -1,42 +0,0 @@

1−name: "Common setup"

2−description: "Common setup steps"

3−inputs:

4− authToken:

5− description: "Cachix auth token"

6− required: true

7−runs:

8− using: "composite"

9− steps:

10− - name: Increase swap if linux

11− shell: bash

12− run: |

13− if [ "$RUNNER_OS" == "Linux" ]; then

14−

15− echo "Is Linux"

16−

17− free -h

18−

19− sudo swapoff /mnt/swapfile

20− sudo fallocate -l 12G /mnt/swapfile

21− sudo mkswap /mnt/swapfile

22− sudo swapon /mnt/swapfile

23−

24− free -h

25−

26− else

27−

28− echo "Not Linux"

29−

30− fi

31−

32− - name: Install Nix

33− uses: cachix/install-nix-action@v27

34− with:

35− extra_nix_config: |

36− system-features = kvm

37− trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=

38− substituters = https://hydra.iohk.io https://cache.nixos.org/

39− - uses: cachix/cachix-action@v15

40− with:

41− name: typeable

42− authToken: "${{ inputs.authToken }}"

.github/workflows/github-actions-image.yaml+27−261

@@ -5,286 +5,52 @@ on:

55 branches: [master]

66 pull_request:

77 branches: [master]

8− release:

9− types: [prereleased]

108

119jobs:

12−# check-formatting:

13−# name: Check Haskell formatting

14−# runs-on: ubuntu-latest

15−# steps:

16−# - uses: actions/checkout@v2

17−#

18−# - name: Common setup

19−# uses: ./.github/actions/common_setup

20−# with:

21−# authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}

22−#

23−# - name: Run fourmolu

24−# run: |

25−# nix-shell nix/ci.nix -j auto --run "git ls-files '*.hs' | xargs fourmolu -m inplace -o -XRecursiveDo -o -XTypeApplications -o -XPatternSynonyms -o -XBangPatterns"

26−# git diff --exit-code

27−

28− check_versions:

10+ build-github-action-image:

2911 runs-on: ubuntu-latest

12+

3013 steps:

3114 - uses: actions/checkout@v2

3215 with:

3316 submodules: recursive

34−

35− - name: Common setup

36− uses: ./.github/actions/common_setup

37− with:

38− authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}

39−

40− - name: Check library version

41− if: github.event_name == 'release'

17+ - name: Increase swap

4218 run: |

43− if [ "$(awk -F ':' '/^version/ {gsub(/ /, "", $2); print $2}' compaREST.cabal)" != "${{ github.event.release.tag_name }}" ]; then

44− echo "::error file=compaREST.cabal::Library version does not match release version."

45− exit 1

46− fi

19+ free -h

4720

48− - name: Check docker tag

49− if: github.event_name == 'release'

50− run: |

51− if [ "$(yq eval '.runs.image' action.yaml | awk -F ':' '{print $NF}')" != "${{ github.event.release.tag_name }}" ]; then

52− echo "::error file=action.yaml::Action docker tag does not match release tag."

53− exit 1

54− fi

21+ sudo swapoff /mnt/swapfile

22+ sudo fallocate -l 12G /mnt/swapfile

23+ sudo mkswap /mnt/swapfile

24+ sudo swapon /mnt/swapfile

5525

56− - name: Check changelog

57− if: github.event_name == 'release'

58− run: |

59− if ! grep '^## ${{ github.event.release.tag_name }}$' CHANGELOG.md; then

60− echo "::error file=CHANGELOG.md::CHANGELOG.md does not contain an entry for this release."

61− exit 1

62− fi

26+ free -h

6327

64− Linux:

65− needs: check_versions

66− runs-on: ubuntu-latest

67− steps:

68− - uses: actions/checkout@v2

69− with:

70− submodules: recursive

71−

72− - name: Common setup

73− uses: ./.github/actions/common_setup

28+ - name: Install Nix

29+ uses: cachix/install-nix-action@v12

7430 with:

75− authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}

76−

77− - name: Test

78− shell: bash

79− run: |

80− $(nix-build -A test -j auto --no-out-link)/bin/compaREST-tests

81−

82− - name: Build Linux static binary

83− shell: bash

84− run: |

85− cp $(nix-build -A compaRESTStaticBin -j auto --no-out-link)/bin/compaREST compaREST

31+ extra_nix_config: |

32+ trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=

33+ substituters = https://hydra.iohk.io https://cache.nixos.org/

8634

87− - name: Upload compaREST Linux Binary

88− uses: actions/upload-artifact@v2

35+ - name: Login to Cachix

36+ uses: cachix/cachix-action@v8

8937 with:

90− name: compaREST-Linux

91− path: compaREST

38+ name: octopod

39+ signingKey: ${{ secrets.CACHIX_SIGNING_KEY }}

9240

93− - name: Build Docker Images

94− shell: bash

41+ - name: Build Github Action Docker Image

9542 run: |

96− cp $(nix-build -A compaRESTGithubAction -j auto --no-out-link) compaREST-Github-Action-image.tar.gz

97− cp $(nix-build -A compaRESTImage -j auto --no-out-link) compaREST-image.tar.gz

43+ nix-build -A compaRESTGithubAction -j auto -o image

9844

99− - name: Upload compaREST Docker Github Action Image

100− uses: actions/upload-artifact@v2

101− with:

102− name: compaREST Github Action Docker Image

103− path: compaREST-Github-Action-image.tar.gz

104−

105− - name: Upload compaREST Docker Image

106− uses: actions/upload-artifact@v2

107− with:

108− name: compaREST Docker Image

109− path: compaREST-image.tar.gz

110−

111− - name: Login to DockerHub

112− uses: docker/login-action@v1.10.0

45+ - name: Log into Docker Hub

46+ if: github.ref == 'refs/heads/master'

47+ uses: docker/login-action@v1

11348 with:

11449 username: ${{ secrets.DOCKER_HUB_USERNAME }}

11550 password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}

11651

117− - name: Push Nightly Docker Images to DockerHub

118− if: github.ref == 'refs/heads/master' && github.event_name == 'push'

119− shell: bash

120− run: |

121− skopeo copy docker-archive:$(nix-build -A compaRESTGithubAction -j auto --no-out-link) docker://typeable/comparest-github-action:nightly

122− skopeo copy docker-archive:$(nix-build -A compaRESTImage -j auto --no-out-link) docker://typeable/comparest:nightly

123−

124− - name: Push Release Docker Images to DockerHub

125− if: github.event_name == 'release'

126− shell: bash

127− run: |

128− skopeo copy docker-archive:$(nix-build -A compaRESTGithubAction -j auto --no-out-link) docker://typeable/comparest-github-action:${{ github.event.release.tag_name }}

129− skopeo copy docker-archive:$(nix-build -A compaRESTImage -j auto --no-out-link) docker://typeable/comparest:${{ github.event.release.tag_name }}

130−

131− - name: Zip Release Assets

132− if: github.event_name == 'release'

133− shell: bash

134− run: |

135− zip compaREST-Linux-x86.zip compaREST

136−

137− - name: Upload compaREST Github Action Docker Image to release

138− if: github.event_name == 'release'

139− uses: svenstaro/upload-release-action@2.2.1

140− with:

141− repo_token: ${{ secrets.GITHUB_TOKEN }}

142− file: compaREST-Github-Action-image.tar.gz

143− tag: ${{ github.ref }}

144−

145− - name: Upload compaREST Docker Image to release

146− if: github.event_name == 'release'

147− uses: svenstaro/upload-release-action@2.2.1

148− with:

149− repo_token: ${{ secrets.GITHUB_TOKEN }}

150− file: compaREST-image.tar.gz

151− tag: ${{ github.ref }}

152−

153− - name: Upload compaREST binary – Linux – x86 to release

154− if: github.event_name == 'release'

155− uses: svenstaro/upload-release-action@2.2.1

156− with:

157− repo_token: ${{ secrets.GITHUB_TOKEN }}

158− file: compaREST-Linux-x86.zip

159− tag: ${{ github.ref }}

160−

161− dist:

162− needs: [check_versions, Linux]

163− runs-on: ubuntu-latest

164− steps:

165− - uses: actions/checkout@v2

166− with:

167− submodules: recursive

168−

169− - name: Common setup

170− uses: ./.github/actions/common_setup

171− with:

172− authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}

173−

174− - name: Cache

175− uses: actions/cache@v1

176− with:

177− path: |

178− ~/.stack

179− .stack-work

180− key: ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}-${{ hashFiles('**.cabal') }}

181− restore-keys: |

182− ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}

183− ${{ runner.os }}-stack

184−

185− - name: Upgrade stack

186− shell: bash

187− # Needed for Hackage token authorization

188− run: stack upgrade --git

189−

190− - name: Build dist

191− run: |

192− stack sdist --pvp-bounds both

193− echo "distPath=$(stack path | awk -F ": " '/dist-dir/ {print $2}')" >> $GITHUB_ENV

194−

195− - name: Upload compaREST sources artifact

196− uses: actions/upload-artifact@v2

197− with:

198− name: compaREST sources

199− path: ${{ env.distPath }}/*.tar.gz

200−

201− - name: Upload compaREST sources to release

202− if: github.event_name == 'release'

203− uses: svenstaro/upload-release-action@2.2.1

204− with:

205− repo_token: ${{ secrets.GITHUB_TOKEN }}

206− file_glob: true

207− file: ${{ env.distPath }}/*.tar.gz

208− tag: ${{ github.ref }}

209−

210− - name: Publish compaREST candidate to Hackage

211− shell: bash

212− if: github.event_name == 'release'

213− env:

214− HACKAGE_KEY: ${{ secrets.HACKAGE_KEY }}

52+ - name: Upload Image to Docker Hub

53+ if: github.ref == 'refs/heads/master'

21554 run: |

216− stack upload --pvp-bounds both --candidate .

217−

218− macOS:

219− needs: check_versions

220− runs-on: macos-latest

221− steps:

222− - uses: actions/checkout@v2

223− with:

224− submodules: recursive

225−

226− - name: Common setup

227− uses: ./.github/actions/common_setup

228− with:

229− authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}

230−

231− - name: Build macOS binary bundle

232− run: |

233− cp -LR $(nix-build -A macOSCompaRESTBundle -j auto --no-out-link) compaREST

234−

235− - name: Upload macOS compaREST bundle

236− uses: actions/upload-artifact@v2

237− with:

238− name: compaREST binary – macOS – x86

239− path: compaREST

240−

241− - name: Zip Release Assets

242− if: github.event_name == 'release'

243− shell: bash

244− run: |

245− zip -r compaREST-macOS-x86.zip compaREST

246−

247− - name: Upload compaREST binary – macOS – x86 to release

248− if: github.event_name == 'release'

249− uses: svenstaro/upload-release-action@2.2.1

250− with:

251− repo_token: ${{ secrets.GITHUB_TOKEN }}

252− file: compaREST-macOS-x86.zip

253− tag: ${{ github.ref }}

254−

255−# Linux-Windows:

256−# needs: check_versions

257−# runs-on: ubuntu-latest

258−# steps:

259−# - uses: actions/checkout@v2

260−# with:

261−# submodules: recursive

262−#

263−# - name: Common setup

264−# uses: ./.github/actions/common_setup

265−# with:

266−# authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}

267−#

268−# - name: Build Windows binary

269−# run: |

270−# cp -LR $(nix-build -A WindowsCompaRESTBin -j auto --no-out-link)/bin compaREST

271−#

272−# - name: Upload Windows compaREST bundle

273−# uses: actions/upload-artifact@v2

274−# with:

275−# name: compaREST binary – Windows

276−# path: compaREST

277−#

278−# - name: Zip Release Assets

279−# if: github.event_name == 'release'

280−# shell: bash

281−# run: |

282−# zip -r compaREST-Windows.zip compaREST

283−#

284−# - name: Upload compaREST binary – Windows to release

285−# if: github.event_name == 'release'

286−# uses: svenstaro/upload-release-action@2.2.1

287−# with:

288−# repo_token: ${{ secrets.GITHUB_TOKEN }}

289−# file: compaREST-Windows.zip

290−# tag: ${{ github.ref }}

55+ docker load -i image

56+ docker push typeable/comparest-github-action:latest

.github/workflows/linux-binary.yamlnew file+54

@@ -0,0 +1,54 @@

1+name: Linux binary

2+

3+on:

4+ push:

5+ branches: [master]

6+ pull_request:

7+ branches: [master]

8+

9+jobs:

10+ linux-build:

11+ runs-on: ubuntu-latest

12+

13+ steps:

14+ - uses: actions/checkout@v2

15+ with:

16+ submodules: recursive

17+ - name: Cache

18+ uses: actions/cache@v1

19+ with:

20+ path: ~/.stack

21+ key: ${{ runner.os }}-build-stack-${{ hashFiles('**/stack.yaml') }}-${{ hashFiles('**/*.cabal') }}

22+ restore-keys: |

23+ ${{ runner.os }}-build-stack-${{ hashFiles('**/stack.yaml') }}

24+ ${{ runner.os }}-build-stack-

25+ - name: Increase swap

26+ run: |

27+ free -h

28+

29+ sudo swapoff /mnt/swapfile

30+ sudo fallocate -l 13G /mnt/swapfile

31+ sudo mkswap /mnt/swapfile

32+ sudo swapon /mnt/swapfile

33+

34+ free -h

35+

36+ - name: Build

37+ run: |

38+ stack build --ghc-options=-O3 --local-bin-path comparest-linux --copy-bins --flag comparest:Static

39+ - name: Test

40+ run: stack test --ghc-options=-O3 --flag comparest:Static --test-arguments='--hide-successes --no-create'

41+

42+ - name: Zip

43+ if: github.ref == 'refs/heads/master'

44+ run: |

45+ zip comparest-linux comparest-linux/comparest

46+ - uses: "marvinpinto/action-automatic-releases@latest"

47+ if: github.ref == 'refs/heads/master'

48+ with:

49+ repo_token: "${{ secrets.GITHUB_TOKEN }}"

50+ automatic_release_tag: "latest"

51+ prerelease: false

52+ title: "Pre-Release"

53+ files: |

54+ *.zip

.github/workflows/remove-artifacts.yamlnew file+17

@@ -0,0 +1,17 @@

1+name: Remove old artifacts

2+

3+on:

4+ schedule:

5+ - cron: '0 0 * * *'

6+jobs:

7+ remove-old-artifacts:

8+ runs-on: ubuntu-latest

9+ timeout-minutes: 10

10+

11+ steps:

12+ - name: Remove old artifacts

13+ uses: c-hive/gha-remove-artifacts@v1

14+ with:

15+ age: '7 days'

16+ skip-tags: true

17+ skip-recent: 10

.gitmodulesnew file+3

@@ -0,0 +1,3 @@

1+[submodule "awsm-css"]

2+ path = awsm-css

3+ url = https://github.com/igoradamenko/awsm.css.git

CHANGELOG.md+3−7

@@ -1,13 +1,9 @@

11# Changelog

22

3−`compaREST` uses [PVP Versioning][1].

3+`comparest` uses [PVP Versioning][1].

44

5−## 0.1.0.1

5+## 0.0.0.0

66

7−* Fixed an issue related to empty commit SHAs in GitHub Actions.

8−

9−## 0.1.0.0

10−

11−* Initial release.

7+* Initially created.

128

139[1]: https://pvp.haskell.org

LICENSE+1−1

@@ -1,6 +1,6 @@

11MIT License

22

44

55Permission is hereby granted, free of charge, to any person obtaining a copy

66of this software and associated documentation files (the "Software"), to deal

README.md+19−40

@@ -1,33 +1,14 @@

1−# compaREST

1+# CompaREST

22

3−[![Hackage](https://img.shields.io/hackage/v/compaREST.svg?logo=haskell)](https://hackage.haskell.org/package/compaREST)

3+[![Hackage](https://img.shields.io/hackage/v/comparest.svg?logo=haskell)](https://hackage.haskell.org/package/comparest)

4+[![Stackage Lts](http://stackage.org/package/comparest/badge/lts)](http://stackage.org/lts/package/comparest)

5+[![Stackage Nightly](http://stackage.org/package/comparest/badge/nightly)](http://stackage.org/nightly/package/comparest)

46[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

57

68Compatibility checker for OpenAPI

9+# Quick Start Guide

710

8−## Using compaREST in Github Actions

9−

10−Add the following step to your Github Actions workflow:

11−

12−```yaml

13−- uses: typeable/comparest

14− if: ${{ github.event_name == 'pull_request' }}

15− with:

16− old: old-openapi.yaml

17− new: new-openapi.yaml

18−```

19−

20−The `new` and `old` values should be paths to your OpenAPI specifications you want to compare.

21−

22−You will get something like this in your pull requests:

23−

24−![](docs/img/github-action-report.png)

25−

26−For more detail please see our [integration guide](docs/Integration_guide.md).

27−

28−## An example

29−

30−### Your situation

11+## Your situation

3112

3213You are developing a very important server with a REST API. You have clients who use your API that you do not control. Say, you are also developing a mobile app that uses your API and you can't force someone to update to the latest version. (Or you prefer not to for UX reasons.)

3314

@@ -94,7 +75,7 @@ components:

9475 $ref: "#/components/schemas/Pet"

9576```

9677

97−### Evolving your product

78+## Evolving your product

9879

9980Enthused over your initial success you hurry to release a new and improved version of your API and mobile app.

10081

@@ -163,7 +144,7 @@ components:

163144

164145Looking at the very large and complex API description, you grow more and more concerned that your old mobile app might stop working when you update the server. But the spec is too large and too complex to reasonably assess this manually.

165146

166−### Assessing compatibility automatically

147+## Assessing compatibility automatically

167148

168149Luckily, you have access to compaREST which can programmatically analyze your APIs and determine what, if anything, breaks compatibility and what doesn't.

169150

@@ -177,15 +158,15 @@ Running this command will output a file `report.md`, containing the compatibilit

177158

178159> # Summary

179160>

180−> | [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

181−> |------------------------------------------|--------------------------------------------------|

182−> | 5 | 6 |

161+> | [⚠️ Breaking changes](#breaking-changes) | [🙆 Non-breaking changes](#non-breaking-changes) | 🤷 Unsupported feature changes |

162+> |------------------------------------------|-------------------------------------------------|-------------------------------|

163+> | 5 | 6 | 0 |

183164>

184−> # ❌ Breaking changes

165+> # ⚠️ Breaking changes

185166>

186167> ## **GET** /pets

187168>

188−> ### ⬅️☁️ JSON Response – 200

169+> ### 📱⬅️ JSON Response – 200

189170>

190171> #### `$[*].name(String)`

191172>

@@ -195,7 +176,7 @@ Running this command will output a file `report.md`, containing the compatibilit

195176>

196177> ## **POST** /pets

197178>

198−> ### ➡️☁️ JSON Request

179+> ### 📱➡️ JSON Request

199180>

200181> #### `$.weight`

201182>

@@ -210,7 +191,7 @@ Running this command will output a file `report.md`, containing the compatibilit

210191>

211192> Value is now a multiple of 1.0.

212193>

213−> # ⚠️ Non-breaking changes

194+> # 🙆 Non-breaking changes

214195>

215196> ## **GET** /pets

216197>

@@ -222,7 +203,7 @@ Running this command will output a file `report.md`, containing the compatibilit

222203>

223204> Upper bound changed from 20.0 inclusive to 30.0 inclusive.

224205>

225−> ### ⬅️☁️ JSON Response – 200

206+> ### 📱⬅️ JSON Response – 200

226207>

227208> #### `$[*].weight`

228209>

@@ -239,7 +220,7 @@ Running this command will output a file `report.md`, containing the compatibilit

239220>

240221> ## **POST** /pets

241222>

242−> ### ➡️☁️ JSON Request

223+> ### 📱➡️ JSON Request

243224>

244225> #### `$.name(String)`

245226>

@@ -249,7 +230,7 @@ Running this command will output a file `report.md`, containing the compatibilit

249230

250231You now know exactly in what situations and in what way your 1.0 version of the app will break if you deploy your 1.1 version of the server.

251232

252−### Additional formats

233+## Additional formats

253234

254235You can also produce a self-contained HTML report that you can open in your browser by simply omitting the file extension of the output file:

255236

@@ -257,9 +238,7 @@ You can also produce a self-contained HTML report that you can open in your brow

257238docker run --rm -v $(pwd):/data:rw typeable/comparest --client /data/api-1.0.0.yaml --server /data/api-1.1.0.yaml --output /data/report

258239```

259240

260−## CLI docs

261−

262−For more detail please see our [user guide](docs/User_guide.md).

241+# CLI docs

263242

264243```

265244Usage: comparest (-c|--client ARG) (-s|--server ARG)

action.yaml+13−14

@@ -7,42 +7,41 @@ inputs:

77 default: "${{ github.token }}"

88 required: false

99 repo:

10− description: The owner of the repo in which to post the results.

10+ description: The owner of the repo in which to post the comment.

1111 default: "${{ github.repository }}"

1212 required: false

13− project_name:

14− description: The name of the project to which the API pertains. Used to name the check. Useful when you have multiple APIs in the same repo.

13+ pull_request:

14+ description: The pull request in which to post the comment.

15+ default: "${{ github.event.pull_request.number }}"

1516 required: false

16− default: ""

17+ project_name:

18+ description: The name of the project to which the API pertains.

19+ required: true

1720 footer:

18− description: A footer that can be appended to the check body.

21+ description: A footer that can be appended to the comment.

1922 required: false

2023 default: ""

2124 old:

22− description: The path to the old (client) specification of the API.

25+ description: The path to old specification of the API.

2326 required: true

2427 new:

25− description: The path to new (server) specification of the API.

28+ description: The path to new specification of the API.

2629 required: true

27− sha:

28− description: The sha of the commit to post the check for.

29− required: false

30− default: "${{ github.event.pull_request.head.sha }}"

3130runs:

3231 using: "docker"

33− image: "docker://typeable/comparest-github-action:0.1.0.1"

32+ image: "typeable/comparest-github-action:latest"

3433 env:

3534 GITHUB_TOKEN: "${{ inputs.GITHUB_TOKEN }}"

3635 REPO: "${{ inputs.repo }}"

36+ PR_NUMBER: "${{ inputs.pull_request }}"

3737 PROJECT_NAME: "${{ inputs.project_name }}"

3838 FOOTER: "${{ inputs.footer }}"

3939 ROOT: "/github/workspace"

4040 OLD: "${{ inputs.old }}"

4141 NEW: "${{ inputs.new }}"

42− SHA: "${{ inputs.sha }}"

4342 pre-entrypoint: "/bin/pre"

4443 entrypoint: "/bin/run"

4544

4645branding:

4746 icon: crosshair

48− color: blue

47+ color: gray-dark

app/Data/OpenApi/Compare/Options.hs+72−92

@@ -1,7 +1,7 @@

11module Data.OpenApi.Compare.Options

2− ( Options (..),

3− OutputMode (..),

4− parseOptions,

2+ ( Options (..)

3+ , OutputMode (..)

4+ , parseOptions

55 )

66where

77

@@ -9,7 +9,6 @@ import Data.OpenApi.Compare.Report

99import GHC.Generics (Generic)

1010import Options.Applicative

1111import Options.Applicative.Help hiding (fullDesc)

12−import Text.PrettyPrint.ANSI.Leijen ((<$$>),string)

1312

1413parseOptions :: IO Options

1514parseOptions = customExecParser (prefs $ showHelpOnError) optionsParserInfo

@@ -31,105 +30,86 @@ optionsParserInfo :: ParserInfo Options

3130optionsParserInfo =

3231 info

3332 (helper <*> optionsParser)

34− ( fullDesc

35− <> header "CompaREST"

36− <> progDescDoc

37− ( Just $

38− par "A tool to check compatibility between two OpenAPI specifications."

39− <$$> hardline <> par "Usage examples" <> hardline

40− <$$> indent

41− 4

42− ( par "Compare files old.yaml with new.yaml and output the resulting report to stdout:"

43− <$$> hardline <> indent 4 "comparest -c old.yaml -s new.yaml"

44− <$$> hardline <> par "Only output breaking changes and write a styled HTML report to file report.html:"

45− <$$> hardline <> indent 4 "comparest -c old.yaml -s new.yaml --only-breaking -o report"

46− <$$> hardline <> par "Don't output anything, only fail if there are breaking changes:"

47− <$$> hardline <> indent 4 "comparest -c old.json -s new.json --silent"

48− <$$> hardline <> par "Write full report suitable for embedding into a GitHub comment to report.html:"

49− <$$> hardline <> indent 4 "comparest -c old.json -s new.json --folding-block-quotes-style -o report.html"

50− )

51− )

52− )

33+ (fullDesc

34+ <> header "CompaREST"

35+ <> progDescDoc

36+ (Just $

37+ par "A tool to check compatibility between two OpenAPI specifications."

38+ <$$> hardline <> par "Usage examples" <> hardline

39+ <$$> indent

40+ 4

41+ (par "Compare files old.yaml with new.yaml and output the resulting report to stdout:"

42+ <$$> hardline <> indent 4 "comparest -c old.yaml -s new.yaml"

43+ <$$> hardline <> par "Only output breaking changes and write a styled HTML report to file report.html:"

44+ <$$> hardline <> indent 4 "comparest -c old.yaml -s new.yaml --only-breaking -o report"

45+ <$$> hardline <> par "Don't output anything, only fail if there are breaking changes:"

46+ <$$> hardline <> indent 4 "comparest -c old.json -s new.json --silent"

47+ <$$> hardline <> par "Write full report suitable for embedding into a GitHub comment to report.html:"

48+ <$$> hardline <> indent 4 "comparest -c old.json -s new.json --folding-block-quotes-style -o report.html")))

5349

5450optionsParser :: Parser Options

5551optionsParser =

5652 Options

5753 <$> strOption

58− ( short 'c'

59− <> long "client"

60− <> help

61− "A path to the file containing the specification that will be \

62− \used for the client of the API. Can be either a YAML or JSON file."

63− )

54+ (short 'c'

55+ <> long "client"

56+ <> help

57+ "A path to the file containing the specification that will be \

58+ \used for the client of the API. Can be either a YAML or JSON file.")

6459 <*> strOption

65− ( short 's'

66− <> long "server"

67− <> help

68− "A path to the file containing the specification that will be \

69− \used for the server of the API. Can be either a YAML or JSON file."

70− )

71− <*> ( flag'

72− Nothing

73− ( long "silent"

74− <> help "Silence all output. Only makes sense in combination with --signal-exit-code."

75− )

76− <|> flag'

77− (Just OnlyErrors)

78− ( long "only-breaking"

79− <> help "Only report breaking changes in the output."

80− )

81− <|> flag'

82− (Just All)

83− ( long "all"

84− <> help

85− "Report both incompatible and compatible changes. \

86− \Compatible changes will not trigger a failure exit code."

87− )

88− <|> pure (Just All)

89− )

90− <*> ( ( FileMode

91− <$> strOption

92− ( short 'o' <> long "output"

93− <> helpDoc

94− ( Just $

95− par "The file path where the output should be written. If the option is omitted the result will be written to stdout."

96− <$$> hardline <> par "The file extension is used to determine the type of the output file."

97− <$$> hardline <> par "Supports many formats such as markdown, html, rtf, doc, txt, rst, and many more."

98− <$$> hardline <> par "Leave out the extension to produce a self-contained HTML report with styling."

99− )

100− )

101− )

102− <|> pure StdoutMode

103− )

104− <*> ( flag'

105− FoldingBlockquotesTreeStyle

106− ( long "folding-block-quotes-style"

60+ (short 's'

61+ <> long "server"

62+ <> help

63+ "A path to the file containing the specification that will be \

64+ \used for the server of the API. Can be either a YAML or JSON file.")

65+ <*> (flag'

66+ Nothing

67+ (long "silent"

68+ <> help "Silence all output. Only makes sense in combination with --signal-exit-code.")

69+ <|> flag'

70+ (Just OnlyErrors)

71+ (long "only-breaking"

72+ <> help "Only report breaking changes in the output.")

73+ <|> flag'

74+ (Just All)

75+ (long "all"

76+ <> help

77+ "Report both incompatible and compatible changes. \

78+ \Compatible changes will not trigger a failure exit code.")

79+ <|> pure (Just All))

80+ <*> ((FileMode

81+ <$> strOption

82+ (short 'o' <> long "output"

83+ <> helpDoc

84+ (Just $

85+ par "The file path where the output should be written. If the option is omitted the result will be written to stdout."

86+ <$$> hardline <> par "The file extension is used to determine the type of the output file."

87+ <$$> hardline <> par "Supports many formats such as markdown, html, rtf, doc, txt, rst, and many more."

88+ <$$> hardline <> par "Leave out the extension to produce a self-contained HTML report with styling.")))

89+ <|> pure StdoutMode)

90+ <*> (flag'

91+ FoldingBlockquotesTreeStyle

92+ (long "folding-block-quotes-style"

93+ <> help

94+ "The report tree is structured using \

95+ \summary/detail HTML elements and indented using \

96+ \block quotes. This style renders well on GitHub.\

97+ \Intended for HTML output format. Markdown has rendering \

98+ \bugs on GitHub.")

99+ <|> flag'

100+ HeadersTreeStyle

101+ (long "header-style"

107102 <> help

108103 "The report tree is structured using \

109− \summary/detail HTML elements and indented using \

110− \block quotes. This style renders well on GitHub.\

111− \Intended for HTML output format. Markdown has rendering \

112− \bugs on GitHub."

113− )

114− <|> flag'

115− HeadersTreeStyle

116− ( long "header-style"

117− <> help

118− "The report tree is structured using \

119− \increasing levels of headers."

120− )

121− <|> pure HeadersTreeStyle

122− )

123− <*> switch

124− ( long "signal-exit-code"

125− <> helpDoc

126− ( Just $

104+ \increasing levels of headers.")

105+ <|> pure HeadersTreeStyle)

106+ <*> switch

107+ (long "signal-exit-code"

108+ <> helpDoc (Just $

127109 par "Signal API compatibility with the exit code."

128110 <$$> hardline <> par "Exit with 0 if there are no breaking changes."

129111 <$$> par "Exit with 1 if there are breaking changes."

130− <$$> par "Exit with 2 if could not determine compatibility."

131− )

132− )

112+ <$$> par "Exit with 2 if could not determine compatibility."))

133113

134114par :: String -> Doc

135115par = foldr1 (</>) . fmap string . words

app/FormatHeuristic.hs+1−1

@@ -2,7 +2,7 @@

22-- Originally based on:

33-- https://github.com/jgm/pandoc/blob/master/src/Text/Pandoc/App/FormatHeuristics.hs

44module FormatHeuristic

5− ( formatFromFilePath,

5+ ( formatFromFilePath

66 )

77where

88

app/Main.hs−1

@@ -2,7 +2,6 @@ module Main (main) where

22

33import Control.Monad

44import Control.Monad.Except

5−import Control.Monad.Trans (lift)

65import Data.Aeson

76import qualified Data.ByteString.Lazy as BSL

87import Data.Default

awsm-cssnew file+1

Submodule changed.

ci/policeman.nixdeleted−4

@@ -1,4 +0,0 @@

1−{ sources ? import ../nix/sources.nix

2−, pkgs ? import sources.nixpkgs { }

3−}:

4−pkgs.haskellPackages.policeman

compaREST.cabal → comparest.cabalrenamed+20−24

@@ -1,24 +1,29 @@

11cabal-version: 2.4

2−name: compaREST

3−version: 0.1.0.1

2+name: comparest

3+version: 0.0.0.0

44synopsis: Compatibility checker for OpenAPI

55description: Compatibility checker for OpenAPI.

66license: MIT

77license-file: LICENSE

88author: Typeable

9−maintainer: compaREST@typeable.io

9+maintainer: comparest@typeable.io

1010copyright: 2021 Typeable

1111category: Web

1212build-type: Simple

1313extra-doc-files: README.md

1414 CHANGELOG.md

15−tested-with: GHC == 9.6

16−extra-source-files: css/awsm.min.css

17−extra-source-files:

18− test/golden/**/*.yaml

19− test/golden/**/*.md

15+tested-with: GHC == 8.10.4

16+extra-source-files: awsm-css/dist/awsm.min.css

17+

18+Flag static

19+ Default: False

20+ Manual: True

2021

2122common common-options

23+ if flag(static)

24+ cc-options: -static

25+ ld-options: -static -pthread

26+ ghc-options: -static

2227 ghc-options:

2328 -Weverything

2429 -Wno-implicit-prelude

@@ -26,17 +31,15 @@ common common-options

2631 -Wno-safe

2732 -Wno-prepositive-qualified-module

2833 -Wno-missing-import-lists

29− -Wno-missing-kind-signatures

3034 -Wno-partial-fields

3135 -Wno-all-missed-specialisations

3236 -Wno-missing-local-signatures

3337 -Wno-unsafe

3438 -fconstraint-solver-iterations=0

3539 default-language: Haskell2010

36− build-depends: base >= 4.12.0.0 && < 5

40+ build-depends: base >= 4.12.0.0 && < 4.16

3741 , text

3842

39−

4043 default-extensions: ApplicativeDo

4144 , BangPatterns

4245 , ConstraintKinds

@@ -78,7 +81,6 @@ common common-options

7881 , QuantifiedConstraints

7982 , DefaultSignatures

8083

81−

8284library

8385 import: common-options

8486 build-depends:

@@ -149,12 +151,12 @@ library

149151 other-modules: Data.HList

150152 , Data.OpenUnion.Extra

151153

152−executable compaREST

154+executable comparest

153155 import: common-options

154156 hs-source-dirs: app

155157 main-is: Main.hs

156158 build-depends:

157− compaREST

159+ comparest

158160 , pandoc

159161 , data-default

160162 , bytestring

@@ -166,7 +168,6 @@ executable compaREST

166168 , containers

167169 , doctemplates

168170 , pandoc-types

169− , prettyprinter-compat-ansi-wl-pprint

170171 ghc-options: -threaded

171172 -rtsopts

172173 -with-rtsopts=-N

@@ -174,12 +175,12 @@ executable compaREST

174175 FormatHeuristic

175176 Data.OpenApi.Compare.Options

176177

177−executable compaREST-GitHub-Action

178+executable comparest-github-action

178179 import: common-options

179180 hs-source-dirs: github-action

180181 main-is: Main.hs

181182 build-depends:

182− compaREST

183+ comparest

183184 , pandoc

184185 , yaml

185186 , aeson

@@ -189,7 +190,6 @@ executable compaREST-GitHub-Action

189190 , pandoc-types

190191 , envy

191192 , filepath

192− , bytestring

193193 ghc-options: -threaded

194194 -rtsopts

195195 -with-rtsopts=-N

@@ -197,10 +197,8 @@ executable compaREST-GitHub-Action

197197 Control.Monad.Freer.GitHub

198198 CompaREST.GitHub.API

199199 CompaREST.GitHub.Action.Config

200− GitHub.Data.Checks

201− GitHub.Endpoints.Checks

202200

203−test-suite compaREST-tests

201+test-suite comparest-tests

204202 import: common-options

205203 type: exitcode-stdio-1.0

206204 hs-source-dirs: test

@@ -208,10 +206,8 @@ test-suite compaREST-tests

208206 other-modules:

209207 Spec.Golden.Extra

210208 Spec.Golden.TraceTree

211− Paths_compaREST

212− autogen-modules: Paths_compaREST

213209 build-depends:

214− , compaREST

210+ , comparest

215211 , tasty-golden

216212 , tasty

217213 , bytestring

css/awsm.min.cssdeleted−1

@@ -1 +0,0 @@

1−@charset "UTF-8";html{font-family:"PT Serif",Georgia,serif;font-size:100%;line-height:1.6;background:#fff;color:#000;-webkit-overflow-scrolling:touch}body{margin:1em;font-size:1rem}@media (min-width:20rem){body{font-size:calc(1rem + .0125*(100vw - 20rem))}}@media (min-width:40rem){body{font-size:1.25rem}}body article,body footer,body header,body main{position:relative;max-width:40rem;margin:0 auto}body>header{margin-bottom:3.5em}body>header h1{margin:0;font-size:1.5em}body>header p{margin:0;font-size:.85em}body>footer{margin-top:4.5em;padding-bottom:1.5em;text-align:center;font-size:.8rem;color:#aaa}details,nav,p{margin:1em 0}nav ul{list-style:none;margin:0;padding:0}nav li{display:inline-block;margin-right:1em;margin-bottom:.25em}nav a:visited{color:#0064c1}article header h1 a:visited:hover,article header h2 a:visited:hover,nav a:hover{color:#3000c1}ol,ul{margin-top:0;padding-top:0;padding-left:2.5em}p{-webkit-hyphens:auto;-ms-hyphens:auto;hyphens:auto}aside:first-child,p:first-child{margin-top:0}aside:last-child,p:last-child{margin-bottom:0}p+ol,p+ul{margin-top:-.75em}p img,p picture{float:right;margin-bottom:.5em;margin-left:.5em}p picture img{float:none;margin:0}blockquote,dd{padding-left:2.5em}dd{margin-bottom:1em;margin-left:0}dt{font-weight:700}blockquote{margin:0}aside{margin:.5em 0;font-style:italic;color:#aaa}@media (min-width:65rem){aside{position:absolute;right:-12.5rem;width:9.375rem;max-width:9.375rem;margin:0;padding-left:.5em;font-size:.8em;border-left:1px solid #f2f2f2}}section+section{margin-top:2em}h1,h2,h3,h4,h5,h6{margin:1.25em 0 0;line-height:1.2}h1:focus>a[href^="#"][id],h1:hover>a[href^="#"][id],h2:focus>a[href^="#"][id],h2:hover>a[href^="#"][id],h3:focus>a[href^="#"][id],h3:hover>a[href^="#"][id],h4:focus>a[href^="#"][id],h4:hover>a[href^="#"][id],h5:focus>a[href^="#"][id],h5:hover>a[href^="#"][id],h6:focus>a[href^="#"][id],h6:hover>a[href^="#"][id]{opacity:1;transition:opacity 0s,color 300ms ease-out}figure+p,h1+details,h1+p,h2+details,h2+p,h3+details,h3+p,h4+details,h4+p,h5+details,h5+p,h6+details,h6+p{margin-top:.5em}h1>a[href^="#"][id],h2>a[href^="#"][id],h3>a[href^="#"][id],h4>a[href^="#"][id],h5>a[href^="#"][id],h6>a[href^="#"][id]{position:absolute;left:-.5em;opacity:0;background:0 0;color:rgba(0,0,0,.5);transition:opacity 300ms ease-out}h1>a[href^="#"][id]:focus,h1>a[href^="#"][id]:hover,h1>a[href^="#"][id]:target,h2>a[href^="#"][id]:focus,h2>a[href^="#"][id]:hover,h2>a[href^="#"][id]:target,h3>a[href^="#"][id]:focus,h3>a[href^="#"][id]:hover,h3>a[href^="#"][id]:target,h4>a[href^="#"][id]:focus,h4>a[href^="#"][id]:hover,h4>a[href^="#"][id]:target,h5>a[href^="#"][id]:focus,h5>a[href^="#"][id]:hover,h5>a[href^="#"][id]:target,h6>a[href^="#"][id]:focus,h6>a[href^="#"][id]:hover,h6>a[href^="#"][id]:target{opacity:1;box-shadow:none;color:#000;transition:opacity 0s,color 0s}h1>a[href^="#"][id]:target:focus,h2>a[href^="#"][id]:target:focus,h3>a[href^="#"][id]:target:focus,h4>a[href^="#"][id]:target:focus,h5>a[href^="#"][id]:target:focus,h6>a[href^="#"][id]:target:focus{outline:0}h1>a[href^="#"][id]::before,h2>a[href^="#"][id]::before,h3>a[href^="#"][id]::before,h4>a[href^="#"][id]::before,h5>a[href^="#"][id]::before,h6>a[href^="#"][id]::before{content:"â€¢"}h1{font-size:2em}h2{font-size:1.75em}h3{font-size:1.25em}h4{font-size:1.15em}h5,h6{font-size:1em}h6{margin-top:1em;color:#aaa}article+article{margin-top:5em}article header p{font-family:system-ui,-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,Oxygen,Ubuntu,Cantarell,"Fira Sans","Droid Sans","Helvetica Neue",Helvetica,Arial,sans-serif;font-size:.6em;color:#aaa}article header p+h1,article header p+h2{margin-top:-.25em}article header h1+p,article header h2+p{margin-top:.25em}article header h1 a,article header h2 a{color:#000;background:url('data:image/svg+xml;charset=utf8,%3Csvg xmlns="http://www.w3.org/2000/svg" width="1" height="1"%3E%3Crect x="0" y="0.5" width="1" height="0.5" fill="rgba(0, 0, 0, 0.35)"/%3E%3C/svg%3E') left bottom repeat-x}@media screen and (-ms-high-contrast:active),(-ms-high-contrast:none){article header h1 a,article header h2 a{background:url('data:image/svg+xml;charset=utf8,%3Csvg xmlns="http://www.w3.org/2000/svg" width="1" height="2"%3E%3Crect x="0" y="1" width="1" height="1" fill="rgba(0, 0, 0, 0.35)"/%3E%3C/svg%3E') left bottom repeat-x}}article header h1 a:visited,article header h2 a:visited{color:#aaa;background:url('data:image/svg+xml;charset=utf8,%3Csvg xmlns="http://www.w3.org/2000/svg" width="1" height="1"%3E%3Crect x="0" y="0.5" width="1" height="0.5" fill="rgba(170, 170, 170, 0.35)"/%3E%3C/svg%3E') left bottom repeat-x}@media screen and (-ms-high-contrast:active),(-ms-high-contrast:none){article header h1 a:visited,article header h2 a:visited{background:url('data:image/svg+xml;charset=utf8,%3Csvg xmlns="http://www.w3.org/2000/svg" width="1" height="2"%3E%3Crect x="0" y="1" width="1" height="1" fill="rgba(170, 170, 170, 0.35)"/%3E%3C/svg%3E') left bottom repeat-x}}article>footer{margin-top:1.5em;font-size:.85em}a,abbr{text-decoration:none}a{color:#0064c1;transition:color 300ms ease-out,box-shadow 300ms ease-out;background:url('data:image/svg+xml;charset=utf8,%3Csvg xmlns="http://www.w3.org/2000/svg" width="1" height="1"%3E%3Crect x="0" y="0.5" width="1" height="0.5" fill="rgba(0, 100, 193, 0.35)"/%3E%3C/svg%3E') left bottom repeat-x}@media screen and (-ms-high-contrast:active),(-ms-high-contrast:none){a{background:url('data:image/svg+xml;charset=utf8,%3Csvg xmlns="http://www.w3.org/2000/svg" width="1" height="2"%3E%3Crect x="0" y="1" width="1" height="1" fill="rgba(0, 100, 193, 0.35)"/%3E%3C/svg%3E') left bottom repeat-x}}a:visited{color:#80b2e0}a:active,a:hover{outline-width:0}a:hover{box-shadow:inset 0 -1px #3000c1;color:#3000c1;transition:color 0s,box-shadow 0s}abbr{margin-right:-.075em;-webkit-hyphens:none;-ms-hyphens:none;hyphens:none;letter-spacing:.075em;font-size:.9em;border-bottom:1px dotted}img,picture{display:block;max-width:100%;margin:0 auto}audio,video{width:100%;max-width:100%}video{-o-object-position:0 -1px;object-position:0 -1px}figure{margin:1em 0 .5em;padding:0}figure figcaption{opacity:.65;font-size:.85em}table{display:inline-block;border-spacing:0;border-collapse:collapse;overflow-x:auto;max-width:100%;text-align:left;vertical-align:top;background:linear-gradient(rgba(0,0,0,.15) 0%,rgba(0,0,0,.15) 100%) 0 0,linear-gradient(rgba(0,0,0,.15) 0%,rgba(0,0,0,.15) 100%) 100% 0;background-attachment:scroll,scroll;background-size:1px 100%,1px 100%;background-repeat:no-repeat,no-repeat}table caption{font-size:.9em;background:#fff}table td,table th{padding:.35em .75em;vertical-align:top;font-size:.9em;border:1px solid #f2f2f2;border-top:0;border-left:0}table td:first-child,table th:first-child{padding-left:0;background-image:linear-gradient(to right,#fff 50%,rgba(255,255,255,0) 100%);background-size:2px 100%;background-repeat:no-repeat}table td:last-child,table th:last-child{padding-right:0;border-right:0;background-image:linear-gradient(to left,#fff 50%,rgba(255,255,255,0) 100%);background-position:100% 0;background-size:2px 100%;background-repeat:no-repeat}table td:only-child,table th:only-child{background-image:linear-gradient(to right,#fff 50%,rgba(255,255,255,0) 100%),linear-gradient(to left,#fff 50%,rgba(255,255,255,0) 100%);background-position:0 0,100% 0;background-size:2px 100%,2px 100%;background-repeat:no-repeat,no-repeat}table th{line-height:1.2}code,kbd,samp,var{font-family:Consolas,"Lucida Console",Monaco,monospace;font-style:normal}pre{overflow-x:auto;font-size:.8em;background:linear-gradient(rgba(0,0,0,.15) 0%,rgba(0,0,0,.15) 100%) 0 0,linear-gradient(rgba(0,0,0,.15) 0%,rgba(0,0,0,.15) 100%) 100% 0;background-attachment:scroll,scroll;background-size:1px 100%,1px 100%;background-repeat:no-repeat,no-repeat}pre>code,summary{display:inline-block}pre>code{overflow-x:visible;box-sizing:border-box;min-width:100%;border-right:3px solid #fff;border-left:1px solid #fff}hr{height:1px;margin:2em 0;border:0;background:#f2f2f2}details[open]{padding-bottom:.5em;border-bottom:1px solid #f2f2f2}summary{font-weight:700;border-bottom:1px dashed;cursor:pointer}summary::-webkit-details-marker{display:none}noscript{color:#d00000}::selection{background:rgba(0,100,193,.15)}

default.nix+14−68

@@ -1,14 +1,10 @@

11{ sources ? import ./nix/sources.nix

22, haskellNix ? import sources.haskellNix { inherit system; }

3−, pkgs ? import haskellNix.sources.nixpkgs-2311 (haskellNix.nixpkgsArgs // { inherit system; })

3+, pkgs ? import haskellNix.sources.nixpkgs-2105 (haskellNix.nixpkgsArgs // { inherit system; })

44, system ? builtins.currentSystem

55, nix-filter ? import sources.nix-filter

66}:

77let

8− masterPkgs = import sources.nixpkgs { inherit system; };

9− yq = import ./nix/yq.nix { pkgs = masterPkgs; };

10− diffYaml = import ./nix/diff-yaml.nix { pkgs = masterPkgs; };

11−

128 hsPkgs = pkgs.haskell-nix.stackProject {

139 src = nix-filter {

1410 root = ./.;

@@ -16,7 +12,7 @@ let

1612 include = [

1713 ./stack.yaml

1814 ./stack.yaml.lock

19− ./compaREST.cabal

15+ ./comparest.cabal

2016 ];

2117 };

2218

@@ -25,22 +21,16 @@ let

2521 dontStrip = false;

2622 dontPatchELF = false;

2723 enableDeadCodeElimination = true;

28− ghcOptions = [

29− "-O2"

30− "-fexpose-all-unfoldings"

31− "-fspecialise-aggressively"

32− ];

33− packages.pandoc.ghcOptions = [ "-O1" ];

34− packages.compaREST.src = nix-filter {

24+ packages.comparest.src = nix-filter {

3525 root = ./.;

3626 name = "compaREST-src";

3727 include = with nix-filter; [

38− (./compaREST.cabal)

28+ (./comparest.cabal)

3929 (inDirectory ./test)

4030 (inDirectory ./src)

4131 (inDirectory ./app)

4232 (inDirectory ./github-action)

43− ./css/awsm.min.css

33+ ./awsm-css/dist/awsm.min.css

4434 ./LICENSE

4535 ];

4636 };

@@ -55,71 +45,27 @@ let

5545 ${pkgs.nukeReferences}/bin/nuke-refs $out/bin/*

5646 '';

5747

58− compaRESTBin = hsPkgs.compaREST.components.exes.compaREST;

59− compaRESTStaticBin = (staticify "compaREST-static" hsPkgs.projectCross.musl64.hsPkgs.compaREST.components.exes.compaREST);

60−

61−

62− # doesn't work

63− armDarwinCompaREST = hsPkgs.projectCross.aarch64-darwin.hsPkgs.compaREST.components.exes.compaREST;

64−

65− compaRESTImage = pkgs.dockerTools.buildImage {

48+ compaREST = pkgs.dockerTools.buildImage {

6649 name = "compaREST";

67− contents = [ compaRESTStaticBin ];

50+ contents = [ (staticify "compaREST-static" hsPkgs.projectCross.musl64.hsPkgs.comparest.components.exes.comparest) ];

6851 config = {

69− Entrypoint = [ "/bin/compaREST" ];

52+ Entrypoint = [ "/bin/comparest" ];

7053 };

7154 };

7255

73− macOSCompaRESTBundle = pkgs.runCommand "compaREST-macOS-bundled"

74− {

75− buildInputs = [ masterPkgs.macdylibbundler ];

76− } ''

77− mkdir -p $out/lib

78− cp ${compaRESTBin}/bin/compaREST $out/compaREST

79− chmod 755 $out/compaREST

80− dylibbundler -b \

81− -x $out/compaREST \

82− -d $out/lib \

83− -p '@executable_path/lib'

84− '';

85−

86−

8756 compaRESTGithubAction =

8857 let

89− action = staticify "compaREST-GitHub-Action-static" hsPkgs.projectCross.musl64.hsPkgs.compaREST.components.exes.compaREST-GitHub-Action;

90− wrapped = pkgs.runCommand "wrapped-compaREST-GitHub-Action" { buildInputs = [ pkgs.makeWrapper ]; } ''

91− makeWrapper ${action}/bin/compaREST-GitHub-Action $out/bin/pre --add-flags "pre"

92− makeWrapper ${action}/bin/compaREST-GitHub-Action $out/bin/run --add-flags "run"

58+ action = staticify "compaREST-github-action-static" hsPkgs.projectCross.musl64.hsPkgs.comparest.components.exes.comparest-github-action;

59+ wrapped = pkgs.runCommand "wrapped-compaREST-github-action" { buildInputs = [ pkgs.makeWrapper ]; } ''

60+ makeWrapper ${action}/bin/comparest-github-action $out/bin/pre --add-flags "pre"

61+ makeWrapper ${action}/bin/comparest-github-action $out/bin/run --add-flags "run"

9362 '';

9463 in

9564 pkgs.dockerTools.buildImage {

96− name = "typeable/compaREST-GitHub-Action";

65+ name = "typeable/comparest-github-action";

9766 tag = "latest";

9867 contents = [ wrapped pkgs.cacert ];

9968 };

10069

101− WindowsCompaRESTBin = hsPkgs.projectCross.mingwW64.hsPkgs.compaREST.components.exes.compaREST;

102−

103− # We use the static version so that we don't have to rebuild everything on CI.

104− # The only binaries build on CI are static.

105− test = hsPkgs.projectCross.musl64.hsPkgs.compaREST.components.tests.compaREST-tests.overrideAttrs (final: old: {

106− buildInputs = old.buildInputs ++ [ diffYaml yq ];

107− nativeBuildInputs = old.nativeBuildInputs ++ (with masterPkgs; [ makeWrapper ]);

108−

109− postInstall = ''

110− wrapProgram $out/bin/compaREST-tests \

111− --prefix PATH : ${masterPkgs.lib.makeBinPath [ diffYaml yq ]}

112− '';

113− });

11470in

115−{

116− inherit

117− compaRESTImage

118− compaRESTGithubAction

119− compaRESTStaticBin

120− compaRESTBin

121− hsPkgs

122− macOSCompaRESTBundle

123− WindowsCompaRESTBin

124− test;

125−}

71+{ inherit compaREST compaRESTGithubAction hsPkgs haskellNix; }

docs/Development_guide.mddeleted−149

@@ -1,149 +0,0 @@

1−CompaREST

2−=========

3−The tool works by simultaneously looking at a pair of nodes in OpenAPI schema

4−trees. At every place we try to understand whether one side (the producer) can

5−produce something that the other side (the consumer) cannot consume. This often

6−involves recursively running the same check on child sub-nodes. The necessary

7−criteria are implemented manually for all types of nodes that appear in the

8−schema. The `Subtree` class in `Data.OpenApi.Compare.Subtree` designates types

9−of nodes for which this compatibility checking is defined. The implementations

10−for various types reside in `Data.OpenApi.Compare.Validate.*`.

11−

12−Producer/Consumer

13−-----------------

14−Rather than looking at which schema is the server's and which is the client's,

15−in terms of compatibility checking it is more useful to track which side is the

16−"producer" and which is the "consumer". At the root of the schema the producer

17−is the client, but as we descend into an HTTP response, the direction flips and

18−the producer becomes the server.

19−

20−We deal with a lot of things in pairs, where one thing belongs to the producer

21−and another belongs to the consumer. The `ProdCons` datatype (in

22−`Data.OpenApi.Compare.Subtree`) is just a pair type that provides an Applicative

23−abstraction for working with two things simultaneously.

24−

25−Trees

26−-----

27−We directly use the datatypes defined in the `openapi3` library. For reasons of

28−identifiability and memoization we tag all nodes in the trees with a path from

29−the root. The tree is heterogeneous (nodes have different types), and every type

30−of node has a different arrangement of children. There is a `Step` data family

31−that defines all the possible children (of a specific type) of a node (of a

32−specific type).

33−

34−A `Trace` is a sequence of steps, except in a path the types of adjacent steps

35−have to agree. The `Paths` datatype achieves this. Together all paths form a

36−`Category`, and we often concatenate them using `>>>`. This is defined in

37−`Data.OpenApi.Compare.Paths`.

38−

39−We often keep a node and a path to it next to each other using an environment

40−comonad. `Traced` is a type alias around `Env` which ensures that the type of

41−the path matches the type of the node.

42−

43−Issues

44−------

45−The output of the tool is a list of compatibility issues that came up during

46−checking. The `Issue` data family describes the kinds of issues that can occur

47−at each type of node. An issue is supposed to characterize a set of interactions

48−(requests or responses) that demonstrate that the schemas are incompatible.

49−

50−Each issue is tagged with a `Behavior` that describes the path to reproducing

51−the issue. While a `Trace` describes a syntactic path down the schema tree, a

52−`Behavior` describes which part of an interaction needs to be focused on for the

53−issue to manifest itself.

54−

55−In most places where we keep multiple issues (e.g. the output), to store them we

56−use a prefix tree map, indexed by both types and values of `Behavior`s. See

57−`Data.OpenApi.Compare.PathsPrefixTree`.

58−

59−Report

60−------

61−The checker ultimately outputs a list of `Issue`s, together with `Behavior`s

62−that cause them. We run the checker twice: forwards and backwards -- to detect

63−non-breaking changes. All of this is then compiled into a report in

64−`Data.OpenApi.Compare.Report`. The tree structure of headings is computed from

65−`Behavior`s, using `Jet`s to collapse particular sequences of behavior steps

66−into a single human-readable header item. The text of each paragraph comes from

67−`describeIssue`.

68−

69−We then use the `pandoc` library to render the report in a variety of formats.

70−

71−Formulas

72−--------

73−The schema has references, so it can end up being recursive. Similarly the

74−process for establishing compatibility can end up being recursive. To keep track

75−of this, the checker actually manipulates *formulas* which can have variables in

76−them, defined in (`Data.OpenApi.Compare.Formula`).

77−

78−A formula represents a set of issues, with the empty set corresponding to a

79−successful compatibility check. A formula can have conjunctions, where we only

80−report success if all parts succeeded, and if not we take the union of all

81−issues. A formula can also have disjunctions, but there it's impossible to

82−guarantee that the issues for the parts also make sense as issues for the whole

83−thing. Due to this if all disjuncted parts have issues we instead return a

84−different issue (usually non-descriptive).

85−

86−The `FormulaF` datatype implements a functor that carries formulaic calculations

87−as well as a result value (a co-Yoneda extension of formulas for the most part).

88−The Applicative interface provides conjunction, and the Alternative interface

89−provides disjunction.

90−

91−When we detect recursion we introduce a variable, compute the compatibility

92−check as a formula with that variable, and then we solve a fixed point equation

93−(`maxFixpoint`) with the variable to obtain the answer.

94−

95−This `FomulaF` is further wrapped in a couple monad transformers

96−(`SemanticCompatFormula`, `StructuralCompatFormula`), and the whole checker is

97−then implemented in the resulting Applicative using ApplicativeDo.

98−

99−Memoization

100−-----------

101−The `Data.OpenApi.Compare.Memo` module contains utilities for stateful

102−memoization and recursion detection. The entire checking process is memoized,

103−and can detect, propagate, and resolve recursion.

104−

105−Structural/Semantic Compatibility

106−---------------------------------

107−When we encounter two nodes we first try to optimistically establish whether

108−they're structurally equal, i.e. the trees are exactly the same modulo reference

109−inlining. This check is also memoized and recursion-aware. If the check succeeds

110−we conclude that the schemas are compatible. Otherwise we fall back to the

111−"normal" semantic compatibility.

112−

113−

114−JSON Schema

115−-----------

116−The language that describes JSON payloads is probably the richest part of

117−OpenAPI schemas, and the checker for it also comes with a lot of moving parts.

118−

119−JSON schema allows arbitrary set arithmetic using `allOf`, `anyOf`, `not` and

120−`oneOf`. To fully check `not` and `oneOf` we would need to compare set

121−subtraction, which involves negating a comparison result. If recursion is

122−involved we would need to be able to solve equations with negation, which we

123−cannot do. So `not` is unsupported altogether, and `oneOf` is only supported

124−when it has disjoint branches and behaves like `anyOf`.

125−

126−With that in mind a JSON schema is first pre-processed into a Disjunctive Normal

127−Form (`DNF` in `Data.OpenApi.Compare.Validate.Schema.DNF`). This pre-processing

128−happens in `Data.OpenApi.Compare.Validate.Schema.Process`.

129−

130−The DNF contains elementary clauses that match on a specific aspect of a JSON

131−object (`Condition`). Most clauses only affect objects of a single type, so JSON

132−values and clauses are segregated by type (`JsonType`, `TypedValue` in

133−`Data.OpenApi.Compare.Validate.Schema.JsonFormula`)

134−

135−Then we reduce the problem of comparing two DNF's to the comparison of a

136−conjunction of clauses in the producer with a single clause in the consumer

137−(`checkFormulas` in `Data.OpenApi.Compare.Validate.Schema`).

138−

139−When we do disjunction in the formula we lose information, so we try to avoid

140−having disjunctions in the consumer DNF. This is done by the means of

141−partitioning. We look for factors that would let us partition the set of all

142−objects into several bins, in a way that hopefully corresponds only a single

143−consumer to each producer. This is implemented in

144−`Data.OpenApi.Compare.Validate.Schema.Partition`. Currently we can only

145−partition by an `enum` value that is accessible via a chain of `required`

146−fields.

147−

148−The same partitioning mechanism is used to test whether the branches of a

149−`oneOf` are disjoint, and emit a warning otherwise.

docs/Integration_guide.md+5−3

@@ -28,6 +28,8 @@ In our example we have already generated the two OpenAPI specs and placed them i

2828

2929We can now run our action:

3030

31+##### NOTE: will only work after public release

32+

3133```yaml

3234- uses: typeable/comparest

3335 with:

@@ -36,11 +38,11 @@ We can now run our action:

3638 project_name: TEST

3739```

3840

39−This will create a check on the pull request displaying the changes (if there are any) similar to this:

41+This will create a comment on the pull request displaying the changes (if there are any) similar to this:

4042

41−![](img/github-action-report.png)

43+![](img/github-action-comment.png)

4244

43−The check will show success when there are no breaking changes, and be neutral otherwise.

45+Consecutive runs of the action will update the comment instead of creating new ones. This will prevent the pile-up of compaREST comments and save you from distracting notifications.

4446

4547## Integrating into something other than Github Actions

4648

docs/Releasing.mddeleted−15

@@ -1,15 +0,0 @@

1−# The release procedure

2−

3−1. Update the version number everywhere:

4− 1. Version in [compaREST.cabal](../compaREST.cabal)

5− 2. Docker tag in [action.yaml](../action.yaml)

6− 3. Set the version of unreleased changes in [CHANGELOG.md](../CHANGELOG.md)

7−2. Publish!

8− 1. Create a pre-release on GitHub:

9− ![](img/pre-release.png)

10− 2. This will automatically start the release procedure. You can check the state of it in the "Actions" tab on GitHub:

11− ![](img/pre-release-ci.png)

12− 3. If everything goes as planned, the release action should pass and all assets should be added to the release:

13− ![](img/pre-release-artifacts.png)

14− 4. The new version should be automatically uploaded a release candidate to [Hackage](https://hackage.haskell.org/package/compaREST/candidates/). Make sure everything looks okay and publish it.

15− 5. Go to the Releases tab on GitHub and edit the release to make it not a "pre-release".

docs/User_guide.mddeleted−51

@@ -1,51 +0,0 @@

1−CompaREST User Guide

2−====================

3−

4−Running the Tool

5−----------------

6−The tool accepts two OpenAPI 3.0.0 schema files in either JSON or YAML format.

7−One is assumed to be the client version of the schema, and the other is the

8−server version.

9−

10−The tool will look for changes between the schemas and detect whether they are

11−breaking or not -- that is, if they prevent interoperability between the client

12−and the server.

13−

14−Running:

15−```

16−comparest -c client.json -s server.json

17−```

18−will output a markdown report of the changes to the standard output.

19−

20−Compatibility status can be signaled via the exit code using

21−`--signal-exit-code`. In case no report is needed, output can be suppressed with

22−`--silent`. For example:

23−```

24−comparest -c client.json -s server.json --signal-exit-code --silent

25−echo $?

26−```

27−If there were changes that the tool determined to be breaking, the exit code

28−will be 1. If there were some changes the tool couldn't understand, the exit

29−code will be 2. Otherwise if there were no breaking changes, the exit code will

30−be 0.

31−

32−Controlling the Report

33−----------------------

34−By default the report includes breaking changes, as well as non-breaking:

35−changes that would be considered breaking in the opposite direction. To only

36−include breaking changes in the report use `--only-breaking`. The `--all` option

37−restores the default behavior.

38−

39−The report can be formatted in a variety of ways supported by Pandoc. The `-o`

40−option causes the report to be written to a file. The format of the file is

41−determined from the extension. The supported extensions include:

42− - `.md` for markdown

43− - `.html` for an HTML snippet

44− - `.rst` for restructured text

45− - no extension for a self-contained HTML document with styles

46−

47−By default the report is split up into parts relating to different paths,

48−requests, responses, etc, using headers of various levels. Alternatively, the

49−report can use indended block-quotes to visualize the tree structure of the

50−report. The header style is enabled with `--header-style`, and the block-quote

51−style is enabled with `--folding-block-quotes-style`.

docs/img/github-action-comment.pngnew file

Binary file not shown.

docs/img/github-action-report.pngdeleted

Binary file not shown.

docs/img/pre-release-artifacts.pngdeleted

Binary file not shown.

docs/img/pre-release-ci.pngdeleted

Binary file not shown.

docs/img/pre-release.pngdeleted

Binary file not shown.

github-action/CompaREST/GitHub/API.hs+39−70

@@ -1,86 +1,55 @@

11module CompaREST.GitHub.API

2− ( postStatus,

3− postStatusProcessing,

2+ ( mapComment,

3+ createOrUpdateComment,

44 )

55where

66

77import CompaREST.GitHub.Action.Config

8+import Control.Monad

89import Control.Monad.Freer

910import Control.Monad.Freer.GitHub

1011import Control.Monad.Freer.Reader

11−import Control.Monad.IO.Class

12−import Data.Aeson

13−import qualified Data.ByteString.Lazy.Char8 as BSLC

14−import Data.OpenApi.Compare.Report

12+import Data.Foldable

1513import Data.Proxy

1614import Data.Text (Text)

15+import qualified Data.Text as T

16+import qualified Data.Vector as V

1717import GitHub

18−import GitHub.Data.Checks

19−import GitHub.Endpoints.Checks

18+import qualified GitHub as GH

2019

21−postStatusProcessing ::

22− (Members '[GitHub, Reader Config] effs, MonadIO (Eff effs)) =>

23− Eff effs ()

24−postStatusProcessing = do

20+findComment :: Members '[GitHub, Reader Config] effs => Eff effs (Maybe GH.IssueComment)

21+findComment = do

2522 Config {..} <- ask

26− printJSON $

27− sendGitHub $

28− checkR

29− repoOwner

30− repoName

31− Check

32− { checkName = mkName Proxy checkName

33− , checkSha = sha

34− , checkDetailsURL = Nothing

35− , checkExternalId = Nothing

36− , checkStatus = Just CheckInProgress

37− , checkStartedAt = Nothing

38− , checkConclusion = Nothing

39− , checkCompletedAt = Nothing

40− , checkOutput = Nothing

41− , checkActions = Nothing

42− }

23+ comments <- sendGitHub $ GH.commentsR repoOwner repoName issue GH.FetchAll

24+ htmlComment <- getHTMLComment

25+ let tryStripPrefix :: GH.IssueComment -> Maybe GH.IssueComment

26+ tryStripPrefix c@GH.IssueComment {issueCommentBody = (T.stripSuffix htmlComment -> Just b)} =

27+ Just $ c {GH.issueCommentBody = b}

28+ tryStripPrefix _ = Nothing

29+ pure . (V.!? 0) $ V.mapMaybe tryStripPrefix comments

4330

44−postStatus ::

45− (Members '[GitHub, Reader Config] effs, MonadIO (Eff effs)) =>

46− -- | 'Nothing' means that there were no changes at all

47− Maybe (Text, ReportStatus) ->

48− Eff effs ()

49−postStatus x = do

50− let (body, (title, conclusion)) = case x of

51− Just (b, s) -> (b,) $ case s of

52− BreakingChanges -> ("⚠️ Breaking changes found!", CheckNeutral)

53− NoBreakingChanges -> ("No breaking changes found ✨", CheckSuccess)

54− OnlyUnsupportedChanges -> ("🤷 Couldn't determine compatibility", CheckNeutral)

55− Nothing -> ("", ("✅ The API did not change", CheckSuccess))

31+mapComment :: Members '[GitHub, Reader Config] effs => (Text -> Text) -> Eff effs ()

32+mapComment f = do

33+ findComment

34+ >>= traverse_

35+ ( \comment -> do

36+ Config {..} <- ask

37+ htmlComment <- getHTMLComment

38+ sendGitHub $ editCommentR repoOwner repoName (GH.mkId Proxy $ GH.issueCommentId comment) ((<> htmlComment) . f $ GH.issueCommentBody comment)

39+ pure ()

40+ )

41+

42+createOrUpdateComment :: Members '[GitHub, Reader Config] effs => Text -> Eff effs ()

43+createOrUpdateComment body' = do

5644 Config {..} <- ask

57− printJSON $

58− sendGitHub $

59− checkR

60− repoOwner

61− repoName

62− Check

63− { checkName = mkName Proxy checkName

64− , checkSha = sha

65− , checkDetailsURL = Nothing

66− , checkExternalId = Nothing

67− , checkStatus = Just CheckCompleted

68− , checkStartedAt = Nothing

69− , checkConclusion = Just conclusion

70− , checkCompletedAt = Nothing

71− , checkOutput =

72− Just $

73− CheckOutput

74− { checkTitle = title

75− , checkSummary = body

76− , checkText = Nothing

77− , checkAnnotations = Nothing

78− , checkImages = Nothing

79− }

80− , checkActions = Nothing

81− }

45+ htmlComment <- getHTMLComment

46+ let body = body' <> htmlComment

47+ void $

48+ findComment >>= \case

49+ Just comment -> sendGitHub $ editCommentR repoOwner repoName (GH.mkId Proxy $ GH.issueCommentId comment) body

50+ Nothing -> sendGitHub $ createCommentR repoOwner repoName issue body

8251

83−printJSON :: MonadIO (Eff effs) => Eff effs Value -> Eff effs ()

84−printJSON m = do

85− x <- m

86− liftIO . BSLC.putStrLn $ encode x

52+getHTMLComment :: Member (Reader Config) effs => Eff effs Text

53+getHTMLComment = do

54+ name <- asks projectName

55+ pure $ "\n\n"

github-action/CompaREST/GitHub/Action/Config.hs+6−10

@@ -8,17 +8,16 @@ import Data.Text (Text)

88import qualified Data.Text as T

99import qualified GitHub as GH

1010

11−import Data.Functor

1211import System.Envy

1312

1413data Config = Config

1514 { githubToken :: GH.Auth

1615 , repoOwner :: GH.Name GH.Owner

1716 , repoName :: GH.Name GH.Repo

18− , checkName :: Text

17+ , issue :: GH.IssueNumber

18+ , projectName :: Text

1919 , footerText :: Text

2020 , root :: FilePath

21− , sha :: GH.Name GH.Commit

2221 }

2322

2423instance FromEnv Config where

@@ -28,20 +27,17 @@ instance FromEnv Config where

2827 T.split (== '/') <$> env "REPO" >>= \case

2928 [owner, name] -> pure (owner, name)

3029 _ -> fail "malformed repo"

31− checkName <-

32− envMaybe "PROJECT_NAME" <&> \case

33− Just pName | not . T.null . T.strip $ pName -> "compaREST – " <> pName

34− _ -> "compaREST"

30+ issue <- GH.IssueNumber <$> env "PR_NUMBER"

31+ projectName <- env "PROJECT_NAME"

3532 footerText <- env "FOOTER"

3633 root <- envMaybe "ROOT" .!= "."

37− sha <- env "SHA"

3834 pure $

3935 Config

4036 { githubToken = token

4137 , repoOwner = GH.mkName Proxy owner

4238 , repoName = GH.mkName Proxy repo

43− , checkName = checkName

39+ , issue = issue

40+ , projectName = projectName

4441 , footerText = footerText

4542 , root = root

46− , sha = GH.mkName Proxy sha

4743 }

github-action/GitHub/Data/Checks.hsdeleted−173

@@ -1,173 +0,0 @@

1−module GitHub.Data.Checks

2− ( Check (..),

3− CheckStatus (..),

4− CheckConclusion (..),

5− CheckOutput (..),

6− CheckAnnotation (..),

7− CheckAnnotationLevel (..),

8− CheckImage (..),

9− CheckAction (..),

10− )

11−where

12−

13−import Data.Aeson

14−import Data.Aeson.Types

15−import Data.Text (Text)

16−import Data.Vector (Vector)

17−import GHC.Generics (Generic)

18−import GitHub

19−import GitHub.Internal.Prelude (UTCTime)

20−

21−data Check = Check

22− { checkName :: !(Name Check)

23− , checkSha :: !(Name Commit)

24− , checkDetailsURL :: !(Maybe URL)

25− , checkExternalId :: !(Maybe (Id Check))

26− , checkStatus :: !(Maybe CheckStatus)

27− , checkStartedAt :: !(Maybe UTCTime)

28− , checkConclusion :: !(Maybe CheckConclusion)

29− , checkCompletedAt :: !(Maybe UTCTime)

30− , checkOutput :: !(Maybe CheckOutput)

31− , checkActions :: !(Maybe (Vector CheckAction))

32− }

33− deriving stock (Show, Eq, Ord, Generic)

34−

35−instance ToJSON Check where

36− toJSON (Check n sha durl eid s sa c ca o a) =

37− object'

38− [ "name" .= n

39− , "head_sha" .= sha

40− , "details_url" .= durl

41− , "external_id" .= eid

42− , "status" .= s

43− , "started_at" .= sa

44− , "conclusion" .= c

45− , "completed_at" .= ca

46− , "output" .= o

47− , "actions" .= a

48− ]

49−

50−data CheckStatus

51− = CheckQueued

52− | CheckInProgress

53− | CheckCompleted

54− deriving stock (Show, Enum, Bounded, Eq, Ord, Generic)

55−

56−instance ToJSON CheckStatus where

57− toJSON CheckQueued = String "queued"

58− toJSON CheckInProgress = String "in_progress"

59− toJSON CheckCompleted = String "completed"

60−

61−data CheckConclusion

62− = CheckActionRequired

63− | CheckCancelled

64− | CheckFailure

65− | CheckNeutral

66− | CheckSuccess

67− | CheckSkipped

68− | CheckStale

69− | CheckTimedOut

70− deriving stock (Show, Enum, Bounded, Eq, Ord, Generic)

71−

72−instance ToJSON CheckConclusion where

73− toJSON CheckActionRequired = String "action_required"

74− toJSON CheckCancelled = String "cancelled"

75− toJSON CheckFailure = String "failure"

76− toJSON CheckNeutral = String "neutral"

77− toJSON CheckSuccess = String "success"

78− toJSON CheckSkipped = String "skipped"

79− toJSON CheckStale = String "stale"

80− toJSON CheckTimedOut = String "timed_out"

81−

82−data CheckOutput = CheckOutput

83− { checkTitle :: !Text

84− , checkSummary :: !Text

85− , checkText :: !(Maybe Text)

86− , checkAnnotations :: !(Maybe (Vector CheckAnnotation))

87− , checkImages :: !(Maybe (Vector CheckImage))

88− }

89− deriving stock (Show, Eq, Ord, Generic)

90−

91−instance ToJSON CheckOutput where

92− toJSON (CheckOutput t s txt a i) =

93− object'

94− [ "title" .= t

95− , "summary" .= s

96− , "text" .= txt

97− , "annotations" .= a

98− , "images" .= i

99− ]

100−

101−data CheckAnnotation = CheckAnnotation

102− { checkPath :: !Text

103− , checkStartLine :: !Int

104− , checkEndLine :: !Int

105− , checkStartColumn :: !(Maybe Int)

106− , checkEndColumn :: !(Maybe Int)

107− , checkAnnotationLevel :: !CheckAnnotationLevel

108− , checkMessage :: !Text

109− , checkTitle :: !(Maybe Text)

110− , checkRawDetails :: !(Maybe Text)

111− }

112− deriving stock (Show, Eq, Ord, Generic)

113−

114−instance ToJSON CheckAnnotation where

115− toJSON (CheckAnnotation p sl el sc ec al m t rd) =

116− object'

117− [ "path" .= p

118− , "start_line" .= sl

119− , "end_line" .= el

120− , "start_column" .= sc

121− , "end_column" .= ec

122− , "annotation_level" .= al

123− , "message" .= m

124− , "title" .= t

125− , "raw_details" .= rd

126− ]

127−

128−data CheckAnnotationLevel

129− = NoticeAnnotation

130− | WarningAnnotation

131− | FailureAnnotation

132− deriving stock (Show, Enum, Bounded, Eq, Ord, Generic)

133−

134−instance ToJSON CheckAnnotationLevel where

135− toJSON NoticeAnnotation = String "notice"

136− toJSON WarningAnnotation = String "warning"

137− toJSON FailureAnnotation = String "failure"

138−

139−data CheckImage = CheckImage

140− { checkImageAlt :: !Text

141− , checkImageURL :: !URL

142− , checkImageCaption :: !(Maybe Text)

143− }

144− deriving stock (Show, Eq, Ord, Generic)

145−

146−instance ToJSON CheckImage where

147− toJSON (CheckImage a url c) =

148− object'

149− [ "alt" .= a

150− , "image_url" .= url

151− , "caption" .= c

152− ]

153−

154−data CheckAction = CheckAction

155− { checkActionLabel :: !Text

156− , checkActionDescription :: !Text

157− , checkActionIdentifier :: !Text

158− }

159− deriving stock (Show, Eq, Ord, Generic)

160−

161−instance ToJSON CheckAction where

162− toJSON (CheckAction l d i) =

163− object'

164− [ "label" .= l

165− , "description" .= d

166− , "identifier" .= i

167− ]

168−

169−object' :: [Pair] -> Value

170−object' = object . filter notNull

171− where

172− notNull (_, Null) = False

173− notNull (_, _) = True

github-action/GitHub/Endpoints/Checks.hsdeleted−12

@@ -1,12 +0,0 @@

1−module GitHub.Endpoints.Checks

2− ( checkR,

3− )

4−where

5−

6−import Data.Aeson

7−import GitHub

8−import GitHub.Data.Checks

9−

10−checkR :: Name Owner -> Name Repo -> Check -> Request 'RW Value

11−checkR user repo =

12− command Post ["repos", toPathPart user, toPathPart repo, "check-runs"] . encode

github-action/Main.hs+35−20

@@ -9,7 +9,6 @@ import Control.Monad.Freer.GitHub

99import Control.Monad.Freer.Reader

1010import Data.OpenApi.Compare.Run

1111import Data.Text (Text)

12−import qualified Data.Text as T

1312import qualified Data.Yaml.Aeson as Yaml

1413import qualified GitHub as GH

1514import System.Environment

@@ -23,18 +22,13 @@ import Text.Pandoc.Writers

2322main :: IO ()

2423main = do

2524 cfg <- decodeEnv >>= either error pure

26− case sha cfg of

27− x | T.null . T.strip . GH.untagName $ x -> do

28− putStrLn "SHA not specified. Exiting without doing anything."

29− pure ()

30− _ ->

31− getArgs >>= \case

32− ["pre"] -> runPre cfg

33− ["run"] -> do

34− oldFile <- getEnv "OLD"

35− newFile <- getEnv "NEW"

36− runRun cfg (root cfg </> oldFile) (root cfg </> newFile)

37− _ -> error "Invalid arguments."

25+ getArgs >>= \case

26+ ["pre"] -> runPre cfg

27+ ["run"] -> do

28+ oldFile <- getEnv "OLD"

29+ newFile <- getEnv "NEW"

30+ runRun cfg (root cfg </> oldFile) (root cfg </> newFile)

31+ _ -> error "Invalid arguments."

3832

3933runner :: Config -> Eff '[GitHub, Error GH.Error, Reader Config, IO] a -> IO a

4034runner cfg =

@@ -43,7 +37,10 @@ runner cfg =

4337 . runGitHub (githubToken cfg)

4438

4539runPre :: Config -> IO ()

46−runPre cfg = runner cfg postStatusProcessing

40+runPre cfg =

41+ runner cfg $

42+ mapComment

43+ (markdown (header 4 "⏳ Report might not be accurate. Attempting to update." <> horizontalRule) <>)

4744

4845runRun :: Config -> FilePath -> FilePath -> IO ()

4946runRun cfg old' new' = runner cfg $ do

@@ -56,13 +53,31 @@ runRun cfg old' new' = runner cfg $ do

5653 }

5754 (report, status) = runReport reportConfig (old, new)

5855

59− body = markdown report <> "\n\n" <> footerText cfg

56+ summaryDetail s d =

57+ rawHtml "<details>"

58+ <> rawHtml "<summary>"

59+ <> s

60+ <> rawHtml "</summary>"

61+ <> d

62+ <> rawHtml "</details>"

63+ where

64+ rawHtml = rawBlock "html"

6065

61− result =

62− if old == new

63− then Nothing

64− else Just (body, status)

65− postStatus result

66+ message =

67+ header 3 (text $ "⛄ compaREST – " <> projectName cfg)

68+ <> if old == new

69+ then header 1 "✅ The API did not change"

70+ else

71+ header

72+ 1

73+ ( case status of

74+ BreakingChanges -> "⚠️ Breaking changes found!"

75+ NoBreakingChanges -> "No breaking changes found ✨"

76+ OnlyUnsupportedChanges -> "🤷 Couldn't determine compatibility"

77+ )

78+ <> summaryDetail (plain "ℹ️ Details") report

79+ messageBody = markdown message <> "\n\n" <> footerText cfg

80+ createOrUpdateComment messageBody

6681

6782markdown :: Blocks -> Text

6883markdown =

nix/ci.nixdeleted−11

@@ -1,11 +0,0 @@

1−{ sources ? import ./sources.nix

2−, pkgs ? import sources.nixpkgs { }

3−}:

4−

5−let

6− yq = import ./yq.nix { inherit pkgs; };

7− diff-yaml = import ./diff-yaml.nix { inherit pkgs; };

8−in

9−pkgs.mkShell {

10− packages = [ pkgs.haskellPackages.fourmolu diff-yaml yq ];

11−}

nix/diff-yaml.nixdeleted−20

@@ -1,20 +0,0 @@

1−{ pkgs ? import <nixpkgs> {} }:

2−

3−let

4− inherit (pkgs) stdenv;

5− yq = import ./yq.nix { inherit pkgs; };

6−in

7−stdenv.mkDerivation {

8− name = "diff-yaml";

9−

10− src = ../scripts/diff-yaml;

11−

12− buildInputs = [ pkgs.bash yq ];

13−

14− phases = [ "installPhase" ];

15−

16− installPhase = ''

17− mkdir -p $out/bin

18− cp $src $out/bin/diff-yaml

19− '';

20−}

nix/shell.nixdeleted−11

@@ -1,11 +0,0 @@

1−{ sources ? import ./sources.nix

2−, pkgs ? import sources.nixpkgs { }

3−}:

4−

5−let

6− patched-yq = import ./yq.nix { inherit pkgs; };

7− diffYaml = import ./diff-yaml.nix { inherit pkgs; };

8−in

9−pkgs.mkShell {

10− buildInputs = with pkgs; [ pkg-config diffYaml patched-yq zlib ];

11−}

nix/sources.json+10−22

@@ -5,10 +5,10 @@

55 "homepage": "https://input-output-hk.github.io/haskell.nix",

66 "owner": "input-output-hk",

77 "repo": "haskell.nix",

8− "rev": "d7f95903c84a5a50d6fe0844280da82c3c81680a",

9− "sha256": "02870rk4sx44lwwa0k20iwdhqcx0ayz34yb3b0qy045p22q45815",

8+ "rev": "1992b910e9b4d880e1f4639f4fe7266bceb9a5ad",

9+ "sha256": "15w3wixjnb52f7cj3s94fy0zc0l1gc94p3n2wyq3qqxj10hvirfw",

1010 "type": "tarball",

11− "url": "https://github.com/input-output-hk/haskell.nix/archive/d7f95903c84a5a50d6fe0844280da82c3c81680a.tar.gz",

11+ "url": "https://github.com/input-output-hk/haskell.nix/archive/1992b910e9b4d880e1f4639f4fe7266bceb9a5ad.tar.gz",

1212 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"

1313 },

1414 "niv": {

@@ -17,34 +17,22 @@

1717 "homepage": "https://github.com/nmattia/niv",

1818 "owner": "nmattia",

1919 "repo": "niv",

20− "rev": "f7c538837892dd2eb83567c9f380a11efb59b53f",

21− "sha256": "0xl33k24vfc29cg9lnp95kvcq69qbq5fzb7jk9ig4lgrhaarh651",

20+ "rev": "e0ca65c81a2d7a4d82a189f1e23a48d59ad42070",

21+ "sha256": "1pq9nh1d8nn3xvbdny8fafzw87mj7gsmp6pxkdl65w2g18rmcmzx",

2222 "type": "tarball",

23− "url": "https://github.com/nmattia/niv/archive/f7c538837892dd2eb83567c9f380a11efb59b53f.tar.gz",

23+ "url": "https://github.com/nmattia/niv/archive/e0ca65c81a2d7a4d82a189f1e23a48d59ad42070.tar.gz",

2424 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"

2525 },

2626 "nix-filter": {

27− "branch": "main",

27+ "branch": "master",

2828 "description": "a small self-container source filtering lib",

2929 "homepage": "",

3030 "owner": "numtide",

3131 "repo": "nix-filter",

32− "rev": "3342559a24e85fc164b295c3444e8a139924675b",

33− "sha256": "08xia32g5jzaiyhfl3kzxslzbr4w1i56i0mhy5gpfggv8gqy8sym",

34− "type": "tarball",

35− "url": "https://github.com/numtide/nix-filter/archive/3342559a24e85fc164b295c3444e8a139924675b.tar.gz",

36− "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"

37− },

38− "nixpkgs": {

39− "branch": "master",

40− "description": "Nix Packages collection",

41− "homepage": "",

42− "owner": "NixOS",

43− "repo": "nixpkgs",

44− "rev": "bf038bd724982de67a2ee9a6b2f1fcb7d6a87bd7",

45− "sha256": "0ivvwdmg9fipj6ylq5ipxqpb0xnz6hsx3lyn377jacfpiqi9w0cv",

32+ "rev": "3c9e33ed627e009428197b07216613206f06ed80",

33+ "sha256": "19w142crrkywxynmyw4rhz4nglrg64yjawfkw3j91qwkwbfjds84",

4634 "type": "tarball",

47− "url": "https://github.com/NixOS/nixpkgs/archive/bf038bd724982de67a2ee9a6b2f1fcb7d6a87bd7.tar.gz",

35+ "url": "https://github.com/numtide/nix-filter/archive/3c9e33ed627e009428197b07216613206f06ed80.tar.gz",

4836 "url_template": "https://github.com/<owner>/<repo>/archive/<rev>.tar.gz"

4937 }

5038}

nix/yq.nixdeleted−26

@@ -1,26 +0,0 @@

1−{ pkgs ? import <nixpkgs> {} }:

2−

3−# Make yq work inside whatever `stack test` launches.

4−# Nuke this when https://github.com/kislyuk/yq/pull/193 is merged

5−# and nixpkgs includes that fix.

6−

7−let

8− yq-patch = pkgs.writeText "yq-tty-fix.patch" ''

9−diff --git a/yq/__init__.py b/yq/__init__.py

10−index d95ac4b..ae7d59e 100644

11−--- a/yq/__init__.py

12−+++ b/yq/__init__.py

13−@@ -110,7 +110,7 @@ def cli(args=None, input_format="yaml", program_name="yq"):

14− in_place = args.in_place

15− delattr(args, "in_place")

16−

17−- if sys.stdin.isatty() and not args.input_streams:

18−+ if (sys.stdin is None or sys.stdin.isatty()) and not args.input_streams:

19− parser.print_help()

20− sys.exit(2)

21− elif not args.input_streams:

22− '';

23−in

24−pkgs.yq.overrideAttrs (final: old: {

25− patches = old.patches ++ [ yq-patch ];

26−})

scripts/diff-yamldeleted−35

@@ -1,35 +0,0 @@

1−#!/usr/bin/env bash

2−set -e

3−

4−# Normalise YAML files passed as inputs, then run diff on them.

5−

6−check_util() {

7− local util=$1

8−

9− if [ -z $util ]; then

10− echo "Error: $util not found in PATH"

11− exit 1

12− fi

13−}

14−

15−DIFF=`which diff`

16−check_util $DIFF

17−

18−YQ=`which yq`

19−check_util $YQ

20−

21−# Only normalise YAML files.

22−# Print anything else as is.

23−normalise() {

24− local file=$1

25− local contents=($YQ -y -S '.' $file)

26−

27− # if $contents contains actual YAML data, print it

28− if [[ $? == 0 ]]; then

29− echo $contents

30− else

31− cat $file

32− fi

33−}

34−

35−$DIFF -u <(normalise $1) <(normalise $2)

src/Data/HList.hs+11−11

@@ -1,11 +1,11 @@

11module Data.HList

2− ( Has,

3− HasAll,

4− getH,

5− HList (..),

6− singletonH,

7− ReassembleHList,

8− reassemble,

2+ ( Has

3+ , HasAll

4+ , getH

5+ , HList (..)

6+ , singletonH

7+ , ReassembleHList

8+ , reassemble

99 )

1010where

1111

@@ -40,8 +40,8 @@ instance (Has' x xs t, HeadEq x (y : xs) ~ 'False) => Has' x (y ': xs) 'False wh

4040 {-# INLINE getH #-}

4141

4242instance

43− TypeError ( 'ShowType x ':<>: 'Text " is not a part of the list.") =>

44− Has' x '[] 'False

43+ TypeError ('ShowType x ':<>: 'Text " is not a part of the list.")

44+ => Has' x '[] 'False

4545 where

4646 getH HNil = undefined

4747 {-# INLINE getH #-}

@@ -74,8 +74,8 @@ instance ReassembleHList' (x ': xs) '[] 'False where

7474 {-# INLINE reassemble #-}

7575

7676instance

77− (Has y xs, ReassembleHList' xs ys f, (xs == (y ': ys)) ~ 'False) =>

78− ReassembleHList' xs (y ': ys) 'False

77+ (Has y xs, ReassembleHList' xs ys f, (xs == (y ': ys)) ~ 'False)

78+ => ReassembleHList' xs (y ': ys) 'False

7979 where

8080 reassemble xs = getH @y xs `HCons` reassemble xs

8181 {-# INLINE reassemble #-}

src/Data/OpenApi/Compare/Behavior.hs+11−11

@@ -1,15 +1,15 @@

11module Data.OpenApi.Compare.Behavior

2− ( BehaviorLevel (..),

3− Behavable (..),

4− IssueKind (..),

5− Issuable (..),

6− Orientation (..),

7− toggleOrientation,

8− Behavior,

9− AnIssue (..),

10− withClass,

11− anIssueKind,

12− relatedAnIssues,

2+ ( BehaviorLevel (..)

3+ , Behavable (..)

4+ , IssueKind (..)

5+ , Issuable (..)

6+ , Orientation (..)

7+ , toggleOrientation

8+ , Behavior

9+ , AnIssue (..)

10+ , withClass

11+ , anIssueKind

12+ , relatedAnIssues

1313 )

1414where

1515

src/Data/OpenApi/Compare/Common.hs+1−1

@@ -1,5 +1,5 @@

11module Data.OpenApi.Compare.Common

2− ( zipAll,

2+ ( zipAll

33 )

44where

55

src/Data/OpenApi/Compare/Formula.hs+21−31

@@ -1,15 +1,14 @@

11module Data.OpenApi.Compare.Formula

2− ( FormulaF,

3− VarRef,

4− variable,

5− eitherOf,

6− anError,

7− errors,

8− calculate,

9− maxFixpoint,

10− mapErrors,

11− )

12−where

2+ ( FormulaF

3+ , VarRef

4+ , variable

5+ , eitherOf

6+ , anError

7+ , errors

8+ , calculate

9+ , maxFixpoint

10+ , mapErrors

11+ ) where

1312

1413import Data.Kind

1514import qualified Data.List.NonEmpty as NE

@@ -25,24 +24,15 @@ type VarRef = Int

2524-- fixpoints always exist, i.e. that @x = f x@ has at least one solution.

2625data FormulaF (q :: k -> k -> Type) (f :: k -> Type) (r :: k) (a :: Type) where

2726 Result :: a -> FormulaF q f r a

28− Errors ::

29− !(P.PathsPrefixTree q f r) ->

30− -- | invariant: never empty

31− FormulaF q f r a

32− Apply ::

33− FormulaF q f r (b -> c) ->

34− FormulaF q f r b ->

35− (c -> a) ->

36− -- | invariant: at least one of LHS and RHS is not 'Errors', and they are

27+ Errors :: !(P.PathsPrefixTree q f r) -> FormulaF q f r a

28+ -- ^ invariant: never empty

29+ Apply :: FormulaF q f r (b -> c) -> FormulaF q f r b -> (c -> a) -> FormulaF q f r a

30+ -- ^ invariant: at least one of LHS and RHS is not 'Errors', and they are

3731 -- both not 'Result'

38− FormulaF q f r a

39− SelectFirst ::

40− NE.NonEmpty (SomeFormulaF b) ->

41− !(P.PathsPrefixTree q f r) ->

42− (b -> a) ->

43− -- | invariant: the list doesn't contain any 'Result's, 'Errors' or

32+ SelectFirst :: NE.NonEmpty (SomeFormulaF b)

33+ -> !(P.PathsPrefixTree q f r) -> (b -> a) -> FormulaF q f r a

34+ -- ^ invariant: the list doesn't contain any 'Result's, 'Errors' or

4435 -- 'SelectFirst'

45− FormulaF q f r a

4636 Variable :: !VarRef -> a -> FormulaF q f r a

4737

4838mkApply :: FormulaF q f r (b -> c) -> FormulaF q f r b -> (c -> a) -> FormulaF q f r a

@@ -54,13 +44,13 @@ mkApply f x h = Apply f x h

5444mkSelectFirst :: [SomeFormulaF b] -> P.PathsPrefixTree q f r -> (b -> a) -> FormulaF q f r a

5545mkSelectFirst fs allE h = case foldMap check fs of

5646 (First (Just x), _) -> Result (h x)

57− (First Nothing, x : xs) -> SelectFirst (x NE.:| xs) allE h

47+ (First Nothing, x:xs) -> SelectFirst (x NE.:| xs) allE h

5848 (First Nothing, []) -> Errors allE

5949 where

6050 check (SomeFormulaF (Result x)) = (First (Just x), mempty)

6151 check (SomeFormulaF (Errors _)) = (mempty, mempty)

62− check (SomeFormulaF (SelectFirst xs _ h')) =

63− (mempty, NE.toList (fmap (fmap h') xs))

52+ check (SomeFormulaF (SelectFirst xs _ h'))

53+ = (mempty, NE.toList (fmap (fmap h') xs))

6454 check x = (mempty, [x])

6555

6656data SomeFormulaF (a :: Type) where

@@ -106,7 +96,7 @@ calculate (Apply f x h) = case calculate f of

10696 Right x' -> Right (h (f' x'))

10797calculate (SelectFirst xs e h) = go (NE.toList xs)

10898 where

109− go (SomeFormulaF r : rs) = case calculate r of

99+ go (SomeFormulaF r:rs) = case calculate r of

110100 Left _ -> go rs

111101 Right x -> Right (h x)

112102 go [] = Left e

src/Data/OpenApi/Compare/Memo.hs+66−104

@@ -1,24 +1,22 @@

11{-# LANGUAGE AllowAmbiguousTypes #-}

2−

32-- | Utilities for effectfully memoizing other, more effectful functions.

43module Data.OpenApi.Compare.Memo

5− ( MonadMemo,

6− MemoState,

7− runMemo,

8− modifyMemoNonce,

9− KnotTier (..),

10− unknot,

11− memoWithKnot,

12− memoTaggedWithKnot,

13− )

14−where

4+ ( MonadMemo

5+ , MemoState

6+ , runMemo

7+ , modifyMemoNonce

8+ , KnotTier(..)

9+ , unknot

10+ , memoWithKnot

11+ , memoTaggedWithKnot

12+ ) where

1513

1614import Control.Monad.State

1715import Data.Dynamic

1816import qualified Data.Map as M

1917import Data.Tagged

20−import qualified Data.TypeRepMap as T

2118import Data.Void

19+import qualified Data.TypeRepMap as T

2220import Type.Reflection

2321

2422data Progress a = Finished a | Started | TyingKnot Dynamic

@@ -31,23 +29,16 @@ data MemoState s = MemoState s (T.TypeRepMap MemoMap)

3129-- | An effectful memoization monad.

3230type MonadMemo s m = MonadState (MemoState s) m

3331

34−memoStateLookup ::

35− forall k v s.

36− (Typeable k, Typeable v, Ord k) =>

37− k ->

38− MemoState s ->

39− Maybe (Progress v)

32+memoStateLookup

33+ :: forall k v s. (Typeable k, Typeable v, Ord k)

34+ => k -> MemoState s -> Maybe (Progress v)

4035memoStateLookup k (MemoState _ t) = case T.lookup @(k, v) t of

4136 Just (MemoMap m) -> M.lookup k m

4237 Nothing -> Nothing

4338

44−memoStateInsert ::

45− forall k v s.

46− (Typeable k, Typeable v, Ord k) =>

47− k ->

48− Progress v ->

49− MemoState s ->

50− MemoState s

39+memoStateInsert

40+ :: forall k v s. (Typeable k, Typeable v, Ord k)

41+ => k -> Progress v -> MemoState s -> MemoState s

5142memoStateInsert k x (MemoState s t) = MemoState s $ T.insert (MemoMap m'') t

5243 where

5344 m'' = M.insert k x m'

@@ -68,23 +59,19 @@ runMemo s = (`evalStateT` MemoState s T.empty)

6859-- | A description of how to effectfully tie knots in type @v@, using the @m@

6960-- monad, and by sharing some @d@ data among the recursive instances.

7061data KnotTier v d m = KnotTier

71− { -- | Create some data that will be connected to this knot

72− onKnotFound :: m d

73− , -- | This is what the knot will look like as a value

62+ { onKnotFound :: m d -- ^ Create some data that will be connected to this knot

63+ , onKnotUsed :: d -> m v -- ^ This is what the knot will look like as a value

7464 -- to the inner computations

75− onKnotUsed :: d -> m v

76− , -- | Once we're done and we're outside, tie the

65+ , tieKnot :: d -> v -> m v -- ^ Once we're done and we're outside, tie the

7766 -- knot using the datum

78− tieKnot :: d -> v -> m v

7967 }

8068

8169unknot :: KnotTier v Void m

82−unknot =

83− KnotTier

84− { onKnotFound = error "Recursion detected"

85− , onKnotUsed = absurd

86− , tieKnot = absurd

87− }

70+unknot = KnotTier

71+ { onKnotFound = error "Recursion detected"

72+ , onKnotUsed = absurd

73+ , tieKnot = absurd

74+ }

8875

8976-- | Run a potentially recursive computation. The provided key will be used to

9077-- refer to the result of this computation. If during the computation, another

@@ -93,72 +80,47 @@ unknot =

9380--

9481-- If another attempt to run the computation with the same key is made

9582-- *after we're done*, we will return the memoized value.

96−memoWithKnot ::

97− forall k v d m s.

98− (Typeable k, Typeable v, Typeable d, Ord k, MonadMemo s m) =>

99− KnotTier v d m ->

100− -- | the computation to memoize

101− m v ->

102− -- | key for memoization

103− k ->

104− m v

105−memoWithKnot tier f k =

106− memoStateLookup @k @v k <$> get >>= \case

107− Just (Finished v) -> pure v

108− Just Started -> do

109− d <- onKnotFound tier

110− modify $ memoStateInsert @k @v k (TyingKnot $ toDyn d)

111− onKnotUsed tier d

112− Just (TyingKnot dyn) -> case fromDynamic dyn of

113− Just d -> onKnotUsed tier d

114− Nothing ->

115− error $

116− "Type mismatch when examining the knot of "

117− <> show (typeRep @(k -> v))

118− <> ": expected "

119− <> show (typeRep @d)

120− <> ", got "

121− <> show (dynTypeRep dyn)

122− Nothing -> do

123− modify $ memoStateInsert @k @v k Started

124− v <- f

125− v' <-

126− memoStateLookup @k @v k <$> get >>= \case

127− Just Started -> pure v

128− Just (TyingKnot dyn) -> case fromDynamic dyn of

129− Just d -> tieKnot tier d v

130− Nothing ->

131− error $

132− "Type mismatch when tying the knot of "

133− <> show (typeRep @(k -> v))

134− <> ": expected "

135− <> show (typeRep @d)

136− <> ", got "

137− <> show (dynTypeRep dyn)

138− Just (Finished _) ->

139− error $

140− "Unexpected Finished when memoizing "

141− <> show (typeRep @(k -> v))

142− Nothing -> pure v

143− -- Normally this would be an error, but the underlying monad can refuse

144− -- to remember memoization state

145− modify $ memoStateInsert @k @v k (Finished v')

146− pure v'

83+memoWithKnot

84+ :: forall k v d m s.

85+ (Typeable k, Typeable v, Typeable d, Ord k, MonadMemo s m)

86+ => KnotTier v d m

87+ -> m v -- ^ the computation to memoize

88+ -> k -- ^ key for memoization

89+ -> m v

90+memoWithKnot tier f k = memoStateLookup @k @v k <$> get >>= \case

91+ Just (Finished v) -> pure v

92+ Just Started -> do

93+ d <- onKnotFound tier

94+ modify $ memoStateInsert @k @v k (TyingKnot $ toDyn d)

95+ onKnotUsed tier d

96+ Just (TyingKnot dyn) -> case fromDynamic dyn of

97+ Just d -> onKnotUsed tier d

98+ Nothing -> error $ "Type mismatch when examining the knot of "

99+ <> show (typeRep @(k -> v)) <> ": expected " <> show (typeRep @d)

100+ <> ", got " <> show (dynTypeRep dyn)

101+ Nothing -> do

102+ modify $ memoStateInsert @k @v k Started

103+ v <- f

104+ v' <- memoStateLookup @k @v k <$> get >>= \case

105+ Just Started -> pure v

106+ Just (TyingKnot dyn) -> case fromDynamic dyn of

107+ Just d -> tieKnot tier d v

108+ Nothing -> error $ "Type mismatch when tying the knot of "

109+ <> show (typeRep @(k -> v)) <> ": expected " <> show (typeRep @d)

110+ <> ", got " <> show (dynTypeRep dyn)

111+ Just (Finished _) -> error $ "Unexpected Finished when memoizing "

112+ <> show (typeRep @(k -> v))

113+ Nothing -> pure v

114+ -- Normally this would be an error, but the underlying monad can refuse

115+ -- to remember memoization state

116+ modify $ memoStateInsert @k @v k (Finished v')

117+ pure v'

147118

148119-- | Disambiguate memoized computations with an arbitrary tag.

149−memoTaggedWithKnot ::

150− forall t k v d m s.

151− ( Typeable t

152− , Typeable k

153− , Typeable v

154− , Typeable d

155− , Ord k

156− , MonadMemo s m

157− ) =>

158− KnotTier v d m ->

159− m v ->

160− k ->

161− m v

162−memoTaggedWithKnot tier f k =

163− withTypeable (typeRepKind $ typeRep @t) $

164− memoWithKnot tier f (Tagged @t k)

120+memoTaggedWithKnot

121+ :: forall t k v d m s.

122+ ( Typeable t, Typeable k, Typeable v, Typeable d

123+ , Ord k, MonadMemo s m )

124+ => KnotTier v d m -> m v -> k -> m v

125+memoTaggedWithKnot tier f k = withTypeable (typeRepKind $ typeRep @t) $

126+ memoWithKnot tier f (Tagged @t k)

src/Data/OpenApi/Compare/Paths.hs+9−9

@@ -2,17 +2,17 @@

22-- collection of datatypes that "contain" eachother in some form of tree

33-- structure.

44module Data.OpenApi.Compare.Paths

5− ( NiceQuiver,

6− AdditionalQuiverConstraints,

7− Paths (..),

8− DiffPaths (..),

9− catDiffPaths,

10− AnItem (..),

11− step,

5+ ( NiceQuiver

6+ , AdditionalQuiverConstraints

7+ , Paths (..)

8+ , DiffPaths (..)

9+ , catDiffPaths

10+ , AnItem (..)

11+ , step

1212

1313 -- * Reexports

14− (>>>),

15− (<<<),

14+ , (>>>)

15+ , (<<<)

1616 )

1717where

1818

src/Data/OpenApi/Compare/PathsPrefixTree.hs+41−42

@@ -1,30 +1,29 @@

11{-# LANGUAGE QuantifiedConstraints #-}

22

33module Data.OpenApi.Compare.PathsPrefixTree

4− ( PathsPrefixTree (PathsPrefixNode),

5− AStep (..),

6− empty,

7− singleton,

8− fromList,

9− null,

10− foldWith,

11− toList,

12− filter,

13− filterWithKey,

14− takeSubtree,

15− lookup,

16− embed,

17− size,

18− partition,

19− map,

4+ ( PathsPrefixTree (PathsPrefixNode)

5+ , AStep (..)

6+ , empty

7+ , singleton

8+ , fromList

9+ , null

10+ , foldWith

11+ , toList

12+ , filter

13+ , filterWithKey

14+ , takeSubtree

15+ , lookup

16+ , embed

17+ , size

18+ , partition

19+ , map

2020 )

2121where

2222

2323import Control.Monad

2424import Data.Aeson

2525import Data.Foldable hiding (null, toList)

26−import qualified Data.Aeson.Key as Key

27−import qualified Data.Aeson.KeyMap as KeyMap

26+import qualified Data.HashMap.Strict as HM

2827import Data.Kind

2928import qualified Data.Map as M

3029import Data.Monoid

@@ -36,7 +35,7 @@ import qualified Data.TypeRepMap as TRM

3635import qualified Data.Vector as V

3736import qualified GHC.Exts as Exts

3837import Type.Reflection

39−import Prelude hiding (filter, lookup, map, null)

38+import Prelude hiding (filter, map, null, lookup)

4039

4140-- | A list of @AnItem r f@, but optimized into a prefix tree.

4241data PathsPrefixTree (q :: k -> k -> Type) (f :: k -> Type) (r :: k) = PathsPrefixTree

@@ -103,11 +102,11 @@ deriving stock instance Eq (PathsPrefixTree q f a)

103102

104103-- Kind of orphan. Treat the map as an infinite tuple of @Maybe (f a)@'s, where

105104-- the components are ordered by the @SomeTypeRep@ of the @a@.

106−compareTRM ::

107− (forall a. Typeable a => Ord (f a)) =>

108− TRM.TypeRepMap f ->

109− TRM.TypeRepMap f ->

110− Ordering

105+compareTRM

106+ :: (forall a. Typeable a => Ord (f a))

107+ => TRM.TypeRepMap f

108+ -> TRM.TypeRepMap f

109+ -> Ordering

111110compareTRM s1 s2 =

112111 foldMap (\k -> compareMaybe compareW (M.lookup k m1) (M.lookup k m2)) mKeys

113112 where

@@ -117,11 +116,11 @@ compareTRM s1 s2 =

117116 compareMaybe _ Nothing (Just _) = LT

118117 compareMaybe _ (Just _) Nothing = GT

119118 compareMaybe cmp (Just x) (Just y) = cmp x y

120− compareW ::

121− (forall a. Typeable a => Ord (f a)) =>

122− TRM.WrapTypeable f ->

123− TRM.WrapTypeable f ->

124− Ordering

119+ compareW

120+ :: (forall a. Typeable a => Ord (f a))

121+ => TRM.WrapTypeable f

122+ -> TRM.WrapTypeable f

123+ -> Ordering

125124 compareW (TRM.WrapTypeable (x :: f a)) (TRM.WrapTypeable (y :: f b))

126125 | Just Refl <- testEquality (typeRep @a) (typeRep @b) = compare x y

127126 | otherwise = EQ -- unreachable

@@ -173,10 +172,10 @@ instance Monoid (ASet a) where

173172 mempty = AnEmptySet

174173

175174data AStep (q :: k -> k -> Type) (f :: k -> Type) (r :: k) (a :: k) where

176− AStep ::

177− NiceQuiver q r a =>

178− !(M.Map (q r a) (PathsPrefixTree q f a)) ->

179− AStep q f r a

175+ AStep

176+ :: NiceQuiver q r a =>

177+ !(M.Map (q r a) (PathsPrefixTree q f a))

178+ -> AStep q f r a

180179

181180mapAStep :: (forall x. f x -> f x) -> AStep q f r a -> AStep q f r a

182181mapAStep f (AStep m) = AStep $ M.map (map f) m

@@ -216,12 +215,12 @@ null :: PathsPrefixTree q f r -> Bool

216215null (PathsPrefixTree AnEmptySet s) = all (\(TRM.WrapTypeable (AStep x)) -> all null x) (Exts.toList s)

217216null _ = False

218217

219−foldWith ::

220− forall q f m r.

221− Monoid m =>

222− (forall a. Ord (f a) => Paths q r a -> f a -> m) ->

223− PathsPrefixTree q f r ->

224− m

218+foldWith

219+ :: forall q f m r.

220+ Monoid m

221+ => (forall a. Ord (f a) => Paths q r a -> f a -> m)

222+ -> PathsPrefixTree q f r

223+ -> m

225224foldWith k = goTPT Root

226225 where

227226 goTPT :: forall a. Paths q r a -> PathsPrefixTree q f a -> m

@@ -257,7 +256,7 @@ newtype MergableObject = MergableObject {getMergableObject :: Object}

257256

258257instance Semigroup MergableObject where

259258 (MergableObject x) <> (MergableObject y) =

260− MergableObject $ KeyMap.unionWith mergeValue x y

259+ MergableObject $ HM.unionWith mergeValue x y

261260 where

262261 mergeValue :: Value -> Value -> Value

263262 mergeValue (Object a) (Object b) =

@@ -272,6 +271,6 @@ instance Monoid MergableObject where

272271

273272traceObject :: Paths q r a -> Value -> Object

274273traceObject Root (Object o) = o

275−traceObject Root v = KeyMap.singleton "root" v

274+traceObject Root v = HM.singleton "root" v

276275traceObject (root `Snoc` s) v =

277− traceObject root . Object $ KeyMap.singleton (Key.fromText . T.pack . show $ s) v

276+ traceObject root . Object $ HM.singleton (T.pack . show $ s) v

src/Data/OpenApi/Compare/References.hs+9−8

@@ -1,9 +1,9 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

22

33module Data.OpenApi.Compare.References

4− ( Step (..),

5− dereference,

6− Typeable,

4+ ( Step (..)

5+ , dereference

6+ , Typeable

77 )

88where

99

@@ -13,16 +13,17 @@ import Data.Maybe

1313import Data.OpenApi

1414import Data.OpenApi.Compare.Orphans ()

1515import Data.OpenApi.Compare.Subtree

16+import Data.Typeable

1617

1718instance Typeable a => Steppable (Referenced a) a where

1819 data Step (Referenced a) a = InlineStep

1920 deriving stock (Eq, Ord, Show)

2021

21−dereference ::

22− Typeable a =>

23− Traced (Definitions a) ->

24− Traced (Referenced a) ->

25− Traced a

22+dereference

23+ :: Typeable a

24+ => Traced (Definitions a)

25+ -> Traced (Referenced a)

26+ -> Traced a

2627dereference defs x = case extract x of

2728 Inline a ->

2829 traced (ask x >>> step InlineStep) a

src/Data/OpenApi/Compare/Report.hs+119−139

@@ -1,13 +1,13 @@

11module Data.OpenApi.Compare.Report

2− ( generateReport,

3− CheckerOutput (..),

4− ReportInput (..),

5− segregateIssues,

6− ReportStatus (..),

7− Pandoc,

8− ReportConfig (..),

9− ReportTreeStyle (..),

10− ReportMode (..),

2+ ( generateReport

3+ , CheckerOutput(..)

4+ , ReportInput (..)

5+ , segregateIssues

6+ , ReportStatus (..)

7+ , Pandoc

8+ , ReportConfig (..)

9+ , ReportTreeStyle (..)

10+ , ReportMode (..)

1111 )

1212where

1313

@@ -30,8 +30,8 @@ import qualified Data.OpenApi.Compare.PathsPrefixTree as P hiding (empty)

3030import Data.OpenApi.Compare.Report.Jet

3131import Data.OpenApi.Compare.Subtree (invertIssueOrientationP)

3232import Data.OpenApi.Compare.Validate.OpenApi

33−import Data.OpenApi.Compare.Validate.Schema.Issues

3433import Data.OpenApi.Compare.Validate.Schema.TypedJson

34+import Data.OpenApi.Compare.Validate.Schema.Issues

3535import Data.OpenUnion

3636import Data.OpenUnion.Extra

3737import Data.Set

@@ -54,27 +54,22 @@ data CheckerOutput = CheckerOutput

5454 deriving anyclass (ToJSON)

5555

5656data ReportInput = ReportInput

57− { -- | forward 'CertainIssue', 'ProbablyIssue' and 'Comment'

58− breakingChanges :: Changes

59− , -- | backward 'CertainIssue', 'ProbablyIssue' and 'Comment', except those shadowed by 'relatedIssues'

60− nonBreakingChanges :: Changes

61− , -- | forward and backward 'Unsupported' (assumed to be the same anyway)

62− unsupportedChanges :: Changes

63− , -- | forward and backward 'SchemaInvalid' (assumed to be the same anyway)

64− schemaIssues :: Changes

57+ { breakingChanges :: Changes -- ^ forward 'CertainIssue', 'ProbablyIssue' and 'Comment'

58+ , nonBreakingChanges :: Changes -- ^ backward 'CertainIssue', 'ProbablyIssue' and 'Comment', except those shadowed by 'relatedIssues'

59+ , unsupportedChanges :: Changes -- ^ forward and backward 'Unsupported' (assumed to be the same anyway)

60+ , schemaIssues :: Changes -- ^ forward and backward 'SchemaInvalid' (assumed to be the same anyway)

6561 }

6662 deriving stock (Generic)

6763 deriving (Semigroup, Monoid) via (Generically ReportInput)

6864 deriving anyclass (ToJSON)

6965

7066segregateIssues :: CheckerOutput -> ReportInput

71−segregateIssues CheckerOutput {forwardChanges = fwd, backwardChanges = bck} =

72− ReportInput

73− { breakingChanges = P.filter isBreaking fwd

74− , nonBreakingChanges = invertIssueOrientationP $ P.filterWithKey isNonBreaking bck

75− , unsupportedChanges = P.filter isUnsupported fwd <> P.filter isUnsupported bck

76− , schemaIssues = P.filter isSchemaIssue fwd <> P.filter isSchemaIssue bck

77− }

67+segregateIssues CheckerOutput {forwardChanges = fwd, backwardChanges = bck} = ReportInput

68+ { breakingChanges = P.filter isBreaking fwd

69+ , nonBreakingChanges = invertIssueOrientationP $ P.filterWithKey isNonBreaking bck

70+ , unsupportedChanges = P.filter isUnsupported fwd <> P.filter isUnsupported bck

71+ , schemaIssues = P.filter isSchemaIssue fwd <> P.filter isSchemaIssue bck

72+ }

7873 where

7974 isBreaking i = anIssueKind i `elem` [CertainIssue, ProbablyIssue, Comment]

8075 isNonBreaking :: Paths Behave 'APILevel a -> AnIssue a -> Bool

@@ -111,7 +106,8 @@ twoRowTable x = simpleTable (para . fst <$> x) [para . snd <$> x]

111106

112107generateReport :: ReportConfig -> ReportInput -> (Blocks, ReportStatus)

113108generateReport cfg inp =

114− let schemaIssuesPresent = not $ P.null $ schemaIssues inp

109+ let

110+ schemaIssuesPresent = not $ P.null $ schemaIssues inp

115111 breakingChangesPresent = not $ P.null $ breakingChanges inp

116112 nonBreakingChangesPresent = not $ P.null $ nonBreakingChanges inp

117113 unsupportedChangesPresent = not $ P.null $ unsupportedChanges inp

@@ -120,55 +116,47 @@ generateReport cfg inp =

120116 OnlyErrors -> False

121117 builder = buildReport cfg

122118 report =

123− header 1 "Summary"

124− <> twoRowTable

125− ( when'

126− schemaIssuesPresent

127− [

128− ( refOpt schemaIssuesPresent schemaIssuesId "‼️ Schema issues"

129− , show' $ P.size $ schemaIssues inp

130− )

131− ]

132− ++ [

133− ( refOpt breakingChangesPresent breakingChangesId "❌ Breaking changes"

119+ header 1 "Summary"

120+ <> twoRowTable

121+ (when'

122+ schemaIssuesPresent

123+ [ ( refOpt schemaIssuesPresent schemaIssuesId "‼️ Schema issues"

124+ , show' $ P.size $ schemaIssues inp

125+ )

126+ ]

127+ ++

128+ [ ( refOpt breakingChangesPresent breakingChangesId "❌ Breaking changes"

134129 , show' $ P.size $ breakingChanges inp

135130 )

136131 ]

137− ++ when'

138− nonBreakingChangesShown

139− [

140− ( refOpt nonBreakingChangesPresent nonBreakingChangesId "⚠️ Non-breaking changes"

141− , show' $ P.size $ nonBreakingChanges inp

142− )

143− ]

144− ++ when'

145− unsupportedChangesPresent

146− [

147− ( refOpt unsupportedChangesPresent unsupportedChangesId "❓ Unsupported feature changes"

148− , show' $ P.size $ unsupportedChanges inp

149− )

150− ]

151− )

152− <> when'

153− schemaIssuesPresent

154− ( header 1 (anchor schemaIssuesId <> "‼️ Schema issues")

155− <> builder (showErrs $ schemaIssues inp)

156− )

157− <> when'

158− breakingChangesPresent

159− ( header 1 (anchor breakingChangesId <> "❌ Breaking changes")

160− <> builder (showErrs $ breakingChanges inp)

161− )

162− <> when'

163− (nonBreakingChangesPresent && nonBreakingChangesShown)

164− ( header 1 (anchor nonBreakingChangesId <> "⚠️ Non-breaking changes")

165− <> builder (showErrs $ nonBreakingChanges inp)

166− )

167− <> when'

168− unsupportedChangesPresent

169− ( header 1 (anchor unsupportedChangesId <> "❓ Unsupported feature changes")

170− <> builder (showErrs $ unsupportedChanges inp)

171− )

132+ ++ when'

133+ nonBreakingChangesShown

134+ [ ( refOpt nonBreakingChangesPresent nonBreakingChangesId "⚠️ Non-breaking changes"

135+ , show' $ P.size $ nonBreakingChanges inp

136+ )

137+ ]

138+ ++ when'

139+ unsupportedChangesPresent

140+ [ ( refOpt unsupportedChangesPresent unsupportedChangesId "❓ Unsupported feature changes"

141+ , show' $ P.size $ unsupportedChanges inp

142+ )

143+ ])

144+ <> when'

145+ schemaIssuesPresent

146+ (header 1 (anchor schemaIssuesId <> "‼️ Schema issues")

147+ <> builder (showErrs $ schemaIssues inp))

148+ <> when'

149+ breakingChangesPresent

150+ (header 1 (anchor breakingChangesId <> "❌ Breaking changes")

151+ <> builder (showErrs $ breakingChanges inp))

152+ <> when'

153+ (nonBreakingChangesPresent && nonBreakingChangesShown)

154+ (header 1 (anchor nonBreakingChangesId <> "⚠️ Non-breaking changes")

155+ <> builder (showErrs $ nonBreakingChanges inp))

156+ <> when'

157+ unsupportedChangesPresent

158+ (header 1 (anchor unsupportedChangesId <> "❓ Unsupported feature changes")

159+ <> builder (showErrs $ unsupportedChanges inp))

172160 status =

173161 if

174162 | breakingChangesPresent -> BreakingChanges

@@ -202,10 +190,9 @@ showErrs x@(P.PathsPrefixNode currentIssues _) =

202190 Just Refl

203191 | (S.toList -> p@((AnIssue ori _) : _), o) <-

204192 S.partition

205− ( \((AnIssue _ u)) -> case u of

206− NoPathsMatched {} -> True

207− AllPathsFailed {} -> True

208− )

193+ (\((AnIssue _ u)) -> case u of

194+ NoPathsMatched {} -> True

195+ AllPathsFailed {} -> True)

209196 currentIssues ->

210197 let p' = p <&> (\(AnIssue _ i) -> i)

211198 in (Just (ori, p'), o)

@@ -216,10 +203,9 @@ showErrs x@(P.PathsPrefixNode currentIssues _) =

216203 paths = case removedPaths of

217204 Just (ori, ps) -> do

218205 singletonHeader

219− ( case ori of

220− Forward -> "Removed paths"

221− Backward -> "Added paths"

222− )

206+ (case ori of

207+ Forward -> "Removed paths"

208+ Backward -> "Added paths")

223209 $ singletonBody $

224210 bulletList $

225211 ps <&> \case

@@ -263,54 +249,52 @@ jets =

263249 unwrapReportJetResult (Pure _) = error "There really shouldn't be any results here."

264250 unwrapReportJetResult (Free f) = f

265251

266− jsonPathJet ::

267− NonEmpty

268− ( Union

269− '[ Behave 'SchemaLevel 'TypedSchemaLevel

270− , Behave 'TypedSchemaLevel 'SchemaLevel

271− ]

272− ) ->

273− Inlines

252+ jsonPathJet

253+ :: NonEmpty

254+ ( Union

255+ '[ Behave 'SchemaLevel 'TypedSchemaLevel

256+ , Behave 'TypedSchemaLevel 'SchemaLevel

257+ ]

258+ )

259+ -> Inlines

274260 jsonPathJet x = code $ "$" <> showParts (NE.toList x)

275261 where

276− showParts ::

277− [ Union

278− '[ Behave 'SchemaLevel 'TypedSchemaLevel

279− , Behave 'TypedSchemaLevel 'SchemaLevel

280− ]

281− ] ->

282− Text

262+ showParts

263+ :: [ Union

264+ '[ Behave 'SchemaLevel 'TypedSchemaLevel

265+ , Behave 'TypedSchemaLevel 'SchemaLevel

266+ ]

267+ ]

268+ -> Text

283269 showParts [] = mempty

284270 showParts (SingletonUnion (OfType Object) : xs@((SingletonUnion (InProperty _)) : _)) = showParts xs

285271 showParts (SingletonUnion (OfType Object) : xs@((SingletonUnion InAdditionalProperty) : _)) = showParts xs

286272 showParts (SingletonUnion (OfType Array) : xs@(SingletonUnion InItems : _)) = showParts xs

287273 showParts (SingletonUnion (OfType Array) : xs@(SingletonUnion (InItem _) : _)) = showParts xs

288274 showParts (y : ys) =

289− ( (\(OfType t) -> "(" <> describeJSONType t <> ")")

290− @@> ( \case

291− InItems -> "[*]"

292− InItem i -> "[" <> T.pack (show i) <> "]"

293− InProperty p -> "." <> p

294− InAdditionalProperty -> ".*"

295− )

296− @@> typesExhausted

297− )

275+ ((\(OfType t) -> "(" <> describeJSONType t <> ")")

276+ @@> (\case

277+ InItems -> "[*]"

278+ InItem i -> "[" <> T.pack (show i) <> "]"

279+ InProperty p -> "." <> p

280+ InAdditionalProperty -> ".*")

281+ @@> typesExhausted)

298282 y

299283 <> showParts ys

300284

301−observeJetShowErrs ::

302− ReportJet' Behave (Maybe Inlines) ->

303− P.PathsPrefixTree Behave AnIssue a ->

304− (Report, P.PathsPrefixTree Behave AnIssue a)

285+observeJetShowErrs

286+ :: ReportJet' Behave (Maybe Inlines)

287+ -> P.PathsPrefixTree Behave AnIssue a

288+ -> (Report, P.PathsPrefixTree Behave AnIssue a)

305289observeJetShowErrs jet p = case observeJetShowErrs' jet p of

306290 Just m -> m

307291 Nothing -> (mempty, p)

308292

309−observeJetShowErrs' ::

310− forall a.

311− ReportJet' Behave (Maybe Inlines) ->

312− P.PathsPrefixTree Behave AnIssue a ->

313− Maybe (Report, P.PathsPrefixTree Behave AnIssue a)

293+observeJetShowErrs'

294+ :: forall a.

295+ ReportJet' Behave (Maybe Inlines)

296+ -> P.PathsPrefixTree Behave AnIssue a

297+ -> Maybe (Report, P.PathsPrefixTree Behave AnIssue a)

314298observeJetShowErrs' (ReportJet jet) (P.PathsPrefixNode currentIssues subIssues) =

315299 let results =

316300 subIssues >>= \(WrapTypeable (AStep m)) ->

@@ -318,23 +302,21 @@ observeJetShowErrs' (ReportJet jet) (P.PathsPrefixNode currentIssues subIssues)

318302 maybe (Left $ embed (step bhv) subErrs) Right . listToMaybe $

319303 jet @_ @_ @[] bhv

320304 & mapMaybe

321− ( \case

322− Free jet' -> fmap (embed $ step bhv) <$> observeJetShowErrs' jet' subErrs

323− Pure (Just h) ->

324− if P.null subErrs

325− then Just mempty

326− else Just (singletonHeader h (showErrs subErrs), mempty)

327− Pure Nothing -> Nothing

328− )

305+ (\case

306+ Free jet' -> fmap (embed $ step bhv) <$> observeJetShowErrs' jet' subErrs

307+ Pure (Just h) ->

308+ if P.null subErrs

309+ then Just mempty

310+ else Just (singletonHeader h (showErrs subErrs), mempty)

311+ Pure Nothing -> Nothing)

329312 in (fmap . fmap) (PathsPrefixNode currentIssues mempty <>) $

330313 if any isRight results

331314 then

332315 Just $

333316 foldMap

334− ( \case

335− Left e -> (mempty, e)

336− Right m -> m

337− )

317+ (\case

318+ Left e -> (mempty, e)

319+ Right m -> m)

338320 results

339321 else Nothing

340322

@@ -357,9 +339,8 @@ buildReport cfg = case treeStyle cfg of

357339 body rprt

358340 <> foldOMapWithKey

359341 (headers rprt)

360− ( \k v ->

361− header level k <> subBuilder v

362− )

342+ (\k v ->

343+ header level k <> subBuilder v)

363344 where

364345 subBuilder = headerStyleBuilder (level + 1)

365346

@@ -368,17 +349,16 @@ buildReport cfg = case treeStyle cfg of

368349 body rprt

369350 <> foldOMapWithKey

370351 (headers rprt)

371− ( \k v ->

372− if (OM.size . headers $ rprt) < 2

373− then para k <> blockQuote (subBuilder v)

374− else

375− rawHtml "<details>"

376− <> rawHtml "<summary>"

377− <> plain k

378− <> rawHtml "</summary>"

379− <> blockQuote (subBuilder v)

380− <> rawHtml "</details>"

381− )

352+ (\k v ->

353+ if (OM.size . headers $ rprt) < 2

354+ then para k <> blockQuote (subBuilder v)

355+ else

356+ rawHtml "<details>"

357+ <> rawHtml "<summary>"

358+ <> plain k

359+ <> rawHtml "</summary>"

360+ <> blockQuote (subBuilder v)

361+ <> rawHtml "</details>")

382362 where

383363 subBuilder = foldingStyleBuilder

384364

src/Data/OpenApi/Compare/Report/Html/Template.hs+2−2

@@ -1,7 +1,7 @@

11{-# LANGUAGE TemplateHaskell #-}

22

33module Data.OpenApi.Compare.Report.Html.Template

4− ( template,

4+ ( template

55 )

66where

77

@@ -36,4 +36,4 @@ template =

3636 \</html>"

3737

3838awsmCss :: ByteString

39−awsmCss = $(makeRelativeToProject "css/awsm.min.css" >>= embedFile)

39+awsmCss = $(makeRelativeToProject "awsm-css/dist/awsm.min.css" >>= embedFile)

src/Data/OpenApi/Compare/Report/Jet.hs+4−4

@@ -1,8 +1,8 @@

11module Data.OpenApi.Compare.Report.Jet

2− ( ReportJet (..),

3− ReportJet',

4− ConstructReportJet (..),

5− ReportJetResult,

2+ ( ReportJet (..)

3+ , ReportJet'

4+ , ConstructReportJet (..)

5+ , ReportJetResult

66 )

77where

88

src/Data/OpenApi/Compare/Run.hs+4−4

@@ -1,17 +1,17 @@

11module Data.OpenApi.Compare.Run

2− ( runChecker,

3− runReport,

4− module Data.OpenApi.Compare.Report,

2+ ( runChecker

3+ , runReport

4+ , module Data.OpenApi.Compare.Report

55 )

66where

77

88import Data.HList

99import Data.OpenApi (OpenApi)

10+import Text.Pandoc.Builder

1011import Data.OpenApi.Compare.Paths

1112import Data.OpenApi.Compare.Report

1213import Data.OpenApi.Compare.Subtree

1314import Data.OpenApi.Compare.Validate.OpenApi ()

14−import Text.Pandoc.Builder

1515

1616runChecker :: (OpenApi, OpenApi) -> CheckerOutput

1717runChecker (client, server) =

src/Data/OpenApi/Compare/Subtree.hs+120−122

@@ -1,52 +1,52 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

22

33module Data.OpenApi.Compare.Subtree

4− ( Steppable (..),

5− Step (..),

6− TraceRoot,

7− Trace,

8− Traced,

9− Traced',

10− pattern Traced,

11− traced,

12− retraced,

13− stepTraced,

14− Subtree (..),

15− checkCompatibility,

16− checkSubstructure,

17− CompatM (..),

18− CompatFormula',

19− SemanticCompatFormula,

20− ProdCons (..),

21− orientProdCons,

22− swapProdCons,

23− runCompatFormula,

24− issueAt,

25− anItem,

26− anIssue,

27− invertIssueOrientation,

28− invertIssueOrientationP,

29− embedFormula,

30− anyOfAt,

31− clarifyIssue,

32− structuralIssue,

4+ ( Steppable (..)

5+ , Step (..)

6+ , TraceRoot

7+ , Trace

8+ , Traced

9+ , Traced'

10+ , pattern Traced

11+ , traced

12+ , retraced

13+ , stepTraced

14+ , Subtree (..)

15+ , checkCompatibility

16+ , checkSubstructure

17+ , CompatM (..)

18+ , CompatFormula'

19+ , SemanticCompatFormula

20+ , ProdCons (..)

21+ , orientProdCons

22+ , swapProdCons

23+ , runCompatFormula

24+ , issueAt

25+ , anItem

26+ , anIssue

27+ , invertIssueOrientation

28+ , invertIssueOrientationP

29+ , embedFormula

30+ , anyOfAt

31+ , clarifyIssue

32+ , structuralIssue

3333

3434 -- * Structural helpers

35− structuralMaybe,

36− structuralMaybeWith,

37− structuralEq,

38− iohmStructural,

39− iohmStructuralWith,

40− structuralList,

35+ , structuralMaybe

36+ , structuralMaybeWith

37+ , structuralEq

38+ , iohmStructural

39+ , iohmStructuralWith

40+ , structuralList

4141

4242 -- * Reexports

43− (>>>),

44− (<<<),

45− extract,

46− ask,

47− local,

48− step,

49− Typeable,

43+ , (>>>)

44+ , (<<<)

45+ , extract

46+ , ask

47+ , local

48+ , step

49+ , Typeable

5050 )

5151where

5252

@@ -115,10 +115,10 @@ orientProdCons :: Orientation -> ProdCons x -> ProdCons x

115115orientProdCons Forward x = x

116116orientProdCons Backward (ProdCons p c) = ProdCons c p

117117

118−swapProdCons ::

119− SwapEnvRoles xs =>

120− (HList xs -> ProdCons x -> CompatFormula' q AnIssue r a) ->

121− (HList xs -> ProdCons x -> CompatFormula' q AnIssue r a)

118+swapProdCons

119+ :: SwapEnvRoles xs

120+ => (HList xs -> ProdCons x -> CompatFormula' q AnIssue r a)

121+ -> (HList xs -> ProdCons x -> CompatFormula' q AnIssue r a)

122122swapProdCons f e (ProdCons p c) =

123123 invertIssueOrientation $

124124 f (swapEnvRoles e) (ProdCons c p)

@@ -153,8 +153,8 @@ instance Applicative ProdCons where

153153 ProdCons fp fc <*> ProdCons xp xc = ProdCons (fp xp) (fc xc)

154154

155155newtype CompatM a = CompatM

156− { unCompatM ::

157− StateT (MemoState VarRef) Identity a

156+ { unCompatM

157+ :: StateT (MemoState VarRef) Identity a

158158 }

159159 deriving newtype

160160 ( Functor

@@ -183,64 +183,64 @@ class (Typeable t, Issuable (SubtreeLevel t)) => Subtree (t :: Type) where

183183 type CheckEnv t :: [Type]

184184 type SubtreeLevel t :: BehaviorLevel

185185

186− checkStructuralCompatibility ::

187− HList (CheckEnv t) ->

188− ProdCons (Traced t) ->

189− StructuralCompatFormula ()

186+ checkStructuralCompatibility

187+ :: HList (CheckEnv t)

188+ -> ProdCons (Traced t)

189+ -> StructuralCompatFormula ()

190190

191− checkSemanticCompatibility ::

192− HList (CheckEnv t) ->

193− Behavior (SubtreeLevel t) ->

194− ProdCons (Traced t) ->

195− SemanticCompatFormula ()

191+ checkSemanticCompatibility

192+ :: HList (CheckEnv t)

193+ -> Behavior (SubtreeLevel t)

194+ -> ProdCons (Traced t)

195+ -> SemanticCompatFormula ()

196196

197197{-# WARNING checkStructuralCompatibility "You should not be calling this directly. Use 'checkSubstructure'" #-}

198198

199199{-# WARNING checkSemanticCompatibility "You should not be calling this directly. Use 'checkCompatibility'" #-}

200200

201−checkCompatibility ::

202− forall t xs.

203− (ReassembleHList xs (CheckEnv t), Subtree t) =>

204− Behavior (SubtreeLevel t) ->

205− HList xs ->

206− ProdCons (Traced t) ->

207− SemanticCompatFormula ()

201+checkCompatibility

202+ :: forall t xs.

203+ (ReassembleHList xs (CheckEnv t), Subtree t)

204+ => Behavior (SubtreeLevel t)

205+ -> HList xs

206+ -> ProdCons (Traced t)

207+ -> SemanticCompatFormula ()

208208checkCompatibility bhv e = memo bhv SemanticMemoKey $ \pc ->

209209 case runCompatFormula $ checkSubstructure e pc of

210210 Left _ -> checkSemanticCompatibility (reassemble e) bhv pc

211211 Right () -> pure ()

212212{-# INLINE checkCompatibility #-}

213213

214−checkSubstructure ::

215− (ReassembleHList xs (CheckEnv t), Subtree t) =>

216− HList xs ->

217− ProdCons (Traced t) ->

218− StructuralCompatFormula ()

214+checkSubstructure

215+ :: (ReassembleHList xs (CheckEnv t), Subtree t)

216+ => HList xs

217+ -> ProdCons (Traced t)

218+ -> StructuralCompatFormula ()

219219checkSubstructure e = memo Root StructuralMemoKey $ checkStructuralCompatibility (reassemble e)

220220{-# INLINE checkSubstructure #-}

221221

222−structuralMaybe ::

223− (Subtree a, ReassembleHList xs (CheckEnv a)) =>

224− HList xs ->

225− ProdCons (Maybe (Traced a)) ->

226− StructuralCompatFormula ()

222+structuralMaybe

223+ :: (Subtree a, ReassembleHList xs (CheckEnv a))

224+ => HList xs

225+ -> ProdCons (Maybe (Traced a))

226+ -> StructuralCompatFormula ()

227227structuralMaybe e = structuralMaybeWith (checkSubstructure e)

228228{-# INLINE structuralMaybe #-}

229229

230−structuralMaybeWith ::

231− (ProdCons a -> StructuralCompatFormula ()) ->

232− ProdCons (Maybe a) ->

233− StructuralCompatFormula ()

230+structuralMaybeWith

231+ :: (ProdCons a -> StructuralCompatFormula ())

232+ -> ProdCons (Maybe a)

233+ -> StructuralCompatFormula ()

234234structuralMaybeWith f (ProdCons (Just a) (Just b)) = f $ ProdCons a b

235235structuralMaybeWith _ (ProdCons Nothing Nothing) = pure ()

236236structuralMaybeWith _ _ = structuralIssue

237237{-# INLINE structuralMaybeWith #-}

238238

239−structuralList ::

240− (Subtree a, ReassembleHList xs (CheckEnv a)) =>

241− HList xs ->

242− ProdCons [Traced a] ->

243− StructuralCompatFormula ()

239+structuralList

240+ :: (Subtree a, ReassembleHList xs (CheckEnv a))

241+ => HList xs

242+ -> ProdCons [Traced a]

243+ -> StructuralCompatFormula ()

244244structuralList _ (ProdCons [] []) = pure ()

245245structuralList e (ProdCons (a : aa) (b : bb)) = do

246246 checkSubstructure e $ ProdCons a b

@@ -253,11 +253,11 @@ structuralEq :: (Eq a, Comonad w) => ProdCons (w a) -> StructuralCompatFormula (

253253structuralEq (ProdCons a b) = if extract a == extract b then pure () else structuralIssue

254254{-# INLINE structuralEq #-}

255255

256−iohmStructural ::

257− (ReassembleHList (k ': xs) (CheckEnv v), Ord k, Subtree v, Hashable k, Typeable k, Show k) =>

258− HList xs ->

259− ProdCons (Traced (IOHM.InsOrdHashMap k v)) ->

260− StructuralCompatFormula ()

256+iohmStructural

257+ :: (ReassembleHList (k ': xs) (CheckEnv v), Ord k, Subtree v, Hashable k, Typeable k, Show k)

258+ => HList xs

259+ -> ProdCons (Traced (IOHM.InsOrdHashMap k v))

260+ -> StructuralCompatFormula ()

261261iohmStructural e =

262262 iohmStructuralWith (\k -> checkSubstructure (k `HCons` e))

263263{-# INLINE iohmStructural #-}

@@ -266,26 +266,25 @@ instance (Typeable k, Typeable v, Ord k, Show k) => Steppable (IOHM.InsOrdHashMa

266266 data Step (IOHM.InsOrdHashMap k v) v = InsOrdHashMapKeyStep k

267267 deriving stock (Eq, Ord, Show)

268268

269−iohmStructuralWith ::

270− (Ord k, Hashable k, Typeable k, Typeable v, Show k) =>

271− (k -> ProdCons (Traced v) -> StructuralCompatFormula ()) ->

272− ProdCons (Traced (IOHM.InsOrdHashMap k v)) ->

273− StructuralCompatFormula ()

269+iohmStructuralWith

270+ :: (Ord k, Hashable k, Typeable k, Typeable v, Show k)

271+ => (k -> ProdCons (Traced v) -> StructuralCompatFormula ())

272+ -> ProdCons (Traced (IOHM.InsOrdHashMap k v))

273+ -> StructuralCompatFormula ()

274274iohmStructuralWith f pc = do

275275 let ProdCons pEKeys cEKeys = S.fromList . IOHM.keys . extract <$> pc

276276 if pEKeys == cEKeys

277277 then

278278 for_

279279 pEKeys

280− ( \eKey ->

281− f eKey $ stepTraced (InsOrdHashMapKeyStep eKey) . fmap (IOHM.lookupDefault (error "impossible") eKey) <$> pc

282− )

280+ (\eKey ->

281+ f eKey $ stepTraced (InsOrdHashMapKeyStep eKey) . fmap (IOHM.lookupDefault (error "impossible") eKey) <$> pc)

283282 else structuralIssue

284283{-# INLINE iohmStructuralWith #-}

285284

286−runCompatFormula ::

287− CompatFormula' q f r a ->

288− Either (P.PathsPrefixTree q f r) a

285+runCompatFormula

286+ :: CompatFormula' q f r a

287+ -> Either (P.PathsPrefixTree q f r) a

289288runCompatFormula (Compose f) =

290289 calculate . runIdentity . runMemo 0 . unCompatM $ f

291290{-# INLINE runCompatFormula #-}

@@ -315,27 +314,27 @@ invertIssueOrientationP = P.map (\(AnIssue ori i) -> AnIssue (toggleOrientation

315314structuralIssue :: StructuralCompatFormula a

316315structuralIssue = Compose $ pure $ anError $ AnItem Root Proxy

317316

318−anyOfAt ::

319− Issuable l =>

320− Paths q r l ->

321− Issue l ->

322− [CompatFormula' q AnIssue r a] ->

323− CompatFormula' q AnIssue r a

317+anyOfAt

318+ :: Issuable l

319+ => Paths q r l

320+ -> Issue l

321+ -> [CompatFormula' q AnIssue r a]

322+ -> CompatFormula' q AnIssue r a

324323anyOfAt _ _ [x] = x

325324anyOfAt xs issue fs =

326325 Compose $ (`eitherOf` AnItem xs (anIssue issue)) <$> traverse getCompose fs

327326

328327-- | If the given formula contains any issues, add another issue on top. Otherwise succeed.

329−clarifyIssue ::

330− AnItem q AnIssue r ->

331− CompatFormula' q AnIssue r a ->

332− CompatFormula' q AnIssue r a

328+clarifyIssue

329+ :: AnItem q AnIssue r

330+ -> CompatFormula' q AnIssue r a

331+ -> CompatFormula' q AnIssue r a

333332clarifyIssue item f =

334333 Compose ((`eitherOf` item) <$> pure <$> getCompose f) *> f

335334

336−fixpointKnot ::

337− MonadState (MemoState VarRef) m =>

338− KnotTier (FormulaF q f r ()) VarRef m

335+fixpointKnot

336+ :: MonadState (MemoState VarRef) m

337+ => KnotTier (FormulaF q f r ()) VarRef m

339338fixpointKnot =

340339 KnotTier

341340 { onKnotFound = modifyMemoNonce succ

@@ -343,20 +342,19 @@ fixpointKnot =

343342 , tieKnot = \i x -> pure $ maxFixpoint i x

344343 }

345344

346−memo ::

347− (Typeable (l :: k), Typeable q, Typeable f, Typeable k, Typeable a) =>

348− Paths q r l ->

349− MemoKey ->

350− (ProdCons (Traced a) -> CompatFormula' q f r ()) ->

351− (ProdCons (Traced a) -> CompatFormula' q f r ())

345+memo

346+ :: (Typeable (l :: k), Typeable q, Typeable f, Typeable k, Typeable a)

347+ => Paths q r l

348+ -> MemoKey

349+ -> (ProdCons (Traced a) -> CompatFormula' q f r ())

350+ -> (ProdCons (Traced a) -> CompatFormula' q f r ())

352351memo bhv k f pc = Compose $ do

353352 formula' <-

354353 memoWithKnot

355354 fixpointKnot

356− ( do

357− formula <- getCompose $ f pc

358− pure $ mapErrors (P.takeSubtree bhv) formula

359− )

355+ (do

356+ formula <- getCompose $ f pc

357+ pure $ mapErrors (P.takeSubtree bhv) formula)

360358 (k, ask <$> pc)

361359 pure $ mapErrors (P.embed bhv) formula'

362360

src/Data/OpenApi/Compare/Validate/MediaTypeObject.hs+2−2

@@ -1,8 +1,8 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

22

33module Data.OpenApi.Compare.Validate.MediaTypeObject

4− ( Issue (..),

5− Behave (..),

4+ ( Issue (..)

5+ , Behave (..)

66 )

77where

88

src/Data/OpenApi/Compare/Validate/OAuth2Flows.hs+13−13

@@ -1,9 +1,9 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

22

33module Data.OpenApi.Compare.Validate.OAuth2Flows

4− ( Step (..),

5− Issue (..),

6− Behave (..),

4+ ( Step (..)

5+ , Issue (..)

6+ , Behave (..)

77 )

88where

99

@@ -26,11 +26,11 @@ instance Subtree OAuth2Flows where

2626 type SubtreeLevel OAuth2Flows = 'SecuritySchemeLevel

2727 checkStructuralCompatibility _ = structuralEq

2828 checkSemanticCompatibility env bhv pc = do

29− let supportFlow ::

30− (Subtree t, SubtreeLevel t ~ SubtreeLevel OAuth2Flows, CheckEnv OAuth2Flows ~ CheckEnv t) =>

31− Issue 'SecuritySchemeLevel ->

32− ProdCons (Maybe (Traced t)) ->

33− SemanticCompatFormula ()

29+ let supportFlow

30+ :: (Subtree t, SubtreeLevel t ~ SubtreeLevel OAuth2Flows, CheckEnv OAuth2Flows ~ CheckEnv t)

31+ => Issue 'SecuritySchemeLevel

32+ -> ProdCons (Maybe (Traced t))

33+ -> SemanticCompatFormula ()

3434 supportFlow i x = case x of

3535 -- producer will not attempt this flow

3636 (ProdCons Nothing _) -> pure ()

@@ -38,11 +38,11 @@ instance Subtree OAuth2Flows where

3838 (ProdCons (Just _) Nothing) -> issueAt bhv i

3939 (ProdCons (Just p) (Just c)) ->

4040 checkCompatibility bhv env $ ProdCons p c

41− getFlow ::

42− Typeable x =>

43− (OAuth2Flows -> Maybe (OAuth2Flow x)) ->

44− Traced OAuth2Flows ->

45− Maybe (Traced (OAuth2Flow x))

41+ getFlow

42+ :: Typeable x

43+ => (OAuth2Flows -> Maybe (OAuth2Flow x))

44+ -> Traced OAuth2Flows

45+ -> Maybe (Traced (OAuth2Flow x))

4646 getFlow f (Traced t a) = Traced (t >>> step (OAuth2FlowsFlow Proxy)) <$> f a

4747 supportFlow ConsumerDoesNotSupportImplicitFlow $ getFlow _oAuth2FlowsImplicit <$> pc

4848 supportFlow ConsumerDoesNotSupportPasswordFlow $ getFlow _oAuth2FlowsPassword <$> pc

src/Data/OpenApi/Compare/Validate/OpenApi.hs+13−15

@@ -3,8 +3,8 @@

33{-# OPTIONS_GHC -fconstraint-solver-iterations=0 #-}

44

55module Data.OpenApi.Compare.Validate.OpenApi

6− ( Behave (..),

7− Issue (..),

6+ ( Behave (..)

7+ , Issue (..)

88 )

99where

1010

@@ -38,8 +38,7 @@ tracedSecuritySchemes :: Traced OpenApi -> Traced (Definitions SecurityScheme)

3838tracedSecuritySchemes oa =

3939 traced

4040 (ask oa >>> step ComponentsSecurityScheme)

41− (unSecurityDefinitions . _componentsSecuritySchemes . _openApiComponents . extract $ oa)

42− where unSecurityDefinitions (SecurityDefinitions ds) = ds

41+ (_componentsSecuritySchemes . _openApiComponents . extract $ oa)

4342

4443tracedResponses :: Traced OpenApi -> Traced (Definitions Response)

4544tracedResponses oa =

@@ -80,17 +79,16 @@ instance Subtree OpenApi where

8079 checkSemanticCompatibility _ beh prodCons = do

8180 checkCompatibility @ProcessedPathItems

8281 beh

83− ( (tracedRequestBodies <$> prodCons)

84− `HCons` (tracedParameters <$> prodCons)

85− `HCons` (tracedSecuritySchemes <$> prodCons)

86− `HCons` (tracedResponses <$> prodCons)

87− `HCons` (tracedHeaders <$> prodCons)

88− `HCons` (tracedSchemas <$> prodCons)

89− `HCons` (_openApiServers . extract <$> prodCons)

90− `HCons` (tracedLinks <$> prodCons)

91− `HCons` (tracedCallbacks <$> prodCons)

92− `HCons` HNil

93− )

82+ ((tracedRequestBodies <$> prodCons)

83+ `HCons` (tracedParameters <$> prodCons)

84+ `HCons` (tracedSecuritySchemes <$> prodCons)

85+ `HCons` (tracedResponses <$> prodCons)

86+ `HCons` (tracedHeaders <$> prodCons)

87+ `HCons` (tracedSchemas <$> prodCons)

88+ `HCons` (_openApiServers . extract <$> prodCons)

89+ `HCons` (tracedLinks <$> prodCons)

90+ `HCons` (tracedCallbacks <$> prodCons)

91+ `HCons` HNil)

9492 (tracedPaths <$> prodCons)

9593

9694instance Steppable OpenApi ProcessedPathItems where

src/Data/OpenApi/Compare/Validate/Operation.hs+24−26

@@ -4,17 +4,17 @@

44

55module Data.OpenApi.Compare.Validate.Operation

66 ( -- * Operation

7− MatchedOperation (..),

8− OperationMethod (..),

9− pathItemMethod,

7+ MatchedOperation (..)

8+ , OperationMethod (..)

9+ , pathItemMethod

1010

1111 -- * ProcessedPathItem

12− ProcessedPathItem (..),

13− ProcessedPathItems (..),

14− processPathItems,

15− Step (..),

16− Behave (..),

17− Issue (..),

12+ , ProcessedPathItem (..)

13+ , ProcessedPathItems (..)

14+ , processPathItems

15+ , Step (..)

16+ , Behave (..)

17+ , Issue (..)

1818 )

1919where

2020

@@ -87,11 +87,10 @@ tracedCallbacks (Traced t oper) =

8787 ]

8888

8989-- FIXME: #28

90−getServers ::

91− -- | Servers from env

92− [Server] ->

93− MatchedOperation ->

94− [Server]

90+getServers

91+ :: [Server] -- ^ Servers from env

92+ -> MatchedOperation

93+ -> [Server]

9594getServers env oper =

9695 case _operationServers . operation $ oper of

9796 [] -> env

@@ -338,10 +337,9 @@ instance Issuable 'APILevel where

338337 deriving stock (Eq, Ord, Show)

339338 issueKind = \case

340339 _ -> CertainIssue

341− relatedIssues =

342− (==) `withClass` \case

343− NoPathsMatched fp -> Just fp

344− AllPathsFailed fp -> Just fp

340+ relatedIssues = (==) `withClass` \case

341+ NoPathsMatched fp -> Just fp

342+ AllPathsFailed fp -> Just fp

345343 describeIssue Forward (NoPathsMatched p) = para $ "The path " <> (code . T.pack) p <> " has been removed."

346344 describeIssue Backward (NoPathsMatched p) = para $ "The path " <> (code . T.pack) p <> " has been added."

347345 describeIssue Forward (AllPathsFailed p) = para $ "The path " <> (code . T.pack) p <> " has been removed."

@@ -436,10 +434,10 @@ tracedFragments mpi =

436434 | (i, x) <- L.zip [0 ..] $ pathFragments $ extract mpi

437435 ]

438436

439−tracedMethod ::

440− OperationMethod ->

441− Traced MatchedPathItem ->

442− Maybe (Traced' MatchedOperation Operation)

437+tracedMethod

438+ :: OperationMethod

439+ -> Traced MatchedPathItem

440+ -> Maybe (Traced' MatchedOperation Operation)

443441tracedMethod s mpi = env (ask mpi >>> step (OperationMethodStep s)) <$> (pathItemMethod s . pathItem . extract $ mpi)

444442

445443instance Issuable 'PathLevel where

@@ -487,10 +485,10 @@ instance Subtree MatchedPathItem where

487485 checkSemanticCompatibility env beh prodCons = do

488486 let paramDefs = getH @(ProdCons (Traced (Definitions Param))) env

489487 pathTracedParams = getPathParams <$> paramDefs <*> prodCons

490− getPathParams ::

491− Traced (Definitions Param) ->

492− Traced MatchedPathItem ->

493− [Traced Param]

488+ getPathParams

489+ :: Traced (Definitions Param)

490+ -> Traced MatchedPathItem

491+ -> [Traced Param]

494492 getPathParams defs mpi = do

495493 paramRef <- tracedMatchedPathItemParameters mpi

496494 pure $ dereference defs paramRef

src/Data/OpenApi/Compare/Validate/Param.hs+7−9

@@ -2,8 +2,8 @@

22{-# OPTIONS_GHC -fno-warn-name-shadowing #-}

33

44module Data.OpenApi.Compare.Validate.Param

5− ( Behave (..),

6− Issue (..),

5+ ( Behave (..)

6+ , Issue (..)

77 )

88where

99

@@ -79,7 +79,7 @@ instance Issuable 'PathFragmentLevel where

7979 describeIssue _ ParamPlaceIncompatible = para "Parameters in incompatible locations."

8080 describeIssue _ ParamStyleMismatch = para "Different parameter styles (encodings)."

8181 describeIssue _ ParamSchemaMismatch = para "Expected a schema, but didn't find one."

82− describeIssue ori (PathFragmentsDontMatch (orientProdCons ori -> ProdCons e a)) =

82+ describeIssue ori (PathFragmentsDontMatch (orientProdCons ori -> ProdCons e a)) =

8383 para $ "Parameter changed from " <> code e <> " to " <> code a <> "."

8484

8585instance Behavable 'PathFragmentLevel 'SchemaLevel where

@@ -106,17 +106,15 @@ instance Subtree Param where

106106 when (_paramName (extract p) /= _paramName (extract c)) $

107107 issueAt beh ParamNameMismatch

108108 when

109− ( (fromMaybe False . _paramRequired . extract $ c)

110− && not (fromMaybe False . _paramRequired . extract $ p)

111− )

109+ ((fromMaybe False . _paramRequired . extract $ c)

110+ && not (fromMaybe False . _paramRequired . extract $ p))

112111 $ issueAt beh ParamRequired

113112 case (_paramIn . extract $ p, _paramIn . extract $ c) of

114113 (ParamQuery, ParamQuery) -> do

115114 -- Emptiness is only for query params

116115 when

117− ( (fromMaybe False . _paramAllowEmptyValue . extract $ p)

118− && not (fromMaybe False . _paramAllowEmptyValue . extract $ c)

119− )

116+ ((fromMaybe False . _paramAllowEmptyValue . extract $ p)

117+ && not (fromMaybe False . _paramAllowEmptyValue . extract $ c))

120118 $ issueAt beh ParamEmptinessIncompatible

121119 (a, b) | a == b -> pure ()

122120 _ -> issueAt beh ParamPlaceIncompatible

src/Data/OpenApi/Compare/Validate/PathFragment.hs+4−3

@@ -1,7 +1,7 @@

11module Data.OpenApi.Compare.Validate.PathFragment

2− ( parsePath,

3− PathFragment (..),

4− PathFragmentParam,

2+ ( parsePath

3+ , PathFragment (..)

4+ , PathFragmentParam

55 )

66where

77

@@ -12,6 +12,7 @@ import Data.OpenApi.Compare.Subtree

1212import Data.OpenApi.Compare.Validate.Param

1313import Data.Text (Text)

1414import qualified Data.Text as T

15+import Data.Typeable

1516

1617-- TODO: templates can be only part of the PathFragment. Currently only supports templates as full PathFragment.

1718-- #23

src/Data/OpenApi/Compare/Validate/Products.hs+28−27

@@ -1,21 +1,21 @@

1−-- | Checks product-like entities. The key is some identificator for the product

2−--element. Each element may be required or optional.

3−--

4−--One example of product is request parameters. There are optional and required

5−--parameters. The client and server have possibly different set of

6−--parameters. What we must check is if server requires some request parameter,

7−--then this parameter must be presented by client and their schemas must match.

8−--

9−--So when we checking products we are checking from the server's (consumer)

10−--perspective, ensuring that all parameters are provided by the client (producer)

11−--and their schemas match.

12−--

13−--This module abstracts this logic for arbitrary elements

1+{- | Checks product-like entities. The key is some identificator for the product

2+element. Each element may be required or optional.

3+

4+One example of product is request parameters. There are optional and required

5+parameters. The client and server have possibly different set of

6+parameters. What we must check is if server requires some request parameter,

7+then this parameter must be presented by client and their schemas must match.

8+

9+So when we checking products we are checking from the server's (consumer)

10+perspective, ensuring that all parameters are provided by the client (producer)

11+and their schemas match.

12+

13+This module abstracts this logic for arbitrary elements -}

14+

1415module Data.OpenApi.Compare.Validate.Products

15− ( checkProducts,

16− ProductLike (..),

17− )

18−where

16+ ( checkProducts

17+ , ProductLike(..)

18+ ) where

1919

2020import Data.Foldable

2121import Data.Map.Strict (Map)

@@ -30,19 +30,20 @@ data ProductLike a = ProductLike

3030 , required :: Bool

3131 }

3232

33−checkProducts ::

34− (Ord k, Issuable l) =>

35− Paths q r l ->

36− -- | No required element found

37− (k -> Issue l) ->

38− (k -> ProdCons t -> CompatFormula' q AnIssue r ()) ->

39− ProdCons (Map k (ProductLike t)) ->

40− CompatFormula' q AnIssue r ()

33+checkProducts

34+ :: (Ord k, Issuable l)

35+ => Paths q r l

36+ -> (k -> Issue l)

37+ -- ^ No required element found

38+ -> (k -> ProdCons t -> CompatFormula' q AnIssue r ())

39+ -> ProdCons (Map k (ProductLike t))

40+ -> CompatFormula' q AnIssue r ()

4141checkProducts xs noElt check (ProdCons p c) = for_ (M.toList c) $ \(key, consElt) ->

4242 case M.lookup key p of

4343 Nothing -> case required consElt of

44− True -> issueAt xs $ noElt key

44+ True -> issueAt xs $ noElt key

4545 False -> pure ()

4646 Just prodElt -> do

47− let elts = ProdCons prodElt consElt

47+ let

48+ elts = ProdCons prodElt consElt

4849 check key (productValue <$> elts)

src/Data/OpenApi/Compare/Validate/RequestBody.hs+2−2

@@ -1,8 +1,8 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

22

33module Data.OpenApi.Compare.Validate.RequestBody

4− ( Issue (..),

5− Behave (..),

4+ ( Issue (..)

5+ , Behave (..)

66 )

77where

88

src/Data/OpenApi/Compare/Validate/Responses.hs+1−1

@@ -2,7 +2,7 @@

22{-# OPTIONS_GHC -fno-warn-name-shadowing #-}

33

44module Data.OpenApi.Compare.Validate.Responses

5− ( Behave (..),

5+ ( Behave (..)

66 )

77where

88

src/Data/OpenApi/Compare/Validate/Schema.hs+98−77

@@ -1,19 +1,18 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

2−

32module Data.OpenApi.Compare.Validate.Schema

43 (

54 )

65where

76

8−import Control.Monad (when,unless)

7+import Control.Monad.Writer

98import qualified Data.Aeson as A

109import Data.Coerce

1110import Data.Foldable (for_, toList)

1211import Data.Functor

1312import Data.HList

14−import Data.List (genericIndex, genericLength, group)

1513import qualified Data.List.NonEmpty as NE

1614import qualified Data.Map as M

15+import Data.List (group, genericLength, genericIndex)

1716import Data.Maybe

1817import Data.OpenApi

1918import Data.OpenApi.Compare.Behavior

@@ -23,24 +22,24 @@ import Data.OpenApi.Compare.Subtree

2322import Data.OpenApi.Compare.Validate.Schema.DNF

2423import Data.OpenApi.Compare.Validate.Schema.Issues

2524import Data.OpenApi.Compare.Validate.Schema.JsonFormula

26−import Data.OpenApi.Compare.Validate.Schema.Partition

27−import Data.OpenApi.Compare.Validate.Schema.Process

2825import Data.OpenApi.Compare.Validate.Schema.Traced

2926import Data.OpenApi.Compare.Validate.Schema.TypedJson

27+import Data.OpenApi.Compare.Validate.Schema.Partition

28+import Data.OpenApi.Compare.Validate.Schema.Process

3029import Data.Ord

3130import Data.Ratio

3231import Data.Semigroup

3332import qualified Data.Set as S

3433import Data.Text (Text)

3534

36−checkFormulas ::

37− (ReassembleHList xs (CheckEnv (Referenced Schema))) =>

38− HList xs ->

39− Behavior 'SchemaLevel ->

40− ProdCons (Trace Schema) ->

41− ProdCons (Traced (Definitions Schema)) ->

42− ProdCons (ForeachType JsonFormula, P.PathsPrefixTree Behave AnIssue 'SchemaLevel) ->

43− SemanticCompatFormula ()

35+checkFormulas

36+ :: (ReassembleHList xs (CheckEnv (Referenced Schema)))

37+ => HList xs

38+ -> Behavior 'SchemaLevel

39+ -> ProdCons (Trace Schema)

40+ -> ProdCons (Traced (Definitions Schema))

41+ -> ProdCons (ForeachType JsonFormula, P.PathsPrefixTree Behave AnIssue 'SchemaLevel)

42+ -> SemanticCompatFormula ()

4443checkFormulas env beh trs defs (ProdCons (fp, ep) (fc, ec)) =

4544 case P.toList ep ++ P.toList ec of

4645 issues@(_ : _) -> for_ issues $ embedFormula beh . anItem

@@ -145,21 +144,21 @@ checkFormulas env beh trs defs (ProdCons (fp, ep) (fc, ec)) =

145144 EnumDoesntSatisfy $ untypeValue e -- what does this look like when partitioned?

146145 issueFromDisjunct mPart ps = NoMatchingCondition mPart $ SomeCondition <$> S.toList ps

147146

148−checkContradiction ::

149− Behavior 'TypedSchemaLevel ->

150− Maybe Partition ->

151− S.Set (Condition t) ->

152− SemanticCompatFormula ()

147+checkContradiction

148+ :: Behavior 'TypedSchemaLevel

149+ -> Maybe Partition

150+ -> S.Set (Condition t)

151+ -> SemanticCompatFormula ()

153152checkContradiction beh mPart _ = issueAt beh $ maybe TypeBecomesEmpty PartitionBecomesEmpty mPart -- TODO #70

154153

155−checkImplication ::

156− (ReassembleHList xs (CheckEnv (Referenced Schema))) =>

157− HList xs ->

158− Behavior 'TypedSchemaLevel ->

159− ProdCons (Trace Schema) -> -- the traces of the root schemas used in this comparison

160− S.Set (Condition t) ->

161− Condition t ->

162− SemanticCompatFormula ()

154+checkImplication

155+ :: (ReassembleHList xs (CheckEnv (Referenced Schema)))

156+ => HList xs

157+ -> Behavior 'TypedSchemaLevel

158+ -> ProdCons (Trace Schema) -- the traces of the root schemas used in this comparison

159+ -> S.Set (Condition t)

160+ -> Condition t

161+ -> SemanticCompatFormula ()

163162checkImplication env beh trs prods cons = case findExactly prods of

164163 Just e

165164 | all (satisfiesTyped e) prods ->

@@ -167,104 +166,124 @@ checkImplication env beh trs prods cons = case findExactly prods of

167166 then pure ()

168167 else issueAt beh (EnumDoesntSatisfy $ untypeValue e)

169168 | otherwise -> pure () -- vacuously true

169+

170170 Nothing -> case cons of

171171 -- the above code didn't catch it, so there's no Exactly condition on the lhs

172172 Exactly e -> issueAt beh (NoMatchingEnum $ untypeValue e)

173+

173174 Maximum m -> foldCheck min m NoMatchingMaximum MatchingMaximumWeak $ \case

174175 Maximum m' -> Just m'

175176 _ -> Nothing

177+

176178 Minimum m -> foldCheck max m (NoMatchingMinimum . coerce) (MatchingMinimumWeak . coerce) $ \case

177179 Minimum m' -> Just m'

178180 _ -> Nothing

181+

179182 MultipleOf m -> foldCheck lcmScientific m NoMatchingMultipleOf MatchingMultipleOfWeak $ \case

180183 MultipleOf m' -> Just m'

181184 _ -> Nothing

185+

182186 NumberFormat f -> case flip any prods $ \case

183− NumberFormat f' -> f == f'

184− _ -> False of

187+ NumberFormat f' -> f == f'

188+ _ -> False

189+ of

185190 True -> pure ()

186191 False -> issueAt beh (NoMatchingFormat f)

192+

187193 MaxLength m -> foldCheck min m NoMatchingMaxLength MatchingMaxLengthWeak $ \case

188194 MaxLength m' -> Just m'

189195 _ -> Nothing

196+

190197 MinLength m -> foldCheck max m NoMatchingMinLength MatchingMinLengthWeak $ \case

191198 MinLength m' -> Just m'

192199 _ -> Nothing

200+

193201 Pattern p -> case flip any prods $ \case

194− Pattern p' -> p == p'

195− _ -> False of

202+ Pattern p' -> p == p'

203+ _ -> False

204+ of

196205 True -> pure ()

197206 False -> issueAt beh (NoMatchingPattern p) -- TODO: regex comparison #32

207+

198208 StringFormat f -> case flip any prods $ \case

199− StringFormat f' -> f == f'

200− _ -> False of

209+ StringFormat f' -> f == f'

210+ _ -> False

211+ of

201212 True -> pure ()

202213 False -> issueAt beh (NoMatchingFormat f)

214+

203215 Items _ cons' -> case foldSome (<>) prods $ \case

204− Items _ rs -> Just (Just (rs NE.:| []), mempty)

205− TupleItems (map snd -> fs) -> Just (mempty, Just (fs NE.:| []))

206− _ -> Nothing of

216+ Items _ rs -> Just (Just (rs NE.:| []), mempty)

217+ TupleItems (map snd -> fs) -> Just (mempty, Just (fs NE.:| []))

218+ _ -> Nothing

219+ of

207220 Just (mItems, Just pfs)

208221 | not $ allSame (length <$> pfs) -> pure () -- vacuously

209− | let plen = genericLength (NE.head pfs) ->

210− clarifyIssue (AnItem beh (anIssue TupleToArray)) $

211− for_ [0 .. plen - 1] $ \i -> do

212− let prod' = tracedConjunct $ case mItems of

213− Just prods' -> ((`genericIndex` i) <$> pfs) <> prods'

214− Nothing -> (`genericIndex` i) <$> pfs

215− checkCompatibility (beh >>> step (InItem i)) env $ ProdCons prod' cons'

222+ | let plen = genericLength (NE.head pfs)

223+ -> clarifyIssue (AnItem beh (anIssue TupleToArray)) $ for_ [0 .. plen - 1] $ \i -> do

224+ let prod' = tracedConjunct $ case mItems of

225+ Just prods' -> ((`genericIndex` i) <$> pfs) <> prods'

226+ Nothing -> (`genericIndex` i) <$> pfs

227+ checkCompatibility (beh >>> step (InItem i)) env $ ProdCons prod' cons'

216228 Just (Just prods', Nothing) -> do

217229 let prod' = tracedConjunct prods'

218230 checkCompatibility (beh >>> step InItems) env $ ProdCons prod' cons'

219231 _ -> clarifyIssue (AnItem beh (anIssue NoMatchingItems)) $ do

220232 checkCompatibility (beh >>> step InItems) env $ ProdCons prodTopSchema cons'

233+

221234 TupleItems (map snd -> fs) -> case foldSome (<>) prods $ \case

222− TupleItems (map snd -> fs') -> Just (Just $ fs' NE.:| [], Just . Max $ genericLength fs', Just . Min $ genericLength fs', mempty)

223− MinItems m' -> Just (mempty, Just . Max $ m', mempty, mempty)

224− MaxItems m' -> Just (mempty, mempty, Just . Min $ m', mempty)

225− Items _ rs -> Just (mempty, mempty, mempty, Just (rs NE.:| []))

226− _ -> Nothing of

227− -- if the length constraints in the producer are contradictory:

228− Just (_, Just (Max lowest), Just (Min highest), _) | lowest > highest -> pure ()

229− -- We have an explicit tuple items clause...

230− Just (Just pfs, Just (Max plen), _, _)

231− | plen /= genericLength fs -> -- ...of wrong length

232− issueAt beh (TupleItemsLengthChanged ProdCons {producer = plen, consumer = genericLength fs})

233− | otherwise ->

234− for_ [0 .. plen - 1] $ \i -> do

235+ TupleItems (map snd -> fs') -> Just (Just $ fs' NE.:| [], Just . Max $ genericLength fs', Just . Min $ genericLength fs', mempty)

236+ MinItems m' -> Just (mempty, Just . Max $ m', mempty, mempty)

237+ MaxItems m' -> Just (mempty, mempty, Just . Min $ m', mempty)

238+ Items _ rs -> Just (mempty, mempty, mempty, Just (rs NE.:| []))

239+ _ -> Nothing

240+ of

241+ -- if the length constraints in the producer are contradictory:

242+ Just (_, Just (Max lowest), Just (Min highest), _) | lowest > highest -> pure ()

243+ -- We have an explicit tuple items clause...

244+ Just (Just pfs, Just (Max plen), _, _)

245+ | plen /= genericLength fs -- ...of wrong length

246+ -> issueAt beh (TupleItemsLengthChanged ProdCons {producer = plen, consumer = genericLength fs})

247+ | otherwise

248+ -> for_ [0 .. plen - 1] $ \i -> do

235249 checkCompatibility (beh >>> step (InItem i)) env $ ProdCons (tracedConjunct $ (`genericIndex` i) <$> pfs) (fs `genericIndex` i)

236− -- We have a fixed length array in the producer...

237− Just (Nothing, Just (Max plen), Just (Min plen'), mProd)

238− | plen == plen' ->

239− clarifyIssue (AnItem beh (anIssue ArrayToTuple)) $ case mProd of

240− _

241− | plen /= genericLength fs -> -- ...of wrong length

242− issueAt beh (TupleItemsLengthChanged ProdCons {producer = plen, consumer = genericLength fs})

250+ -- We have a fixed length array in the producer...

251+ Just (Nothing, Just (Max plen), Just (Min plen'), mProd)

252+ | plen == plen'

253+ -> clarifyIssue (AnItem beh (anIssue ArrayToTuple)) $ case mProd of

254+ _ | plen /= genericLength fs -> -- ...of wrong length

255+ issueAt beh (TupleItemsLengthChanged ProdCons {producer = plen, consumer = genericLength fs})

243256 Just rs -> for_ [0 .. plen - 1] $ \i -> do

244257 checkCompatibility (beh >>> step (InItem i)) env $ ProdCons (tracedConjunct rs) (fs `genericIndex` i)

245258 -- ...and no "items" schema

246259 Nothing -> clarifyIssue (AnItem beh (anIssue NoMatchingTupleItems)) $ do

247260 for_ [0 .. plen - 1] $ \i -> do

248261 checkCompatibility (beh >>> step (InItem i)) env $ ProdCons prodTopSchema (fs `genericIndex` i)

249− _ -> issueAt beh NoMatchingTupleItems

262+ _ -> issueAt beh NoMatchingTupleItems

263+

250264 MaxItems m -> foldCheck min m NoMatchingMaxItems MatchingMaxItemsWeak $ \case

251265 MaxItems m' -> Just m'

252266 TupleItems fs -> Just $ toInteger $ length fs

253267 _ -> Nothing

268+

254269 MinItems m -> foldCheck max m NoMatchingMinItems MatchingMinItemsWeak $ \case

255270 MinItems m' -> Just m'

256271 TupleItems fs -> Just $ toInteger $ length fs

257272 _ -> Nothing

273+

258274 UniqueItems -> case flip any prods $ \case

259− UniqueItems -> True

260− MaxItems 1 -> True

261− TupleItems fs | length fs == 1 -> True

262− _ -> False of

275+ UniqueItems -> True

276+ MaxItems 1 -> True

277+ TupleItems fs | length fs == 1 -> True

278+ _ -> False

279+ of

263280 True -> pure ()

264281 False -> issueAt beh NoMatchingUniqueItems

282+

265283 Properties props _ madd -> case foldSome (<>) prods $ \case

266− Properties props' _ madd' -> Just $ (props', madd') NE.:| []

267− _ -> Nothing of

284+ Properties props' _ madd' -> Just $ (props', madd') NE.:| []

285+ _ -> Nothing

286+ of

268287 Just pm ->

269288 anyOfAt beh NoMatchingProperties $ -- TODO: could first "concat" the lists

270289 NE.toList pm <&> \(props', madd') -> do

@@ -295,9 +314,11 @@ checkImplication env beh trs prods cons = case findExactly prods of

295314 (Just add', Just add) -> checkCompatibility (beh >>> step InAdditionalProperty) env (ProdCons add' add)

296315 pure ()

297316 Nothing -> issueAt beh NoMatchingProperties

317+

298318 MaxProperties m -> foldCheck min m NoMatchingMaxProperties MatchingMaxPropertiesWeak $ \case

299319 MaxProperties m' -> Just m'

300320 _ -> Nothing

321+

301322 MinProperties m -> foldCheck max m NoMatchingMinProperties MatchingMinPropertiesWeak $ \case

302323 MinProperties m' -> Just m'

303324 _ -> Nothing

@@ -305,14 +326,14 @@ checkImplication env beh trs prods cons = case findExactly prods of

305326 lcmScientific (toRational -> a) (toRational -> b) =

306327 fromRational $ lcm (numerator a) (numerator b) % gcd (denominator a) (denominator b)

307328

308− foldCheck ::

309− Eq a =>

310− (a -> a -> a) ->

311− a ->

312− (a -> Issue 'TypedSchemaLevel) ->

313− (ProdCons a -> Issue 'TypedSchemaLevel) ->

314− (forall t. Condition t -> Maybe a) ->

315− SemanticCompatFormula ()

329+ foldCheck

330+ :: Eq a

331+ => (a -> a -> a)

332+ -> a

333+ -> (a -> Issue 'TypedSchemaLevel)

334+ -> (ProdCons a -> Issue 'TypedSchemaLevel)

335+ -> (forall t. Condition t -> Maybe a)

336+ -> SemanticCompatFormula ()

316337 foldCheck f m missing weak extr = case foldSome f prods extr of

317338 Just m'

318339 | f m' m == m' -> pure ()

src/Data/OpenApi/Compare/Validate/Schema/DNF.hs+8−8

@@ -1,12 +1,12 @@

11module Data.OpenApi.Compare.Validate.Schema.DNF

2− ( DNF (..),

3− Disjunct (..),

4− pattern SingleDisjunct,

5− pattern TopDNF,

6− pattern BottomDNF,

7− pattern LiteralDNF,

8− foldDNF,

9− forDNF,

2+ ( DNF (..)

3+ , Disjunct (..)

4+ , pattern SingleDisjunct

5+ , pattern TopDNF

6+ , pattern BottomDNF

7+ , pattern LiteralDNF

8+ , foldDNF

9+ , forDNF

1010 )

1111where

1212

src/Data/OpenApi/Compare/Validate/Schema/Issues.hs+51−53

@@ -1,8 +1,8 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

22

33module Data.OpenApi.Compare.Validate.Schema.Issues

4− ( Issue (..),

5− Behave (..),

4+ ( Issue (..)

5+ , Behave (..)

66 )

77where

88

@@ -100,54 +100,53 @@ instance Issuable 'TypedSchemaLevel where

100100 TypeBecomesEmpty -> ProbablyIssue -- TODO: #70

101101 PartitionBecomesEmpty _ -> ProbablyIssue -- ditto

102102 _ -> CertainIssue

103− relatedIssues =

104− (==) `withClass` \case

103+ relatedIssues = (==) `withClass` \case

105104 EnumDoesntSatisfy v -> Just v

106105 NoMatchingEnum v -> Just v

107106 _ -> Nothing

108− `withClass` \case

109− NoMatchingMaximum _ -> Just ()

110− MatchingMaximumWeak _ -> Just ()

111− _ -> Nothing

112− `withClass` \case

113− NoMatchingMinimum _ -> Just ()

114− MatchingMinimumWeak _ -> Just ()

115− _ -> Nothing

116− `withClass` \case

117− NoMatchingMultipleOf _ -> Just ()

118− MatchingMultipleOfWeak _ -> Just ()

119− _ -> Nothing

120− `withClass` \case

121− NoMatchingMaxLength _ -> Just ()

122− MatchingMaxLengthWeak _ -> Just ()

123− _ -> Nothing

124− `withClass` \case

125− NoMatchingMinLength _ -> Just ()

126− MatchingMinLengthWeak _ -> Just ()

127− _ -> Nothing

128− `withClass` \case

129− NoMatchingItems -> Just ()

130− ArrayToTuple -> Just ()

131− TupleToArray -> Just ()

132− NoMatchingTupleItems -> Just ()

133− TupleItemsLengthChanged _ -> Just ()

134− _ -> Nothing

135− `withClass` \case

136− NoMatchingMaxItems _ -> Just ()

137− MatchingMaxItemsWeak _ -> Just ()

138− _ -> Nothing

139− `withClass` \case

140− NoMatchingMinItems _ -> Just ()

141− MatchingMinItemsWeak _ -> Just ()

142− _ -> Nothing

143− `withClass` \case

144− NoMatchingMaxProperties _ -> Just ()

145− MatchingMaxPropertiesWeak _ -> Just ()

146− _ -> Nothing

147− `withClass` \case

148− NoMatchingMinProperties _ -> Just ()

149− MatchingMinPropertiesWeak _ -> Just ()

150− _ -> Nothing

107+ `withClass` \case

108+ NoMatchingMaximum _ -> Just ()

109+ MatchingMaximumWeak _ -> Just ()

110+ _ -> Nothing

111+ `withClass` \case

112+ NoMatchingMinimum _ -> Just ()

113+ MatchingMinimumWeak _ -> Just ()

114+ _ -> Nothing

115+ `withClass` \case

116+ NoMatchingMultipleOf _ -> Just ()

117+ MatchingMultipleOfWeak _ -> Just ()

118+ _ -> Nothing

119+ `withClass` \case

120+ NoMatchingMaxLength _ -> Just ()

121+ MatchingMaxLengthWeak _ -> Just ()

122+ _ -> Nothing

123+ `withClass` \case

124+ NoMatchingMinLength _ -> Just ()

125+ MatchingMinLengthWeak _ -> Just ()

126+ _ -> Nothing

127+ `withClass` \case

128+ NoMatchingItems -> Just ()

129+ ArrayToTuple -> Just ()

130+ TupleToArray -> Just ()

131+ NoMatchingTupleItems -> Just ()

132+ TupleItemsLengthChanged _ -> Just ()

133+ _ -> Nothing

134+ `withClass` \case

135+ NoMatchingMaxItems _ -> Just ()

136+ MatchingMaxItemsWeak _ -> Just ()

137+ _ -> Nothing

138+ `withClass` \case

139+ NoMatchingMinItems _ -> Just ()

140+ MatchingMinItemsWeak _ -> Just ()

141+ _ -> Nothing

142+ `withClass` \case

143+ NoMatchingMaxProperties _ -> Just ()

144+ MatchingMaxPropertiesWeak _ -> Just ()

145+ _ -> Nothing

146+ `withClass` \case

147+ NoMatchingMinProperties _ -> Just ()

148+ MatchingMinPropertiesWeak _ -> Just ()

149+ _ -> Nothing

151150 describeIssue Forward (EnumDoesntSatisfy v) = para "The following enum value was removed:" <> showJSONValue v

152151 describeIssue Backward (EnumDoesntSatisfy v) = para "The following enum value was added:" <> showJSONValue v

153152 describeIssue Forward (NoMatchingEnum v) = para "The following enum value has been added:" <> showJSONValue v

@@ -255,15 +254,14 @@ instance Issuable 'SchemaLevel where

255254 PropertyToAdditional -> Comment

256255 TypesRestricted _ -> ProbablyIssue -- TODO: #70

257256 _ -> CertainIssue

258− relatedIssues =

259− (==) `withClass` \case

257+ relatedIssues = (==) `withClass` \case

260258 AdditionalToProperty -> Just ()

261259 PropertyToAdditional -> Just ()

262260 _ -> Nothing

263− `withClass` \case

264− PropertyNowRequired -> Just ()

265− UnexpectedProperty -> Just ()

266− _ -> Nothing

261+ `withClass` \case

262+ PropertyNowRequired -> Just ()

263+ UnexpectedProperty -> Just ()

264+ _ -> Nothing

267265 describeIssue _ (NotSupported i) =

268266 para (emph "Encountered a feature that CompaREST does not support: " <> text i <> ".")

269267 describeIssue _ OneOfNotDisjoint =

src/Data/OpenApi/Compare/Validate/Schema/JsonFormula.hs+48−56

@@ -1,27 +1,26 @@

11module Data.OpenApi.Compare.Validate.Schema.JsonFormula

2− ( Bound (..),

3− showBound,

4− Property (..),

5− Condition (..),

6− showCondition,

7− satisfiesTyped,

8− checkStringFormat,

9− checkNumberFormat,

10− SomeCondition (..),

11− JsonFormula (..),

12− satisfiesFormula,

13− satisfies,

14− showJSONValue,

15− showJSONValueInline,

2+ ( Bound (..)

3+ , showBound

4+ , Property (..)

5+ , Condition (..)

6+ , showCondition

7+ , satisfiesTyped

8+ , checkStringFormat

9+ , checkNumberFormat

10+ , SomeCondition (..)

11+ , JsonFormula (..)

12+ , satisfiesFormula

13+ , satisfies

14+ , showJSONValue

15+ , showJSONValueInline

1616 )

1717where

1818

1919import Algebra.Lattice

2020import qualified Data.Aeson as A

21−import qualified Data.Aeson.Key as Key

22−import qualified Data.Aeson.KeyMap as KeyMap

2321import qualified Data.ByteString.Lazy as BSL

2422import qualified Data.Foldable as F

23+import qualified Data.HashMap.Strict as HM

2524import Data.Functor

2625import Data.Int

2726import Data.Kind

@@ -40,7 +39,7 @@ import Data.Text (Text)

4039import qualified Data.Text as T

4140import qualified Data.Text.Encoding as T

4241import Data.Typeable

43−import Text.Pandoc.Builder hiding (Format)

42+import Text.Pandoc.Builder hiding (Format, Null)

4443import Text.Regex.Pcre2

4544

4645data Bound a = Exclusive !a | Inclusive !a

@@ -68,33 +67,30 @@ data Property = Property

6867data Condition :: JsonType -> Type where

6968 Exactly :: TypedValue t -> Condition t

7069 Maximum :: !(Bound Scientific) -> Condition 'Number

71− Minimum ::

72− !(Down (Bound (Down Scientific))) ->

73− -- | this has the right Ord

74− Condition 'Number

70+ Minimum

71+ :: !(Down (Bound (Down Scientific)))

72+ -> Condition 'Number -- ^ this has the right Ord

7573 MultipleOf :: !Scientific -> Condition 'Number

7674 NumberFormat :: !Format -> Condition 'Number

7775 MaxLength :: !Integer -> Condition 'String

7876 MinLength :: !Integer -> Condition 'String

7977 Pattern :: !Pattern -> Condition 'String

8078 StringFormat :: !Format -> Condition 'String

81− Items ::

82− !(ForeachType JsonFormula) ->

83− !(Traced (Referenced Schema)) ->

84− Condition 'Array

85− TupleItems ::

86− ![(ForeachType JsonFormula, Traced (Referenced Schema))] ->

87− Condition 'Array

79+ Items

80+ :: !(ForeachType JsonFormula)

81+ -> !(Traced (Referenced Schema))

82+ -> Condition 'Array

83+ TupleItems

84+ :: ![(ForeachType JsonFormula, Traced (Referenced Schema))]

85+ -> Condition 'Array

8886 MaxItems :: !Integer -> Condition 'Array

8987 MinItems :: !Integer -> Condition 'Array

9088 UniqueItems :: Condition 'Array

91− Properties ::

92− !(M.Map Text Property) ->

93− -- | formula for additional properties

94− !(ForeachType JsonFormula) ->

95− -- | schema for additional properties, Nothing means bottom

96− !(Maybe (Traced (Referenced Schema))) ->

97− Condition 'Object

89+ Properties

90+ :: !(M.Map Text Property)

91+ -> !(ForeachType JsonFormula) -- ^ formula for additional properties

92+ -> !(Maybe (Traced (Referenced Schema))) -- ^ schema for additional properties, Nothing means bottom

93+ -> Condition 'Object

9894 MaxProperties :: !Integer -> Condition 'Object

9995 MinProperties :: !Integer -> Condition 'Object

10096

@@ -122,15 +118,13 @@ showCondition = \case

122118 UniqueItems -> para "The elements in the array should be unique."

123119 (Properties props additional _) ->

124120 bulletList $

125− ( M.toList props

126− <&> ( \(k, p) ->

127− para (code k)

128− <> para (strong $ if propRequired p then "Required" else "Optional")

129− <> showForEachJsonFormula (propFormula p)

130− )

131− )

121+ (M.toList props

122+ <&> (\(k, p) ->

123+ para (code k)

124+ <> para (strong $ if propRequired p then "Required" else "Optional")

125+ <> showForEachJsonFormula (propFormula p)))

132126 <> [ para (emph "Additional properties")

133− <> showForEachJsonFormula additional

127+ <> showForEachJsonFormula additional

134128 ]

135129 (MaxProperties n) -> para $ "The maximum number of fields should be " <> show' n <> "."

136130 (MinProperties n) -> para $ "The minimum number of fields should be " <> show' n <> "."

@@ -139,17 +133,15 @@ showCondition = \case

139133 showForEachJsonFormula i =

140134 bulletList $

141135 foldType

142− ( \t f -> case getJsonFormula $ f i of

143− BottomDNF -> mempty

144− (DNF conds) ->

136+ (\t f -> case getJsonFormula $ f i of

137+ BottomDNF -> mempty

138+ (DNF conds) ->

145139 [ para (describeJSONType t)

146140 <> bulletList

147− ( S.toList conds <&> \case

148− Disjunct (S.toList -> []) -> para "Empty"

149− Disjunct (S.toList -> cond) -> bulletList (showCondition <$> cond)

150− )

151− ]

152− )

141+ (S.toList conds <&> \case

142+ Disjunct (S.toList -> []) -> para "Empty"

143+ Disjunct (S.toList -> cond) -> bulletList (showCondition <$> cond))

144+ ])

153145

154146showJSONValue :: A.Value -> Blocks

155147showJSONValue v = codeBlockWith ("", ["json"], mempty) (T.decodeUtf8 . BSL.toStrict . A.encode $ v)

@@ -178,10 +170,10 @@ satisfiesTyped (TArray a) (MaxItems m) = fromIntegral (F.length a) <= m

178170satisfiesTyped (TArray a) (MinItems m) = fromIntegral (F.length a) >= m

179171satisfiesTyped (TArray a) UniqueItems = S.size (S.fromList $ F.toList a) == F.length a -- TODO: could be better #36

180172satisfiesTyped (TObject o) (Properties props additional _) =

181− all (`KeyMap.member` o) (map Key.fromText $ M.keys (M.filter propRequired props))

182− && all (\(k, v) -> satisfies v $ maybe additional propFormula $ M.lookup (Key.toText k) props) (KeyMap.toList o)

183−satisfiesTyped (TObject o) (MaxProperties m) = fromIntegral (KeyMap.size o) <= m

184−satisfiesTyped (TObject o) (MinProperties m) = fromIntegral (KeyMap.size o) >= m

173+ all (`HM.member` o) (M.keys (M.filter propRequired props))

174+ && all (\(k, v) -> satisfies v $ maybe additional propFormula $ M.lookup k props) (HM.toList o)

175+satisfiesTyped (TObject o) (MaxProperties m) = fromIntegral (HM.size o) <= m

176+satisfiesTyped (TObject o) (MinProperties m) = fromIntegral (HM.size o) >= m

185177

186178checkNumberFormat :: Format -> Scientific -> Bool

187179checkNumberFormat "int32" (toRational -> n) =

src/Data/OpenApi/Compare/Validate/Schema/Partition.hs+30−34

@@ -1,22 +1,21 @@

11module Data.OpenApi.Compare.Validate.Schema.Partition

2− ( partitionSchema,

3− partitionRefSchema,

4− selectPartition,

5− runPartitionM,

6− tryPartition,

7− showPartition,

8− intersectSchema,

9− intersectRefSchema,

10− IntersectionResult (..),

11− runIntersectionM,

12− Partition,

2+ ( partitionSchema

3+ , partitionRefSchema

4+ , selectPartition

5+ , runPartitionM

6+ , tryPartition

7+ , showPartition

8+ , intersectSchema

9+ , intersectRefSchema

10+ , IntersectionResult (..)

11+ , runIntersectionM

12+ , Partition

1313 )

1414where

1515

1616import Algebra.Lattice

1717import Algebra.Lattice.Lifted

1818import Control.Applicative

19−import Control.Monad (when)

2019import Control.Monad.Reader hiding (ask)

2120import qualified Control.Monad.Reader as R

2221import Control.Monad.State

@@ -32,7 +31,6 @@ import qualified Data.List as L

3231import qualified Data.List.NonEmpty as NE

3332import qualified Data.Map as M

3433import Data.Maybe

35−import Data.Monoid

3634import Data.OpenApi

3735import Data.OpenApi.Compare.Memo

3836import Data.OpenApi.Compare.References

@@ -45,8 +43,7 @@ import Data.Ord

4543import qualified Data.Set as S

4644import Data.Text (Text)

4745import qualified Data.Text as T

48−import Data.Traversable (forM)

49−import Text.Pandoc.Builder hiding (Format)

46+import Text.Pandoc.Builder hiding (Format, Null)

5047

5148data PartitionData

5249 = DByEnumValue (DNF (S.Set A.Value))

@@ -146,11 +143,10 @@ partitionCondition = \case

146143 Just _ -> top

147144 Nothing ->

148145 singletonPart $

149− DByProperties $

150− LiteralDNF

151− ( M.keysSet $ M.filter (not . propRequired) props

152− , M.keysSet $ M.filter propRequired props

153− )

146+ DByProperties $ LiteralDNF

147+ ( M.keysSet $ M.filter (not . propRequired) props

148+ , M.keysSet $ M.filter propRequired props

149+ )

154150 inProps <- forM (M.toList $ M.filter propRequired props) $ \(k, prop) -> do

155151 f <- partitionRefSchema $ propRefSchema prop

156152 pure $ fmap (\(Partitions m) -> Partitions $ M.mapKeysMonotonic (PInProperty k) m) f

@@ -160,10 +156,10 @@ partitionCondition = \case

160156runPartitionM :: Traced (Definitions Schema) -> PartitionM a -> a

161157runPartitionM defs = runIdentity . runMemo () . (`runReaderT` defs)

162158

163−partitionJsonFormulas ::

164− ProdCons (Traced (Definitions Schema)) ->

165− ProdCons (JsonFormula t) ->

166− Lifted Partitions

159+partitionJsonFormulas

160+ :: ProdCons (Traced (Definitions Schema))

161+ -> ProdCons (JsonFormula t)

162+ -> Lifted Partitions

167163partitionJsonFormulas defs pc = producer pcPart \/ consumer pcPart

168164 where

169165 pcPart = partitionFormula <$> defs <*> pc

@@ -215,11 +211,11 @@ runIntersectionM defs act = case runWriterT $ runReaderT act defs of

215211 Just (x, Any False) -> Same x

216212 Just (x, Any True) -> New x

217213

218−intersectSchema ::

219− PartitionLocation ->

220− PartitionChoice ->

221− Traced Schema ->

222− IntersectionM Schema

214+intersectSchema

215+ :: PartitionLocation

216+ -> PartitionChoice

217+ -> Traced Schema

218+ -> IntersectionM Schema

223219intersectSchema loc part sch = do

224220 allOf' <- forM (tracedAllOf sch) $ \rss ->

225221 -- Assuming i ranges over a nonempty set (checked in processSchema)

@@ -262,11 +258,11 @@ intersectSchema loc part sch = do

262258 pure $ sch' {_schemaEnum = Just enum'}

263259 CByProperties {} -> error "CByProperties not implemented"

264260

265−intersectRefSchema ::

266− PartitionLocation ->

267− PartitionChoice ->

268− Traced (Referenced Schema) ->

269− IntersectionM (Referenced Schema)

261+intersectRefSchema

262+ :: PartitionLocation

263+ -> PartitionChoice

264+ -> Traced (Referenced Schema)

265+ -> IntersectionM (Referenced Schema)

270266intersectRefSchema loc part rs = do

271267 defs <- R.ask

272268 Inline <$> intersectSchema loc part (dereference defs rs)

src/Data/OpenApi/Compare/Validate/Schema/Process.hs+48−47

@@ -1,11 +1,11 @@

11module Data.OpenApi.Compare.Validate.Schema.Process

2− ( schemaToFormula,

2+ ( schemaToFormula

33 )

44where

55

66import Algebra.Lattice

7−import Control.Monad.Reader hiding (ask)

87import qualified Control.Monad.Reader as R

8+import Control.Monad.Reader hiding (ask)

99import Control.Monad.State

1010import Control.Monad.Writer

1111import qualified Data.Aeson as A

@@ -13,7 +13,6 @@ import Data.Functor.Identity

1313import qualified Data.HashMap.Strict.InsOrd as IOHM

1414import qualified Data.Map as M

1515import Data.Maybe

16−import Data.Monoid

1716import Data.OpenApi hiding (get)

1817import Data.OpenApi.Compare.Behavior

1918import Data.OpenApi.Compare.Memo

@@ -29,7 +28,6 @@ import Data.OpenApi.Compare.Validate.Schema.Traced

2928import Data.OpenApi.Compare.Validate.Schema.TypedJson

3029import Data.Ord

3130import qualified Data.Set as S

32−import Data.Traversable (forM)

3331

3432-- | A fake writer monad that doesn't actually record anything and allows lazy recursion.

3533newtype Silent w a = Silent {runSilent :: a}

@@ -41,11 +39,15 @@ instance Monoid w => MonadWriter w (Silent w) where

4139 listen (Silent x) = Silent (x, mempty)

4240 pass (Silent (x, _)) = Silent x

4341

42+instance MonadState (MemoState ()) (Silent w) where

43+ get = Silent $ runIdentity $ runMemo () get

44+ put _ = pure ()

45+

4446type ProcessM = StateT (MemoState ()) (ReaderT (Traced (Definitions Schema)) (Writer (P.PathsPrefixTree Behave AnIssue 'SchemaLevel)))

4547

46−type SilentM = StateT (MemoState ()) (ReaderT (Traced (Definitions Schema)) (Silent (P.PathsPrefixTree Behave AnIssue 'SchemaLevel)))

48+type SilentM = ReaderT (Traced (Definitions Schema)) (Silent (P.PathsPrefixTree Behave AnIssue 'SchemaLevel))

4749

48−-- Either ProcessM or SilentM

50+-- Either SilentM or ProcessM

4951type MonadProcess m =

5052 ( MonadReader (Traced (Definitions Schema)) m

5153 , MonadWriter (P.PathsPrefixTree Behave AnIssue 'SchemaLevel) m

@@ -55,11 +57,11 @@ type MonadProcess m =

5557warn :: MonadProcess m => Issue 'SchemaLevel -> m ()

5658warn issue = tell $ P.singleton $ AnItem Root $ anIssue issue

5759

58−-- Perform a computation lazily, ignoring the warnings and discarding memoization/loop detection information.

59−lazily :: MonadProcess m => SilentM a -> m a

60−lazily m = do

60+-- | Ignore warnings but allow a recursive loop that lazily computes a recursive 'Condition'.

61+silently :: MonadProcess m => SilentM a -> m a

62+silently m = do

6163 defs <- R.ask

62− pure $ runSilent $ runReaderT (runMemo () m) defs

64+ pure . runSilent $ runReaderT m defs

6365

6466warnKnot :: MonadProcess m => KnotTier (ForeachType JsonFormula) () m

6567warnKnot =

@@ -69,10 +71,10 @@ warnKnot =

6971 , tieKnot = \_ -> pure

7072 }

7173

72−processRefSchema ::

73− MonadProcess m =>

74− Traced (Referenced Schema) ->

75− m (ForeachType JsonFormula)

74+processRefSchema

75+ :: MonadProcess m

76+ => Traced (Referenced Schema)

77+ -> m (ForeachType JsonFormula)

7678processRefSchema x = do

7779 defs <- R.ask

7880 memoWithKnot warnKnot (processSchema $ dereference defs x) (ask x)

@@ -80,10 +82,10 @@ processRefSchema x = do

8082-- | Turn a schema into a tuple of 'JsonFormula's that describes the condition

8183-- for every possible type of a JSON value. The conditions are independent, and

8284-- are thus checked independently.

83−processSchema ::

84− MonadProcess m =>

85− Traced Schema ->

86− m (ForeachType JsonFormula)

85+processSchema

86+ :: MonadProcess m

87+ => Traced Schema

88+ -> m (ForeachType JsonFormula)

8789processSchema sch@(extract -> Schema {..}) = do

8890 let singletonFormula :: Condition t -> JsonFormula t

8991 singletonFormula = JsonFormula . LiteralDNF

@@ -241,11 +243,11 @@ processSchema sch@(extract -> Schema {..}) = do

241243 itemsClause <- case tracedItems sch of

242244 Nothing -> pure top

243245 Just (Left rs) -> do

244− f <- lazily $ processRefSchema rs

246+ f <- silently $ processRefSchema rs

245247 pure top {forArray = singletonFormula $ Items f rs}

246248 Just (Right rss) -> do

247249 fsrs <- forM rss $ \rs -> do

248− f <- lazily $ processRefSchema rs

250+ f <- silently $ processRefSchema rs

249251 pure (f, rs)

250252 pure top {forArray = singletonFormula $ TupleItems fsrs}

251253

@@ -271,12 +273,12 @@ processSchema sch@(extract -> Schema {..}) = do

271273 _ -> top

272274

273275 (addProps, addPropSchema) <- case tracedAdditionalProperties sch of

274− Just (Right rs) -> (,Just rs) <$> lazily (processRefSchema rs)

276+ Just (Right rs) -> (,Just rs) <$> silently (processRefSchema rs)

275277 Just (Left False) -> pure (bottom, Nothing)

276278 _ -> pure (top, Just $ traced (ask sch `Snoc` AdditionalPropertiesStep) $ Inline mempty)

277279 propList <- forM (S.toList . S.fromList $ IOHM.keys _schemaProperties <> _schemaRequired) $ \k -> do

278280 (f, psch) <- case IOHM.lookup k $ tracedProperties sch of

279− Just rs -> (,rs) <$> lazily (processRefSchema rs)

281+ Just rs -> (,rs) <$> silently (processRefSchema rs)

280282 Nothing ->

281283 let fakeSchema = traced (ask sch `Snoc` AdditionalPropertiesStep) $ Inline mempty

282284 in -- The mempty here is incorrect, but if addPropSchema was Nothing, then

@@ -329,27 +331,26 @@ processSchema sch@(extract -> Schema {..}) = do

329331 pure $

330332 nullableClause

331333 \/ meets

332− ( allClauses

333− <> [ anyClause

334− , oneClause

335− , typeClause

336− , enumClause

337− , maximumClause

338− , minimumClause

339− , multipleOfClause

340− , formatClause

341− , maxLengthClause

342− , minLengthClause

343− , patternClause

344− , itemsClause

345− , maxItemsClause

346− , minItemsClause

347− , uniqueItemsClause

348− , propertiesClause

349− , maxPropertiesClause

350− , minPropertiesClause

351− ]

352− )

334+ (allClauses

335+ <> [ anyClause

336+ , oneClause

337+ , typeClause

338+ , enumClause

339+ , maximumClause

340+ , minimumClause

341+ , multipleOfClause

342+ , formatClause

343+ , maxLengthClause

344+ , minLengthClause

345+ , patternClause

346+ , itemsClause

347+ , maxItemsClause

348+ , minItemsClause

349+ , uniqueItemsClause

350+ , propertiesClause

351+ , maxPropertiesClause

352+ , minPropertiesClause

353+ ])

353354

354355{- TODO: ReadOnly/WriteOnly #68 -}

355356

@@ -368,8 +369,8 @@ checkOneOfDisjoint schs = do

368369runProcessM :: Traced (Definitions Schema) -> ProcessM a -> (a, P.PathsPrefixTree Behave AnIssue 'SchemaLevel)

369370runProcessM defs = runWriter . (`runReaderT` defs) . runMemo ()

370371

371−schemaToFormula ::

372− Traced (Definitions Schema) ->

373− Traced Schema ->

374− (ForeachType JsonFormula, P.PathsPrefixTree Behave AnIssue 'SchemaLevel)

372+schemaToFormula

373+ :: Traced (Definitions Schema)

374+ -> Traced Schema

375+ -> (ForeachType JsonFormula, P.PathsPrefixTree Behave AnIssue 'SchemaLevel)

375376schemaToFormula defs rs = runProcessM defs $ processSchema rs

src/Data/OpenApi/Compare/Validate/Schema/Traced.hs+12−12

@@ -1,18 +1,18 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

22

33module Data.OpenApi.Compare.Validate.Schema.Traced

4− ( Step (..),

5− tracedAllOf,

6− tracedAnyOf,

7− tracedOneOf,

8− tracedItems,

9− tracedAdditionalProperties,

10− tracedDiscriminator,

11− tracedProperties,

12− tracedConjunct,

13− PartitionLocation (..),

14− PartitionChoice (..),

15− Partition,

4+ ( Step (..)

5+ , tracedAllOf

6+ , tracedAnyOf

7+ , tracedOneOf

8+ , tracedItems

9+ , tracedAdditionalProperties

10+ , tracedDiscriminator

11+ , tracedProperties

12+ , tracedConjunct

13+ , PartitionLocation (..)

14+ , PartitionChoice (..)

15+ , Partition

1616 )

1717where

1818

src/Data/OpenApi/Compare/Validate/Schema/TypedJson.hs+23−25

@@ -1,11 +1,11 @@

11module Data.OpenApi.Compare.Validate.Schema.TypedJson

2− ( JsonType (..),

3− describeJSONType,

4− TypedValue (..),

5− untypeValue,

6− ForeachType (..),

7− foldType,

8− forType_,

2+ ( JsonType (..)

3+ , describeJSONType

4+ , TypedValue (..)

5+ , untypeValue

6+ , ForeachType (..)

7+ , foldType

8+ , forType_

99 )

1010where

1111

@@ -88,26 +88,24 @@ forType_ :: Applicative m => (forall x. Typeable x => JsonType -> (ForeachType f

8888forType_ k = getAp $ foldType (\ty proj -> Ap $ k ty proj)

8989

9090broadcastType :: (forall x. Typeable x => f x) -> ForeachType f

91−broadcastType k =

92− ForeachType

93− { forNull = k

94− , forBoolean = k

95− , forNumber = k

96− , forString = k

97− , forArray = k

98− , forObject = k

99− }

91+broadcastType k = ForeachType

92+ { forNull = k

93+ , forBoolean = k

94+ , forNumber = k

95+ , forString = k

96+ , forArray = k

97+ , forObject = k

98+ }

10099

101100zipType :: (forall x. Typeable x => f x -> g x -> h x) -> ForeachType f -> ForeachType g -> ForeachType h

102−zipType k f1 f2 =

103− ForeachType

104− { forNull = k (forNull f1) (forNull f2)

105− , forBoolean = k (forBoolean f1) (forBoolean f2)

106− , forNumber = k (forNumber f1) (forNumber f2)

107− , forString = k (forString f1) (forString f2)

108− , forArray = k (forArray f1) (forArray f2)

109− , forObject = k (forObject f1) (forObject f2)

110− }

101+zipType k f1 f2 = ForeachType

102+ { forNull = k (forNull f1) (forNull f2)

103+ , forBoolean = k (forBoolean f1) (forBoolean f2)

104+ , forNumber = k (forNumber f1) (forNumber f2)

105+ , forString = k (forString f1) (forString f2)

106+ , forArray = k (forArray f1) (forArray f2)

107+ , forObject = k (forObject f1) (forObject f2)

108+ }

111109

112110instance (forall x. Lattice (f x)) => Lattice (ForeachType f) where

113111 (\/) = zipType (\/)

src/Data/OpenApi/Compare/Validate/SecurityRequirement.hs+8−9

@@ -2,7 +2,7 @@

22{-# OPTIONS_GHC -Wno-orphans #-}

33

44module Data.OpenApi.Compare.Validate.SecurityRequirement

5− ( Issue (..),

5+ ( Issue (..)

66 )

77where

88

@@ -41,19 +41,18 @@ instance Subtree SecurityRequirement where

4141 for (IOHM.toList $ getSecurityRequirement sec) $ \(key, scopes) ->

4242 (,scopes) <$> lookupScheme key defs

4343 structuralMaybeWith

44− ( \pc' -> do

45− let ProdCons pScopes cScopes = fmap snd <$> pc'

46− unless (pScopes == cScopes) structuralIssue

47− structuralList env $ fmap fst <$> pc'

48− pure ()

49− )

44+ (\pc' -> do

45+ let ProdCons pScopes cScopes = fmap snd <$> pc'

46+ unless (pScopes == cScopes) structuralIssue

47+ structuralList env $ fmap fst <$> pc'

48+ pure ())

5049 normalized

5150 pure ()

5251 checkSemanticCompatibility env bhv' pc = do

5352 let schemes = getH @(ProdCons (Traced (Definitions SecurityScheme))) env

5453 ( ProdCons pErrs cErrs

55− , (ProdCons pSchemes cSchemes) ::

56− ProdCons [(Behavior 'SecuritySchemeLevel, Traced SecurityScheme, [Text])]

54+ , (ProdCons pSchemes cSchemes)

55+ :: ProdCons [(Behavior 'SecuritySchemeLevel, Traced SecurityScheme, [Text])]

5756 ) =

5857 NE.unzip $

5958 partitionEithers <$> do

src/Data/OpenApi/Compare/Validate/Server.hs+9−10

@@ -1,7 +1,7 @@

11{-# OPTIONS_GHC -Wno-orphans #-}

22

33module Data.OpenApi.Compare.Validate.Server

4− ( Issue (..),

4+ ( Issue (..)

55 )

66where

77

@@ -31,9 +31,9 @@ import Data.Traversable

3131import Text.Pandoc.Builder

3232import Prelude as P

3333

34−tracedParsedServerUrlParts ::

35− Server ->

36− Either (Issue 'ServerLevel) ProcessedServer

34+tracedParsedServerUrlParts

35+ :: Server

36+ -> Either (Issue 'ServerLevel) ProcessedServer

3737tracedParsedServerUrlParts s =

3838 let parsedUrl = parseServerUrl $ _serverUrl s

3939 lookupVar var = case IOHM.lookup var (_serverVariables s) of

@@ -63,12 +63,11 @@ instance Subtree [Server] where

6363 pcServer

6464 <&> partitionEithers

6565 . fmap

66− ( \(Traced t s) ->

67− let bhv = beh >>> step (InServer $ _serverUrl s)

68− in case tracedParsedServerUrlParts s of

69− Left e -> Left $ issueAt bhv e

70− Right u -> Right (bhv, Traced (t >>> step (ServerStep $ _serverUrl s)) u)

71− )

66+ (\(Traced t s) ->

67+ let bhv = beh >>> step (InServer $ _serverUrl s)

68+ in case tracedParsedServerUrlParts s of

69+ Left e -> Left $ issueAt bhv e

70+ Right u -> Right (bhv, Traced (t >>> step (ServerStep $ _serverUrl s)) u))

7271 . sequence

7372 sequenceA_ pErrs

7473 sequenceA_ cErrs

src/Data/OpenApi/Compare/Validate/Sums.hs+11−12

@@ -1,25 +1,24 @@

11module Data.OpenApi.Compare.Validate.Sums

2− ( checkSums,

3− )

4−where

2+ ( checkSums

3+ ) where

54

65import Data.Foldable

76import Data.Map.Strict (Map)

87import qualified Data.Map.Strict as M

98import Data.OpenApi.Compare.Behavior

10−import Data.OpenApi.Compare.Paths

119import Data.OpenApi.Compare.Subtree

10+import Data.OpenApi.Compare.Paths

1211

13−checkSums ::

14− (Ord k, Issuable l) =>

15− Paths q r l ->

16− (k -> Issue l) ->

17− (k -> ProdCons t -> CompatFormula' q AnIssue r ()) ->

18− ProdCons (Map k t) ->

19− CompatFormula' q AnIssue r ()

12+checkSums

13+ :: (Ord k, Issuable l)

14+ => Paths q r l

15+ -> (k -> Issue l)

16+ -> (k -> ProdCons t -> CompatFormula' q AnIssue r ())

17+ -> ProdCons (Map k t)

18+ -> CompatFormula' q AnIssue r ()

2019checkSums xs noElt check (ProdCons p c) = for_ (M.toList p) $ \(key, prodElt) ->

2120 case M.lookup key c of

2221 Nothing -> issueAt xs $ noElt key

2322 Just consElt ->

2423 let sumElts = ProdCons prodElt consElt

25− in check key sumElts

24+ in check key sumElts

src/Data/OpenUnion/Extra.hs+5−5

@@ -1,7 +1,7 @@

11module Data.OpenUnion.Extra

2− ( (@@>),

3− TryLiftUnion (..),

4− pattern SingletonUnion,

2+ ( (@@>)

3+ , TryLiftUnion (..)

4+ , pattern SingletonUnion

55 )

66where

77

@@ -18,8 +18,8 @@ instance TryLiftUnion '[] where

1818 tryLiftUnion _ = empty

1919

2020instance

21− (Typeable y, SubList ys (y : ys), TryLiftUnion ys) =>

22− TryLiftUnion (y ': ys)

21+ (Typeable y, SubList ys (y : ys), TryLiftUnion ys)

22+ => TryLiftUnion (y ': ys)

2323 where

2424 tryLiftUnion (x :: x) = case eqT @x @y of

2525 Nothing -> reUnion <$> tryLiftUnion @ys x

stack.yaml+6−18

@@ -1,23 +1,11 @@

1−resolver: lts-22.34

2−

3−packages:

4− - .

1+resolver: lts-18.4

52

63extra-deps:

7− - base16-bytestring-1.0.2.0

8− - freer-simple-1.2.1.2

9− - generics-sop-0.5.1.4

10− - github-0.29

11− - http-link-header-1.2.1

124 - open-union-0.4.0.0

13− - th-abstraction-0.7.0.0

145 - type-fun-0.1.3

15− - typerep-map-0.6.0.0

16−

17−# Required for freer-simple and typerep-map

18−allow-newer: true

6+ - github-0.26

7+ - base16-bytestring-0.1.1.7

8+ - http-link-header-1.0.3.1

199

20−nix:

21−# packages: [pkg-config yq zlib]

22− shell-file: ./nix/shell.nix

23− pure: false

10+apply-ghc-options: everything

11+rebuild-ghc-options: true

stack.yaml.lock+4−4

@@ -41,7 +41,7 @@ packages:

4141 hackage: http-link-header-1.0.3.1

4242snapshots:

4343- completed:

44− size: 587393

45− url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/18/25.yaml

46− sha256: 1b74fb5e970497b5aefae56703f1bd44aa648bd1a5ef95c1eb8c29775087e2bf

47− original: lts-18.25

44+ size: 585817

45+ url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/18/4.yaml

46+ sha256: ea3a318eafa9e9cc56bfbe46099fd0d54d32641ab7bbe1d182ed8f5de39f804c

47+ original: lts-18.4

test/Spec/Golden/Extra.hs+44−48

@@ -1,8 +1,8 @@

11module Spec.Golden.Extra

2− ( getGoldenInputs,

3− getGoldenInputsUniform,

4− goldenInputsTree,

5− goldenInputsTreeUniform,

2+ ( getGoldenInputs

3+ , getGoldenInputsUniform

4+ , goldenInputsTree

5+ , goldenInputsTreeUniform

66 )

77where

88

@@ -19,12 +19,12 @@ data TestInput t

1919 | TestInputLeaf TestName t FilePath

2020 deriving stock (Functor)

2121

22−getGoldenInputs ::

23− (Each s t (FilePath, FilePath -> IO a) a) =>

24− TestName ->

25− FilePath ->

26− s ->

27− IO (TestInput t)

22+getGoldenInputs

23+ :: (Each s t (FilePath, FilePath -> IO a) a)

24+ => TestName

25+ -> FilePath

26+ -> s

27+ -> IO (TestInput t)

2828getGoldenInputs name filepath inp = do

2929 dirs' <- listDirectory filepath >>= filterM (doesDirectoryExist . (filepath </>))

3030 case dirs' of

@@ -39,55 +39,51 @@ getGoldenInputs name filepath inp = do

3939 TestInputNode name

4040 <$> forM dirs (\dir -> getGoldenInputs dir (filepath </> dir) inp)

4141

42−getGoldenInputsUniform ::

43− (Each t h (FilePath, FilePath -> IO a) a) =>

44− (Each s t FilePath (FilePath, FilePath -> IO a)) =>

45− TestName ->

46− (FilePath -> IO a) ->

47− FilePath ->

48− s ->

49− IO (TestInput h)

42+getGoldenInputsUniform

43+ :: (Each t h (FilePath, FilePath -> IO a) a)

44+ => (Each s t FilePath (FilePath, FilePath -> IO a))

45+ => TestName

46+ -> (FilePath -> IO a)

47+ -> FilePath

48+ -> s

49+ -> IO (TestInput h)

5050getGoldenInputsUniform name f filepath inp = getGoldenInputs name filepath $ inp & each %~ (,f)

5151

52−goldenInputsTree ::

53− (Each s t (FilePath, FilePath -> IO a) a) =>

54− TestName ->

55− -- | Root path

56− FilePath ->

57− -- | Name of golden file

58− FilePath ->

59− s ->

60− (t -> IO BSL.ByteString) ->

61− IO TestTree

62−goldenInputsTree name filepath golden inp f =

52+goldenInputsTree

53+ :: (Each s t (FilePath, FilePath -> IO a) a)

54+ => TestName

55+ -> FilePath -- ^ Root path

56+ -> FilePath -- ^ Name of golden file

57+ -> s

58+ -> (t -> IO BSL.ByteString)

59+ -> IO TestTree

60+goldenInputsTree name filepath golden inp f = do

6361 runTestInputTree golden f <$> getGoldenInputs name filepath inp

6462

65−runTestInputTree ::

66− FilePath ->

67− (t -> IO BSL.ByteString) ->

68− TestInput t ->

69− TestTree

63+runTestInputTree

64+ :: FilePath

65+ -> (t -> IO BSL.ByteString)

66+ -> TestInput t

67+ -> TestTree

7068runTestInputTree golden f (TestInputNode name rest) =

7169 testGroup name (runTestInputTree golden f <$> rest)

7270runTestInputTree golden f (TestInputLeaf name t path) =

7371 goldenVsStringDiff

7472 name

75− (\ref new -> ["diff-yaml", ref, new])

73+ (\ref new -> ["diff", "-u", ref, new])

7674 (path </> golden)

7775 (f t)

7876

79−goldenInputsTreeUniform ::

80− ( Each t h (FilePath, FilePath -> IO a) a

81− , Each s t FilePath (FilePath, FilePath -> IO a)

82− ) =>

83− String ->

84− -- | Root path

85− FilePath ->

86− -- | Name of golden file

87− FilePath ->

88− s ->

89− (FilePath -> IO a) ->

90− (h -> IO BSL.ByteString) ->

91− IO TestTree

77+goldenInputsTreeUniform

78+ :: ( Each t h (FilePath, FilePath -> IO a) a

79+ , Each s t FilePath (FilePath, FilePath -> IO a)

80+ )

81+ => String

82+ -> FilePath -- ^ Root path

83+ -> FilePath -- ^ Name of golden file

84+ -> s

85+ -> (FilePath -> IO a)

86+ -> (h -> IO BSL.ByteString)

87+ -> IO TestTree

9288goldenInputsTreeUniform name filepath golden inp h =

9389 goldenInputsTree name filepath golden (inp & each %~ (,h))

test/Spec/Golden/TraceTree.hs+2−2

@@ -25,7 +25,7 @@ tests = do

2525 traceTreeTests <-

2626 goldenInputsTreeUniform

2727 "TraceTree"

28− "test/golden"

28+ "test/golden/common"

2929 "trace-tree.yaml"

3030 ("a.yaml", "b.yaml")

3131 Yaml.decodeFileThrow

@@ -34,7 +34,7 @@ tests = do

3434 reportTests <-

3535 goldenInputsTreeUniform

3636 "Report"

37− "test/golden"

37+ "test/golden/common"

3838 "report.md"

3939 ("a.yaml", "b.yaml")

4040 Yaml.decodeFileThrow

test/golden/common/bad-oneof-unchanged/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes | [❓ Unsupported feature changes](#unsupported-changes) |

4−|---------------------|-------------------------|--------------------------------------------------------|

5−| 0 | 0 | 2 |

4+|--------------------|-------------------------|-------------------------------------------------------|

5+| 0 | 0 | 2 |

66

77# ❓ Unsupported feature changes

88

test/golden/common/enum-added/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 1 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 1 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/enum-anyof/report.md+2−2

@@ -1,5 +1,5 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes |

4−|---------------------|-------------------------|

5−| 0 | 0 |

4+|--------------------|-------------------------|

5+| 0 | 0 |

test/golden/common/id/report.md+2−2

@@ -1,5 +1,5 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes |

4−|---------------------|-------------------------|

5−| 0 | 0 |

4+|--------------------|-------------------------|

5+| 0 | 0 |

test/golden/common/json/recursive/report.md+2−2

@@ -1,5 +1,5 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes |

4−|---------------------|-------------------------|

5−| 0 | 0 |

4+|--------------------|-------------------------|

5+| 0 | 0 |

test/golden/common/maximum-lowered/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 1 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 1 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/parameters/allowEmptyValue/reset/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 1 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 1 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/parameters/allowEmptyValue/set/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|---------------------|--------------------------------------------------|

5−| 0 | 1 |

4+|--------------------|--------------------------------------------------|

5+| 0 | 1 |

66

77# ⚠️ Non-breaking changes

88

test/golden/common/pathItem/operation/parameters/change/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 1 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 1 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/parameters/required/false/add/report.md+2−2

@@ -1,5 +1,5 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes |

4−|---------------------|-------------------------|

5−| 0 | 0 |

4+|--------------------|-------------------------|

5+| 0 | 0 |

test/golden/common/pathItem/operation/parameters/required/false/del/report.md+2−2

@@ -1,5 +1,5 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes |

4−|---------------------|-------------------------|

5−| 0 | 0 |

4+|--------------------|-------------------------|

5+| 0 | 0 |

test/golden/common/pathItem/operation/parameters/required/reset/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|---------------------|--------------------------------------------------|

5−| 0 | 1 |

4+|--------------------|--------------------------------------------------|

5+| 0 | 1 |

66

77# ⚠️ Non-breaking changes

88

test/golden/common/pathItem/operation/parameters/required/set/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 1 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 1 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/parameters/required/true/add/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 1 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 1 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/parameters/required/true/del/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|---------------------|--------------------------------------------------|

5−| 0 | 1 |

4+|--------------------|--------------------------------------------------|

5+| 0 | 1 |

66

77# ⚠️ Non-breaking changes

88

test/golden/common/pathItem/operation/requestBody/mediaTypeObject/add/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|---------------------|--------------------------------------------------|

5−| 0 | 1 |

4+|--------------------|--------------------------------------------------|

5+| 0 | 1 |

66

77# ⚠️ Non-breaking changes

88

test/golden/common/pathItem/operation/requestBody/mediaTypeObject/change/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 1 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 1 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/requestBody/mediaTypeObject/del/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 1 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 1 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/requestBody/required/reset/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|---------------------|--------------------------------------------------|

5−| 0 | 1 |

4+|--------------------|--------------------------------------------------|

5+| 0 | 1 |

66

77# ⚠️ Non-breaking changes

88

test/golden/common/pathItem/operation/requestBody/required/set/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 1 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 1 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/responses/add/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 1 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 1 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/responses/change/headers/mandatory/add/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|---------------------|--------------------------------------------------|

5−| 0 | 1 |

4+|--------------------|--------------------------------------------------|

5+| 0 | 1 |

66

77# ⚠️ Non-breaking changes

88

test/golden/common/pathItem/operation/responses/change/headers/mandatory/del/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 1 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 1 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/responses/change/headers/optional/add/report.md+2−2

@@ -1,5 +1,5 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes |

4−|---------------------|-------------------------|

5−| 0 | 0 |

4+|--------------------|-------------------------|

5+| 0 | 0 |

test/golden/common/pathItem/operation/responses/change/headers/optional/del/report.md+2−2

@@ -1,5 +1,5 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes |

4−|---------------------|-------------------------|

5−| 0 | 0 |

4+|--------------------|-------------------------|

5+| 0 | 0 |

test/golden/common/pathItem/operation/responses/change/mediaTypeObject/add/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 1 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 1 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/responses/change/mediaTypeObject/change/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 1 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 1 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/pathItem/operation/responses/change/mediaTypeObject/del/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|---------------------|--------------------------------------------------|

5−| 0 | 1 |

4+|--------------------|--------------------------------------------------|

5+| 0 | 1 |

66

77# ⚠️ Non-breaking changes

88

test/golden/common/pathItem/operation/responses/del/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|---------------------|--------------------------------------------------|

5−| 0 | 1 |

4+|--------------------|--------------------------------------------------|

5+| 0 | 1 |

66

77# ⚠️ Non-breaking changes

88

test/golden/common/property-removed-additional/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 3 | 3 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 3 | 3 |

66

77# ❌ Breaking changes

88

test/golden/common/property-removed/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 2 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 2 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/property-required/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 1 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 1 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/random-example/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 5 | 6 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 5 | 6 |

66

77# ❌ Breaking changes

88

test/golden/common/random-example/trace-tree.yaml+4−4

@@ -23,10 +23,6 @@ forwardChanges:

2323backwardChanges:

2424 AtPath "/pets":

2525 InOperation GetMethod:

26− InParam "limit":

27− InParamSchema:

28− OfType Number: MatchingMaximumWeak (ProdCons {producer = Inclusive 30.0,

29− consumer = Inclusive 20.0})

3026 WithStatusCode 200:

3127 ResponsePayload:

3228 PayloadSchema:

@@ -37,6 +33,10 @@ backwardChanges:

3733 - TypesRestricted [Number]

3834 - AdditionalToProperty

3935 - OfType Number: NoMatchingMultipleOf 1.0

36+ InParam "limit":

37+ InParamSchema:

38+ OfType Number: MatchingMaximumWeak (ProdCons {producer = Inclusive 30.0,

39+ consumer = Inclusive 20.0})

4040 InOperation PostMethod:

4141 InRequest:

4242 InPayload:

test/golden/common/recursive/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 1 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 1 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/security-scheme/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 2 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 2 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/servers/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 3 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 3 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/tuple-items/heterogeneous-component-mismatch/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 2 | 2 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 2 | 2 |

66

77# ❌ Breaking changes

88

test/golden/common/tuple-items/heterogeneous-length-mismatch/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | ⚠️ Non-breaking changes |

4−|------------------------------------------|-------------------------|

5−| 2 | 0 |

4+|-----------------------------------------|-------------------------|

5+| 2 | 0 |

66

77# ❌ Breaking changes

88

test/golden/common/tuple-items/homogeneous-component-mismatch/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 4 | 2 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 4 | 2 |

66

77# ❌ Breaking changes

88

test/golden/common/tuple-items/homogeneous-length-mismatch/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 5 | 5 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 5 | 5 |

66

77# ❌ Breaking changes

88

test/golden/common/tuple-items/homogeneous-vector/report.md+2−2

@@ -1,5 +1,5 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes |

4−|---------------------|-------------------------|

5−| 0 | 0 |

4+|--------------------|-------------------------|

5+| 0 | 0 |

test/golden/common/type-changing/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 6 | 6 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 6 | 6 |

66

77# ❌ Breaking changes

88

test/golden/common/unguarded-recursive/basic/a.yaml → test/golden/common/unguarded-recursive/a.yamlrenamed

The content is the same.

test/golden/common/unguarded-recursive/basic/b.yaml → test/golden/common/unguarded-recursive/b.yamlrenamed

The content is the same.

test/golden/common/unguarded-recursive/basic/report.md → test/golden/common/unguarded-recursive/report.mdrenamed+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| ❌ Breaking changes | ⚠️ Non-breaking changes | [❓ Unsupported feature changes](#unsupported-changes) |

4−|---------------------|-------------------------|--------------------------------------------------------|

5−| 0 | 0 | 1 |

4+|--------------------|-------------------------|-------------------------------------------------------|

5+| 0 | 0 | 1 |

66

77# ❓ Unsupported feature changes

88

test/golden/common/unguarded-recursive/silent/a.yamldeleted−25

@@ -1,25 +0,0 @@

1−components:

2− schemas:

3− A:

4− type: object

5− properties:

6− bar:

7− $ref: "#/components/schemas/B"

8− B:

9− anyOf:

10− - $ref: "#/components/schemas/B"

11− type: object

12−openapi: 3.0.0

13−info:

14− version: ""

15− title: ""

16−paths:

17− /foo:

18− get:

19− responses:

20− "200":

21− content:

22− application/json;charset=utf-8:

23− schema:

24− $ref: "#/components/schemas/A"

25− description: ""

test/golden/common/unguarded-recursive/silent/b.yamldeleted−19

@@ -1,19 +0,0 @@

1−components:

2− schemas: {}

3−openapi: 3.0.0

4−info:

5− version: ""

6− title: ""

7−paths:

8− /foo:

9− get:

10− responses:

11− "200":

12− content:

13− application/json;charset=utf-8:

14− schema:

15− type: object

16− properties:

17− bar:

18− type: object

19− description: ""

test/golden/common/unguarded-recursive/silent/report.mddeleted−15

@@ -1,15 +0,0 @@

1−# Summary

2−

3−| ❌ Breaking changes | ⚠️ Non-breaking changes | [❓ Unsupported feature changes](#unsupported-changes) |

4−|---------------------|-------------------------|--------------------------------------------------------|

5−| 0 | 0 | 1 |

6−

7−# ❓ Unsupported feature changes

8−

9−## **GET** /foo

10−

11−### ⬅️☁️ JSON Response – 200

12−

13−#### `$.bar`

14−

15−Encountered recursion that is too complex for CompaREST to untangle.

test/golden/common/unguarded-recursive/silent/trace-tree.yamldeleted−16

@@ -1,16 +0,0 @@

1−forwardChanges:

2− AtPath "/foo":

3− InOperation GetMethod:

4− WithStatusCode 200:

5− ResponsePayload:

6− PayloadSchema:

7− OfType Object:

8− InProperty "bar": UnguardedRecursion

9−backwardChanges:

10− AtPath "/foo":

11− InOperation GetMethod:

12− WithStatusCode 200:

13− ResponsePayload:

14− PayloadSchema:

15− OfType Object:

16− InProperty "bar": UnguardedRecursion

test/golden/common/unguarded-recursive/basic/trace-tree.yaml → test/golden/common/unguarded-recursive/trace-tree.yamlrenamed

The content is the same.

test/golden/common/variant-added/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 1 | 1 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 1 | 1 |

66

77# ❌ Breaking changes

88

test/golden/common/variant-changed/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 2 | 2 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 2 | 2 |

66

77# ❌ Breaking changes

88

test/golden/common/variant-deep-changed/report.md+2−2

@@ -1,8 +1,8 @@

11# Summary

22

33| [❌ Breaking changes](#breaking-changes) | [⚠️ Non-breaking changes](#non-breaking-changes) |

4−|------------------------------------------|--------------------------------------------------|

5−| 2 | 2 |

4+|-----------------------------------------|--------------------------------------------------|

5+| 2 | 2 |

66

77# ❌ Breaking changes

88