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

Enhance Testing Infrastructure and Documentation #599

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

teocns
Copy link
Contributor

@teocns teocns commented Dec 23, 2024

Description

This PR improves the testing infrastructure and documentation by:

  1. Moving detailed testing documentation from CONTRIBUTING.md to a dedicated tests/README.md
  2. Adding comprehensive VCR.py configuration for HTTP interaction testing
  3. Implementing test fixtures for LLM event spying
  4. Adding proper test organization and best practices documentation

Key Changes

  • Created dedicated testing documentation in tests/README.md
  • Added VCR.py configuration in conftest.py for recording/replaying HTTP interactions
  • Implemented session-wide VCR stats tracking
  • Added filtering for sensitive API headers and credentials
  • Updated OpenAI integration tests with VCR markers (see Add OpenAI Integration Test (Sync/Async + Streaming) #598 )
  • Added new test fixtures for LLM providers
  • Added Constantin Teodorescu to contributors list

Testing

The changes have been tested by:

  • Running the full test suite
  • Verifying VCR cassette recording/playback
  • Testing OpenAI integration with the new infrastructure

Documentation

  • Moved testing documentation to dedicated tests/README.md
  • Added VCR.py usage instructions
  • Updated test organization guidelines
  • Added best practices for writing tests

@teocns teocns force-pushed the tests-improve branch 2 times, most recently from a563b31 to 2677ddd Compare December 23, 2024 04:22
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.

1 participant