backend.yml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358
  1. name: backend
  2. on:
  3. push:
  4. branches:
  5. - master
  6. pull_request:
  7. # Cancel in progress workflows on pull_requests.
  8. # https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
  9. concurrency:
  10. group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  11. cancel-in-progress: true
  12. # hack for https://github.com/actions/cache/issues/810#issuecomment-1222550359
  13. env:
  14. SEGMENT_DOWNLOAD_TIMEOUT_MINS: 3
  15. jobs:
  16. files-changed:
  17. name: detect what files changed
  18. runs-on: ubuntu-22.04
  19. timeout-minutes: 3
  20. # Map a step output to a job output
  21. outputs:
  22. api_docs: ${{ steps.changes.outputs.api_docs }}
  23. backend: ${{ steps.changes.outputs.backend_all }}
  24. backend_dependencies: ${{ steps.changes.outputs.backend_dependencies }}
  25. backend_any_type: ${{ steps.changes.outputs.backend_any_type }}
  26. migration_lockfile: ${{ steps.changes.outputs.migration_lockfile }}
  27. steps:
  28. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  29. - name: Check for backend file changes
  30. uses: dorny/paths-filter@0bc4621a3135347011ad047f9ecf449bf72ce2bd # v3.0.0
  31. id: changes
  32. with:
  33. token: ${{ github.token }}
  34. filters: .github/file-filters.yml
  35. api-docs:
  36. if: needs.files-changed.outputs.api_docs == 'true'
  37. needs: files-changed
  38. name: api docs test
  39. runs-on: ubuntu-22.04
  40. steps:
  41. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  42. - uses: getsentry/action-setup-volta@e4939d337b83760d13a9d7030a6f68c9d0ee7581 # v2.0.0
  43. - name: Setup sentry python env
  44. uses: ./.github/actions/setup-sentry
  45. id: setup
  46. with:
  47. snuba: true
  48. - name: Run API docs tests
  49. # install ts-node for ts build scripts to execute properly without potentially installing
  50. # conflicting deps when running scripts locally
  51. # see: https://github.com/getsentry/sentry/pull/32328/files
  52. run: |
  53. yarn add ts-node && make test-api-docs
  54. backend-test:
  55. if: needs.files-changed.outputs.backend == 'true'
  56. needs: files-changed
  57. name: backend test
  58. runs-on: ubuntu-22.04
  59. timeout-minutes: 60
  60. strategy:
  61. # This helps not having to run multiple jobs because one fails, thus, reducing resource usage
  62. # and reducing the risk that one of many runs would turn red again (read: intermittent tests)
  63. fail-fast: false
  64. matrix:
  65. # XXX: When updating this, make sure you also update MATRIX_INSTANCE_TOTAL.
  66. instance: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
  67. pg-version: ['14']
  68. env:
  69. # XXX: `MATRIX_INSTANCE_TOTAL` must be hardcoded to the length of `strategy.matrix.instance`.
  70. # If this increases, make sure to also increase `flags.backend.after_n_builds` in `codecov.yml`.
  71. MATRIX_INSTANCE_TOTAL: 11
  72. steps:
  73. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  74. with:
  75. # Avoid codecov error message related to SHA resolution:
  76. # https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
  77. fetch-depth: '2'
  78. - name: Setup sentry env
  79. uses: ./.github/actions/setup-sentry
  80. id: setup
  81. with:
  82. redis_cluster: true
  83. kafka: true
  84. snuba: true
  85. symbolicator: true
  86. # Right now, we run so few bigtable related tests that the
  87. # overhead of running bigtable in all backend tests
  88. # is way smaller than the time it would take to run in its own job.
  89. bigtable: true
  90. pg-version: ${{ matrix.pg-version }}
  91. - name: Run backend test (${{ steps.setup.outputs.matrix-instance-number }} of ${{ steps.setup.outputs.matrix-instance-total }})
  92. run: |
  93. make test-python-ci
  94. # Upload coverage data even if running the tests step fails since
  95. # it reduces large coverage fluctuations
  96. - name: Handle artifacts
  97. if: ${{ always() }}
  98. uses: ./.github/actions/artifacts
  99. with:
  100. token: ${{ secrets.CODECOV_TOKEN }}
  101. backend-migration-tests:
  102. if: needs.files-changed.outputs.backend == 'true'
  103. needs: files-changed
  104. name: backend migration tests
  105. runs-on: ubuntu-22.04
  106. timeout-minutes: 30
  107. strategy:
  108. matrix:
  109. pg-version: ['14']
  110. steps:
  111. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  112. with:
  113. # Avoid codecov error message related to SHA resolution:
  114. # https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
  115. fetch-depth: '2'
  116. - name: Setup sentry env
  117. uses: ./.github/actions/setup-sentry
  118. id: setup
  119. with:
  120. snuba: true
  121. pg-version: ${{ matrix.pg-version }}
  122. - name: run tests
  123. run: |
  124. # historic migrations trigger some warnings
  125. PYTEST_ADDOPTS="$PYTEST_ADDOPTS -m migrations --migrations" make test-python-ci
  126. # Upload coverage data even if running the tests step fails since
  127. # it reduces large coverage fluctuations
  128. - name: Handle artifacts
  129. if: ${{ always() }}
  130. uses: ./.github/actions/artifacts
  131. with:
  132. token: ${{ secrets.CODECOV_TOKEN }}
  133. cli:
  134. if: needs.files-changed.outputs.backend == 'true'
  135. needs: files-changed
  136. name: cli test
  137. runs-on: ubuntu-22.04
  138. timeout-minutes: 10
  139. strategy:
  140. matrix:
  141. pg-version: ['14']
  142. steps:
  143. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  144. - name: Setup sentry env
  145. uses: ./.github/actions/setup-sentry
  146. id: setup
  147. with:
  148. pg-version: ${{ matrix.pg-version }}
  149. - name: Run test
  150. run: |
  151. make test-cli
  152. # Upload coverage data even if running the tests step fails since
  153. # it reduces large coverage fluctuations
  154. - name: Handle artifacts
  155. if: ${{ always() }}
  156. uses: ./.github/actions/artifacts
  157. with:
  158. token: ${{ secrets.CODECOV_TOKEN }}
  159. requirements:
  160. if: needs.files-changed.outputs.backend_dependencies == 'true'
  161. needs: files-changed
  162. name: requirements check
  163. runs-on: ubuntu-22.04
  164. timeout-minutes: 3
  165. steps:
  166. - uses: getsentry/action-github-app-token@d4b5da6c5e37703f8c3b3e43abb5705b46e159cc # v3.0.0
  167. id: token
  168. continue-on-error: true
  169. with:
  170. app_id: ${{ vars.SENTRY_INTERNAL_APP_ID }}
  171. private_key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}
  172. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  173. - uses: getsentry/action-setup-venv@a133e6fd5fa6abd3f590a1c106abda344f5df69f # v2.1.0
  174. with:
  175. python-version: 3.11.6
  176. cache-dependency-path: requirements-dev-frozen.txt
  177. install-cmd: python3 -m tools.hack_pip && pip install -q --constraint requirements-dev-frozen.txt pip-tools
  178. - name: check requirements
  179. run: |
  180. python -S -m tools.freeze_requirements
  181. if ! git diff --exit-code; then
  182. echo $'\n\nrun `make freeze-requirements` locally to update requirements'
  183. exit 1
  184. fi
  185. - name: apply any requirements changes
  186. if: steps.token.outcome == 'success' && github.ref != 'refs/heads/master' && always()
  187. uses: getsentry/action-github-commit@31f6706ca1a7b9ad6d22c1b07bf3a92eabb05632 # v2.0.0
  188. with:
  189. github-token: ${{ steps.token.outputs.token }}
  190. message: ':snowflake: re-freeze requirements'
  191. migration:
  192. if: needs.files-changed.outputs.migration_lockfile == 'true'
  193. needs: files-changed
  194. name: check migration
  195. runs-on: ubuntu-22.04
  196. strategy:
  197. matrix:
  198. pg-version: ['14']
  199. steps:
  200. - name: Checkout sentry
  201. uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  202. - name: Setup sentry env
  203. uses: ./.github/actions/setup-sentry
  204. id: setup
  205. with:
  206. pg-version: ${{ matrix.pg-version }}
  207. - name: Migration & lockfile checks
  208. env:
  209. SENTRY_LOG_LEVEL: ERROR
  210. PGPASSWORD: postgres
  211. run: |
  212. ./.github/workflows/scripts/migration-check.sh
  213. monolith-dbs:
  214. if: needs.files-changed.outputs.backend == 'true'
  215. needs: files-changed
  216. name: monolith-dbs test
  217. runs-on: ubuntu-22.04
  218. timeout-minutes: 20
  219. steps:
  220. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  221. with:
  222. # Avoid codecov error message related to SHA resolution:
  223. # https://github.com/codecov/codecov-bash/blob/7100762afbc822b91806a6574658129fe0d23a7d/codecov#L891
  224. fetch-depth: '2'
  225. - name: Setup sentry env
  226. uses: ./.github/actions/setup-sentry
  227. id: setup
  228. - name: Run test
  229. run: |
  230. make test-monolith-dbs
  231. # Upload coverage data even if running the tests step fails since
  232. # it reduces large coverage fluctuations
  233. - name: Handle artifacts
  234. if: ${{ always() }}
  235. uses: ./.github/actions/artifacts
  236. with:
  237. token: ${{ secrets.CODECOV_TOKEN }}
  238. typing:
  239. if: needs.files-changed.outputs.backend == 'true'
  240. needs: files-changed
  241. name: backend typing
  242. runs-on: ubuntu-22.04
  243. timeout-minutes: 20
  244. steps:
  245. - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
  246. - uses: getsentry/action-setup-venv@a133e6fd5fa6abd3f590a1c106abda344f5df69f # v2.1.0
  247. with:
  248. python-version: 3.11.6
  249. cache-dependency-path: requirements-dev-frozen.txt
  250. install-cmd: python3 -m tools.hack_pip && pip install -r requirements-dev-frozen.txt
  251. - name: setup sentry (lite)
  252. run: |
  253. python3 -m tools.fast_editable --path .
  254. sentry init
  255. - run: mypy
  256. id: run
  257. - uses: getsentry/action-github-app-token@d4b5da6c5e37703f8c3b3e43abb5705b46e159cc # v3.0.0
  258. id: token
  259. continue-on-error: true
  260. with:
  261. app_id: ${{ vars.SENTRY_INTERNAL_APP_ID }}
  262. private_key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}
  263. # only if `mypy` succeeds should we try and trim the blocklist
  264. - run: python3 -m tools.mypy_helpers.make_module_ignores
  265. id: regen-blocklist
  266. - run: git diff --exit-code
  267. - run: |
  268. # mypy does not have granular codes so don't allow specific messages to regress
  269. ! grep "'Settings' object has no attribute" .artifacts/mypy-all
  270. ! grep 'Cannot override class variable' .artifacts/mypy-all
  271. ! grep 'Exception type must be derived from BaseException' .artifacts/mypy-all
  272. ! grep 'Incompatible default for argument' .artifacts/mypy-all
  273. ! grep 'Incompatible return value type (got "HttpResponseBase"' .artifacts/mypy-all
  274. ! grep 'Incompatible types in "yield"' .artifacts/mypy-all
  275. ! grep 'Module "sentry.*has no attribute' .artifacts/mypy-all
  276. ! grep 'base class .* defined the type as.*Permission' .artifacts/mypy-all
  277. ! grep 'does not explicitly export attribute' .artifacts/mypy-all
  278. - name: apply blocklist changes
  279. if: |
  280. steps.token.outcome == 'success' &&
  281. steps.run.outcome == 'success' &&
  282. steps.regen-blocklist.outcome == 'success' &&
  283. github.ref != 'refs/heads/master' &&
  284. always()
  285. uses: getsentry/action-github-commit@31f6706ca1a7b9ad6d22c1b07bf3a92eabb05632 # v2.0.0
  286. with:
  287. github-token: ${{ steps.token.outputs.token }}
  288. message: ':knife: regenerate mypy module blocklist'
  289. # This check runs once all dependent jobs have passed
  290. # It symbolizes that all required Backend checks have succesfully passed (Or skipped)
  291. # This step is the only required backend check
  292. backend-required-check:
  293. needs:
  294. [
  295. api-docs,
  296. backend-test,
  297. backend-migration-tests,
  298. cli,
  299. files-changed,
  300. requirements,
  301. migration,
  302. monolith-dbs,
  303. typing,
  304. ]
  305. name: Backend
  306. # This is necessary since a failed/skipped dependent job would cause this job to be skipped
  307. if: always()
  308. runs-on: ubuntu-22.04
  309. steps:
  310. # If any jobs we depend on fail, we will fail since this is a required check
  311. # NOTE: A timeout is considered a failure
  312. - name: Check for failures
  313. if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
  314. run: |
  315. echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1