Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/python-code-quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ jobs:
os: ${{ runner.os }}
env:
UV_CACHE_DIR: /tmp/.uv-cache
- name: Test Markdown file selection
run: uv run --locked --group tool-markdown python -m unittest discover -s scripts/tests -p test_check_md_code_blocks.py
- name: Run samples checks
run: uv run poe check -S
- name: Run markdown code lint
Expand Down
2 changes: 1 addition & 1 deletion python/scripts/check_md_code_blocks.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def expand_file_patterns(patterns: list[str], skip_glob: bool = False) -> list[s
# When skip_glob is True, treat patterns as literal file paths
# Only include if it's a markdown file
if pattern.endswith(".md"):
matches = glob.glob(pattern, recursive=False)
matches = glob.glob(glob.escape(pattern), recursive=False)
all_files.extend(matches)
else:
# Handle both relative and absolute paths with glob expansion
Expand Down
81 changes: 81 additions & 0 deletions python/scripts/tests/test_check_md_code_blocks.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Copyright (c) Microsoft. All rights reserved.

"""Regression tests for literal Markdown file selection."""

import subprocess
import sys
import tempfile
import unittest
from pathlib import Path

from scripts.check_md_code_blocks import expand_file_patterns


class MarkdownFileSelectionTests(unittest.TestCase):
def setUp(self) -> None:
self.temp_dir = tempfile.TemporaryDirectory()
self.addCleanup(self.temp_dir.cleanup)
self.root = Path(self.temp_dir.name)

def markdown(self, name: str) -> str:
path = self.root / name
path.parent.mkdir(parents=True, exist_ok=True)
path.write_text("```python\nprint('example')\n```\n", encoding="utf-8")
return str(path)

def test_literal_bracketed_filename(self) -> None:
literal = self.markdown("guide[1].md")
self.assertEqual(expand_file_patterns([literal], skip_glob=True), [literal])

def test_literal_filename_does_not_select_glob_match(self) -> None:
literal = self.markdown("guide[1].md")
self.markdown("guide1.md")
self.assertEqual(expand_file_patterns([literal], skip_glob=True), [literal])

def test_literal_bracketed_directory(self) -> None:
literal = self.markdown("docs[1]/guide.md")
self.markdown("docs1/guide.md")
self.assertEqual(expand_file_patterns([literal], skip_glob=True), [literal])

def test_literal_mode_preserves_file_filtering(self) -> None:
ordinary = self.markdown("guide.md")
non_markdown = self.markdown("notes.txt")
missing = str(self.root / "missing.md")
self.assertEqual(
expand_file_patterns([ordinary, non_markdown, missing], skip_glob=True),
[ordinary],
)

def test_literal_mode_sorts_and_deduplicates(self) -> None:
first = self.markdown("a.md")
last = self.markdown("z.md")
self.assertEqual(expand_file_patterns([last, first, last], skip_glob=True), [first, last])

def test_default_mode_still_expands_brackets(self) -> None:
pattern = self.markdown("guide[1].md")
match = self.markdown("guide1.md")
self.assertEqual(expand_file_patterns([pattern]), [match])

def test_default_mode_still_expands_recursive_patterns(self) -> None:
first = self.markdown("guide.md")
nested = self.markdown("nested/guide.md")
pattern = str(self.root / "**" / "*.md")
self.assertEqual(expand_file_patterns([pattern]), sorted([first, nested]))

def test_cli_checks_the_literal_file(self) -> None:
literal = self.markdown("guide[1].md")
other = self.markdown("guide1.md")
script = Path(__file__).resolve().parents[1] / "check_md_code_blocks.py"
result = subprocess.run(
[sys.executable, "-B", str(script), "--no-glob", literal],
capture_output=True,
text=True,
check=False,
)
self.assertEqual(result.returncode, 0, result.stderr)
self.assertIn(literal, result.stderr)
self.assertNotIn(other, result.stderr)


if __name__ == "__main__":
unittest.main()
Loading