Add better debugging if hatch subprocess fails during bootstrap_gen by phillipuniverse · Pull Request #1672 · open-telemetry/opentelemetry-python-contrib

phillipuniverse · 2023-02-14T21:10:27Z

Description

This has been bugging me for a while, I could not run the tox -e generate command. It turns out that the problem was I had an empty directory in the instrumentations folder for an instrumentation I had started but never completed.

The problem is I had no indication as to where the problem was, or how I could fix it.

To reproduce, just mkdir instrumentation/opentelemetry-instrumentation-somelib and run tox -e generate.

Current output

(3.9.5/envs/opentelemetry-python-contrib) ~/opentelemetry-python-contrib ‹main*› » tox -e generate                                                                                          [15:08:14]
generate installed: anyio==3.6.2,astor==0.8.1,black==22.12.0,certifi==2022.12.7,charset-normalizer==3.0.1,click==8.1.3,commonmark==0.9.1,distlib==0.3.6,editables==0.3,filelock==3.9.0,h11==0.14.0,hatch==1.6.3,hatchling==1.12.2,httpcore==0.16.3,httpx==0.23.3,hyperlink==21.0.0,idna==3.4,importlib-metadata==6.0.0,isort==5.11.4,jaraco.classes==3.2.3,Jinja2==2.11.3,keyring==23.13.1,MarkupSafe==2.0.1,more-itertools==9.0.0,mypy-extensions==0.4.3,packaging==23.0,pathspec==0.10.3,pexpect==4.8.0,platformdirs==2.6.2,pluggy==1.0.0,ptyprocess==0.7.0,Pygments==2.14.0,pyperclip==1.8.2,requests==2.28.2,rfc3986==1.5.0,rich==13.1.0,shellingham==1.5.0.post1,sniffio==1.3.0,tomli==2.0.1,tomli_w==1.0.0,tomlkit==0.11.6,typing_extensions==4.4.0,urllib3==1.26.14,userpath==1.8.0,virtualenv==20.17.1,zipp==3.11.0
generate run-test-pre: PYTHONHASHSEED='418181719'
generate run-test: commands[0] | /Users/phillip/opentelemetry-python-contrib/scripts/generate_instrumentation_bootstrap.py
Traceback (most recent call last):
  File "/Users/phillip/opentelemetry-python-contrib/scripts/generate_instrumentation_bootstrap.py", line 104, in <module>
    main()
  File "/Users/phillip/opentelemetry-python-contrib/scripts/generate_instrumentation_bootstrap.py", line 62, in main
    for pkg in get_instrumentation_packages():
  File "/Users/phillip/opentelemetry-python-contrib/scripts/otel_packaging.py", line 31, in get_instrumentation_packages
    version = subprocess.check_output(
  File "/Users/phillip/.pyenv/versions/3.9.5/lib/python3.9/subprocess.py", line 424, in check_output
    return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
  File "/Users/phillip/.pyenv/versions/3.9.5/lib/python3.9/subprocess.py", line 528, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command 'hatch version' returned non-zero exit status 1.
ERROR: InvocationError for command /Users/phillip/opentelemetry-python-contrib/scripts/generate_instrumentation_bootstrap.py (exited with code 1)
_______________________________________________________________________________________________ summary ________________________________________________________________________________________________
ERROR:   generate: commands failed

With my change, this is the output of the failure:

Modified output

(3.9.5/envs/opentelemetry-python-contrib) ~/opentelemetry-python-contrib ‹hatch-version-debug*› » tox -e generate                                                                           [15:05:55]
generate installed: anyio==3.6.2,astor==0.8.1,black==22.12.0,certifi==2022.12.7,charset-normalizer==3.0.1,click==8.1.3,commonmark==0.9.1,distlib==0.3.6,editables==0.3,filelock==3.9.0,h11==0.14.0,hatch==1.6.3,hatchling==1.12.2,httpcore==0.16.3,httpx==0.23.3,hyperlink==21.0.0,idna==3.4,importlib-metadata==6.0.0,isort==5.11.4,jaraco.classes==3.2.3,Jinja2==2.11.3,keyring==23.13.1,MarkupSafe==2.0.1,more-itertools==9.0.0,mypy-extensions==0.4.3,packaging==23.0,pathspec==0.10.3,pexpect==4.8.0,platformdirs==2.6.2,pluggy==1.0.0,ptyprocess==0.7.0,Pygments==2.14.0,pyperclip==1.8.2,requests==2.28.2,rfc3986==1.5.0,rich==13.1.0,shellingham==1.5.0.post1,sniffio==1.3.0,tomli==2.0.1,tomli_w==1.0.0,tomlkit==0.11.6,typing_extensions==4.4.0,urllib3==1.26.14,userpath==1.8.0,virtualenv==20.17.1,zipp==3.11.0
generate run-test-pre: PYTHONHASHSEED='2056460220'
generate run-test: commands[0] | /Users/phillip/opentelemetry-python-contrib/scripts/generate_instrumentation_bootstrap.py
Could not get hatch version from path /Users/phillip/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-somelib
╭─────────────────────────────── Traceback (most recent call last) ────────────────────────────────╮
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/hatch/cli/ │
│ __init__.py:205 in main                                                                          │
│                                                                                                  │
│   202                                                                                            │
│   203 def main():  # no cov                                                                      │
│   204 │   try:                                                                                   │
│ ❱ 205 │   │   return hatch(windows_expand_args=False)                                            │
│   206 │   except Exception:                                                                      │
│   207 │   │   from rich.console import Console                                                   │
│   208                                                                                            │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/click/core │
│ .py:1130 in __call__                                                                             │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/click/core │
│ .py:1055 in main                                                                                 │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/click/core │
│ .py:1657 in invoke                                                                               │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/click/core │
│ .py:1404 in invoke                                                                               │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/click/core │
│ .py:760 in invoke                                                                                │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/click/deco │
│ rators.py:38 in new_func                                                                         │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/hatch/cli/ │
│ version/__init__.py:20 in version                                                                │
│                                                                                                  │
│   17 │                                                                                           │
│   18 │   with app.project.location.as_cwd():                                                     │
│   19 │   │   if not (                                                                            │
│ ❱ 20 │   │   │   'version' in app.project.metadata.dynamic or app.project.metadata.hatch.meta    │
│   21 │   │   ) or dependencies_in_sync(app.project.metadata.build.requires_complex):             │
│   22 │   │   │   source = app.project.metadata.hatch.version.source                              │
│   23                                                                                             │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/hatchling/ │
│ metadata/core.py:94 in dynamic                                                                   │
│                                                                                                  │
│     91 │   def dynamic(self) -> list[str]:                                                       │
│     92 │   │   # Keep track of the original dynamic fields before depopulation                   │
│     93 │   │   if self._dynamic is None:                                                         │
│ ❱   94 │   │   │   dynamic = self.core_raw_metadata.get('dynamic', [])                           │
│     95 │   │   │   if not isinstance(dynamic, list):                                             │
│     96 │   │   │   │   message = 'Field `project.dynamic` must be an array'                      │
│     97 │   │   │   │   raise TypeError(message)                                                  │
│                                                                                                  │
│ /Users/phillip/opentelemetry-python-contrib/.tox/generate/lib/python3.9/site-packages/hatchling/ │
│ metadata/core.py:79 in core_raw_metadata                                                         │
│                                                                                                  │
│     76 │   │   if self._core_raw_metadata is None:                                               │
│     77 │   │   │   if 'project' not in self.config:                                              │
│     78 │   │   │   │   message = 'Missing `project` metadata table in configuration'             │
│ ❱   79 │   │   │   │   raise ValueError(message)                                                 │
│     80 │   │   │                                                                                 │
│     81 │   │   │   core_raw_metadata = self.config['project']                                    │
│     82 │   │   │   if not isinstance(core_raw_metadata, dict):                                   │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
ValueError: Missing `project` metadata table in configuration

Traceback (most recent call last):
  File "/Users/phillip/opentelemetry-python-contrib/scripts/generate_instrumentation_bootstrap.py", line 104, in <module>
    main()
  File "/Users/phillip/opentelemetry-python-contrib/scripts/generate_instrumentation_bootstrap.py", line 62, in main
    for pkg in get_instrumentation_packages():
  File "/Users/phillip/opentelemetry-python-contrib/scripts/otel_packaging.py", line 42, in get_instrumentation_packages
    raise e
  File "/Users/phillip/opentelemetry-python-contrib/scripts/otel_packaging.py", line 33, in get_instrumentation_packages
    version = subprocess.check_output(
  File "/Users/phillip/.pyenv/versions/3.9.5/lib/python3.9/subprocess.py", line 424, in check_output
    return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
  File "/Users/phillip/.pyenv/versions/3.9.5/lib/python3.9/subprocess.py", line 528, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command 'hatch version' returned non-zero exit status 1.
ERROR: InvocationError for command /Users/phillip/opentelemetry-python-contrib/scripts/generate_instrumentation_bootstrap.py (exited with code 1)
_______________________________________________________________________________________________ summary ________________________________________________________________________________________________
ERROR:   generate: commands failed

Fixes # (issue)

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Local observation

Does This PR Require a Core Repo Change?

Yes. - Link to PR:
No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

scripts/otel_packaging.py

phillipuniverse · 2023-02-15T14:43:19Z

@shalevr @srikanthccv looks like the auto-merge got disabled on this one after my push.

…/github.com/shalevr/opentelemetry-python-contrib into Change-metrics-tests-to-work-with-test_base * 'Change-metrics-tests-to-work-with-test_base' of https://github.com/shalevr/opentelemetry-python-contrib: Fix issue with Flask instrumentation when a request spawn children threads and copies the request context (open-telemetry#1654) Add connection attributes to sqlalchemy connect span (open-telemetry#1608) Add boto3sqs to docs (open-telemetry#1666) Audit and test opentelemetry-instrumentation-elasticsearch NoOpTracer… (open-telemetry#1616) Copy change log updates from release/v1.16.x-0.37bx (open-telemetry#1683) Update version to 1.17.0.dev/0.38b0.dev (open-telemetry#1677) Fix CI Failure (open-telemetry#1680) Add better debugging if hatch subprocess fails (open-telemetry#1672) Add confluent kafka docs (open-telemetry#1668) Support aio_pika 9 (open-telemetry#1670) Audit and test opentelemetry-instrumentation-wsgi NoOpTracerProvider (open-telemetry#1610) bot (open-telemetry#1667) Add commit method for ConfluentKafkaInstrumentor's ProxiedConsumer (open-telemetry#1656) Revert open-telemetry#1097 (open-telemetry#1660) Audit and test opentelemetry-instrumentation-django NoOpTracerProvider (open-telemetry#1611) Audit and test opentelemetry-instrumentation-aiohttp-client NoOpTrace… (open-telemetry#1612) Audit and test opentelemetry-instrumentation-flask NoOpTracerProvider (open-telemetry#1614) Audit and test opentelemetry-instrumentation-dbapi NoOpTracerProvider (open-telemetry#1607)

phillipuniverse requested a review from a team February 14, 2023 21:10

phillipuniverse changed the title ~~Add better debugging if hatch subprocess fails~~ Add better debugging if hatch subprocess fails during bootstrap_gen Feb 14, 2023

srikanthccv approved these changes Feb 15, 2023

View reviewed changes

srikanthccv added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Feb 15, 2023

srikanthccv enabled auto-merge (squash) February 15, 2023 11:43

shalevr reviewed Feb 15, 2023

View reviewed changes

scripts/otel_packaging.py Outdated Show resolved Hide resolved

shalevr approved these changes Feb 15, 2023

View reviewed changes

Add better debugging if hatch subprocess fails

e7396c8

auto-merge was automatically disabled February 15, 2023 14:33
Head branch was pushed to by a user without write access

phillipuniverse force-pushed the hatch-version-debug branch from d174243 to e7396c8 Compare February 15, 2023 14:33

srikanthccv merged commit ffbbb4d into open-telemetry:main Feb 15, 2023

phillipuniverse deleted the hatch-version-debug branch February 15, 2023 16:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add better debugging if hatch subprocess fails during bootstrap_gen#1672

Add better debugging if hatch subprocess fails during bootstrap_gen#1672
srikanthccv merged 1 commit intoopen-telemetry:mainfrom
phillipuniverse:hatch-version-debug

phillipuniverse commented Feb 14, 2023

Uh oh!

Uh oh!

phillipuniverse commented Feb 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

phillipuniverse commented Feb 14, 2023

Description

Type of change

How Has This Been Tested?

Does This PR Require a Core Repo Change?

Checklist:

Uh oh!

Uh oh!

phillipuniverse commented Feb 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants