PyPi sources are missing util directory reqiured for tests

[glaubitz]

I'm currently trying to upgrade the opentelemtry-api package in openSUSE from 1.1.0 to 1.6.2 using the sources from PyPi.

Running the testsuite fails because the PyPy sources are missing some of the testsuite dependencies:

[    5s] + pytest-3.6 --ignore=_build.python36 --ignore=_build.python39 --ignore=_build.python38 -v
[    5s] ============================= test session starts ==============================
[    5s] platform linux -- Python 3.6.15, pytest-6.2.5, py-1.10.0, pluggy-1.0.0 -- /usr/bin/python3.6
[    5s] cachedir: .pytest_cache
[    5s] rootdir: /home/abuild/rpmbuild/BUILD/opentelemetry-api-1.6.2
[    5s] collecting ... collected 99 items / 3 errors / 96 selected
[    5s] 
[    5s] ==================================== ERRORS ====================================
[    5s] _________________ ERROR collecting tests/trace/test_globals.py _________________
[    5s] ImportError while importing test module '/home/abuild/rpmbuild/BUILD/opentelemetry-api-1.6.2/tests/trace/test_globals.py'.
[    5s] Hint: make sure your test modules/packages have valid Python names.
[    5s] Traceback:
[    5s] /usr/lib64/python3.6/importlib/__init__.py:126: in import_module
[    5s]     return _bootstrap._gcd_import(name[level:], package, level)
[    5s] tests/trace/test_globals.py:5: in <module>
[    5s]     from opentelemetry.test.concurrency_test import ConcurrencyTestBase, MockFunc
[    5s] E   ModuleNotFoundError: No module named 'opentelemetry.test'
[    5s] __________________ ERROR collecting tests/trace/test_proxy.py __________________
[    5s] ImportError while importing test module '/home/abuild/rpmbuild/BUILD/opentelemetry-api-1.6.2/tests/trace/test_proxy.py'.
[    5s] Hint: make sure your test modules/packages have valid Python names.
[    5s] Traceback:
[    5s] /usr/lib64/python3.6/importlib/__init__.py:126: in import_module
[    5s]     return _bootstrap._gcd_import(name[level:], package, level)
[    5s] tests/trace/test_proxy.py:20: in <module>
[    5s]     from opentelemetry.test.globals_test import TraceGlobalsTest
[    5s] E   ModuleNotFoundError: No module named 'opentelemetry.test'
[    5s] ___________________ ERROR collecting tests/util/test_once.py ___________________
[    5s] ImportError while importing test module '/home/abuild/rpmbuild/BUILD/opentelemetry-api-1.6.2/tests/util/test_once.py'.
[    5s] Hint: make sure your test modules/packages have valid Python names.
[    5s] Traceback:
[    5s] /usr/lib64/python3.6/importlib/__init__.py:126: in import_module
[    5s]     return _bootstrap._gcd_import(name[level:], package, level)
[    5s] tests/util/test_once.py:15: in <module>
[    5s]     from opentelemetry.test.concurrency_test import ConcurrencyTestBase, MockFunc
[    5s] E   ModuleNotFoundError: No module named 'opentelemetry.test'
[    5s] =========================== short test summary info ============================
[    5s] ERROR tests/trace/test_globals.py
[    5s] ERROR tests/trace/test_proxy.py
[    5s] ERROR tests/util/test_once.py
[    5s] !!!!!!!!!!!!!!!!!!! Interrupted: 3 errors during collection !!!!!!!!!!!!!!!!!!!!
[    5s] ============================== 3 errors in 0.38s ===============================
[    5s] error: Bad exit status from /var/tmp/rpm-tmp.1B6CG6 (%check)

[owais]

This package is not published to pypi and can be installed directly from https://github.com/open-telemetry/opentelemetry-python/tree/main/tests/util

[glaubitz]

This package is not published to pypi and can be installed directly from https://github.com/open-telemetry/opentelemetry-python/tree/main/tests/util

Yes, that's my point. It's currently not easily possible to package opentelemetry-api in distributions because of that.

[owais]

It should be possible to package it as this is not a runtime dependency but if the build needs to run the test suite before building the packages then it needs this dep which can be installed from git. This should be automatically handled if tox is used to run the tests. If that is not viable for some reason, running the following command before testing should do it:

pip install git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-test&subdirectory=tests/util

[owais]

If there are compelling enough reasons, we can publish the package to pypi. I don't think it should be a problem but so far we haven't seen any use cases where it'd make a significant difference.

[glaubitz]

It should be possible to package it as this is not a runtime dependency but if the build needs to run the test suite before building the packages then it needs this dep which can be installed from git. This should be automatically handled if tox is used to run the tests. If that is not viable for some reason, running the following command before testing should do it:

pip install git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-test&subdirectory=tests/util

The build servers cannot download any code for security reasons. No Linux distribution that I know of allows code downloads during builds.

[glaubitz]

If there are compelling enough reasons, we can publish the package to pypi. I don't think it should be a problem but so far we haven't seen any use cases where it'd make a significant difference.

That would be really appreciated. I have been spending a lot of time now getting all the individual opentelemetry Python packages updated in openSUSE and it's quite frustrating due to the various issues with the testsuite.

[owais]

@open-telemetry/python-maintainers I think we should publish the test utils package to pypi to make life easier for people re-packing Otel for different platforms. It can perpetually stay unstable (0.x) and we can document that it is meant for internal Otel use only. Any concerns?

[ocelotl]

@open-telemetry/python-maintainers I think we should publish the test utils package to pypi to make life easier for people re-packing Otel for different platforms. It can perpetually stay unstable (0.x) and we can document that it is meant for internal Otel use only. Any concerns?

sounds good to me 👍