tox.ini

[tox]
skipsdist = True
skip_missing_interpreters = True
envlist =
    ; Environments are organized by individual package, allowing
    ; for specifying supported Python versions per package.

    ; opentelemetry-sdk-extension-aws
    py3{6,7,8,9}-test-sdkextension-aws
    pypy3-test-sdkextension-aws

    ; opentelemetry-instrumentation-aiohttp-client
    py3{6,7,8,9}-test-instrumentation-aiohttp-client
    pypy3-test-instrumentation-aiohttp-client

    ; opentelemetry-instrumentation-aiopg
    py3{6,7,8,9}-test-instrumentation-aiopg
    ; instrumentation-aiopg intentionally excluded from pypy3

    ; opentelemetry-instrumentation-botocore
    py3{6,7,8,9}-test-instrumentation-botocore
    pypy3-test-instrumentation-botocore

    ; opentelemetry-instrumentation-django
    py3{6,7,8,9}-test-instrumentation-django
    pypy3-test-instrumentation-django

    ; opentelemetry-instrumentation-dbapi
    py3{6,7,8,9}-test-instrumentation-dbapi
    pypy3-test-instrumentation-dbapi

    ; opentelemetry-instrumentation-boto
    py3{6,7,8,9}-test-instrumentation-boto
    pypy3-test-instrumentation-boto

    ; opentelemetry-instrumentation-elasticsearch
    py3{6,7,8,9}-test-instrumentation-elasticsearch{2,5,6,7}
    pypy3-test-instrumentation-elasticsearch{2,5,6,7}

    ; opentelemetry-instrumentation-falcon
    py3{4,5,6,7,8,9}-test-instrumentation-falcon
    pypy3-test-instrumentation-falcon

    ; opentelemetry-instrumentation-fastapi
    ; fastapi only supports 3.6 and above.
    py3{6,7,8,9}-test-instrumentation-fastapi
    pypy3-test-instrumentation-fastapi

    ; opentelemetry-instrumentation-flask
    py3{6,7,8,9}-test-instrumentation-flask
    pypy3-test-instrumentation-flask

    ; opentelemetry-instrumentation-urllib
    py3{6,7,8,9}-test-instrumentation-urllib
    pypy3-test-instrumentation-urllib

    ; opentelemetry-instrumentation-urllib3
    py3{6,7,8,9}-test-instrumentation-urllib3
    pypy3-test-instrumentation-urllib3

    ; opentelemetry-instrumentation-requests
    py3{6,7,8,9}-test-instrumentation-requests
    pypy3-test-instrumentation-requests

    ; opentelemetry-instrumentation-starlette.
    ; starlette only supports 3.6 and above.
    py3{6,7,8,9}-test-instrumentation-starlette
    pypy3-test-instrumentation-starlette

    ; opentelemetry-instrumentation-jinja2
    py3{6,7,8,9}-test-instrumentation-jinja2
    pypy3-test-instrumentation-jinja2

    ; opentelemetry-instrumentation-logging
    py3{6,7,8,9}-test-instrumentation-logging
    pypy3-test-instrumentation-logging

    ; opentelemetry-exporter-datadog
    py3{6,7,8,9}-test-exporter-datadog

    ; opentelemetry-instrumentation-mysql
    py3{6,7,8,9}-test-instrumentation-mysql
    pypy3-test-instrumentation-mysql

    ; opentelemetry-instrumentation-psycopg2
    py3{6,7,8,9}-test-instrumentation-psycopg2
    ; ext-psycopg2 intentionally excluded from pypy3

    ; opentelemetry-instrumentation-pymemcache
    py3{6,7,8,9}-test-instrumentation-pymemcache
    pypy3-test-instrumentation-pymemcache

    ; opentelemetry-instrumentation-pymongo
    py3{6,7,8,9}-test-instrumentation-pymongo
    pypy3-test-instrumentation-pymongo

    ; opentelemetry-instrumentation-pymysql
    py3{6,7,8,9}-test-instrumentation-pymysql
    pypy3-test-instrumentation-pymysql

    ; opentelemetry-instrumentation-pyramid
    py3{6,7,8,9}-test-instrumentation-pyramid
    pypy3-test-instrumentation-pyramid

    ; opentelemetry-instrumentation-asgi
    py3{6,7,8,9}-test-instrumentation-asgi
    pypy3-test-instrumentation-asgi

    ; opentelemetry-instrumentation-asyncpg
    py3{6,7,8,9}-test-instrumentation-asyncpg
    ; ext-asyncpg intentionally excluded from pypy3

    ; opentelemetry-instrumentation-sqlite3
    py3{6,7,8,9}-test-instrumentation-sqlite3
    pypy3-test-instrumentation-sqlite3

    ; opentelemetry-instrumentation-wsgi
    py3{6,7,8,9}-test-instrumentation-wsgi
    pypy3-test-instrumentation-wsgi

    ; opentelemetry-instrumentation-grpc
    py3{6,7,8,9}-test-instrumentation-grpc

    ; opentelemetry-instrumentation-sqlalchemy
    py3{6,7,8,9}-test-instrumentation-sqlalchemy{11,14}
    pypy3-test-instrumentation-sqlalchemy{11,14}

    ; opentelemetry-instrumentation-redis
    py3{6,7,8,9}-test-instrumentation-redis
    pypy3-test-instrumentation-redis

    ; opentelemetry-instrumentation-celery
    py3{6,7,8,9}-test-instrumentation-celery
    pypy3-test-instrumentation-celery

    ; opentelemetry-instrumentation-sklearn
    py3{6,7,8}-test-instrumentation-sklearn

    ; opentelemetry-instrumentation-tornado
    py3{6,7,8,9}-test-instrumentation-tornado
    pypy3-test-instrumentation-tornado

    ; opentelemetry-instrumentation-httpx
    py3{6,7,8,9}-test-instrumentation-httpx
    pypy3-test-instrumentation-httpx

    ; opentelemetry-util-http
    py3{6,7,8,9}-test-util-http
    pypy3-test-util-http

    ; opentelemetry-propagator-ot-trace
    py3{6,7,8,9}-test-propagator-ot-trace
    pypy3-test-propagator-ot-trace

    lint
    docker-tests
    docs

    generate

