feat: add support for 3.11 (Rd 11429) (#499)

* feat: enable 3.11 support testing

Maintain a compatibility matrix instead of taking a one-size-fits-all approach

* fix: supported django versions

* fix: noxfile process kill method

* chore: old version testing branches cleaned up

Author: therightstuff

.github/workflows/push-actions.yml

@@ -11,7 +11,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.10'
+          python-version: '3.11'
           architecture: x64
       - name: Install jq
         run:
@@ -34,9 +34,9 @@ jobs:
     strategy:
       fail-fast: false # Prevent a single failure in the matrix from stopping all other jobs
       matrix:
-        python-version: [ '3.7', '3.8', '3.9', '3.10' ]
+        python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11' ]
         integration-test-family: ${{ fromJson(needs.list-instrumentations.outputs.integration-tests) }}
-    name: ITest ${{ matrix.integration-test-family }} / Python ${{ matrix.python-version }}
+    name: ${{ matrix.python-version }} ${{ matrix.integration-test-family }}
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
@@ -52,7 +52,7 @@ jobs:
     strategy:
       fail-fast: false # Prevent a single failure in the matrix from stopping all other jobs
       matrix:
-        python-version: [ '3.7', '3.8', '3.9', '3.10' ]
+        python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11' ]
     name: Component Test for Python ${{ matrix.python-version }}
     steps:
       - uses: actions/checkout@v3

.github/workflows/version-testing.yml

@@ -4,14 +4,14 @@ on:
   schedule:
     - cron: "0 7 * * *"
 jobs:
-  # If this key gets renamed, nox.py needs to be adjusted
-  check-new-versions-of-instrumented-packages:
+  # If this key gets renamed, noxfile.py needs to be updated accordingly
+  test-untested-versions:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        # If this key gets renamed, nox.py needs to be adjusted
-        python-version: [ '3.7', '3.8', '3.9', '3.10' ]
-    name: check-new-versions-of-instrumented-packages
+        # If this key gets renamed, noxfile.py needs to be updated accordingly
+        python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11' ]
+    name: test-untested-versions
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
@@ -31,10 +31,10 @@ jobs:
           name: ${{ matrix.python-version }}
           path: versions_artifact
 
-  push-branch:
+  create-pr-for-new-versions:
     runs-on: ubuntu-latest
-    name: push-branch
-    needs: check-new-versions-of-instrumented-packages
+    name: create-pr-for-new-versions
+    needs: test-untested-versions
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python
@@ -62,6 +62,11 @@ jobs:
         with:
           name: '3.10'
           path: versions_artifacts/3.10
+      - uses: actions/download-artifact@v2
+        continue-on-error: true
+        with:
+          name: '3.11'
+          path: versions_artifacts/3.11
       - run: python3 -m pip install -r requirements.txt
       - run: python3 -m scripts.gather_version_artifacts
       - run: git --no-pager diff
@@ -76,6 +81,7 @@ jobs:
           echo "$new_versions" >> $GITHUB_ENV
           echo "EOF" >> $GITHUB_ENV
       - name: Create Pull Request
+        # WARNING: the create pull request action must be the last action in the job, it changes the current branch
         uses: peter-evans/create-pull-request@v4
         with:
           token: "${{ secrets.GITHUB_TOKEN }}"
@@ -85,4 +91,14 @@ jobs:
           body: ${{ env.new_versions }}
           base: main
           labels: version-testing, automerge
-          reviewers: GuyMoses,saartochner,shanishiri,mmanciop
+          reviewers: GuyMoses,saartochner,shanishiri
+        # WARNING: the create pull request action must be the last action in the job, it changes the current branch
+
+  delete-old-version-testing-branches:
+    runs-on: ubuntu-latest
+    name: delete-old-version-testing-branches
+    needs: create-pr-for-new-versions
+    steps:
+      - uses: actions/checkout@v3
+      - run: |  # remove all the version testing branches that aren't from today
+          ./scripts/delete_old_version_testing_branches.sh

CONTRIBUTING.md

@@ -26,12 +26,33 @@ Run `./scripts/checks.sh` in the root folder.
 python3 -m nox
 # List all the tests
 python3 -m nox -l
+```
+
+To run specific tests and/or specify Python versions:
+
+* Use `--python PYTHON_VERSION` to specify a Python version eg.
+
+    `--python 3.9`
+* Use `-e` to specify a dependency to test eg.
+
+    `python3 -m nox -e integration_tests_flask`
+* Use `--session` to specify a dependency and version eg.
+
+    `--session "integration_tests_grpcio(python='3.9', grpcio_version='1.56.0')"`
+
+```sh
 # Run a given test with the entire parameter matrix
 python3 -m nox -e integration_tests_flask
 # Run a given test for a given version of Python and all dependency versions
 python -m nox -e integration_tests_grpcio --python 3.9
 # Run a given test for a given version of Python and a given dependency version
-python -m nox --session "integration_tests_grpcio-3.9(grpcio_version='1.56.0')"
+python -m nox --session "integration_tests_grpcio(python='3.9', grpcio_version='1.56.0')"
+```
+
+To run version testing locally, prefix the test command with `TEST_ONLY_UNTESTED_NEW_VERSIONS=true` eg.
+
+```sh
+TEST_ONLY_UNTESTED_NEW_VERSIONS=true python3 -m nox -e integration_tests_flask`
 ```
 
 ## Adding support for a new package

README.md

@@ -199,34 +199,36 @@ get_current_span().add_event('<error-message>', {'lumigo.type': '<error-type>'})
 
 ## Supported runtimes
 
-* cpython: 3.7.x, 3.8.x, 3.9.x, 3.10.x
+* cpython: 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
 
 ## Supported packages
 
-| Instrumentation | Package | Supported Versions |
-| --- | --- | --- |
-| botocore | [boto3](https://pypi.org/project/boto3) | 1.17.22~1.28.40 |
-| fastapi | [fastapi](https://pypi.org/project/fastapi) | 0.56.1~0.100.0 |
-| | | 0.100.0b2~0.103.1 |
-| | [uvicorn](https://pypi.org/project/uvicorn) | 0.11.3~0.22.0 |
-| flask | [flask](https://pypi.org/project/flask) | 2.0.0~2.2.5 |
-| grpcio | [grpcio](https://pypi.org/project/grpcio) | 1.45.0~1.58.0rc1 |
-| kafka_python | [kafka_python](https://pypi.org/project/kafka_python) | 2.0.0~2.0.2 |
-| pika | [pika](https://pypi.org/project/pika) | 1.0.0 |
-| | | 1.0.1~1.3.0 |
-| | | 1.3.0rc5~1.3.2 |
-| pymongo | [pymongo](https://pypi.org/project/pymongo) | 3.1.1~3.3.1 |
-| | | 3.5.0~3.13.0 |
-| | | 4.0.1~4.5.0 |
-| | | 3.1 |
-| | | 3.2 |
-| | | 4.0 |
-| pymysql | [pymysql](https://pypi.org/project/pymysql) | 0.9.0~0.10.1 |
-| | | 1.0.0~1.0.3 |
-| | | 1.1.0~1.1.0rc2 |
-| redis | [redis](https://pypi.org/project/redis) | 4.1.1~4.2.0 |
-| | | 4.2.1~4.6.0 |
-| | | 5.0.0~5.0.0rc2 |
+| Instrumentation | Package | Supported Versions | | | | |
+| --- | --- | :---: | :---: | :---: | :---: | :---: |
+| | | 3.7 | 3.8 | 3.9 | 3.10 | 3.11 |
+| botocore | [boto3](https://pypi.org/project/boto3) | 1.17.22~1.28.40|1.17.22~1.28.40|1.17.22~1.28.40|1.17.22~1.28.40| |
+| django | [django](https://pypi.org/project/django) |  |4.2.5|4.2.5|4.2.5|4.2.5|
+| fastapi | [fastapi](https://pypi.org/project/fastapi) | 0.56.1~0.100.0|0.56.1~0.100.0|0.56.1~0.100.0|0.56.1~0.100.0|0.56.1~0.100.0|
+| | | 0.100.0b2~0.103.1| 0.100.0b2~0.103.1| 0.100.0b2~0.103.1| 0.100.0b2~0.103.1| 0.100.0b2~0.103.1|
+|  | [uvicorn](https://pypi.org/project/uvicorn) | 0.11.3~0.22.0|0.11.3~0.22.0|0.11.3~0.22.0|0.11.3~0.22.0|0.12.0~0.22.0|
+| flask | [flask](https://pypi.org/project/flask) | 2.0.0~2.2.5|2.0.0~2.2.5|2.0.0~2.2.5|2.0.0~2.2.5|2.0.0~2.2.5|
+| grpcio | [grpcio](https://pypi.org/project/grpcio) | 1.45.0~1.58.0rc1|1.45.0~1.58.0rc1|1.45.0~1.58.0rc1|1.45.0~1.58.0rc1|1.49.0~1.58.0rc1|
+| kafka_python | [kafka_python](https://pypi.org/project/kafka_python) | 2.0.0~2.0.2|2.0.0~2.0.2|2.0.0~2.0.2|2.0.0~2.0.2| |
+| pika | [pika](https://pypi.org/project/pika) | 1.0.0|1.0.0|1.0.0|1.0.0| |
+| | | 1.0.1~1.3.0| 1.0.1~1.3.0| 1.0.1~1.3.0| 1.0.1~1.3.0| |
+| | | 1.3.0rc5~1.3.2| 1.3.0rc5~1.3.2| 1.3.0rc5~1.3.2| 1.3.0rc5~1.3.2| |
+| pymongo | [pymongo](https://pypi.org/project/pymongo) | 3.1.1~3.3.1|3.1.1~3.3.1|3.1.1~3.3.1|3.1.1~3.3.1|3.1.1~3.3.1|
+| | | 3.5.0~3.13.0| 3.5.0~3.13.0| 3.5.0~3.13.0| 3.5.0~3.13.0| 3.5.0~3.9.0|
+| | | 4.0.1~4.5.0| 4.0.1~4.5.0| 4.0.1~4.5.0| 4.0.1~4.5.0| 3.1|
+| | | 3.1| 3.1| 3.1| 3.1| 3.2|
+| | | 3.2| 3.2| 3.2| 3.2| |
+| | | 4.0| 4.0| 4.0| 4.0| |
+| pymysql | [pymysql](https://pypi.org/project/pymysql) | 0.9.0~0.10.1|0.9.0~0.10.1|0.9.0~0.10.1|0.9.0~0.10.1| |
+| | | 1.0.0~1.0.3| 1.0.0~1.0.3| 1.0.0~1.0.3| 1.0.0~1.0.3| |
+| | | 1.1.0~1.1.0rc2| 1.1.0~1.1.0rc2| 1.1.0~1.1.0rc2| 1.1.0~1.1.0rc2| |
+| redis | [redis](https://pypi.org/project/redis) | 4.1.1~4.2.0|4.1.1~4.2.0|4.1.1~4.2.0|4.1.1~4.2.0|4.1.1~4.2.0|
+| | | 4.2.1~4.6.0| 4.2.1~4.6.0| 4.2.1~4.6.0| 4.2.1~4.6.0| 4.2.1~4.6.0|
+| | | 5.0.0~5.0.0rc2| 5.0.0~5.0.0rc2| 5.0.0~5.0.0rc2| 5.0.0~5.0.0rc2| 5.0.0~5.0.0rc2|
 
 ## Automated dependency reporting
 
@@ -343,22 +345,18 @@ Without the scope provided by the iterator over `response["Messages"]`, `span_1`
 
 ### Filtering out empty SQS messages
 
-A common pattern in SQS-based applications is to continuously poll an SQS queue for messages, 
+A common pattern in SQS-based applications is to continuously poll an SQS queue for messages,
 and to process them as they arrive.
-In order not to clutter the Lumigo platform with empty SQS polling messages, the default behavior is to filter them 
+In order not to clutter the Lumigo platform with empty SQS polling messages, the default behavior is to filter them
 out from being sent to Lumigo.
 
 You can change this behavior by setting the boolean environment variable `LUMIGO_AUTO_FILTER_EMPTY_SQS` to `false`.
 The possible variations are:
+
 * `LUMIGO_AUTO_FILTER_EMPTY_SQS=true` filter out empty SQS polling messages
 * `LUMIGO_AUTO_FILTER_EMPTY_SQS=false` do not filter out empty SQS polling messages
 * No environment variable set (default): filter out empty SQS polling messages
 
-## Testing
-
-We use [nox](https://pypi.org/project/nox/) for setting up and running our tests.
+## Contributing
 
-```sh
-python3 -m nox
-python3 -m nox -e integration_tests_flask
-```
+For guidelines on contributing, please see [CONTRIBUTING.md](./CONTRIBUTING.md).