test_client.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. # test_client.py -- Compatibility tests for git client.
  2. # Copyright (C) 2010 Google, Inc.
  3. #
  4. # SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
  5. # Dulwich is dual-licensed under the Apache License, Version 2.0 and the GNU
  6. # General Public License as published by the Free Software Foundation; version 2.0
  7. # or (at your option) any later version. You can redistribute it and/or
  8. # modify it under the terms of either of these two licenses.
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. #
  16. # You should have received a copy of the licenses; if not, see
  17. # <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
  18. # and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
  19. # License, Version 2.0.
  20. #
  21. """Compatibility tests between the Dulwich client and the cgit server."""
  22. import copy
  23. import http.server
  24. import os
  25. import select
  26. import signal
  27. import stat
  28. import subprocess
  29. import sys
  30. import tarfile
  31. import tempfile
  32. import threading
  33. from collections.abc import Iterator
  34. from contextlib import suppress
  35. from io import BytesIO
  36. from typing import NoReturn
  37. from unittest.mock import patch
  38. from urllib.parse import unquote
  39. from dulwich import client, file, index, objects, protocol, repo
  40. from dulwich.porcelain import tag_create
  41. from .. import SkipTest, expectedFailure
  42. from .utils import (
  43. _DEFAULT_GIT,
  44. CompatTestCase,
  45. check_for_daemon,
  46. import_repo_to_dir,
  47. rmtree_ro,
  48. run_git_or_fail,
  49. )
  50. if sys.platform == "win32":
  51. import ctypes
  52. class DulwichClientTestBase:
  53. """Tests for client/server compatibility."""
  54. def setUp(self) -> None:
  55. self.gitroot = os.path.dirname(
  56. import_repo_to_dir("server_new.export").rstrip(os.sep)
  57. )
  58. self.dest = os.path.join(self.gitroot, "dest")
  59. file.ensure_dir_exists(self.dest)
  60. run_git_or_fail(["init", "--quiet", "--bare"], cwd=self.dest)
  61. # Register cleanup to run after test's cleanup handlers
  62. self.addCleanup(rmtree_ro, self.gitroot)
  63. def assertDestEqualsSrc(self) -> None:
  64. repo_dir = os.path.join(self.gitroot, "server_new.export")
  65. dest_repo_dir = os.path.join(self.gitroot, "dest")
  66. with repo.Repo(repo_dir) as src:
  67. with repo.Repo(dest_repo_dir) as dest:
  68. self.assertReposEqual(src, dest)
  69. def _client(self) -> NoReturn:
  70. raise NotImplementedError
  71. def _build_path(self) -> NoReturn:
  72. raise NotImplementedError
  73. def _do_send_pack(self) -> None:
  74. c = self._client()
  75. srcpath = os.path.join(self.gitroot, "server_new.export")
  76. with repo.Repo(srcpath) as src:
  77. sendrefs = dict(src.get_refs())
  78. del sendrefs[b"HEAD"]
  79. # Wrap generate_pack_data to match expected signature
  80. def generate_pack_data_wrapper(
  81. have: set[bytes],
  82. want: set[bytes],
  83. *,
  84. ofs_delta: bool = False,
  85. progress=None,
  86. ) -> tuple[int, Iterator]:
  87. return src.generate_pack_data(
  88. have, want, progress=progress, ofs_delta=ofs_delta
  89. )
  90. c.send_pack(
  91. self._build_path("/dest"),
  92. lambda _: sendrefs,
  93. generate_pack_data_wrapper,
  94. )
  95. def test_send_pack(self) -> None:
  96. self._do_send_pack()
  97. self.assertDestEqualsSrc()
  98. def test_send_pack_nothing_to_send(self) -> None:
  99. self._do_send_pack()
  100. self.assertDestEqualsSrc()
  101. # nothing to send, but shouldn't raise either.
  102. self._do_send_pack()
  103. @staticmethod
  104. def _add_file(repo, tree_id, filename, contents):
  105. tree = repo[tree_id]
  106. blob = objects.Blob()
  107. blob.data = contents.encode("utf-8")
  108. repo.object_store.add_object(blob)
  109. tree.add(filename.encode("utf-8"), stat.S_IFREG | 0o644, blob.id)
  110. repo.object_store.add_object(tree)
  111. return tree.id
  112. def test_send_pack_from_shallow_clone(self) -> None:
  113. c = self._client()
  114. server_new_path = os.path.join(self.gitroot, "server_new.export")
  115. run_git_or_fail(["config", "http.uploadpack", "true"], cwd=server_new_path)
  116. run_git_or_fail(["config", "http.receivepack", "true"], cwd=server_new_path)
  117. remote_path = self._build_path("/server_new.export")
  118. with repo.Repo(self.dest) as local:
  119. result = c.fetch(remote_path, local, depth=1)
  120. for r in result.refs.items():
  121. local.refs.set_if_equals(r[0], None, r[1])
  122. tree_id = local[local.head()].tree
  123. for filename, contents in [
  124. ("bar", "bar contents"),
  125. ("zop", "zop contents"),
  126. ]:
  127. tree_id = self._add_file(local, tree_id, filename, contents)
  128. commit_id = local.get_worktree().commit(
  129. message=b"add " + filename.encode("utf-8"),
  130. committer=b"Joe Example <joe@example.com>",
  131. tree=tree_id,
  132. )
  133. sendrefs = dict(local.get_refs())
  134. del sendrefs[b"HEAD"]
  135. # Wrap generate_pack_data to match expected signature
  136. def generate_pack_data_wrapper(
  137. have: set[bytes],
  138. want: set[bytes],
  139. *,
  140. ofs_delta: bool = False,
  141. progress=None,
  142. ) -> tuple[int, Iterator]:
  143. return local.generate_pack_data(
  144. have, want, progress=progress, ofs_delta=ofs_delta
  145. )
  146. c.send_pack(remote_path, lambda _: sendrefs, generate_pack_data_wrapper)
  147. with repo.Repo(server_new_path) as remote:
  148. self.assertEqual(remote.head(), commit_id)
  149. def test_send_without_report_status(self) -> None:
  150. c = self._client()
  151. c._send_capabilities.remove(b"report-status")
  152. srcpath = os.path.join(self.gitroot, "server_new.export")
  153. with repo.Repo(srcpath) as src:
  154. sendrefs = dict(src.get_refs())
  155. del sendrefs[b"HEAD"]
  156. # Wrap generate_pack_data to match expected signature
  157. def generate_pack_data_wrapper(
  158. have: set[bytes],
  159. want: set[bytes],
  160. *,
  161. ofs_delta: bool = False,
  162. progress=None,
  163. ) -> tuple[int, Iterator]:
  164. return src.generate_pack_data(
  165. have, want, progress=progress, ofs_delta=ofs_delta
  166. )
  167. c.send_pack(
  168. self._build_path("/dest"),
  169. lambda _: sendrefs,
  170. generate_pack_data_wrapper,
  171. )
  172. self.assertDestEqualsSrc()
  173. def make_dummy_commit(self, dest):
  174. b = objects.Blob.from_string(b"hi")
  175. dest.object_store.add_object(b)
  176. t = index.commit_tree(dest.object_store, [(b"hi", b.id, 0o100644)])
  177. c = objects.Commit()
  178. c.author = c.committer = b"Foo Bar <foo@example.com>"
  179. c.author_time = c.commit_time = 0
  180. c.author_timezone = c.commit_timezone = 0
  181. c.message = b"hi"
  182. c.tree = t
  183. dest.object_store.add_object(c)
  184. return c.id
  185. def disable_ff_and_make_dummy_commit(self):
  186. # disable non-fast-forward pushes to the server
  187. dest = repo.Repo(os.path.join(self.gitroot, "dest"))
  188. self.addCleanup(dest.close)
  189. run_git_or_fail(
  190. ["config", "receive.denyNonFastForwards", "true"], cwd=dest.path
  191. )
  192. commit_id = self.make_dummy_commit(dest)
  193. return dest, commit_id
  194. def compute_send(self, src):
  195. sendrefs = dict(src.get_refs())
  196. del sendrefs[b"HEAD"]
  197. # Wrap generate_pack_data to match expected signature
  198. def generate_pack_data_wrapper(
  199. have: set[bytes],
  200. want: set[bytes],
  201. *,
  202. ofs_delta: bool = False,
  203. progress=None,
  204. ) -> tuple[int, Iterator]:
  205. return src.generate_pack_data(
  206. have, want, progress=progress, ofs_delta=ofs_delta
  207. )
  208. return sendrefs, generate_pack_data_wrapper
  209. def test_send_pack_one_error(self) -> None:
  210. dest, dummy_commit = self.disable_ff_and_make_dummy_commit()
  211. dest.refs[b"refs/heads/master"] = dummy_commit
  212. repo_dir = os.path.join(self.gitroot, "server_new.export")
  213. with repo.Repo(repo_dir) as src:
  214. sendrefs, gen_pack = self.compute_send(src)
  215. c = self._client()
  216. result = c.send_pack(
  217. self._build_path("/dest"), lambda _: sendrefs, gen_pack
  218. )
  219. self.assertEqual(
  220. {
  221. b"refs/heads/branch": None,
  222. b"refs/heads/master": "non-fast-forward",
  223. },
  224. result.ref_status,
  225. )
  226. def test_send_pack_multiple_errors(self) -> None:
  227. dest, dummy = self.disable_ff_and_make_dummy_commit()
  228. # set up for two non-ff errors
  229. branch, master = b"refs/heads/branch", b"refs/heads/master"
  230. dest.refs[branch] = dest.refs[master] = dummy
  231. repo_dir = os.path.join(self.gitroot, "server_new.export")
  232. with repo.Repo(repo_dir) as src:
  233. sendrefs, gen_pack = self.compute_send(src)
  234. c = self._client()
  235. result = c.send_pack(
  236. self._build_path("/dest"), lambda _: sendrefs, gen_pack
  237. )
  238. self.assertEqual(
  239. {branch: "non-fast-forward", master: "non-fast-forward"},
  240. result.ref_status,
  241. )
  242. def test_archive(self) -> None:
  243. c = self._client()
  244. f = BytesIO()
  245. c.archive(self._build_path("/server_new.export"), b"HEAD", f.write)
  246. f.seek(0)
  247. tf = tarfile.open(fileobj=f)
  248. self.assertEqual(["baz", "foo"], tf.getnames())
  249. def test_fetch_pack(self) -> None:
  250. c = self._client()
  251. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  252. result = c.fetch(self._build_path("/server_new.export"), dest)
  253. self.assertEqual(
  254. {b"HEAD": b"refs/heads/master"},
  255. result.symrefs,
  256. )
  257. for r in result.refs.items():
  258. dest.refs.set_if_equals(r[0], None, r[1])
  259. self.assertDestEqualsSrc()
  260. def test_fetch_pack_with_nondefault_symref(self) -> None:
  261. c = self._client()
  262. src = repo.Repo(os.path.join(self.gitroot, "server_new.export"))
  263. self.addCleanup(src.close)
  264. src.refs.add_if_new(b"refs/heads/main", src.refs[b"refs/heads/master"])
  265. src.refs.set_symbolic_ref(b"HEAD", b"refs/heads/main")
  266. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  267. result = c.fetch(self._build_path("/server_new.export"), dest)
  268. self.assertEqual(
  269. {b"HEAD": b"refs/heads/main"},
  270. result.symrefs,
  271. )
  272. for r in result.refs.items():
  273. dest.refs.set_if_equals(r[0], None, r[1])
  274. self.assertDestEqualsSrc()
  275. def test_get_refs_with_peeled_tag(self) -> None:
  276. tag_create(
  277. os.path.join(self.gitroot, "server_new.export"),
  278. b"v1.0",
  279. message=b"tagging",
  280. annotated=True,
  281. )
  282. c = self._client()
  283. refs = c.get_refs(self._build_path("/server_new.export"))
  284. self.assertEqual(
  285. [
  286. b"HEAD",
  287. b"refs/heads/branch",
  288. b"refs/heads/master",
  289. b"refs/tags/v1.0",
  290. b"refs/tags/v1.0^{}",
  291. ],
  292. sorted(refs.refs.keys()),
  293. )
  294. def test_get_refs_with_ref_prefix(self) -> None:
  295. c = self._client()
  296. refs = c.get_refs(
  297. self._build_path("/server_new.export"), ref_prefix=[b"refs/heads"]
  298. )
  299. self.assertEqual(
  300. [
  301. b"refs/heads/branch",
  302. b"refs/heads/master",
  303. ],
  304. sorted(refs.refs.keys()),
  305. )
  306. def test_fetch_pack_depth(self) -> None:
  307. c = self._client()
  308. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  309. result = c.fetch(self._build_path("/server_new.export"), dest, depth=1)
  310. for r in result.refs.items():
  311. dest.refs.set_if_equals(r[0], None, r[1])
  312. self.assertEqual(
  313. dest.get_shallow(),
  314. {
  315. b"35e0b59e187dd72a0af294aedffc213eaa4d03ff",
  316. b"514dc6d3fbfe77361bcaef320c4d21b72bc10be9",
  317. },
  318. )
  319. def test_fetch_pack_deepen_since(self) -> None:
  320. c = self._client()
  321. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  322. # Fetch commits since a specific date
  323. # Using Unix timestamp - the test repo has commits around 1265755064 (Feb 2010)
  324. # So we use a timestamp between first and last commit
  325. result = c.fetch(
  326. self._build_path("/server_new.export"),
  327. dest,
  328. shallow_since="1265755100",
  329. )
  330. for r in result.refs.items():
  331. dest.refs.set_if_equals(r[0], None, r[1])
  332. # Verify that shallow commits were created
  333. shallow = dest.get_shallow()
  334. self.assertIsNotNone(shallow)
  335. self.assertGreater(len(shallow), 0)
  336. def test_fetch_pack_deepen_not(self) -> None:
  337. c = self._client()
  338. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  339. # Fetch excluding commits reachable from a specific ref
  340. result = c.fetch(
  341. self._build_path("/server_new.export"),
  342. dest,
  343. shallow_exclude=["refs/heads/branch"],
  344. )
  345. for r in result.refs.items():
  346. dest.refs.set_if_equals(r[0], None, r[1])
  347. # Verify that shallow commits were created
  348. shallow = dest.get_shallow()
  349. self.assertIsNotNone(shallow)
  350. self.assertGreater(len(shallow), 0)
  351. def test_fetch_pack_deepen_since_and_not(self) -> None:
  352. c = self._client()
  353. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  354. # Fetch combining deepen-since and deepen-not
  355. result = c.fetch(
  356. self._build_path("/server_new.export"),
  357. dest,
  358. shallow_since="1265755100",
  359. shallow_exclude=["refs/heads/branch"],
  360. )
  361. for r in result.refs.items():
  362. dest.refs.set_if_equals(r[0], None, r[1])
  363. # Verify that shallow commits were created
  364. shallow = dest.get_shallow()
  365. self.assertIsNotNone(shallow)
  366. self.assertGreater(len(shallow), 0)
  367. def test_repeat(self) -> None:
  368. c = self._client()
  369. dest = repo.Repo(os.path.join(self.gitroot, "dest"))
  370. self.addCleanup(dest.close)
  371. result = c.fetch(self._build_path("/server_new.export"), dest)
  372. for r in result.refs.items():
  373. dest.refs.set_if_equals(r[0], None, r[1])
  374. self.assertDestEqualsSrc()
  375. result = c.fetch(self._build_path("/server_new.export"), dest)
  376. for r in result.refs.items():
  377. dest.refs.set_if_equals(r[0], None, r[1])
  378. self.assertDestEqualsSrc()
  379. def test_fetch_empty_pack(self) -> None:
  380. c = self._client()
  381. dest = repo.Repo(os.path.join(self.gitroot, "dest"))
  382. self.addCleanup(dest.close)
  383. result = c.fetch(self._build_path("/server_new.export"), dest)
  384. for r in result.refs.items():
  385. dest.refs.set_if_equals(r[0], None, r[1])
  386. self.assertDestEqualsSrc()
  387. def dw(refs, **kwargs):
  388. return list(refs.values())
  389. result = c.fetch(
  390. self._build_path("/server_new.export"),
  391. dest,
  392. determine_wants=dw,
  393. )
  394. for r in result.refs.items():
  395. dest.refs.set_if_equals(r[0], None, r[1])
  396. self.assertDestEqualsSrc()
  397. def test_incremental_fetch_pack(self) -> None:
  398. self.test_fetch_pack()
  399. dest, dummy = self.disable_ff_and_make_dummy_commit()
  400. dest.refs[b"refs/heads/master"] = dummy
  401. c = self._client()
  402. repo_dir = os.path.join(self.gitroot, "server_new.export")
  403. with repo.Repo(repo_dir) as dest:
  404. result = c.fetch(self._build_path("/dest"), dest)
  405. for r in result.refs.items():
  406. dest.refs.set_if_equals(r[0], None, r[1])
  407. self.assertDestEqualsSrc()
  408. def test_fetch_pack_no_side_band_64k(self) -> None:
  409. if protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH >= 2:
  410. raise SkipTest("side-band-64k cannot be disabled with git protocol v2")
  411. c = self._client()
  412. c._fetch_capabilities.remove(b"side-band-64k")
  413. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  414. result = c.fetch(self._build_path("/server_new.export"), dest)
  415. for r in result.refs.items():
  416. dest.refs.set_if_equals(r[0], None, r[1])
  417. self.assertDestEqualsSrc()
  418. def test_fetch_pack_zero_sha(self) -> None:
  419. # zero sha1s are already present on the client, and should
  420. # be ignored
  421. c = self._client()
  422. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  423. result = c.fetch(
  424. self._build_path("/server_new.export"),
  425. dest,
  426. lambda refs, **kwargs: [protocol.ZERO_SHA],
  427. )
  428. for r in result.refs.items():
  429. dest.refs.set_if_equals(r[0], None, r[1])
  430. def test_send_remove_branch(self) -> None:
  431. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  432. dummy_commit = self.make_dummy_commit(dest)
  433. dest.refs[b"refs/heads/master"] = dummy_commit
  434. dest.refs[b"refs/heads/abranch"] = dummy_commit
  435. sendrefs = dict(dest.refs)
  436. sendrefs[b"refs/heads/abranch"] = b"00" * 20
  437. del sendrefs[b"HEAD"]
  438. def gen_pack(have, want, ofs_delta=False, progress=None):
  439. return 0, []
  440. c = self._client()
  441. self.assertEqual(dest.refs[b"refs/heads/abranch"], dummy_commit)
  442. c.send_pack(self._build_path("/dest"), lambda _: sendrefs, gen_pack)
  443. self.assertNotIn(b"refs/heads/abranch", dest.refs)
  444. def test_send_new_branch_empty_pack(self) -> None:
  445. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  446. dummy_commit = self.make_dummy_commit(dest)
  447. dest.refs[b"refs/heads/master"] = dummy_commit
  448. dest.refs[b"refs/heads/abranch"] = dummy_commit
  449. sendrefs = {b"refs/heads/bbranch": dummy_commit}
  450. def gen_pack(have, want, ofs_delta=False, progress=None):
  451. return 0, []
  452. c = self._client()
  453. self.assertEqual(dest.refs[b"refs/heads/abranch"], dummy_commit)
  454. c.send_pack(self._build_path("/dest"), lambda _: sendrefs, gen_pack)
  455. self.assertEqual(dummy_commit, dest.refs[b"refs/heads/abranch"])
  456. def test_get_refs(self) -> None:
  457. c = self._client()
  458. refs = c.get_refs(self._build_path("/server_new.export"))
  459. repo_dir = os.path.join(self.gitroot, "server_new.export")
  460. with repo.Repo(repo_dir) as dest:
  461. self.assertDictEqual(dest.refs.as_dict(), refs.refs)
  462. class DulwichTCPClientTest(CompatTestCase, DulwichClientTestBase):
  463. def setUp(self) -> None:
  464. CompatTestCase.setUp(self)
  465. DulwichClientTestBase.setUp(self)
  466. if check_for_daemon(limit=1):
  467. raise SkipTest(
  468. f"git-daemon was already running on port {protocol.TCP_GIT_PORT}"
  469. )
  470. fd, self.pidfile = tempfile.mkstemp(
  471. prefix="dulwich-test-git-client", suffix=".pid"
  472. )
  473. os.fdopen(fd).close()
  474. args = [
  475. _DEFAULT_GIT,
  476. "daemon",
  477. "--verbose",
  478. "--export-all",
  479. f"--pid-file={self.pidfile}",
  480. f"--base-path={self.gitroot}",
  481. "--enable=receive-pack",
  482. "--enable=upload-archive",
  483. "--listen=localhost",
  484. "--reuseaddr",
  485. self.gitroot,
  486. ]
  487. self.process = subprocess.Popen(
  488. args,
  489. cwd=self.gitroot,
  490. stdout=subprocess.PIPE,
  491. stderr=subprocess.PIPE,
  492. )
  493. if not check_for_daemon():
  494. raise SkipTest("git-daemon failed to start")
  495. def tearDown(self) -> None:
  496. with open(self.pidfile) as f:
  497. pid = int(f.read().strip())
  498. if sys.platform == "win32":
  499. PROCESS_TERMINATE = 1
  500. handle = ctypes.windll.kernel32.OpenProcess(PROCESS_TERMINATE, False, pid)
  501. ctypes.windll.kernel32.TerminateProcess(handle, -1)
  502. ctypes.windll.kernel32.CloseHandle(handle)
  503. else:
  504. with suppress(OSError):
  505. os.kill(pid, signal.SIGKILL)
  506. os.unlink(self.pidfile)
  507. self.process.wait()
  508. self.process.stdout.close()
  509. self.process.stderr.close()
  510. CompatTestCase.tearDown(self)
  511. def _client(self):
  512. return client.TCPGitClient("localhost")
  513. def _build_path(self, path):
  514. return path
  515. if sys.platform == "win32" and protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH < 2:
  516. @expectedFailure
  517. def test_fetch_pack_no_side_band_64k(self) -> None:
  518. DulwichClientTestBase.test_fetch_pack_no_side_band_64k(self)
  519. def test_send_remove_branch(self) -> None:
  520. # This test fails intermittently on my machine, probably due to some sort
  521. # of race condition. Probably also related to #1015
  522. self.skipTest("skip flaky test; see #1015")
  523. @patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
  524. class DulwichTCPClientTestGitProtov0(DulwichTCPClientTest):
  525. pass
  526. class TestSSHVendor:
  527. @staticmethod
  528. def run_command(
  529. host,
  530. command,
  531. username=None,
  532. port=None,
  533. password=None,
  534. key_filename=None,
  535. ssh_command=None,
  536. protocol_version=None,
  537. ):
  538. # Handle both bytes and string commands
  539. if isinstance(command, bytes):
  540. cmd, path = command.split(b" ")
  541. cmd = cmd.decode("utf-8").split("-", 1)
  542. path = path.decode("utf-8").replace("'", "")
  543. else:
  544. cmd, path = command.split(" ")
  545. cmd = cmd.split("-", 1)
  546. path = path.replace("'", "")
  547. env = dict(os.environ)
  548. if protocol_version is None:
  549. protocol_version = protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH
  550. if protocol_version > 0:
  551. env["GIT_PROTOCOL"] = f"version={protocol_version}"
  552. p = subprocess.Popen(
  553. [*cmd, path],
  554. bufsize=0,
  555. stdin=subprocess.PIPE,
  556. stdout=subprocess.PIPE,
  557. stderr=subprocess.PIPE,
  558. env=env,
  559. )
  560. return client.SubprocessWrapper(p)
  561. class DulwichMockSSHClientTest(CompatTestCase, DulwichClientTestBase):
  562. def setUp(self) -> None:
  563. CompatTestCase.setUp(self)
  564. DulwichClientTestBase.setUp(self)
  565. self.real_vendor = client.get_ssh_vendor
  566. client.get_ssh_vendor = TestSSHVendor
  567. def tearDown(self) -> None:
  568. CompatTestCase.tearDown(self)
  569. client.get_ssh_vendor = self.real_vendor
  570. def _client(self):
  571. return client.SSHGitClient("localhost")
  572. def _build_path(self, path):
  573. return self.gitroot + path
  574. @patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
  575. class DulwichMockSSHClientTestGitProtov0(DulwichMockSSHClientTest):
  576. pass
  577. class DulwichSubprocessClientTest(CompatTestCase, DulwichClientTestBase):
  578. def setUp(self) -> None:
  579. CompatTestCase.setUp(self)
  580. DulwichClientTestBase.setUp(self)
  581. def tearDown(self) -> None:
  582. CompatTestCase.tearDown(self)
  583. def _client(self):
  584. return client.SubprocessGitClient()
  585. def _build_path(self, path):
  586. return self.gitroot + path
  587. @patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
  588. class DulwichSubprocessClientTestGitProtov0(DulwichSubprocessClientTest):
  589. pass
  590. class GitHTTPRequestHandler(http.server.SimpleHTTPRequestHandler):
  591. """HTTP Request handler that calls out to 'git http-backend'."""
  592. # Make rfile unbuffered -- we need to read one line and then pass
  593. # the rest to a subprocess, so we can't use buffered input.
  594. rbufsize = 0
  595. def do_POST(self) -> None:
  596. self.run_backend()
  597. def do_GET(self) -> None:
  598. self.run_backend()
  599. def send_head(self):
  600. return self.run_backend()
  601. def log_request(self, code="-", size="-") -> None:
  602. # Let's be quiet, the test suite is noisy enough already
  603. pass
  604. def run_backend(self) -> None:
  605. """Call out to git http-backend."""
  606. # Based on CGIHTTPServer.CGIHTTPRequestHandler.run_cgi:
  607. # Copyright (c) 2001-2010 Python Software Foundation;
  608. # All Rights Reserved
  609. # Licensed under the Python Software Foundation License.
  610. rest = self.path
  611. # find an explicit query string, if present.
  612. i = rest.rfind("?")
  613. if i >= 0:
  614. rest, query = rest[:i], rest[i + 1 :]
  615. else:
  616. query = ""
  617. env = copy.deepcopy(os.environ)
  618. env["SERVER_SOFTWARE"] = self.version_string()
  619. env["SERVER_NAME"] = self.server.server_name
  620. env["GATEWAY_INTERFACE"] = "CGI/1.1"
  621. env["SERVER_PROTOCOL"] = self.protocol_version
  622. env["SERVER_PORT"] = str(self.server.server_port)
  623. env["GIT_PROJECT_ROOT"] = self.server.root_path
  624. env["GIT_HTTP_EXPORT_ALL"] = "1"
  625. env["REQUEST_METHOD"] = self.command
  626. uqrest = unquote(rest)
  627. env["PATH_INFO"] = uqrest
  628. env["SCRIPT_NAME"] = "/"
  629. if query:
  630. env["QUERY_STRING"] = query
  631. host = self.address_string()
  632. if host != self.client_address[0]:
  633. env["REMOTE_HOST"] = host
  634. env["REMOTE_ADDR"] = self.client_address[0]
  635. authorization = self.headers.get("authorization")
  636. if authorization:
  637. authorization = authorization.split()
  638. if len(authorization) == 2:
  639. import base64
  640. import binascii
  641. env["AUTH_TYPE"] = authorization[0]
  642. if authorization[0].lower() == "basic":
  643. try:
  644. authorization = base64.decodestring(authorization[1])
  645. except binascii.Error:
  646. pass
  647. else:
  648. authorization = authorization.split(":")
  649. if len(authorization) == 2:
  650. env["REMOTE_USER"] = authorization[0]
  651. # XXX REMOTE_IDENT
  652. content_type = self.headers.get("content-type")
  653. if content_type:
  654. env["CONTENT_TYPE"] = content_type
  655. length = self.headers.get("content-length")
  656. if length:
  657. env["CONTENT_LENGTH"] = length
  658. referer = self.headers.get("referer")
  659. if referer:
  660. env["HTTP_REFERER"] = referer
  661. accept = []
  662. for line in self.headers.getallmatchingheaders("accept"):
  663. if line[:1] in "\t\n\r ":
  664. accept.append(line.strip())
  665. else:
  666. accept = accept + line[7:].split(",")
  667. env["HTTP_ACCEPT"] = ",".join(accept)
  668. ua = self.headers.get("user-agent")
  669. if ua:
  670. env["HTTP_USER_AGENT"] = ua
  671. co = self.headers.get("cookie")
  672. if co:
  673. env["HTTP_COOKIE"] = co
  674. proto = self.headers.get("Git-Protocol")
  675. if proto:
  676. env["GIT_PROTOCOL"] = proto
  677. # XXX Other HTTP_* headers
  678. # Since we're setting the env in the parent, provide empty
  679. # values to override previously set values
  680. for k in (
  681. "QUERY_STRING",
  682. "REMOTE_HOST",
  683. "CONTENT_LENGTH",
  684. "HTTP_USER_AGENT",
  685. "HTTP_COOKIE",
  686. "HTTP_REFERER",
  687. ):
  688. env.setdefault(k, "")
  689. self.wfile.write(b"HTTP/1.1 200 Script output follows\r\n")
  690. self.wfile.write((f"Server: {self.server.server_name}\r\n").encode("ascii"))
  691. self.wfile.write((f"Date: {self.date_time_string()}\r\n").encode("ascii"))
  692. decoded_query = query.replace("+", " ")
  693. try:
  694. nbytes = int(length)
  695. except (TypeError, ValueError):
  696. nbytes = -1
  697. if self.command.lower() == "post":
  698. if nbytes > 0:
  699. data = self.rfile.read(nbytes)
  700. elif self.headers.get("transfer-encoding") == "chunked":
  701. chunks = []
  702. while True:
  703. line = self.rfile.readline()
  704. length = int(line.rstrip(), 16)
  705. chunk = self.rfile.read(length + 2)
  706. chunks.append(chunk[:-2])
  707. if length == 0:
  708. break
  709. data = b"".join(chunks)
  710. env["CONTENT_LENGTH"] = str(len(data))
  711. else:
  712. raise AssertionError
  713. else:
  714. data = None
  715. env["CONTENT_LENGTH"] = "0"
  716. # throw away additional data [see bug #427345]
  717. while select.select([self.rfile._sock], [], [], 0)[0]:
  718. if not self.rfile._sock.recv(1):
  719. break
  720. args = ["http-backend"]
  721. if "=" not in decoded_query:
  722. args.append(decoded_query)
  723. stdout = run_git_or_fail(args, input=data, env=env, stderr=subprocess.PIPE)
  724. self.wfile.write(stdout)
  725. class HTTPGitServer(http.server.HTTPServer):
  726. allow_reuse_address = True
  727. def __init__(self, server_address, root_path) -> None:
  728. http.server.HTTPServer.__init__(self, server_address, GitHTTPRequestHandler)
  729. self.root_path = root_path
  730. self.server_name = "localhost"
  731. def get_url(self) -> str:
  732. return f"http://{self.server_name}:{self.server_port}/"
  733. class DulwichHttpClientTest(CompatTestCase, DulwichClientTestBase):
  734. min_git_version = (1, 7, 0, 2)
  735. def setUp(self) -> None:
  736. CompatTestCase.setUp(self)
  737. DulwichClientTestBase.setUp(self)
  738. self._httpd = HTTPGitServer(("localhost", 0), self.gitroot)
  739. self.addCleanup(self._httpd.shutdown)
  740. threading.Thread(target=self._httpd.serve_forever).start()
  741. run_git_or_fail(["config", "http.uploadpack", "true"], cwd=self.dest)
  742. run_git_or_fail(["config", "http.receivepack", "true"], cwd=self.dest)
  743. def tearDown(self) -> None:
  744. CompatTestCase.tearDown(self)
  745. self._httpd.shutdown()
  746. self._httpd.socket.close()
  747. def _client(self):
  748. return client.HttpGitClient(self._httpd.get_url())
  749. def _build_path(self, path):
  750. return path
  751. def test_archive(self) -> NoReturn:
  752. raise SkipTest("exporting archives not supported over http")
  753. @patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
  754. class DulwichHttpClientTestGitProtov0(DulwichHttpClientTest):
  755. pass