Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c40f10d

Browse files
author
alrex
authored
remove dependency on contrib repo to run tox (open-telemetry#2108)
1 parent 9020b0b commit c40f10d

File tree

8 files changed

+26
-27
lines changed

8 files changed

+26
-27
lines changed

‎.flake8

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,3 @@ exclude =
2424
docs/examples/opentelemetry-example-app/build/*
2525
opentelemetry-proto/build/*
2626
opentelemetry-proto/src/opentelemetry/proto/
27-
opentelemetry-python-contrib/

‎.github/workflows/test.yml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,6 @@ jobs:
3232
steps:
3333
- name: Checkout Core Repo @ SHA - ${{ github.sha }}
3434
uses: actions/checkout@v2
35-
- name: Checkout Contrib Repo @ SHA - ${{ env.CONTRIB_REPO_SHA }}
36-
uses: actions/checkout@v2
37-
with:
38-
repository: open-telemetry/opentelemetry-python-contrib
39-
ref: ${{ env.CONTRIB_REPO_SHA }}
40-
path: opentelemetry-python-contrib
4135
- name: Set up Python ${{ env[matrix.python-version] }}
4236
uses: actions/setup-python@v2
4337
with:
@@ -93,12 +87,6 @@ jobs:
9387
steps:
9488
- name: Checkout Core Repo @ SHA - ${{ github.sha }}
9589
uses: actions/checkout@v2
96-
- name: Checkout Contrib Repo @ SHA - ${{ env.CONTRIB_REPO_SHA }}
97-
uses: actions/checkout@v2
98-
with:
99-
repository: open-telemetry/opentelemetry-python-contrib
100-
ref: ${{ env.CONTRIB_REPO_SHA }}
101-
path: opentelemetry-python-contrib
10290
- name: Set up Python
10391
uses: actions/setup-python@v2
10492
with:

‎.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ lib64
2424
__pycache__
2525
venv*/
2626
.venv*/
27-
opentelemetry-python-contrib/
28-
# in case of symlink
29-
opentelemetry-python-contrib
3027

3128
# Installer logs
3229
pip-log.txt

‎.isort.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ profile=black
1414
; docs: https://github.com/timothycrosley/isort#multi-line-output-modes
1515
multi_line_output=3
1616
skip=target
17-
skip_glob=**/gen/*,.venv*/*,venv*/*,**/proto/*,opentelemetry-python-contrib/*,.tox/*
17+
skip_glob=**/gen/*,.venv*/*,venv*/*,**/proto/*,.tox/*
1818
known_first_party=opentelemetry,opentelemetry_example_app
1919
known_third_party=psutil,pytest,redis,redis_opentracing

‎CONTRIBUTING.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,6 @@ ships with this project. First create a virtualenv and activate it.
5050
Then run `python scripts/eachdist.py develop` to install all required packages
5151
as well as the project's packages themselves (in `--editable` mode).
5252

53-
Further, you'll want to clone the Contrib repo locally to resolve paths needed
54-
to run tests. `git clone [email protected]:open-telemetry/opentelemetry-python-contrib.git opentelemetry-python-contrib`.
55-
5653
You can then run `scripts/eachdist.py test` to test everything or
5754
`scripts/eachdist.py lint` to lint everything (fixing anything that is auto-fixable).
5855

@@ -81,6 +78,19 @@ See
8178
[`tox.ini`](https://github.com/open-telemetry/opentelemetry-python/blob/main/tox.ini)
8279
for more detail on available tox commands.
8380

81+
#### Contrib repo
82+
83+
Some of the `tox` targets install packages from the [OpenTelemetry Python Contrib Repository](https://github.com/open-telemetry/opentelemetry-python.git) via
84+
pip. The version of the packages installed defaults to the `main` branch in that repository when `tox` is run locally. It is possible to install packages tagged
85+
with a specific git commit hash by setting an environment variable before running tox as per the following example:
86+
87+
```
88+
CONTRIB_REPO_SHA=dde62cebffe519c35875af6d06fae053b3be65ec tox
89+
```
90+
91+
The continuation integration overrides that environment variable with as per the configuration
92+
[here](https://github.com/open-telemetry/opentelemetry-python/blob/9020b0baaeb41b7137badca988bb5c2d562cddee/.github/workflows/test.yml#L13).
93+
8494
### Benchmarks
8595

8696
Performance progression of benchmarks for packages distributed by OpenTelemetry Python can be viewed as a [graph of throughput vs commit history](https://opentelemetry-python.readthedocs.io/en/latest/performance/benchmarks.html). From the linked page, you can download a JSON file with the performance results.

‎eachdist.ini

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# These will be sorted first in that order.
22
# All packages that are depended upon by others should be listed here.
33
[DEFAULT]
4-
ignore=
5-
opentelemetry-python-contrib
64

75
sortfirst=
86
opentelemetry-api

‎pyproject.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ exclude = '''
44
(
55
/( # generated files
66
.tox|
7-
opentelemetry-python-contrib|
87
exporter/opentelemetry-exporter-jaeger-proto-grpc/src/opentelemetry/exporter/jaeger/proto/grpc/gen|
98
exporter/opentelemetry-exporter-jaeger-thrift/src/opentelemetry/exporter/jaeger/thrift/gen|
109
exporter/opentelemetry-exporter-zipkin-proto-http/src/opentelemetry/exporter/zipkin/proto/http/v2/gen|

‎tox.ini

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ deps =
8181
mypy,mypyinstalled: mypy
8282

8383
setenv =
84+
; override CONTRIB_REPO_SHA via env variable when testing other branches/commits than main
85+
; i.e: CONTRIB_REPO_SHA=dde62cebffe519c35875af6d06fae053b3be65ec tox -e <env to test>
86+
CONTRIB_REPO_SHA={env:CONTRIB_REPO_SHA:"main"}
87+
CONTRIB_REPO="git+https://github.com/open-telemetry/opentelemetry-python-contrib.git@{env:CONTRIB_REPO_SHA}"
8488
mypy: MYPYPATH={toxinidir}/opentelemetry-api/src/
8589

8690
changedir =
@@ -121,7 +125,11 @@ commands_pre =
121125
distro: pip install {toxinidir}/opentelemetry-distro
122126
instrumentation: pip install {toxinidir}/opentelemetry-instrumentation
123127

124-
getting-started: pip install requests==2.26.0 flask==2.0.1 -e {toxinidir}/opentelemetry-instrumentation -e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-requests {toxinidir}/opentelemetry-python-contrib/util/opentelemetry-util-http -e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-wsgi -e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-flask
128+
getting-started: pip install requests==2.26.0 flask==2.0.1 -e {toxinidir}/opentelemetry-instrumentation
129+
getting-started: pip install -e "{env:CONTRIB_REPO}#egg=opentelemetry-instrumentation-requests&subdirectory=instrumentation/opentelemetry-instrumentation-requests"
130+
getting-started: pip install -e "{env:CONTRIB_REPO}#egg=opentelemetry-instrumentation-wsgi&subdirectory=instrumentation/opentelemetry-instrumentation-wsgi"
131+
getting-started: pip install -e "{env:CONTRIB_REPO}#egg=opentelemetry-util-http&subdirectory=util/opentelemetry-util-http"
132+
getting-started: pip install -e "{env:CONTRIB_REPO}#egg=opentelemetry-instrumentation-flask&subdirectory=instrumentation/opentelemetry-instrumentation-flask"
125133

126134
opencensus: pip install {toxinidir}/exporter/opentelemetry-exporter-opencensus
127135

@@ -246,9 +254,9 @@ commands_pre =
246254
-e {toxinidir}/opentelemetry-semantic-conventions \
247255
-e {toxinidir}/opentelemetry-instrumentation \
248256
-e {toxinidir}/opentelemetry-sdk \
249-
-e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-requests \
250-
-e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-wsgi \
251-
-e {toxinidir}/opentelemetry-python-contrib/util/opentelemetry-util-http
257+
-e "{env:CONTRIB_REPO}#egg=opentelemetry-instrumentation-requests&subdirectory=instrumentation/opentelemetry-instrumentation-requests" \
258+
-e "{env:CONTRIB_REPO}#egg=opentelemetry-instrumentation-wsgi&subdirectory=instrumentation/opentelemetry-instrumentation-wsgi" \
259+
-e "{env:CONTRIB_REPO}#egg=opentelemetry-util-http&subdirectory=util/opentelemetry-util-http"
252260

253261
commands =
254262
{toxinidir}/scripts/tracecontext-integration-test.sh

0 commit comments

Comments
 (0)