Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove unused assertEqualSpanInstrumentationInfo #4310

Merged
merged 7 commits into from
Nov 26, 2024

Conversation

tammy-baylis-swi
Copy link
Contributor

@tammy-baylis-swi tammy-baylis-swi commented Nov 22, 2024

Description

It doesn't look like this repo uses assertEqualSpanInstrumentationInfo (grep).

All contrib repo uses were removed in open-telemetry/opentelemetry-python-contrib#3037.

This will break testing for any users that do from opentelemetry.test.test_base import TestBase and use assertEqualSpanInstrumentationInfo. However, there should have been warnings logged that lookup of instrumentation info has been deprecated since version 1.11.1 via calls to that helper instead of assertEqualSpanInstrumentationScope (see contrib issue OP)

Alternatively: We could add a logger to test_base or use print / sys.stdout to show a warning that assertEqualSpanInstrumentationInfo will be removed in a future release. Is that the approach we prefer?

Fixes #4301

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?

Run all unit tests.

Does This PR Require a Contrib Repo Change?

Checklist:

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

@tammy-baylis-swi tammy-baylis-swi marked this pull request as ready for review November 22, 2024 18:28
@tammy-baylis-swi tammy-baylis-swi requested a review from a team as a code owner November 22, 2024 18:28
@lzchen
Copy link
Contributor

lzchen commented Nov 25, 2024

I am not sure if our stability guarantees extend to testing utils so I am fine with removing it outright. I am also not against adding a warning about the removal and remove it in a subsequent release. Feel free to bring it up in the SIG so we can get a concensus.

@xrmx
Copy link
Contributor

xrmx commented Nov 26, 2024

I am not sure if our stability guarantees extend to testing utils so I am fine with removing it outright. I am also not against adding a warning about the removal and remove it in a subsequent release. Feel free to bring it up in the SIG so we can get a concensus.

There were warnings at runtime already when using it because the helper was accessing a deprecated property so it shouldn't come as a surpise 😅

CHANGELOG.md Outdated Show resolved Hide resolved
@xrmx xrmx merged commit 2ddb076 into open-telemetry:main Nov 26, 2024
353 checks passed
@tammy-baylis-swi tammy-baylis-swi deleted the rm-assertequal-instrinfo branch November 26, 2024 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove TestBase assertEqualSpanInstrumentationInfo when no longer used
3 participants