Separate lint into several jobs (open-telemetry#3902)

ocelotl · web-flow · commit 5dc48c522d27 · 2024-07-11T12:19:08.000-06:00
* Separate lint into several jobs Fixes open-telemetry#3893 * Remove proto-related packages from getting-started * Add global lint * Fix lint workflow * Revert "Remove proto-related packages from getting-started" This reverts commit 34d6139. * Do not run getting started tests with pypy * Add missing requirements for lint
diff --git a/.codespellrc b/.codespellrc
@@ -1,4 +1,4 @@
 [codespell]
 # skipping auto generated folders
-skip = ./.tox,./.mypy_cache,./docs/_build,./target,*/LICENSE,./venv,.git,./opentelemetry-semantic-conventions
+skip = ./.tox,./.mypy_cache,./docs/_build,./target,*/LICENSE,./venv,.git,./opentelemetry-semantic-conventions,*-requirements*.txt
 ignore-words-list = ans,ue,ot,hist,ro
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,54 @@
+name: Lint tests
+
+on:
+  push:
+    branches-ignore:
+    - 'release/*'
+  pull_request:
+
+jobs:
+  lint-3_12:
+    strategy:
+      fail-fast: false  # ensures the entire test matrix is run, even if one permutation fails
+      matrix:
+        package:
+          - "opentelemetry-api"
+          - "opentelemetry-proto"
+          - "opentelemetry-sdk"
+          - "opentelemetry-semantic-conventions"
+          - "opentelemetry-getting-started"
+          - "opentelemetry-opentracing-shim"
+          - "opentelemetry-opencensus-shim"
+          - "opentelemetry-exporter-opencensus"
+          - "opentelemetry-exporter-otlp-proto-common"
+          - "opentelemetry-exporter-otlp-combined"
+          - "opentelemetry-exporter-otlp-proto-grpc"
+          - "opentelemetry-exporter-otlp-proto-http"
+          - "opentelemetry-exporter-otlp-proto-prometheus"
+          - "opentelemetry-exporter-otlp-proto-zipkin-combined"
+          - "opentelemetry-exporter-otlp-proto-zipkin-proto-http"
+          - "opentelemetry-exporter-otlp-proto-zipkin-json"
+          - "opentelemetry-propagator-b3"
+          - "opentelemetry-propagator-jaeger"
+          - "opentelemetry-test-utils"
+        os: [ubuntu-20.04]
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout Core Repo @ SHA - ${{ github.sha }}
+        uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install tox
+        run: pip install tox
+      - name: Cache tox environment
+        # Preserves .tox directory between runs for faster installs
+        uses: actions/cache@v4
+        with:
+          path: |
+            .tox
+            ~/.cache/pip
+          key: v7-build-tox-cache-${{ matrix.package }}-${{ hashFiles('tox.ini', 'gen-requirements.txt', 'dev-requirements.txt') }}
+      - name: run tox
+        run: tox -e lint-${{ matrix.package }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -56,7 +56,7 @@ jobs:
           - "exporter-zipkin-combined"
           - "exporter-zipkin-proto-http"
           - "exporter-zipkin-json"
-          - "protobuf"
+          - "proto"
           - "propagator-b3"
           - "propagator-jaeger"
         os: [ubuntu-20.04, windows-2019]
@@ -69,6 +69,8 @@ jobs:
             package: "exporter-otlp-combined"
           - python-version: pypy3
             package: "exporter-otlp-proto-grpc"
+          - python-version: pypy3
+            package: "getting-started"
 
     steps:
     - name: Checkout Core Repo @ SHA - ${{ github.sha }}
@@ -98,7 +100,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        tox-environment: ["docker-tests-proto3", "docker-tests-proto4", "lint", "spellcheck",
+        tox-environment: ["docker-tests-proto3", "docker-tests-proto4", "spellcheck",
           "docs", "mypy", "mypyinstalled", "tracecontext"]
     name: ${{ matrix.tox-environment }}
     runs-on: ubuntu-20.04
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -57,7 +57,7 @@ You can run `tox` with the following arguments:
 - `tox -e py312-opentelemetry-api` to e.g. run the API unit tests under a specific
   Python version
 - `tox -e spellcheck` to run a spellcheck on all the code
-- `tox -e lint` to run lint checks on all code
+- `tox -e lint-some-package` to run lint checks on `some-package`
 
 `black` and `isort` are executed when `tox -e lint` is run. The reported errors can be tedious to fix manually.
 An easier way to do so is:
diff --git a/docs/getting_started/__init__.py b/docs/getting_started/__init__.py
diff --git a/docs/getting_started/flask_example.py b/docs/getting_started/flask_example.py
@@ -40,7 +40,7 @@
 @app.route("/")
 def hello():
     with tracer.start_as_current_span("example-request"):
-        requests.get("http://www.example.com")
+        requests.get("http://www.example.com", timeout=10)
     return "hello"
 
 
diff --git a/docs/getting_started/tests/requirements.txt b/docs/getting_started/tests/requirements.txt
@@ -23,5 +23,8 @@ Werkzeug==3.0.3
 wrapt==1.15.0
 zipp==3.19.2
 -e opentelemetry-semantic-conventions
+-e opentelemetry-proto
+-e exporter/opentelemetry-exporter-otlp-proto-common
+-e exporter/opentelemetry-exporter-otlp-proto-grpc
 -e opentelemetry-api
 -e opentelemetry-sdk
diff --git a/docs/getting_started/tests/test_flask.py b/docs/getting_started/tests/test_flask.py
@@ -19,14 +19,16 @@
 
 import requests
 from requests.adapters import HTTPAdapter
-from requests.packages.urllib3.util.retry import Retry
+from requests.packages.urllib3.util.retry import (  # pylint: disable=import-error
+    Retry,
+)
 
 
 class TestFlask(unittest.TestCase):
     def test_flask(self):
         dirpath = os.path.dirname(os.path.realpath(__file__))
         server_script = f"{dirpath}/../flask_example.py"
-        server = subprocess.Popen(
+        server = subprocess.Popen(  # pylint: disable=consider-using-with
             [sys.executable, server_script],
             stdout=subprocess.PIPE,
         )
diff --git a/exporter/opentelemetry-exporter-zipkin-proto-http/test-requirements.txt b/exporter/opentelemetry-exporter-zipkin-proto-http/test-requirements.txt
@@ -17,6 +17,7 @@ urllib3==2.2.2
 wrapt==1.16.0
 zipp==3.19.2
 -e opentelemetry-api
+-e opentelemetry-proto
 -e exporter/opentelemetry-exporter-zipkin-json
 -e opentelemetry-sdk
 -e tests/opentelemetry-test-utils
diff --git a/lint-requirements.txt b/lint-requirements.txt
@@ -0,0 +1,15 @@
+astroid==3.0.3
+black==24.3.0
+click==8.1.7
+dill==0.3.8
+flake8==6.1.0
+isort==5.12.0
+mccabe==0.7.0
+mypy-extensions==1.0.0
+packaging==24.0
+pathspec==0.12.1
+platformdirs==4.2.1
+pycodestyle==2.11.1
+pyflakes==3.1.0
+pylint==3.0.2
+tomlkit==0.12.4
diff --git a/tox.ini b/tox.ini
