fix: add condition to init encoder

[jamescalam]

PR Type

Bug fix, Tests

---

Description

• Added a condition to the openai_encoder fixture to return a BaseEncoder instance if the OPENAI_API_KEY environment variable is not set.
• This change ensures that tests do not fail when the OPENAI_API_KEY is missing.
• Added import for BaseEncoder in the test file.

---

Changes walkthrough 📝

	Relevant files
Bug fix	test_openai_integration.py Add condition to initialize OpenAI encoder based on API key. tests/integration/encoders/test_openai_integration.py Added import for BaseEncoder. Modified openai_encoder fixture to return BaseEncoder if OPENAI_API_KEY is not set. +5/-1

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[github-actions]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	2
🧪 Relevant tests	Yes
🔒 Security concerns	No
⚡ Key issues to review	None

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Change the behavior to raise an exception when the required environment variable is not set Instead of returning a BaseEncoder instance when the OPENAI_API_KEY is not set, it might be more appropriate to raise an exception. This would prevent the test from silently passing with a different encoder than intended, which could lead to misleading test results. tests/integration/encoders/test_openai_integration.py [12-13] if os.environ.get("OPENAI_API_KEY") is None: - return BaseEncoder() + raise EnvironmentError("OPENAI_API_KEY is not set") Suggestion importance[1-10]: 9 Why: Raising an exception when the OPENAI_API_KEY is not set ensures that the test fails explicitly, preventing misleading results and making it clear that a required configuration is missing.	9
Enhancement	Add logging for better error tracking when the environment variable is missing To ensure that the openai_encoder fixture is more robust, consider adding a logging statement before raising an exception. This will help in debugging by providing a clear log message about why the test setup failed. tests/integration/encoders/test_openai_integration.py [12-13] if os.environ.get("OPENAI_API_KEY") is None: + logger.error("OPENAI_API_KEY environment variable is required but not set.") raise EnvironmentError("OPENAI_API_KEY is not set") Suggestion importance[1-10]: 8 Why: Adding a logging statement before raising an exception enhances debuggability by providing clear information about the failure reason, which is valuable for diagnosing issues.	8
Maintainability	Simplify the conditional logic for returning the encoder using a ternary operator To make the test setup more explicit and clear, consider using a ternary conditional operator for returning the encoder based on the presence of the OPENAI_API_KEY. This reduces the lines of code and increases readability. tests/integration/encoders/test_openai_integration.py [12-15] -if os.environ.get("OPENAI_API_KEY") is None: - return BaseEncoder() -else: - return OpenAIEncoder() +return OpenAIEncoder() if os.environ.get("OPENAI_API_KEY") else BaseEncoder() Suggestion importance[1-10]: 7 Why: Using a ternary operator simplifies the code and improves readability, but it is a minor improvement and does not affect the overall functionality.	7
Best practice	Improve readability and conformity by using os.getenv for environment variables Consider using os.getenv instead of os.environ.get for fetching environment variables. os.getenv is more commonly used in Python for this purpose and is functionally equivalent but slightly shorter and more readable. tests/integration/encoders/test_openai_integration.py [12] -if os.environ.get("OPENAI_API_KEY") is None: +if os.getenv("OPENAI_API_KEY") is None: Suggestion importance[1-10]: 6 Why: Using os.getenv improves readability and is a common practice in Python, but it does not significantly impact the functionality of the code.	6

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.83%. Comparing base (43779a6) to head (26070a3).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #329   +/-   ##
=======================================
  Coverage   71.83%   71.83%           
=======================================
  Files          45       45           
  Lines        2901     2901           
=======================================
  Hits         2084     2084           
  Misses        817      817           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.