Fix test issues: Improve UTF-8 encoding and test reliability #4813
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1. Add UTF-8 encoding to file operations in docs_render_provider_snippets.py 2. Normalize path separators for cross-platform compatibility 3. Improve test reliability by increasing sleep time and max attempts 4. Add detailed comments explaining the changes These changes address the feedback from PR keephq#4721 review.
|
@Kunal-Darekar is attempting to deploy a commit to the KeepHQ Team on Vercel. A member of the Team first needs to authorize it. |
dosubot
bot
added
the
size:M
|
Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted. Details: |
|
No linked issues found. Please add the corresponding issues in the pull request description. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the test-related issues identified in the review of PR #4721 (FluxCD provider implementation). These changes have been separated into a dedicated PR as requested by the reviewer.
Changes:
UTF-8 Encoding Improvements:
Added explicit UTF-8 encoding to all file operations in scripts/docs_render_provider_snippets.py
Removed exception handling for UnicodeDecodeError to ensure all files use UTF-8 encoding
Path Normalization for Cross-Platform Compatibility:
Added path separator normalization (replacing backslashes with forward slashes)
Added clear comments explaining the purpose of path normalization
Ensures consistent paths on Windows and Unix-like systems
Test Reliability Improvements:
Increased sleep time from 1 to 2 seconds in tests/e2e_tests/incidents_alerts_tests/incidents_alerts_setup.py
Increased max attempts from 10 to 30
Added detailed error reporting with more debugging information
Added comprehensive comments explaining the changes
These improvements help reduce flaky test failures, especially in CI environments, and ensure consistent behavior across different platforms.
Related:
Addresses feedback from PR #4721