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 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
|
# test_client.py -- Compatibility tests for git client.
# Copyright (C) 2010 Google, Inc.
#
# 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.
#
"""Compatibility tests between the Dulwich client and the cgit server."""
import copy
import http.server
import os
import select
import signal
import stat
import subprocess
import sys
import tarfile
import tempfile
import threading
from collections.abc import Iterator
from contextlib import suppress
from io import BytesIO
from typing import NoReturn
from unittest.mock import patch
from urllib.parse import unquote
from dulwich import client, file, index, objects, protocol, repo
from dulwich.porcelain import tag_create
from .. import SkipTest, expectedFailure
from .utils import (
_DEFAULT_GIT,
CompatTestCase,
check_for_daemon,
import_repo_to_dir,
rmtree_ro,
run_git_or_fail,
)
if sys.platform == "win32":
import ctypes
class DulwichClientTestBase:
"""Tests for client/server compatibility."""
def setUp(self) -> None:
self.gitroot = os.path.dirname(
import_repo_to_dir("server_new.export").rstrip(os.sep)
)
self.dest = os.path.join(self.gitroot, "dest")
file.ensure_dir_exists(self.dest)
run_git_or_fail(["init", "--quiet", "--bare"], cwd=self.dest)
# Register cleanup to run after test's cleanup handlers
self.addCleanup(rmtree_ro, self.gitroot)
def assertDestEqualsSrc(self) -> None:
repo_dir = os.path.join(self.gitroot, "server_new.export")
dest_repo_dir = os.path.join(self.gitroot, "dest")
with repo.Repo(repo_dir) as src:
with repo.Repo(dest_repo_dir) as dest:
self.assertReposEqual(src, dest)
def _client(self) -> NoReturn:
raise NotImplementedError
def _build_path(self) -> NoReturn:
raise NotImplementedError
def _do_send_pack(self) -> None:
c = self._client()
srcpath = os.path.join(self.gitroot, "server_new.export")
with repo.Repo(srcpath) as src:
sendrefs = dict(src.get_refs())
del sendrefs[b"HEAD"]
# Wrap generate_pack_data to match expected signature
def generate_pack_data_wrapper(
have: set[bytes],
want: set[bytes],
*,
ofs_delta: bool = False,
progress=None,
) -> tuple[int, Iterator]:
return src.generate_pack_data(
have, want, progress=progress, ofs_delta=ofs_delta
)
c.send_pack(
self._build_path("/dest"),
lambda _: sendrefs,
generate_pack_data_wrapper,
)
def test_send_pack(self) -> None:
self._do_send_pack()
self.assertDestEqualsSrc()
def test_send_pack_nothing_to_send(self) -> None:
self._do_send_pack()
self.assertDestEqualsSrc()
# nothing to send, but shouldn't raise either.
self._do_send_pack()
@staticmethod
def _add_file(repo, tree_id, filename, contents):
tree = repo[tree_id]
blob = objects.Blob()
blob.data = contents.encode("utf-8")
repo.object_store.add_object(blob)
tree.add(filename.encode("utf-8"), stat.S_IFREG | 0o644, blob.id)
repo.object_store.add_object(tree)
return tree.id
def test_send_pack_from_shallow_clone(self) -> None:
c = self._client()
server_new_path = os.path.join(self.gitroot, "server_new.export")
run_git_or_fail(["config", "http.uploadpack", "true"], cwd=server_new_path)
run_git_or_fail(["config", "http.receivepack", "true"], cwd=server_new_path)
remote_path = self._build_path("/server_new.export")
with repo.Repo(self.dest) as local:
result = c.fetch(remote_path, local, depth=1)
for r in result.refs.items():
local.refs.set_if_equals(r[0], None, r[1])
tree_id = local[local.head()].tree
for filename, contents in [
("bar", "bar contents"),
("zop", "zop contents"),
]:
tree_id = self._add_file(local, tree_id, filename, contents)
commit_id = local.get_worktree().commit(
message=b"add " + filename.encode("utf-8"),
committer=b"Joe Example <joe@example.com>",
tree=tree_id,
)
sendrefs = dict(local.get_refs())
del sendrefs[b"HEAD"]
# Wrap generate_pack_data to match expected signature
def generate_pack_data_wrapper(
have: set[bytes],
want: set[bytes],
*,
ofs_delta: bool = False,
progress=None,
) -> tuple[int, Iterator]:
return local.generate_pack_data(
have, want, progress=progress, ofs_delta=ofs_delta
)
c.send_pack(remote_path, lambda _: sendrefs, generate_pack_data_wrapper)
with repo.Repo(server_new_path) as remote:
self.assertEqual(remote.head(), commit_id)
def test_send_without_report_status(self) -> None:
c = self._client()
c._send_capabilities.remove(b"report-status")
srcpath = os.path.join(self.gitroot, "server_new.export")
with repo.Repo(srcpath) as src:
sendrefs = dict(src.get_refs())
del sendrefs[b"HEAD"]
# Wrap generate_pack_data to match expected signature
def generate_pack_data_wrapper(
have: set[bytes],
want: set[bytes],
*,
ofs_delta: bool = False,
progress=None,
) -> tuple[int, Iterator]:
return src.generate_pack_data(
have, want, progress=progress, ofs_delta=ofs_delta
)
c.send_pack(
self._build_path("/dest"),
lambda _: sendrefs,
generate_pack_data_wrapper,
)
self.assertDestEqualsSrc()
def make_dummy_commit(self, dest):
b = objects.Blob.from_string(b"hi")
dest.object_store.add_object(b)
t = index.commit_tree(dest.object_store, [(b"hi", b.id, 0o100644)])
c = objects.Commit()
c.author = c.committer = b"Foo Bar <foo@example.com>"
c.author_time = c.commit_time = 0
c.author_timezone = c.commit_timezone = 0
c.message = b"hi"
c.tree = t
dest.object_store.add_object(c)
return c.id
def disable_ff_and_make_dummy_commit(self):
# disable non-fast-forward pushes to the server
dest = repo.Repo(os.path.join(self.gitroot, "dest"))
self.addCleanup(dest.close)
run_git_or_fail(
["config", "receive.denyNonFastForwards", "true"], cwd=dest.path
)
commit_id = self.make_dummy_commit(dest)
return dest, commit_id
def compute_send(self, src):
sendrefs = dict(src.get_refs())
del sendrefs[b"HEAD"]
# Wrap generate_pack_data to match expected signature
def generate_pack_data_wrapper(
have: set[bytes],
want: set[bytes],
*,
ofs_delta: bool = False,
progress=None,
) -> tuple[int, Iterator]:
return src.generate_pack_data(
have, want, progress=progress, ofs_delta=ofs_delta
)
return sendrefs, generate_pack_data_wrapper
def test_send_pack_one_error(self) -> None:
dest, dummy_commit = self.disable_ff_and_make_dummy_commit()
dest.refs[b"refs/heads/master"] = dummy_commit
repo_dir = os.path.join(self.gitroot, "server_new.export")
with repo.Repo(repo_dir) as src:
sendrefs, gen_pack = self.compute_send(src)
c = self._client()
result = c.send_pack(
self._build_path("/dest"), lambda _: sendrefs, gen_pack
)
self.assertEqual(
{
b"refs/heads/branch": None,
b"refs/heads/master": "non-fast-forward",
},
result.ref_status,
)
def test_send_pack_multiple_errors(self) -> None:
dest, dummy = self.disable_ff_and_make_dummy_commit()
# set up for two non-ff errors
branch, master = b"refs/heads/branch", b"refs/heads/master"
dest.refs[branch] = dest.refs[master] = dummy
repo_dir = os.path.join(self.gitroot, "server_new.export")
with repo.Repo(repo_dir) as src:
sendrefs, gen_pack = self.compute_send(src)
c = self._client()
result = c.send_pack(
self._build_path("/dest"), lambda _: sendrefs, gen_pack
)
self.assertEqual(
{branch: "non-fast-forward", master: "non-fast-forward"},
result.ref_status,
)
def test_archive(self) -> None:
c = self._client()
f = BytesIO()
c.archive(self._build_path("/server_new.export"), b"HEAD", f.write)
f.seek(0)
tf = tarfile.open(fileobj=f)
self.assertEqual(["baz", "foo"], tf.getnames())
def test_fetch_pack(self) -> None:
c = self._client()
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
result = c.fetch(self._build_path("/server_new.export"), dest)
self.assertEqual(
{b"HEAD": b"refs/heads/master"},
result.symrefs,
)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertDestEqualsSrc()
def test_fetch_pack_with_nondefault_symref(self) -> None:
c = self._client()
src = repo.Repo(os.path.join(self.gitroot, "server_new.export"))
self.addCleanup(src.close)
src.refs.add_if_new(b"refs/heads/main", src.refs[b"refs/heads/master"])
src.refs.set_symbolic_ref(b"HEAD", b"refs/heads/main")
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
result = c.fetch(self._build_path("/server_new.export"), dest)
self.assertEqual(
{b"HEAD": b"refs/heads/main"},
result.symrefs,
)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertDestEqualsSrc()
def test_get_refs_with_peeled_tag(self) -> None:
tag_create(
os.path.join(self.gitroot, "server_new.export"),
b"v1.0",
message=b"tagging",
annotated=True,
)
c = self._client()
refs = c.get_refs(self._build_path("/server_new.export"))
self.assertEqual(
[
b"HEAD",
b"refs/heads/branch",
b"refs/heads/master",
b"refs/tags/v1.0",
b"refs/tags/v1.0^{}",
],
sorted(refs.refs.keys()),
)
def test_get_refs_with_ref_prefix(self) -> None:
c = self._client()
refs = c.get_refs(
self._build_path("/server_new.export"), ref_prefix=[b"refs/heads"]
)
self.assertEqual(
[
b"refs/heads/branch",
b"refs/heads/master",
],
sorted(refs.refs.keys()),
)
def test_fetch_pack_depth(self) -> None:
c = self._client()
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
result = c.fetch(self._build_path("/server_new.export"), dest, depth=1)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertEqual(
dest.get_shallow(),
{
b"35e0b59e187dd72a0af294aedffc213eaa4d03ff",
b"514dc6d3fbfe77361bcaef320c4d21b72bc10be9",
},
)
def test_fetch_pack_deepen_since(self) -> None:
c = self._client()
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
# Fetch commits since a specific date
# Using Unix timestamp - the test repo has commits around 1265755064 (Feb 2010)
# So we use a timestamp between first and last commit
result = c.fetch(
self._build_path("/server_new.export"),
dest,
shallow_since="1265755100",
)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
# Verify that shallow commits were created
shallow = dest.get_shallow()
self.assertIsNotNone(shallow)
self.assertGreater(len(shallow), 0)
def test_fetch_pack_deepen_not(self) -> None:
c = self._client()
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
# Fetch excluding commits reachable from a specific ref
result = c.fetch(
self._build_path("/server_new.export"),
dest,
shallow_exclude=["refs/heads/branch"],
)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
# Verify that shallow commits were created
shallow = dest.get_shallow()
self.assertIsNotNone(shallow)
self.assertGreater(len(shallow), 0)
def test_fetch_pack_deepen_since_and_not(self) -> None:
c = self._client()
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
# Fetch combining deepen-since and deepen-not
result = c.fetch(
self._build_path("/server_new.export"),
dest,
shallow_since="1265755100",
shallow_exclude=["refs/heads/branch"],
)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
# Verify that shallow commits were created
shallow = dest.get_shallow()
self.assertIsNotNone(shallow)
self.assertGreater(len(shallow), 0)
def test_repeat(self) -> None:
c = self._client()
dest = repo.Repo(os.path.join(self.gitroot, "dest"))
self.addCleanup(dest.close)
result = c.fetch(self._build_path("/server_new.export"), dest)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertDestEqualsSrc()
result = c.fetch(self._build_path("/server_new.export"), dest)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertDestEqualsSrc()
def test_fetch_empty_pack(self) -> None:
c = self._client()
dest = repo.Repo(os.path.join(self.gitroot, "dest"))
self.addCleanup(dest.close)
result = c.fetch(self._build_path("/server_new.export"), dest)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertDestEqualsSrc()
def dw(refs, **kwargs):
return list(refs.values())
result = c.fetch(
self._build_path("/server_new.export"),
dest,
determine_wants=dw,
)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertDestEqualsSrc()
def test_incremental_fetch_pack(self) -> None:
self.test_fetch_pack()
dest, dummy = self.disable_ff_and_make_dummy_commit()
dest.refs[b"refs/heads/master"] = dummy
c = self._client()
repo_dir = os.path.join(self.gitroot, "server_new.export")
with repo.Repo(repo_dir) as dest:
result = c.fetch(self._build_path("/dest"), dest)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertDestEqualsSrc()
def test_fetch_pack_no_side_band_64k(self) -> None:
if protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH >= 2:
raise SkipTest("side-band-64k cannot be disabled with git protocol v2")
c = self._client()
c._fetch_capabilities.remove(b"side-band-64k")
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
result = c.fetch(self._build_path("/server_new.export"), dest)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
self.assertDestEqualsSrc()
def test_fetch_pack_zero_sha(self) -> None:
# zero sha1s are already present on the client, and should
# be ignored
c = self._client()
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
result = c.fetch(
self._build_path("/server_new.export"),
dest,
lambda refs, **kwargs: [protocol.ZERO_SHA],
)
for r in result.refs.items():
dest.refs.set_if_equals(r[0], None, r[1])
def test_send_remove_branch(self) -> None:
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
dummy_commit = self.make_dummy_commit(dest)
dest.refs[b"refs/heads/master"] = dummy_commit
dest.refs[b"refs/heads/abranch"] = dummy_commit
sendrefs = dict(dest.refs)
sendrefs[b"refs/heads/abranch"] = b"00" * 20
del sendrefs[b"HEAD"]
def gen_pack(have, want, ofs_delta=False, progress=None):
return 0, []
c = self._client()
self.assertEqual(dest.refs[b"refs/heads/abranch"], dummy_commit)
c.send_pack(self._build_path("/dest"), lambda _: sendrefs, gen_pack)
self.assertNotIn(b"refs/heads/abranch", dest.refs)
def test_send_new_branch_empty_pack(self) -> None:
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
dummy_commit = self.make_dummy_commit(dest)
dest.refs[b"refs/heads/master"] = dummy_commit
dest.refs[b"refs/heads/abranch"] = dummy_commit
sendrefs = {b"refs/heads/bbranch": dummy_commit}
def gen_pack(have, want, ofs_delta=False, progress=None):
return 0, []
c = self._client()
self.assertEqual(dest.refs[b"refs/heads/abranch"], dummy_commit)
c.send_pack(self._build_path("/dest"), lambda _: sendrefs, gen_pack)
self.assertEqual(dummy_commit, dest.refs[b"refs/heads/abranch"])
def test_get_refs(self) -> None:
c = self._client()
refs = c.get_refs(self._build_path("/server_new.export"))
repo_dir = os.path.join(self.gitroot, "server_new.export")
with repo.Repo(repo_dir) as dest:
self.assertDictEqual(dest.refs.as_dict(), refs.refs)
class DulwichTCPClientTest(CompatTestCase, DulwichClientTestBase):
def setUp(self) -> None:
CompatTestCase.setUp(self)
DulwichClientTestBase.setUp(self)
if check_for_daemon(limit=1):
raise SkipTest(
f"git-daemon was already running on port {protocol.TCP_GIT_PORT}"
)
fd, self.pidfile = tempfile.mkstemp(
prefix="dulwich-test-git-client", suffix=".pid"
)
os.fdopen(fd).close()
args = [
_DEFAULT_GIT,
"daemon",
"--verbose",
"--export-all",
f"--pid-file={self.pidfile}",
f"--base-path={self.gitroot}",
"--enable=receive-pack",
"--enable=upload-archive",
"--listen=localhost",
"--reuseaddr",
self.gitroot,
]
self.process = subprocess.Popen(
args,
cwd=self.gitroot,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
if not check_for_daemon():
raise SkipTest("git-daemon failed to start")
def tearDown(self) -> None:
with open(self.pidfile) as f:
pid = int(f.read().strip())
if sys.platform == "win32":
PROCESS_TERMINATE = 1
handle = ctypes.windll.kernel32.OpenProcess(PROCESS_TERMINATE, False, pid)
ctypes.windll.kernel32.TerminateProcess(handle, -1)
ctypes.windll.kernel32.CloseHandle(handle)
else:
with suppress(OSError):
os.kill(pid, signal.SIGKILL)
os.unlink(self.pidfile)
self.process.wait()
self.process.stdout.close()
self.process.stderr.close()
CompatTestCase.tearDown(self)
def _client(self):
return client.TCPGitClient("localhost")
def _build_path(self, path):
return path
if sys.platform == "win32" and protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH < 2:
@expectedFailure
def test_fetch_pack_no_side_band_64k(self) -> None:
DulwichClientTestBase.test_fetch_pack_no_side_band_64k(self)
def test_send_remove_branch(self) -> None:
# This test fails intermittently on my machine, probably due to some sort
# of race condition. Probably also related to #1015
self.skipTest("skip flaky test; see #1015")
@patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
class DulwichTCPClientTestGitProtov0(DulwichTCPClientTest):
pass
class TestSSHVendor:
@staticmethod
def run_command(
host,
command,
username=None,
port=None,
password=None,
key_filename=None,
ssh_command=None,
protocol_version=None,
):
# Handle both bytes and string commands
if isinstance(command, bytes):
cmd, path = command.split(b" ")
cmd = cmd.decode("utf-8").split("-", 1)
path = path.decode("utf-8").replace("'", "")
else:
cmd, path = command.split(" ")
cmd = cmd.split("-", 1)
path = path.replace("'", "")
env = dict(os.environ)
if protocol_version is None:
protocol_version = protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH
if protocol_version > 0:
env["GIT_PROTOCOL"] = f"version={protocol_version}"
p = subprocess.Popen(
[*cmd, path],
bufsize=0,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
env=env,
)
return client.SubprocessWrapper(p)
class DulwichMockSSHClientTest(CompatTestCase, DulwichClientTestBase):
def setUp(self) -> None:
CompatTestCase.setUp(self)
DulwichClientTestBase.setUp(self)
self.real_vendor = client.get_ssh_vendor
client.get_ssh_vendor = TestSSHVendor
def tearDown(self) -> None:
CompatTestCase.tearDown(self)
client.get_ssh_vendor = self.real_vendor
def _client(self):
return client.SSHGitClient("localhost")
def _build_path(self, path):
return self.gitroot + path
@patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
class DulwichMockSSHClientTestGitProtov0(DulwichMockSSHClientTest):
pass
class DulwichSubprocessClientTest(CompatTestCase, DulwichClientTestBase):
def setUp(self) -> None:
CompatTestCase.setUp(self)
DulwichClientTestBase.setUp(self)
def tearDown(self) -> None:
CompatTestCase.tearDown(self)
def _client(self):
return client.SubprocessGitClient()
def _build_path(self, path):
return self.gitroot + path
@patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
class DulwichSubprocessClientTestGitProtov0(DulwichSubprocessClientTest):
pass
class GitHTTPRequestHandler(http.server.SimpleHTTPRequestHandler):
"""HTTP Request handler that calls out to 'git http-backend'."""
# Make rfile unbuffered -- we need to read one line and then pass
# the rest to a subprocess, so we can't use buffered input.
rbufsize = 0
def do_POST(self) -> None:
self.run_backend()
def do_GET(self) -> None:
self.run_backend()
def send_head(self):
return self.run_backend()
def log_request(self, code="-", size="-") -> None:
# Let's be quiet, the test suite is noisy enough already
pass
def run_backend(self) -> None:
"""Call out to git http-backend."""
# Based on CGIHTTPServer.CGIHTTPRequestHandler.run_cgi:
# Copyright (c) 2001-2010 Python Software Foundation;
# All Rights Reserved
# Licensed under the Python Software Foundation License.
rest = self.path
# find an explicit query string, if present.
i = rest.rfind("?")
if i >= 0:
rest, query = rest[:i], rest[i + 1 :]
else:
query = ""
env = copy.deepcopy(os.environ)
env["SERVER_SOFTWARE"] = self.version_string()
env["SERVER_NAME"] = self.server.server_name
env["GATEWAY_INTERFACE"] = "CGI/1.1"
env["SERVER_PROTOCOL"] = self.protocol_version
env["SERVER_PORT"] = str(self.server.server_port)
env["GIT_PROJECT_ROOT"] = self.server.root_path
env["GIT_HTTP_EXPORT_ALL"] = "1"
env["REQUEST_METHOD"] = self.command
uqrest = unquote(rest)
env["PATH_INFO"] = uqrest
env["SCRIPT_NAME"] = "/"
if query:
env["QUERY_STRING"] = query
host = self.address_string()
if host != self.client_address[0]:
env["REMOTE_HOST"] = host
env["REMOTE_ADDR"] = self.client_address[0]
authorization = self.headers.get("authorization")
if authorization:
authorization = authorization.split()
if len(authorization) == 2:
import base64
import binascii
env["AUTH_TYPE"] = authorization[0]
if authorization[0].lower() == "basic":
try:
authorization = base64.decodestring(authorization[1])
except binascii.Error:
pass
else:
authorization = authorization.split(":")
if len(authorization) == 2:
env["REMOTE_USER"] = authorization[0]
# XXX REMOTE_IDENT
content_type = self.headers.get("content-type")
if content_type:
env["CONTENT_TYPE"] = content_type
length = self.headers.get("content-length")
if length:
env["CONTENT_LENGTH"] = length
referer = self.headers.get("referer")
if referer:
env["HTTP_REFERER"] = referer
accept = []
for line in self.headers.getallmatchingheaders("accept"):
if line[:1] in "\t\n\r ":
accept.append(line.strip())
else:
accept = accept + line[7:].split(",")
env["HTTP_ACCEPT"] = ",".join(accept)
ua = self.headers.get("user-agent")
if ua:
env["HTTP_USER_AGENT"] = ua
co = self.headers.get("cookie")
if co:
env["HTTP_COOKIE"] = co
proto = self.headers.get("Git-Protocol")
if proto:
env["GIT_PROTOCOL"] = proto
# XXX Other HTTP_* headers
# Since we're setting the env in the parent, provide empty
# values to override previously set values
for k in (
"QUERY_STRING",
"REMOTE_HOST",
"CONTENT_LENGTH",
"HTTP_USER_AGENT",
"HTTP_COOKIE",
"HTTP_REFERER",
):
env.setdefault(k, "")
self.wfile.write(b"HTTP/1.1 200 Script output follows\r\n")
self.wfile.write((f"Server: {self.server.server_name}\r\n").encode("ascii"))
self.wfile.write((f"Date: {self.date_time_string()}\r\n").encode("ascii"))
decoded_query = query.replace("+", " ")
try:
nbytes = int(length)
except (TypeError, ValueError):
nbytes = -1
if self.command.lower() == "post":
if nbytes > 0:
data = self.rfile.read(nbytes)
elif self.headers.get("transfer-encoding") == "chunked":
chunks = []
while True:
line = self.rfile.readline()
length = int(line.rstrip(), 16)
chunk = self.rfile.read(length + 2)
chunks.append(chunk[:-2])
if length == 0:
break
data = b"".join(chunks)
env["CONTENT_LENGTH"] = str(len(data))
else:
raise AssertionError
else:
data = None
env["CONTENT_LENGTH"] = "0"
# throw away additional data [see bug #427345]
while select.select([self.rfile._sock], [], [], 0)[0]:
if not self.rfile._sock.recv(1):
break
args = ["http-backend"]
if "=" not in decoded_query:
args.append(decoded_query)
stdout = run_git_or_fail(args, input=data, env=env, stderr=subprocess.PIPE)
self.wfile.write(stdout)
class HTTPGitServer(http.server.HTTPServer):
allow_reuse_address = True
def __init__(self, server_address, root_path) -> None:
http.server.HTTPServer.__init__(self, server_address, GitHTTPRequestHandler)
self.root_path = root_path
self.server_name = "localhost"
def get_url(self) -> str:
return f"http://{self.server_name}:{self.server_port}/"
class DulwichHttpClientTest(CompatTestCase, DulwichClientTestBase):
min_git_version = (1, 7, 0, 2)
def setUp(self) -> None:
CompatTestCase.setUp(self)
DulwichClientTestBase.setUp(self)
self._httpd = HTTPGitServer(("localhost", 0), self.gitroot)
self.addCleanup(self._httpd.shutdown)
threading.Thread(target=self._httpd.serve_forever).start()
run_git_or_fail(["config", "http.uploadpack", "true"], cwd=self.dest)
run_git_or_fail(["config", "http.receivepack", "true"], cwd=self.dest)
def tearDown(self) -> None:
CompatTestCase.tearDown(self)
self._httpd.shutdown()
self._httpd.socket.close()
def _client(self):
return client.HttpGitClient(self._httpd.get_url())
def _build_path(self, path):
return path
def test_archive(self) -> NoReturn:
raise SkipTest("exporting archives not supported over http")
@patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
class DulwichHttpClientTestGitProtov0(DulwichHttpClientTest):
pass
|