[testenv]
deps =
  -c dev-requirements.txt
  test: pytest
  test: pytest-benchmark
  coverage: pytest
  coverage: pytest-cov
  elasticsearch2: elasticsearch-dsl>=2.0,<3.0
  elasticsearch2: elasticsearch>=2.0,<3.0
  elasticsearch5: elasticsearch-dsl>=5.0,<6.0
  elasticsearch5: elasticsearch>=5.0,<6.0
  elasticsearch6: elasticsearch-dsl>=6.0,<7.0
  elasticsearch6: elasticsearch>=6.0,<7.0
  elasticsearch7: elasticsearch-dsl>=7.0,<8.0
  elasticsearch7: elasticsearch>=7.0,<8.0
  sqlalchemy11: sqlalchemy>=1.1,<1.2
  sqlalchemy14: aiosqlite
  sqlalchemy14: sqlalchemy~=1.4

  ; FIXME: add coverage testing
  ; FIXME: add mypy testing

changedir =
  test-instrumentation-aiohttp-client: instrumentation/opentelemetry-instrumentation-aiohttp-client/tests
  test-instrumentation-aiopg: instrumentation/opentelemetry-instrumentation-aiopg/tests
  test-instrumentation-asgi: instrumentation/opentelemetry-instrumentation-asgi/tests
  test-instrumentation-asyncpg: instrumentation/opentelemetry-instrumentation-asyncpg/tests
  test-instrumentation-boto: instrumentation/opentelemetry-instrumentation-boto/tests
  test-instrumentation-botocore: instrumentation/opentelemetry-instrumentation-botocore/tests
  test-instrumentation-celery: instrumentation/opentelemetry-instrumentation-celery/tests
  test-instrumentation-dbapi: instrumentation/opentelemetry-instrumentation-dbapi/tests
  test-instrumentation-django: instrumentation/opentelemetry-instrumentation-django/tests
  test-instrumentation-elasticsearch{2,5,6,7}: instrumentation/opentelemetry-instrumentation-elasticsearch/tests
  test-instrumentation-falcon: instrumentation/opentelemetry-instrumentation-falcon/tests
  test-instrumentation-fastapi: instrumentation/opentelemetry-instrumentation-fastapi/tests
  test-instrumentation-flask: instrumentation/opentelemetry-instrumentation-flask/tests
  test-instrumentation-urllib: instrumentation/opentelemetry-instrumentation-urllib/tests
  test-instrumentation-urllib3: instrumentation/opentelemetry-instrumentation-urllib3/tests
  test-instrumentation-grpc: instrumentation/opentelemetry-instrumentation-grpc/tests
  test-instrumentation-jinja2: instrumentation/opentelemetry-instrumentation-jinja2/tests
  test-instrumentation-logging: instrumentation/opentelemetry-instrumentation-logging/tests
  test-instrumentation-mysql: instrumentation/opentelemetry-instrumentation-mysql/tests
  test-instrumentation-psycopg2: instrumentation/opentelemetry-instrumentation-psycopg2/tests
  test-instrumentation-pymemcache: instrumentation/opentelemetry-instrumentation-pymemcache/tests
  test-instrumentation-pymongo: instrumentation/opentelemetry-instrumentation-pymongo/tests
  test-instrumentation-pymysql: instrumentation/opentelemetry-instrumentation-pymysql/tests
  test-instrumentation-pyramid: instrumentation/opentelemetry-instrumentation-pyramid/tests
  test-instrumentation-redis: instrumentation/opentelemetry-instrumentation-redis/tests
  test-instrumentation-requests: instrumentation/opentelemetry-instrumentation-requests/tests
  test-instrumentation-sklearn: instrumentation/opentelemetry-instrumentation-sklearn/tests
  test-instrumentation-sqlalchemy{11,14}: instrumentation/opentelemetry-instrumentation-sqlalchemy/tests
  test-instrumentation-sqlite3: instrumentation/opentelemetry-instrumentation-sqlite3/tests
  test-instrumentation-starlette: instrumentation/opentelemetry-instrumentation-starlette/tests
  test-instrumentation-tornado: instrumentation/opentelemetry-instrumentation-tornado/tests
  test-instrumentation-wsgi: instrumentation/opentelemetry-instrumentation-wsgi/tests
  test-instrumentation-httpx: instrumentation/opentelemetry-instrumentation-httpx/tests
  test-util-http: util/opentelemetry-util-http/tests
  test-sdkextension-aws: sdk-extension/opentelemetry-sdk-extension-aws/tests
  test-propagator-ot-trace: propagator/opentelemetry-propagator-ot-trace/tests
  test-exporter-datadog: exporter/opentelemetry-exporter-datadog/tests

