1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
|
# test_sparse_patterns.py -- Sparse checkout (full and cone mode) pattern handling
# Copyright (C) 2013 Jelmer Vernooij <jelmer@jelmer.uk>
#
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
# Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
# General Public License as published by the Free Software Foundation; version 2.0
# or (at your option) any later version. You can redistribute it and/or
# modify it under the terms of either of these two licenses.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# You should have received a copy of the licenses; if not, see
# <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
# and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
# License, Version 2.0.
#
"""Tests for dulwich.sparse_patterns."""
import os
import shutil
import tempfile
import time
from dulwich.index import IndexEntry
from dulwich.objects import Blob
from dulwich.repo import Repo
from dulwich.sparse_patterns import (
BlobNotFoundError,
SparseCheckoutConflictError,
apply_included_paths,
compute_included_paths_cone,
compute_included_paths_full,
determine_included_paths,
match_gitignore_patterns,
parse_sparse_patterns,
)
from . import TestCase
class ParseSparsePatternsTests(TestCase):
"""Test parse_sparse_patterns function."""
def test_empty_and_comment_lines(self):
lines = [
"",
"# comment here",
" ",
"# another comment",
]
parsed = parse_sparse_patterns(lines)
self.assertEqual(parsed, [])
def test_simple_patterns(self):
lines = [
"*.py",
"!*.md",
"/docs/",
"!/docs/images/",
]
parsed = parse_sparse_patterns(lines)
self.assertEqual(len(parsed), 4)
self.assertEqual(parsed[0], ("*.py", False, False, False)) # include *.py
self.assertEqual(parsed[1], ("*.md", True, False, False)) # exclude *.md
self.assertEqual(parsed[2], ("docs", False, True, True)) # anchored, dir_only
self.assertEqual(parsed[3], ("docs/images", True, True, True))
def test_trailing_slash_dir(self):
lines = [
"src/",
]
parsed = parse_sparse_patterns(lines)
# "src/" => (pattern="src", negation=False, dir_only=True, anchored=False)
self.assertEqual(parsed, [("src", False, True, False)])
def test_negation_anchor(self):
lines = [
"!/foo.txt",
]
parsed = parse_sparse_patterns(lines)
# => (pattern="foo.txt", negation=True, dir_only=False, anchored=True)
self.assertEqual(parsed, [("foo.txt", True, False, True)])
class MatchGitignorePatternsTests(TestCase):
"""Test the match_gitignore_patterns function."""
def test_no_patterns_returns_excluded(self):
"""If no patterns are provided, by default we treat the path as excluded."""
self.assertFalse(match_gitignore_patterns("anyfile.py", []))
def test_last_match_wins(self):
"""Checks that the last pattern to match determines included vs excluded."""
parsed = parse_sparse_patterns(
[
"*.py", # include
"!foo.py", # exclude
]
)
# "foo.py" matches first pattern => included
# then matches second pattern => excluded
self.assertFalse(match_gitignore_patterns("foo.py", parsed))
def test_dir_only(self):
"""A pattern with a trailing slash should only match directories and subdirectories."""
parsed = parse_sparse_patterns(["docs/"])
# Because we set path_is_dir=False, it won't match
self.assertTrue(
match_gitignore_patterns("docs/readme.md", parsed, path_is_dir=False)
)
self.assertTrue(match_gitignore_patterns("docs", parsed, path_is_dir=True))
# Even if the path name is "docs", if it's a file, won't match:
self.assertFalse(match_gitignore_patterns("docs", parsed, path_is_dir=False))
def test_anchored(self):
"""Anchored patterns match from the start of the path only."""
parsed = parse_sparse_patterns(["/foo"])
self.assertTrue(match_gitignore_patterns("foo", parsed))
# But "some/foo" doesn't match because anchored requires start
self.assertFalse(match_gitignore_patterns("some/foo", parsed))
def test_unanchored_uses_fnmatch(self):
parsed = parse_sparse_patterns(["foo"])
self.assertTrue(match_gitignore_patterns("some/foo", parsed))
self.assertFalse(match_gitignore_patterns("some/bar", parsed))
def test_anchored_empty_pattern(self):
"""Test handling of empty pattern with anchoring (e.g., '/')."""
parsed = parse_sparse_patterns(["/"])
# Check the structure of the parsed empty pattern first
self.assertEqual(parsed, [("", False, False, True)])
# When the pattern is empty with anchoring, it's continued (skipped) in match_gitignore_patterns
# for non-empty paths but for empty string it might match due to empty string comparisons
self.assertFalse(match_gitignore_patterns("foo", parsed))
# An empty string with empty pattern will match (implementation detail)
self.assertTrue(match_gitignore_patterns("", parsed))
def test_anchored_dir_only_exact_match(self):
"""Test anchored directory-only patterns with exact matching."""
parsed = parse_sparse_patterns(["/docs/"])
# Test with exact match "docs" and path_is_dir=True
self.assertTrue(match_gitignore_patterns("docs", parsed, path_is_dir=True))
# Test with "docs/" (exact match + trailing slash)
self.assertTrue(match_gitignore_patterns("docs/", parsed, path_is_dir=True))
def test_complex_anchored_patterns(self):
"""Test more complex anchored pattern matching."""
parsed = parse_sparse_patterns(["/dir/subdir"])
# Test exact match
self.assertTrue(match_gitignore_patterns("dir/subdir", parsed))
# Test subdirectory path
self.assertTrue(match_gitignore_patterns("dir/subdir/file.txt", parsed))
# Test non-matching path
self.assertFalse(match_gitignore_patterns("otherdir/subdir", parsed))
def test_pattern_matching_edge_cases(self):
"""Test various edge cases in pattern matching."""
# Test exact equality with an anchored pattern
parsed = parse_sparse_patterns(["/foo"])
self.assertTrue(match_gitignore_patterns("foo", parsed))
# Test with path_is_dir=True
self.assertTrue(match_gitignore_patterns("foo", parsed, path_is_dir=True))
# Test exact match with pattern with dir_only=True
parsed = parse_sparse_patterns(["/bar/"])
self.assertTrue(match_gitignore_patterns("bar", parsed, path_is_dir=True))
# Test startswith match for anchored pattern
parsed = parse_sparse_patterns(["/prefix"])
self.assertTrue(
match_gitignore_patterns("prefix/subdirectory/file.txt", parsed)
)
class ComputeIncludedPathsFullTests(TestCase):
"""Test compute_included_paths_full using a real ephemeral repo index."""
def setUp(self):
super().setUp()
self.temp_dir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, self.temp_dir)
self.repo = Repo.init(self.temp_dir)
def _add_file_to_index(self, relpath, content=b"test"):
full = os.path.join(self.temp_dir, relpath)
os.makedirs(os.path.dirname(full), exist_ok=True)
with open(full, "wb") as f:
f.write(content)
# Stage in the index
self.repo.get_worktree().stage([relpath])
def test_basic_inclusion_exclusion(self):
"""Given patterns, check correct set of included paths."""
self._add_file_to_index("foo.py", b"print(1)")
self._add_file_to_index("bar.md", b"markdown")
self._add_file_to_index("docs/readme", b"# docs")
lines = [
"*.py", # include all .py
"!bar.*", # exclude bar.md
"docs/", # include docs dir
]
included = compute_included_paths_full(self.repo.open_index(), lines)
self.assertEqual(included, {"foo.py", "docs/readme"})
def test_full_with_utf8_paths(self):
"""Test that UTF-8 encoded paths are handled correctly."""
self._add_file_to_index("unicode/文件.txt", b"unicode content")
self._add_file_to_index("unicode/другой.md", b"more unicode")
# Include all text files
lines = ["*.txt"]
included = compute_included_paths_full(self.repo.open_index(), lines)
self.assertEqual(included, {"unicode/文件.txt"})
class ComputeIncludedPathsConeTests(TestCase):
"""Test compute_included_paths_cone with ephemeral repo to see included vs excluded."""
def setUp(self):
super().setUp()
self.temp_dir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, self.temp_dir)
self.repo = Repo.init(self.temp_dir)
def _add_file_to_index(self, relpath, content=b"test"):
full = os.path.join(self.temp_dir, relpath)
os.makedirs(os.path.dirname(full), exist_ok=True)
with open(full, "wb") as f:
f.write(content)
self.repo.get_worktree().stage([relpath])
def test_cone_mode_patterns(self):
"""Simpler pattern handling in cone mode.
Lines in 'cone' style typically look like:
- /* -> include top-level
- !/*/ -> exclude all subdirs
- /docs/ -> reinclude 'docs' directory
"""
self._add_file_to_index("topfile", b"hi")
self._add_file_to_index("docs/readme.md", b"stuff")
self._add_file_to_index("lib/code.py", b"stuff")
lines = [
"/*",
"!/*/",
"/docs/",
]
included = compute_included_paths_cone(self.repo.open_index(), lines)
# top-level => includes 'topfile'
# subdirs => excluded, except docs/
self.assertEqual(included, {"topfile", "docs/readme.md"})
def test_cone_mode_with_empty_pattern(self):
"""Test cone mode with an empty reinclude directory."""
self._add_file_to_index("topfile", b"hi")
self._add_file_to_index("docs/readme.md", b"stuff")
# Include an empty pattern that should be skipped
lines = [
"/*",
"!/*/",
"/", # This empty pattern should be skipped
]
included = compute_included_paths_cone(self.repo.open_index(), lines)
# Only topfile should be included since the empty pattern is skipped
self.assertEqual(included, {"topfile"})
def test_no_exclude_subdirs(self):
"""If lines never specify '!/*/', we include everything by default."""
self._add_file_to_index("topfile", b"hi")
self._add_file_to_index("docs/readme.md", b"stuff")
self._add_file_to_index("lib/code.py", b"stuff")
lines = [
"/*", # top-level
"/docs/", # re-include docs?
]
included = compute_included_paths_cone(self.repo.open_index(), lines)
# Because exclude_subdirs was never set, everything is included:
self.assertEqual(
included,
{"topfile", "docs/readme.md", "lib/code.py"},
)
def test_only_reinclude_dirs(self):
"""Test cone mode when only reinclude directories are specified."""
self._add_file_to_index("topfile", b"hi")
self._add_file_to_index("docs/readme.md", b"stuff")
self._add_file_to_index("lib/code.py", b"stuff")
# Only specify reinclude_dirs, need to explicitly exclude subdirs
lines = ["!/*/", "/docs/"]
included = compute_included_paths_cone(self.repo.open_index(), lines)
# Only docs/* should be included, not topfile or lib/*
self.assertEqual(included, {"docs/readme.md"})
def test_exclude_subdirs_no_toplevel(self):
"""Test with exclude_subdirs but without toplevel files."""
self._add_file_to_index("topfile", b"hi")
self._add_file_to_index("docs/readme.md", b"stuff")
self._add_file_to_index("lib/code.py", b"stuff")
# Only exclude subdirs and reinclude docs
lines = ["!/*/", "/docs/"]
included = compute_included_paths_cone(self.repo.open_index(), lines)
# Only docs/* should be included since we didn't include top level
self.assertEqual(included, {"docs/readme.md"})
class DetermineIncludedPathsTests(TestCase):
"""Test the top-level determine_included_paths function."""
def setUp(self):
super().setUp()
self.temp_dir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, self.temp_dir)
self.repo = Repo.init(self.temp_dir)
def _add_file_to_index(self, relpath):
path = os.path.join(self.temp_dir, relpath)
os.makedirs(os.path.dirname(path), exist_ok=True)
with open(path, "wb") as f:
f.write(b"data")
self.repo.get_worktree().stage([relpath])
def test_full_mode(self):
self._add_file_to_index("foo.py")
self._add_file_to_index("bar.md")
lines = ["*.py", "!bar.*"]
index = self.repo.open_index()
included = determine_included_paths(index, lines, cone=False)
self.assertEqual(included, {"foo.py"})
def test_cone_mode(self):
self._add_file_to_index("topfile")
self._add_file_to_index("subdir/anotherfile")
lines = ["/*", "!/*/"]
index = self.repo.open_index()
included = determine_included_paths(index, lines, cone=True)
self.assertEqual(included, {"topfile"})
class ApplyIncludedPathsTests(TestCase):
"""Integration tests for apply_included_paths, verifying skip-worktree bits and file removal."""
def setUp(self):
super().setUp()
self.temp_dir = tempfile.mkdtemp()
self.addCleanup(shutil.rmtree, self.temp_dir)
self.repo = Repo.init(self.temp_dir)
# For testing local_modifications_exist logic, we'll need the normalizer
# plus some real content in the object store.
def _commit_blob(self, relpath, content=b"hello"):
"""Create a blob object in object_store, stage an index entry for it."""
full = os.path.join(self.temp_dir, relpath)
os.makedirs(os.path.dirname(full), exist_ok=True)
with open(full, "wb") as f:
f.write(content)
self.repo.get_worktree().stage([relpath])
# Actually commit so the object is in the store
self.repo.get_worktree().commit(
message=b"Commit " + relpath.encode(),
)
def test_set_skip_worktree_bits(self):
"""If a path is not in included_paths, skip_worktree bit is set."""
self._commit_blob("keep.py", b"print('keep')")
self._commit_blob("exclude.md", b"# exclude")
included = {"keep.py"}
apply_included_paths(self.repo, included_paths=included, force=False)
idx = self.repo.open_index()
self.assertIn(b"keep.py", idx)
self.assertFalse(idx[b"keep.py"].skip_worktree)
self.assertIn(b"exclude.md", idx)
self.assertTrue(idx[b"exclude.md"].skip_worktree)
# Also check that the exclude.md file was removed from the working tree
exclude_path = os.path.join(self.temp_dir, "exclude.md")
self.assertFalse(os.path.exists(exclude_path))
def test_conflict_with_local_modifications_no_force(self):
"""If local modifications exist for an excluded path, raise SparseCheckoutConflictError."""
self._commit_blob("foo.txt", b"original")
# Modify foo.txt on disk
with open(os.path.join(self.temp_dir, "foo.txt"), "ab") as f:
f.write(b" local changes")
with self.assertRaises(SparseCheckoutConflictError):
apply_included_paths(self.repo, included_paths=set(), force=False)
def test_conflict_with_local_modifications_forced_removal(self):
"""With force=True, we remove local modifications and skip_worktree the file."""
self._commit_blob("foo.txt", b"original")
with open(os.path.join(self.temp_dir, "foo.txt"), "ab") as f:
f.write(b" local changes")
# This time, pass force=True => file is removed
apply_included_paths(self.repo, included_paths=set(), force=True)
# Check skip-worktree in index
idx = self.repo.open_index()
self.assertTrue(idx[b"foo.txt"].skip_worktree)
# Working tree file removed
self.assertFalse(os.path.exists(os.path.join(self.temp_dir, "foo.txt")))
def test_materialize_included_file_if_missing(self):
"""If a path is included but missing from disk, we restore it from the blob in the store."""
self._commit_blob("restored.txt", b"some content")
# Manually remove the file from the working tree
os.remove(os.path.join(self.temp_dir, "restored.txt"))
apply_included_paths(self.repo, included_paths={"restored.txt"}, force=False)
# Should have re-created "restored.txt" from the blob
self.assertTrue(os.path.exists(os.path.join(self.temp_dir, "restored.txt")))
with open(os.path.join(self.temp_dir, "restored.txt"), "rb") as f:
self.assertEqual(f.read(), b"some content")
def test_blob_not_found_raises(self):
"""If the object store is missing the blob for an included path, raise BlobNotFoundError."""
# We'll create an entry in the index that references a nonexistent sha
idx = self.repo.open_index()
fake_sha = b"ab" * 20
e = IndexEntry(
ctime=(int(time.time()), 0), # ctime (s, ns)
mtime=(int(time.time()), 0), # mtime (s, ns)
dev=0, # dev
ino=0, # ino
mode=0o100644, # mode
uid=0, # uid
gid=0, # gid
size=0, # size
sha=fake_sha, # sha
flags=0, # flags
extended_flags=0,
)
e.set_skip_worktree(False)
e.sha = fake_sha
idx[(b"missing_file")] = e
idx.write()
with self.assertRaises(BlobNotFoundError):
apply_included_paths(
self.repo, included_paths={"missing_file"}, force=False
)
def test_directory_removal(self):
"""Test handling of directories when removing excluded files."""
# Create a directory with a file
dir_path = os.path.join(self.temp_dir, "dir")
os.makedirs(dir_path, exist_ok=True)
self._commit_blob("dir/file.txt", b"content")
# Make sure it exists before we proceed
self.assertTrue(os.path.exists(os.path.join(dir_path, "file.txt")))
# Exclude everything
apply_included_paths(self.repo, included_paths=set(), force=True)
# The file should be removed, but the directory might remain
self.assertFalse(os.path.exists(os.path.join(dir_path, "file.txt")))
# Test when file is actually a directory - should hit the IsADirectoryError case
another_dir_path = os.path.join(self.temp_dir, "another_dir")
os.makedirs(another_dir_path, exist_ok=True)
self._commit_blob("another_dir/subfile.txt", b"content")
# Create a path with the same name as the file but make it a dir to trigger IsADirectoryError
subfile_dir_path = os.path.join(another_dir_path, "subfile.txt")
if os.path.exists(subfile_dir_path):
# Remove any existing file first
os.remove(subfile_dir_path)
os.makedirs(subfile_dir_path, exist_ok=True)
# Attempt to apply sparse checkout, should trigger IsADirectoryError but not fail
apply_included_paths(self.repo, included_paths=set(), force=True)
def test_handling_removed_files(self):
"""Test that files already removed from disk are handled correctly during exclusion."""
self._commit_blob("test_file.txt", b"test content")
# Remove the file manually
os.remove(os.path.join(self.temp_dir, "test_file.txt"))
# Should not raise any errors when excluding this file
apply_included_paths(self.repo, included_paths=set(), force=True)
# Verify skip-worktree bit is set in index
idx = self.repo.open_index()
self.assertTrue(idx[b"test_file.txt"].skip_worktree)
def test_local_modifications_ioerror(self):
"""Test handling of PermissionError/OSError when checking for local modifications."""
import sys
self._commit_blob("special_file.txt", b"content")
file_path = os.path.join(self.temp_dir, "special_file.txt")
# On Windows, chmod with 0 doesn't make files unreadable the same way
# Skip this test on Windows as the permission model is different
if sys.platform == "win32":
self.skipTest("File permissions work differently on Windows")
# Make the file unreadable on Unix-like systems
os.chmod(file_path, 0)
# Add a cleanup that checks if file exists first
def safe_chmod_cleanup():
if os.path.exists(file_path):
try:
os.chmod(file_path, 0o644)
except (FileNotFoundError, PermissionError):
pass
self.addCleanup(safe_chmod_cleanup)
# Should raise PermissionError with unreadable file and force=False
with self.assertRaises((PermissionError, OSError)):
apply_included_paths(self.repo, included_paths=set(), force=False)
# With force=True, should remove the file anyway
apply_included_paths(self.repo, included_paths=set(), force=True)
# Verify file is gone and skip-worktree bit is set
self.assertFalse(os.path.exists(file_path))
idx = self.repo.open_index()
self.assertTrue(idx[b"special_file.txt"].skip_worktree)
def test_checkout_normalization_applied(self):
"""Test that checkout normalization is applied when materializing files during sparse checkout."""
# Create a simple filter that converts content to uppercase
class UppercaseFilter:
def smudge(self, input_bytes, path=b""):
return input_bytes.upper()
def clean(self, input_bytes):
return input_bytes.lower()
def cleanup(self):
pass
def reuse(self, config, filter_name):
return False
# Create .gitattributes file
gitattributes_path = os.path.join(self.temp_dir, ".gitattributes")
with open(gitattributes_path, "w") as f:
f.write("*.txt filter=uppercase\n")
# Add and commit .gitattributes
self.repo.get_worktree().stage([b".gitattributes"])
self.repo.get_worktree().commit(
b"Add gitattributes", committer=b"Test <test@example.com>"
)
# Initialize the filter context and register the filter
_ = self.repo.get_blob_normalizer()
# Register the filter with the cached filter context
uppercase_filter = UppercaseFilter()
self.repo.filter_context.filter_registry.register_driver(
"uppercase", uppercase_filter
)
# Commit a file with lowercase content
self._commit_blob("test.txt", b"hello world")
# Remove the file from working tree to force materialization
os.remove(os.path.join(self.temp_dir, "test.txt"))
# Apply sparse checkout - this will call get_blob_normalizer() internally
# which will use the cached filter_context with our registered filter
apply_included_paths(self.repo, included_paths={"test.txt"}, force=False)
# Verify file was materialized with uppercase content (checkout normalization applied)
with open(os.path.join(self.temp_dir, "test.txt"), "rb") as f:
content = f.read()
self.assertEqual(content, b"HELLO WORLD")
def test_checkout_normalization_with_lf_to_crlf(self):
"""Test that line ending normalization is applied during sparse checkout."""
# Commit a file with LF line endings
self._commit_blob("unix_file.txt", b"line1\nline2\nline3\n")
# Remove the file from working tree
os.remove(os.path.join(self.temp_dir, "unix_file.txt"))
# Create a normalizer that converts LF to CRLF on checkout
class CRLFNormalizer:
def checkin_normalize(self, data, path):
# For checkin, return unchanged
return data
def checkout_normalize(self, blob, path):
if isinstance(blob, Blob):
# Convert LF to CRLF
new_blob = Blob()
new_blob.data = blob.data.replace(b"\n", b"\r\n")
return new_blob
return blob
# Monkey patch the repo to use our normalizer
original_get_blob_normalizer = self.repo.get_blob_normalizer
self.repo.get_blob_normalizer = lambda: CRLFNormalizer()
# Apply sparse checkout
apply_included_paths(self.repo, included_paths={"unix_file.txt"}, force=False)
# Verify file was materialized with CRLF line endings
with open(os.path.join(self.temp_dir, "unix_file.txt"), "rb") as f:
content = f.read()
self.assertEqual(content, b"line1\r\nline2\r\nline3\r\n")
# Restore original method
self.repo.get_blob_normalizer = original_get_blob_normalizer
def test_checkout_normalization_not_applied_without_normalizer(self):
"""Test that when normalizer returns original blob, no transformation occurs."""
# Commit a file with specific content
original_content = b"original content\nwith newlines\n"
self._commit_blob("no_norm.txt", original_content)
# Remove the file from working tree
os.remove(os.path.join(self.temp_dir, "no_norm.txt"))
# Create a normalizer that returns blob unchanged
class NoOpNormalizer:
def checkin_normalize(self, data, path):
return data
def checkout_normalize(self, blob, path):
# Return the blob unchanged
return blob
# Monkey patch the repo to use our no-op normalizer
original_get_blob_normalizer = self.repo.get_blob_normalizer
self.repo.get_blob_normalizer = lambda: NoOpNormalizer()
# Apply sparse checkout
apply_included_paths(self.repo, included_paths={"no_norm.txt"}, force=False)
# Verify file was materialized with original content (no normalization)
with open(os.path.join(self.temp_dir, "no_norm.txt"), "rb") as f:
content = f.read()
self.assertEqual(content, original_content)
# Restore original method
self.repo.get_blob_normalizer = original_get_blob_normalizer
|