-
Notifications
You must be signed in to change notification settings - Fork 52
fix: render standard-test assertion messages correctly #1141
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
Draft
devin-ai-integration
wants to merge
2
commits into
main
Choose a base branch
from
devin/1788275255-fix-standard-test-assert-messages
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Copyright (c) 2025 Airbyte, Inc., all rights reserved. | ||
| """Guards against assertion messages that never render as intended. | ||
|
|
||
| Two failure modes are covered: | ||
|
|
||
| - A string message containing a `{placeholder}` but missing the `f` prefix, which | ||
| prints the literal braces instead of the interpolated value. | ||
| - A tuple message, which is always truthy and prints as a tuple repr. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| import ast | ||
| import re | ||
| from pathlib import Path | ||
|
|
||
| import pytest | ||
|
|
||
| import airbyte_cdk.test.standard_tests as standard_tests | ||
|
|
||
| _PLACEHOLDER_PATTERN = re.compile(r"\{[A-Za-z_][A-Za-z0-9_.\[\]()!:'\"\s]*\}") | ||
| _STANDARD_TESTS_DIR = Path(standard_tests.__file__).parent | ||
|
|
||
|
|
||
| def _uninterpolated_placeholders(node: ast.expr) -> list[str]: | ||
| """Return placeholder-looking substrings that will print literally.""" | ||
| if isinstance(node, ast.Constant) and isinstance(node.value, str): | ||
| return _PLACEHOLDER_PATTERN.findall(node.value) | ||
|
|
||
| if isinstance(node, ast.JoinedStr): | ||
| # Implicit concatenation of f-string and plain-string fragments collapses | ||
| # into a single JoinedStr; plain fragments survive as Constant values. | ||
| found: list[str] = [] | ||
| for value in node.values: | ||
| found.extend(_uninterpolated_placeholders(value)) | ||
| return found | ||
|
|
||
| if isinstance(node, ast.BinOp) and isinstance(node.op, ast.Add): | ||
| # Messages built with `+` concatenation. | ||
| return _uninterpolated_placeholders(node.left) + _uninterpolated_placeholders(node.right) | ||
|
|
||
| return [] | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "source_file", | ||
| sorted(_STANDARD_TESTS_DIR.rglob("*.py")), | ||
| ids=lambda path: path.name, | ||
| ) | ||
| def test_assert_messages_are_renderable(source_file: Path) -> None: | ||
| tree = ast.parse(source_file.read_text(), filename=str(source_file)) | ||
| problems: list[str] = [] | ||
| for node in ast.walk(tree): | ||
| if not isinstance(node, ast.Assert) or node.msg is None: | ||
| continue | ||
|
|
||
| if isinstance(node.msg, ast.Tuple): | ||
| problems.append( | ||
| f"{source_file.name}:{node.lineno}: assert message is a tuple, " | ||
| "which is always truthy and prints as a tuple repr" | ||
| ) | ||
| continue | ||
|
|
||
| for placeholder in _uninterpolated_placeholders(node.msg): | ||
| problems.append( | ||
| f"{source_file.name}:{node.lineno}: assert message contains " | ||
| f"{placeholder} but the fragment is missing the `f` prefix" | ||
| ) | ||
|
|
||
| assert not problems, "\n".join(problems) | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.