commands_pre =
; Install without -e to test the actual installation
  py3{6,7,8,9}: python -m pip install -U pip setuptools wheel
; Install common packages for all the tests. These are not needed in all the
; cases but it saves a lot of boilerplate in this file.
  test: pip install {toxinidir}/opentelemetry-python-core/opentelemetry-api[test]
  test: pip install {toxinidir}/opentelemetry-python-core/opentelemetry-semantic-conventions[test]
  test: pip install {toxinidir}/opentelemetry-python-core/opentelemetry-instrumentation[test]
  test: pip install {toxinidir}/opentelemetry-python-core/opentelemetry-sdk[test]
  test: pip install {toxinidir}/opentelemetry-python-core/tests/util[test]

  celery: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-celery[test]

  grpc: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-grpc[test]

  falcon,flask,django,pyramid,tornado,starlette,fastapi,aiohttp,asgi,requests,urllib,wsgi: pip install {toxinidir}/util/opentelemetry-util-http[test]
  wsgi,falcon,flask,django,pyramid: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-wsgi[test]
  asgi,starlette,fastapi: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-asgi[test]

  asyncpg: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-asyncpg[test]

  boto: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-botocore[test]
  boto: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-boto[test]

  falcon: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-falcon[test]

  flask: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-flask[test]

  urllib: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-urllib[test]

  urllib3: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-urllib3[test]

  botocore: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-botocore[test]

  dbapi: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi[test]

  django: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-django[test]

  fastapi: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-fastapi[test]

  mysql: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi {toxinidir}/instrumentation/opentelemetry-instrumentation-mysql[test]

  pymemcache: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-pymemcache[test]

  pymongo: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-pymongo[test]

  psycopg2: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi {toxinidir}/instrumentation/opentelemetry-instrumentation-psycopg2[test]

  pymysql: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi {toxinidir}/instrumentation/opentelemetry-instrumentation-pymysql[test]

  pyramid: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-pyramid[test]

  sqlite3: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi {toxinidir}/instrumentation/opentelemetry-instrumentation-sqlite3[test]

  redis: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-redis[test]

  requests: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-requests[test]

  starlette: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-starlette[test]

  tornado: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-tornado[test]

  jinja2: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-jinja2[test]

  logging: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-logging[test]

  aiohttp-client: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-aiohttp-client[test]

  aiopg: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-aiopg[test]

  datadog: pip install flaky {toxinidir}/exporter/opentelemetry-exporter-datadog[test]

  sklearn: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-sklearn[test]

  sqlalchemy{11,14}: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-sqlalchemy[test]

  elasticsearch{2,5,6,7}: pip install {toxinidir}/opentelemetry-python-core/opentelemetry-instrumentation {toxinidir}/instrumentation/opentelemetry-instrumentation-elasticsearch[test]

  httpx: pip install {toxinidir}/instrumentation/opentelemetry-instrumentation-httpx[test]

  aws: pip install requests {toxinidir}/sdk-extension/opentelemetry-sdk-extension-aws[test]

  http: pip install {toxinidir}/util/opentelemetry-util-http[test]
