Repository navigation
fix: guard enclosure against None/non-positive length values #457
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
Open
Zerthick
wants to merge
1
commit into
Guts:main
Choose a base branch
from
Zerthick:fix/enclosure-length-guard
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.
Open
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| #! python3 # noqa: E265 | ||
|
|
||
| """Test that <enclosure> is omitted when image length is None or non-positive. | ||
|
|
||
| When a remote image returns 404, the length field becomes None, | ||
| which would produce invalid XML like <enclosure length="None" />. | ||
|
|
||
| Usage from the repo root folder: | ||
|
|
||
| python -m unittest tests.test_enclosure_guard | ||
|
|
||
| """ | ||
|
|
||
| # ############################################################################# | ||
| # ########## Libraries ############# | ||
| # ################################## | ||
|
|
||
| # Standard library | ||
| import logging | ||
| import tempfile | ||
| from pathlib import Path | ||
| from traceback import format_exception | ||
|
|
||
| # test suite | ||
| from tests.base import BaseTest | ||
|
|
||
| # -- Globals -- | ||
| logger = logging.getLogger(__name__) | ||
| logger.setLevel(logging.DEBUG) | ||
|
|
||
| OUTPUT_RSS_FEED_CREATED = "feed_rss_created.xml" | ||
|
|
||
| # ############################################################################# | ||
| # ########## Classes ############### | ||
| # ################################## | ||
|
|
||
|
|
||
| class TestEnclosureGuard(BaseTest): | ||
| """Test that <enclosure> is properly guarded against invalid length values.""" | ||
|
|
||
| def test_enclosure_guard_none_length(self): | ||
| """Verify that <enclosure> is omitted when image length is None or non-positive. | ||
|
|
||
| When a remote image returns 404, the length field becomes None, | ||
| which would produce invalid XML like <enclosure length="None" />. | ||
| """ | ||
| with tempfile.TemporaryDirectory() as tmpdirname: | ||
| cli_result = self.build_docs_setup( | ||
| testproject_path="docs", | ||
| mkdocs_yml_filepath=Path("tests/fixtures/mkdocs_complete.yml"), | ||
| output_path=tmpdirname, | ||
| strict=True, | ||
| ) | ||
|
|
||
| if cli_result.exception is not None: | ||
| e = cli_result.exception | ||
| logger.debug(format_exception(type(e), e, e.__traceback__)) | ||
|
|
||
| self.assertEqual(cli_result.exit_code, 0) | ||
| self.assertIsNone(cli_result.exception) | ||
|
|
||
| # Read raw XML content | ||
| rss_path = Path(tmpdirname) / OUTPUT_RSS_FEED_CREATED | ||
| rss_content = rss_path.read_text() | ||
|
|
||
| # Check that no enclosure has length="None" or length="0" or negative | ||
| self.assertNotIn( | ||
| 'length="None"', | ||
| rss_content, | ||
| "Found enclosure with length='None'. " | ||
| "The template should guard against None length values.", | ||
| ) | ||
| self.assertNotIn( | ||
| 'length="0"', | ||
| rss_content, | ||
| "Found enclosure with length='0'. " | ||
| "The template should guard against zero length values.", | ||
| ) |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As #455 and #456, this module can be replaced by a mocked unknown length in a single
test_build.pymethod making it deterministic.