Add decorator for Sentry tracing (#1089)

* Add decorator for Sentry tracing
---------
Co-authored-by: Anton Pirker <anton.pirker@sentry.io>
Co-authored-by: Daniel Griesser <daniel.griesser.86@gmail.com>

.github/workflows/test-common.yml

@@ -1,4 +1,4 @@
-name: Test Common
+name: Test common
 
 on:
   push:
@@ -8,6 +8,12 @@ on:
 
   pull_request:
 
+# Cancel in progress workflows on pull_requests.
+# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 permissions:
   contents: read
 
@@ -18,18 +24,20 @@ env:
 
 jobs:
   test:
-    name: Test Python ${{ matrix.python-version }}, ${{ matrix.os }}
+    name: common, python ${{ matrix.python-version }}, ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     timeout-minutes: 45
-    continue-on-error: true
+
     strategy:
+      fail-fast: false
       matrix:
+        python-version: ["2.7","3.5","3.6","3.7","3.8","3.9","3.10","3.11"]
         # python3.6 reached EOL and is no longer being supported on
         # new versions of hosted runners on Github Actions
         # ubuntu-20.04 is the last version that supported python3.6
         # see https://github.com/actions/setup-python/issues/544#issuecomment-1332535877
         os: [ubuntu-20.04]
-        python-version: ["2.7", "3.5", "3.6", "3.7", "3.8", "3.9", "3.10", "3.11"]
+
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
@@ -38,16 +46,28 @@ jobs:
 
       - name: Setup Test Env
         run: |
-          pip install codecov tox
+          pip install codecov "tox>=3,<4"
 
-      - name: Run Tests
+      - name: Test common
         timeout-minutes: 45
         shell: bash
         run: |
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "py${{ matrix.python-version }}$" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch --ignore=tests/integrations
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-common" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml
+
+  check_required_tests:
+    name: All common tests passed or skipped
+    needs: test
+    # Always run this, even if a dependent job failed
+    if: always()
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Check for failures
+        if: contains(needs.test.result, 'failure')
+        run: |
+          echo "One of the dependent jobs have failed. You may need to re-run it." && exit 1

.github/workflows/test-integration-aiohttp.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-aiohttp" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-aiohttp" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-arq.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-arq" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-arq" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-asgi.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-asgi" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-asgi" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-aws_lambda.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-aws_lambda" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-aws_lambda" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-beam.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-beam" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-beam" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-boto3.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-boto3" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-boto3" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-bottle.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-bottle" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-bottle" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-celery.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-celery" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-celery" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-chalice.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-chalice" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-chalice" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-cloud_resource_context.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-cloud_resource_context" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-cloud_resource_context" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-django.yml

@@ -73,7 +73,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-django" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-django" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-falcon.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-falcon" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-falcon" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-fastapi.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-fastapi" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-fastapi" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-flask.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-flask" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-flask" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-gcp.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-gcp" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-gcp" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-gevent.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-gevent" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-gevent" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-httpx.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-httpx" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-httpx" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-huey.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-huey" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-huey" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-opentelemetry.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-opentelemetry" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-opentelemetry" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-pure_eval.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-pure_eval" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-pure_eval" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-pymongo.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-pymongo" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-pymongo" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-pyramid.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-pyramid" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-pyramid" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-quart.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-quart" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-quart" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-redis.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-redis" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-redis" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-rediscluster.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-rediscluster" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-rediscluster" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-requests.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-requests" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-requests" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-rq.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-rq" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-rq" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-sanic.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-sanic" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-sanic" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-sqlalchemy.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-sqlalchemy" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-sqlalchemy" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-starlette.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-starlette" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-starlette" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-starlite.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-starlite" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-starlite" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-tornado.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-tornado" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-tornado" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

.github/workflows/test-integration-trytond.yml

@@ -55,7 +55,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-trytond" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-trytond" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

scripts/split-tox-gh-actions/ci-yaml.txt

@@ -47,7 +47,7 @@ jobs:
           set -x # print commands that are executed
           coverage erase
 
-          ./scripts/runtox.sh "${{ matrix.python-version }}-{{ framework }}" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
+          ./scripts/runtox.sh "py${{ matrix.python-version }}-{{ framework }}" --cov=tests --cov=sentry_sdk --cov-report= --cov-branch
           coverage combine .coverage*
           coverage xml -i
           codecov --file coverage.xml

scripts/split-tox-gh-actions/split-tox-gh-actions.py

@@ -71,7 +71,11 @@ def write_yaml_file(
             out += template_line.replace("{{ framework }}", current_framework)
 
     # write rendered template
-    outfile_name = OUT_DIR / f"test-integration-{current_framework}.yml"
+    if current_framework == "common":
+        outfile_name = OUT_DIR / f"test-{current_framework}.yml"
+    else:
+        outfile_name = OUT_DIR / f"test-integration-{current_framework}.yml"
+
     print(f"Writing {outfile_name}")
     f = open(outfile_name, "w")
     f.writelines(out)