; In order to get a health coverage report,
  propagator-ot-trace: pip install {toxinidir}/propagator/opentelemetry-propagator-ot-trace[test]

; we have to install packages in editable mode.
  coverage: python {toxinidir}/scripts/eachdist.py install --editable

commands =
  test: pytest {posargs}
  coverage: {toxinidir}/scripts/coverage.sh

[testenv:docs]
deps =
  -c {toxinidir}/dev-requirements.txt
  -r {toxinidir}/docs-requirements.txt
  pytest

commands_pre =
  python -m pip install {toxinidir}/opentelemetry-python-core/opentelemetry-api
  python -m pip install {toxinidir}/opentelemetry-python-core/opentelemetry-semantic-conventions
  python -m pip install {toxinidir}/opentelemetry-python-core/opentelemetry-instrumentation
  python -m pip install {toxinidir}/opentelemetry-python-core/opentelemetry-sdk
  python -m pip install {toxinidir}/util/opentelemetry-util-http

changedir = docs

commands =
  sphinx-build -E -a -W -b html -T . _build/html

[testenv:lint]
basepython: python3.9
recreate = False
deps =
  -c dev-requirements.txt
  flaky
  pylint
  flake8
  isort
  black
  readme_renderer
  httpretty

commands_pre =
  sudo apt-get install libsnappy-dev
  python -m pip install {toxinidir}/opentelemetry-python-core/opentelemetry-api
  python -m pip install {toxinidir}/opentelemetry-python-core/opentelemetry-semantic-conventions
  python -m pip install {toxinidir}/opentelemetry-python-core/opentelemetry-instrumentation[test]
  python -m pip install {toxinidir}/opentelemetry-python-core/opentelemetry-sdk
  python -m pip install {toxinidir}/opentelemetry-python-core/tests/util
  python -m pip install -e {toxinidir}/util/opentelemetry-util-http[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-wsgi[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-asgi[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-botocore[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-django[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-starlette[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-grpc[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-falcon[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-boto[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-flask[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-sqlalchemy[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-celery[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-sklearn[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-redis[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-fastapi[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-jinja2[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-logging[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymemcache[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-psycopg2[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-aiohttp-client[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-aiopg[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-sqlite3[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pyramid[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-requests[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-urllib[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-urllib3[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymysql[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymongo[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-elasticsearch[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-asyncpg[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-tornado[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-mysql[test]
  python -m pip install -e {toxinidir}/instrumentation/opentelemetry-instrumentation-httpx[test]
  python -m pip install -e {toxinidir}/exporter/opentelemetry-exporter-datadog[test]
  python -m pip install -e {toxinidir}/sdk-extension/opentelemetry-sdk-extension-aws[test]
  python -m pip install -e {toxinidir}/propagator/opentelemetry-propagator-ot-trace[test]

commands =
  python scripts/eachdist.py lint --check-only

[testenv:docker-tests]
deps =
  pip >= 20.3.3
  pytest
  asyncpg==0.20.1
  docker-compose >= 1.25.2
  mysql-connector-python ~=  8.0
  pymongo ~= 3.1
  PyMySQL ~= 0.10.1
  psycopg2 ~= 2.8.4
  aiopg >= 0.13.0, < 1.3.0
  sqlalchemy ~= 1.4
  redis ~= 3.3.11
  celery[pytest] >= 4.0, < 6.0
  protobuf>=3.13.0
  requests==2.25.0
  pyodbc~=4.0.30

changedir =
  tests/opentelemetry-docker-tests/tests

commands_pre =
  pip install -e {toxinidir}/opentelemetry-python-core/opentelemetry-api \
              -e {toxinidir}/opentelemetry-python-core/opentelemetry-semantic-conventions \
              -e {toxinidir}/opentelemetry-python-core/opentelemetry-instrumentation \
              -e {toxinidir}/opentelemetry-python-core/opentelemetry-sdk \
              -e {toxinidir}/opentelemetry-python-core/tests/util \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-asyncpg \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-celery \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-dbapi \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-mysql \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-psycopg2 \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymongo \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-pymysql \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-sqlalchemy \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-aiopg \
              -e {toxinidir}/instrumentation/opentelemetry-instrumentation-redis \
              -e {toxinidir}/opentelemetry-python-core/exporter/opentelemetry-exporter-opencensus
  docker-compose up -d
  python check_availability.py

commands =
  pytest {posargs}

commands_post =
  docker-compose down -v

[testenv:generate]
deps =
  -r {toxinidir}/gen-requirements.txt

commands =
  {toxinidir}/scripts/generate_setup.py
  {toxinidir}/scripts/generate_instrumentation_bootstrap.py