open-telemetry / open-telemetry/opentelemetry-python-contrib

Add sitecustomize.py tests for Auto-Instrumentation

Open
#1,104 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature-request
Dominant language
Python
Stars
1.1k
Forks
1.1k
Avg merge
4d 15h
Merged PRs (30d)
16

Description

Is your feature request related to a problem?
If so, provide a concise description of the problem:
Yes. There are currently no unit tests for sitecustomize.py. Such tests could have caught the Windows bug I noticed recently.

Describe the solution you'd like
What do you want to happen instead? What is the expected behavior?
I propose creating unit tests for sitecustomize to make sure it works and continues to work for linux, windows, and mac environments.

Describe alternatives you've considered
Which alternative solutions or features have you considered?

Additional context
Add any other context about the feature request here.
Adding tests was suggested in this PR I proposed creating this ticket instead since no test suite currently exists.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading sitecustomize.py and the testing discussion in PR #1100, then review the referenced Windows bug in #1102. Add unit coverage for Auto-Instrumentation behavior on Linux, Windows, and macOS, and run the new tests to confirm the platform cases are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.