open-telemetry / open-telemetry/opentelemetry-python-genai

Re-record AI-generated cassettes for OpenAI Responses retrieve tests

Open Beginner friendly
#341 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
39
Forks
63
Avg merge
1d 15h
Merged PRs (30d)
175

Description

The Responses.retrieve / AsyncResponses.retrieve tests added in #184 are backed by cassettes that were synthesized without provider access, so they carry the # TODO: this is generated by AI, re-record marker required by CONTRIBUTING.md.

Affected cassettes in instrumentation/opentelemetry-instrumentation-genai-openai/tests/cassettes/:

  • test_responses_retrieve_basic[content_mode0].yaml
  • test_responses_retrieve_captures_content[content_mode0].yaml
  • test_responses_retrieve_api_error[content_mode0].yaml
  • test_async_responses_retrieve_basic[content_mode0].yaml
  • test_async_responses_retrieve_captures_content[content_mode0].yaml
  • test_async_responses_retrieve_api_error[content_mode0].yaml

To resolve, per CONTRIBUTING.md: delete the cassettes, export a real OPENAI_API_KEY, rerun the retrieve tests so pytest-vcr records the live interactions, confirm vcr_config() scrubbed the auth/org/project headers, and remove the markers.

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 with CONTRIBUTING.md and the Responses.retrieve and AsyncResponses.retrieve tests that use the six named cassettes under instrumentation/opentelemetry-instrumentation-genai-openai/tests/cassettes/. Delete those cassettes, export a real OPENAI_API_KEY, and rerun the retrieve tests so pytest-vcr records live interactions. Done means the cassettes are regenerated, auth/org/project headers are scrubbed by vcr_config(), and the AI-generation markers are gone.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.