test_client.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863
  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. def tearDown(self) -> None:
  62. 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. run_git_or_fail(
  189. ["config", "receive.denyNonFastForwards", "true"], cwd=dest.path
  190. )
  191. commit_id = self.make_dummy_commit(dest)
  192. return dest, commit_id
  193. def compute_send(self, src):
  194. sendrefs = dict(src.get_refs())
  195. del sendrefs[b"HEAD"]
  196. # Wrap generate_pack_data to match expected signature
  197. def generate_pack_data_wrapper(
  198. have: set[bytes],
  199. want: set[bytes],
  200. *,
  201. ofs_delta: bool = False,
  202. progress=None,
  203. ) -> tuple[int, Iterator]:
  204. return src.generate_pack_data(
  205. have, want, progress=progress, ofs_delta=ofs_delta
  206. )
  207. return sendrefs, generate_pack_data_wrapper
  208. def test_send_pack_one_error(self) -> None:
  209. dest, dummy_commit = self.disable_ff_and_make_dummy_commit()
  210. dest.refs[b"refs/heads/master"] = dummy_commit
  211. repo_dir = os.path.join(self.gitroot, "server_new.export")
  212. with repo.Repo(repo_dir) as src:
  213. sendrefs, gen_pack = self.compute_send(src)
  214. c = self._client()
  215. result = c.send_pack(
  216. self._build_path("/dest"), lambda _: sendrefs, gen_pack
  217. )
  218. self.assertEqual(
  219. {
  220. b"refs/heads/branch": None,
  221. b"refs/heads/master": "non-fast-forward",
  222. },
  223. result.ref_status,
  224. )
  225. def test_send_pack_multiple_errors(self) -> None:
  226. dest, dummy = self.disable_ff_and_make_dummy_commit()
  227. # set up for two non-ff errors
  228. branch, master = b"refs/heads/branch", b"refs/heads/master"
  229. dest.refs[branch] = dest.refs[master] = dummy
  230. repo_dir = os.path.join(self.gitroot, "server_new.export")
  231. with repo.Repo(repo_dir) as src:
  232. sendrefs, gen_pack = self.compute_send(src)
  233. c = self._client()
  234. result = c.send_pack(
  235. self._build_path("/dest"), lambda _: sendrefs, gen_pack
  236. )
  237. self.assertEqual(
  238. {branch: "non-fast-forward", master: "non-fast-forward"},
  239. result.ref_status,
  240. )
  241. def test_archive(self) -> None:
  242. c = self._client()
  243. f = BytesIO()
  244. c.archive(self._build_path("/server_new.export"), b"HEAD", f.write)
  245. f.seek(0)
  246. tf = tarfile.open(fileobj=f)
  247. self.assertEqual(["baz", "foo"], tf.getnames())
  248. def test_fetch_pack(self) -> None:
  249. c = self._client()
  250. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  251. result = c.fetch(self._build_path("/server_new.export"), dest)
  252. self.assertEqual(
  253. {b"HEAD": b"refs/heads/master"},
  254. result.symrefs,
  255. )
  256. for r in result.refs.items():
  257. dest.refs.set_if_equals(r[0], None, r[1])
  258. self.assertDestEqualsSrc()
  259. def test_fetch_pack_with_nondefault_symref(self) -> None:
  260. c = self._client()
  261. src = repo.Repo(os.path.join(self.gitroot, "server_new.export"))
  262. src.refs.add_if_new(b"refs/heads/main", src.refs[b"refs/heads/master"])
  263. src.refs.set_symbolic_ref(b"HEAD", b"refs/heads/main")
  264. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  265. result = c.fetch(self._build_path("/server_new.export"), dest)
  266. self.assertEqual(
  267. {b"HEAD": b"refs/heads/main"},
  268. result.symrefs,
  269. )
  270. for r in result.refs.items():
  271. dest.refs.set_if_equals(r[0], None, r[1])
  272. self.assertDestEqualsSrc()
  273. def test_get_refs_with_peeled_tag(self) -> None:
  274. tag_create(
  275. os.path.join(self.gitroot, "server_new.export"),
  276. b"v1.0",
  277. message=b"tagging",
  278. annotated=True,
  279. )
  280. c = self._client()
  281. refs = c.get_refs(self._build_path("/server_new.export"))
  282. self.assertEqual(
  283. [
  284. b"HEAD",
  285. b"refs/heads/branch",
  286. b"refs/heads/master",
  287. b"refs/tags/v1.0",
  288. b"refs/tags/v1.0^{}",
  289. ],
  290. sorted(refs.refs.keys()),
  291. )
  292. def test_get_refs_with_ref_prefix(self) -> None:
  293. c = self._client()
  294. refs = c.get_refs(
  295. self._build_path("/server_new.export"), ref_prefix=[b"refs/heads"]
  296. )
  297. self.assertEqual(
  298. [
  299. b"refs/heads/branch",
  300. b"refs/heads/master",
  301. ],
  302. sorted(refs.refs.keys()),
  303. )
  304. def test_fetch_pack_depth(self) -> None:
  305. c = self._client()
  306. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  307. result = c.fetch(self._build_path("/server_new.export"), dest, depth=1)
  308. for r in result.refs.items():
  309. dest.refs.set_if_equals(r[0], None, r[1])
  310. self.assertEqual(
  311. dest.get_shallow(),
  312. {
  313. b"35e0b59e187dd72a0af294aedffc213eaa4d03ff",
  314. b"514dc6d3fbfe77361bcaef320c4d21b72bc10be9",
  315. },
  316. )
  317. def test_fetch_pack_deepen_since(self) -> None:
  318. c = self._client()
  319. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  320. # Fetch commits since a specific date
  321. # Using Unix timestamp - the test repo has commits around 1265755064 (Feb 2010)
  322. # So we use a timestamp between first and last commit
  323. result = c.fetch(
  324. self._build_path("/server_new.export"),
  325. dest,
  326. shallow_since="1265755100",
  327. )
  328. for r in result.refs.items():
  329. dest.refs.set_if_equals(r[0], None, r[1])
  330. # Verify that shallow commits were created
  331. shallow = dest.get_shallow()
  332. self.assertIsNotNone(shallow)
  333. self.assertGreater(len(shallow), 0)
  334. def test_fetch_pack_deepen_not(self) -> None:
  335. c = self._client()
  336. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  337. # Fetch excluding commits reachable from a specific ref
  338. result = c.fetch(
  339. self._build_path("/server_new.export"),
  340. dest,
  341. shallow_exclude=["refs/heads/branch"],
  342. )
  343. for r in result.refs.items():
  344. dest.refs.set_if_equals(r[0], None, r[1])
  345. # Verify that shallow commits were created
  346. shallow = dest.get_shallow()
  347. self.assertIsNotNone(shallow)
  348. self.assertGreater(len(shallow), 0)
  349. def test_fetch_pack_deepen_since_and_not(self) -> None:
  350. c = self._client()
  351. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  352. # Fetch combining deepen-since and deepen-not
  353. result = c.fetch(
  354. self._build_path("/server_new.export"),
  355. dest,
  356. shallow_since="1265755100",
  357. shallow_exclude=["refs/heads/branch"],
  358. )
  359. for r in result.refs.items():
  360. dest.refs.set_if_equals(r[0], None, r[1])
  361. # Verify that shallow commits were created
  362. shallow = dest.get_shallow()
  363. self.assertIsNotNone(shallow)
  364. self.assertGreater(len(shallow), 0)
  365. def test_repeat(self) -> None:
  366. c = self._client()
  367. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  368. result = c.fetch(self._build_path("/server_new.export"), dest)
  369. for r in result.refs.items():
  370. dest.refs.set_if_equals(r[0], None, r[1])
  371. self.assertDestEqualsSrc()
  372. result = c.fetch(self._build_path("/server_new.export"), dest)
  373. for r in result.refs.items():
  374. dest.refs.set_if_equals(r[0], None, r[1])
  375. self.assertDestEqualsSrc()
  376. def test_fetch_empty_pack(self) -> None:
  377. c = self._client()
  378. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  379. result = c.fetch(self._build_path("/server_new.export"), dest)
  380. for r in result.refs.items():
  381. dest.refs.set_if_equals(r[0], None, r[1])
  382. self.assertDestEqualsSrc()
  383. def dw(refs, **kwargs):
  384. return list(refs.values())
  385. result = c.fetch(
  386. self._build_path("/server_new.export"),
  387. dest,
  388. determine_wants=dw,
  389. )
  390. for r in result.refs.items():
  391. dest.refs.set_if_equals(r[0], None, r[1])
  392. self.assertDestEqualsSrc()
  393. def test_incremental_fetch_pack(self) -> None:
  394. self.test_fetch_pack()
  395. dest, dummy = self.disable_ff_and_make_dummy_commit()
  396. dest.refs[b"refs/heads/master"] = dummy
  397. c = self._client()
  398. repo_dir = os.path.join(self.gitroot, "server_new.export")
  399. with repo.Repo(repo_dir) as dest:
  400. result = c.fetch(self._build_path("/dest"), dest)
  401. for r in result.refs.items():
  402. dest.refs.set_if_equals(r[0], None, r[1])
  403. self.assertDestEqualsSrc()
  404. def test_fetch_pack_no_side_band_64k(self) -> None:
  405. if protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH >= 2:
  406. raise SkipTest("side-band-64k cannot be disabled with git protocol v2")
  407. c = self._client()
  408. c._fetch_capabilities.remove(b"side-band-64k")
  409. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  410. result = c.fetch(self._build_path("/server_new.export"), dest)
  411. for r in result.refs.items():
  412. dest.refs.set_if_equals(r[0], None, r[1])
  413. self.assertDestEqualsSrc()
  414. def test_fetch_pack_zero_sha(self) -> None:
  415. # zero sha1s are already present on the client, and should
  416. # be ignored
  417. c = self._client()
  418. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  419. result = c.fetch(
  420. self._build_path("/server_new.export"),
  421. dest,
  422. lambda refs, **kwargs: [protocol.ZERO_SHA],
  423. )
  424. for r in result.refs.items():
  425. dest.refs.set_if_equals(r[0], None, r[1])
  426. def test_send_remove_branch(self) -> None:
  427. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  428. dummy_commit = self.make_dummy_commit(dest)
  429. dest.refs[b"refs/heads/master"] = dummy_commit
  430. dest.refs[b"refs/heads/abranch"] = dummy_commit
  431. sendrefs = dict(dest.refs)
  432. sendrefs[b"refs/heads/abranch"] = b"00" * 20
  433. del sendrefs[b"HEAD"]
  434. def gen_pack(have, want, ofs_delta=False, progress=None):
  435. return 0, []
  436. c = self._client()
  437. self.assertEqual(dest.refs[b"refs/heads/abranch"], dummy_commit)
  438. c.send_pack(self._build_path("/dest"), lambda _: sendrefs, gen_pack)
  439. self.assertNotIn(b"refs/heads/abranch", dest.refs)
  440. def test_send_new_branch_empty_pack(self) -> None:
  441. with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
  442. dummy_commit = self.make_dummy_commit(dest)
  443. dest.refs[b"refs/heads/master"] = dummy_commit
  444. dest.refs[b"refs/heads/abranch"] = dummy_commit
  445. sendrefs = {b"refs/heads/bbranch": dummy_commit}
  446. def gen_pack(have, want, ofs_delta=False, progress=None):
  447. return 0, []
  448. c = self._client()
  449. self.assertEqual(dest.refs[b"refs/heads/abranch"], dummy_commit)
  450. c.send_pack(self._build_path("/dest"), lambda _: sendrefs, gen_pack)
  451. self.assertEqual(dummy_commit, dest.refs[b"refs/heads/abranch"])
  452. def test_get_refs(self) -> None:
  453. c = self._client()
  454. refs = c.get_refs(self._build_path("/server_new.export"))
  455. repo_dir = os.path.join(self.gitroot, "server_new.export")
  456. with repo.Repo(repo_dir) as dest:
  457. self.assertDictEqual(dest.refs.as_dict(), refs.refs)
  458. class DulwichTCPClientTest(CompatTestCase, DulwichClientTestBase):
  459. def setUp(self) -> None:
  460. CompatTestCase.setUp(self)
  461. DulwichClientTestBase.setUp(self)
  462. if check_for_daemon(limit=1):
  463. raise SkipTest(
  464. f"git-daemon was already running on port {protocol.TCP_GIT_PORT}"
  465. )
  466. fd, self.pidfile = tempfile.mkstemp(
  467. prefix="dulwich-test-git-client", suffix=".pid"
  468. )
  469. os.fdopen(fd).close()
  470. args = [
  471. _DEFAULT_GIT,
  472. "daemon",
  473. "--verbose",
  474. "--export-all",
  475. f"--pid-file={self.pidfile}",
  476. f"--base-path={self.gitroot}",
  477. "--enable=receive-pack",
  478. "--enable=upload-archive",
  479. "--listen=localhost",
  480. "--reuseaddr",
  481. self.gitroot,
  482. ]
  483. self.process = subprocess.Popen(
  484. args,
  485. cwd=self.gitroot,
  486. stdout=subprocess.PIPE,
  487. stderr=subprocess.PIPE,
  488. )
  489. if not check_for_daemon():
  490. raise SkipTest("git-daemon failed to start")
  491. def tearDown(self) -> None:
  492. with open(self.pidfile) as f:
  493. pid = int(f.read().strip())
  494. if sys.platform == "win32":
  495. PROCESS_TERMINATE = 1
  496. handle = ctypes.windll.kernel32.OpenProcess(PROCESS_TERMINATE, False, pid)
  497. ctypes.windll.kernel32.TerminateProcess(handle, -1)
  498. ctypes.windll.kernel32.CloseHandle(handle)
  499. else:
  500. with suppress(OSError):
  501. os.kill(pid, signal.SIGKILL)
  502. os.unlink(self.pidfile)
  503. self.process.wait()
  504. self.process.stdout.close()
  505. self.process.stderr.close()
  506. DulwichClientTestBase.tearDown(self)
  507. CompatTestCase.tearDown(self)
  508. def _client(self):
  509. return client.TCPGitClient("localhost")
  510. def _build_path(self, path):
  511. return path
  512. if sys.platform == "win32" and protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH < 2:
  513. @expectedFailure
  514. def test_fetch_pack_no_side_band_64k(self) -> None:
  515. DulwichClientTestBase.test_fetch_pack_no_side_band_64k(self)
  516. def test_send_remove_branch(self) -> None:
  517. # This test fails intermittently on my machine, probably due to some sort
  518. # of race condition. Probably also related to #1015
  519. self.skipTest("skip flaky test; see #1015")
  520. @patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
  521. class DulwichTCPClientTestGitProtov0(DulwichTCPClientTest):
  522. pass
  523. class TestSSHVendor:
  524. @staticmethod
  525. def run_command(
  526. host,
  527. command,
  528. username=None,
  529. port=None,
  530. password=None,
  531. key_filename=None,
  532. ssh_command=None,
  533. protocol_version=None,
  534. ):
  535. # Handle both bytes and string commands
  536. if isinstance(command, bytes):
  537. cmd, path = command.split(b" ")
  538. cmd = cmd.decode("utf-8").split("-", 1)
  539. path = path.decode("utf-8").replace("'", "")
  540. else:
  541. cmd, path = command.split(" ")
  542. cmd = cmd.split("-", 1)
  543. path = path.replace("'", "")
  544. env = dict(os.environ)
  545. if protocol_version is None:
  546. protocol_version = protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH
  547. if protocol_version > 0:
  548. env["GIT_PROTOCOL"] = f"version={protocol_version}"
  549. p = subprocess.Popen(
  550. [*cmd, path],
  551. bufsize=0,
  552. stdin=subprocess.PIPE,
  553. stdout=subprocess.PIPE,
  554. stderr=subprocess.PIPE,
  555. env=env,
  556. )
  557. return client.SubprocessWrapper(p)
  558. class DulwichMockSSHClientTest(CompatTestCase, DulwichClientTestBase):
  559. def setUp(self) -> None:
  560. CompatTestCase.setUp(self)
  561. DulwichClientTestBase.setUp(self)
  562. self.real_vendor = client.get_ssh_vendor
  563. client.get_ssh_vendor = TestSSHVendor
  564. def tearDown(self) -> None:
  565. DulwichClientTestBase.tearDown(self)
  566. CompatTestCase.tearDown(self)
  567. client.get_ssh_vendor = self.real_vendor
  568. def _client(self):
  569. return client.SSHGitClient("localhost")
  570. def _build_path(self, path):
  571. return self.gitroot + path
  572. @patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
  573. class DulwichMockSSHClientTestGitProtov0(DulwichMockSSHClientTest):
  574. pass
  575. class DulwichSubprocessClientTest(CompatTestCase, DulwichClientTestBase):
  576. def setUp(self) -> None:
  577. CompatTestCase.setUp(self)
  578. DulwichClientTestBase.setUp(self)
  579. def tearDown(self) -> None:
  580. DulwichClientTestBase.tearDown(self)
  581. CompatTestCase.tearDown(self)
  582. def _client(self):
  583. return client.SubprocessGitClient()
  584. def _build_path(self, path):
  585. return self.gitroot + path
  586. @patch("dulwich.protocol.DEFAULT_GIT_PROTOCOL_VERSION_FETCH", new=0)
  587. class DulwichSubprocessClientTestGitProtov0(DulwichSubprocessClientTest):
  588. pass
  589. class GitHTTPRequestHandler(http.server.SimpleHTTPRequestHandler):
  590. """HTTP Request handler that calls out to 'git http-backend'."""
  591. # Make rfile unbuffered -- we need to read one line and then pass
  592. # the rest to a subprocess, so we can't use buffered input.
  593. rbufsize = 0
  594. def do_POST(self) -> None:
  595. self.run_backend()
  596. def do_GET(self) -> None:
  597. self.run_backend()
  598. def send_head(self):
  599. return self.run_backend()
  600. def log_request(self, code="-", size="-") -> None:
  601. # Let's be quiet, the test suite is noisy enough already
  602. pass
  603. def run_backend(self) -> None:
  604. """Call out to git http-backend."""
  605. # Based on CGIHTTPServer.CGIHTTPRequestHandler.run_cgi:
  606. # Copyright (c) 2001-2010 Python Software Foundation;
  607. # All Rights Reserved
  608. # Licensed under the Python Software Foundation License.
  609. rest = self.path
  610. # find an explicit query string, if present.
  611. i = rest.rfind("?")
  612. if i >= 0:
  613. rest, query = rest[:i], rest[i + 1 :]
  614. else:
  615. query = ""
  616. env = copy.deepcopy(os.environ)
  617. env["SERVER_SOFTWARE"] = self.version_string()
  618. env["SERVER_NAME"] = self.server.server_name
  619. env["GATEWAY_INTERFACE"] = "CGI/1.1"
  620. env["SERVER_PROTOCOL"] = self.protocol_version
  621. env["SERVER_PORT"] = str(self.server.server_port)
  622. env["GIT_PROJECT_ROOT"] = self.server.root_path
  623. env["GIT_HTTP_EXPORT_ALL"] = "1"
  624. env["REQUEST_METHOD"] = self.command
  625. uqrest = unquote(rest)
  626. env["PATH_INFO"] = uqrest
  627. env["SCRIPT_NAME"] = "/"
  628. if query:
  629. env["QUERY_STRING"] = query
  630. host = self.address_string()
  631. if host != self.client_address[0]:
  632. env["REMOTE_HOST"] = host
  633. env["REMOTE_ADDR"] = self.client_address[0]
  634. authorization = self.headers.get("authorization")
  635. if authorization:
  636. authorization = authorization.split()
  637. if len(authorization) == 2:
  638. import base64
  639. import binascii
  640. env["AUTH_TYPE"] = authorization[0]
  641. if authorization[0].lower() == "basic":
  642. try:
  643. authorization = base64.decodestring(authorization[1])
  644. except binascii.Error:
  645. pass
  646. else:
  647. authorization = authorization.split(":")
  648. if len(authorization) == 2:
  649. env["REMOTE_USER"] = authorization[0]
  650. # XXX REMOTE_IDENT
  651. content_type = self.headers.get("content-type")
  652. if content_type:
  653. env["CONTENT_TYPE"] = content_type
  654. length = self.headers.get("content-length")
  655. if length:
  656. env["CONTENT_LENGTH"] = length
  657. referer = self.headers.get("referer")
  658. if referer:
  659. env["HTTP_REFERER"] = referer
  660. accept = []
  661. for line in self.headers.getallmatchingheaders("accept"):
  662. if line[:1] in "\t\n\r ":
  663. accept.append(line.strip())
  664. else:
  665. accept = accept + line[7:].split(",")
  666. env["HTTP_ACCEPT"] = ",".join(accept)
  667. ua = self.headers.get("user-agent")
  668. if ua:
  669. env["HTTP_USER_AGENT"] = ua
  670. co = self.headers.get("cookie")
  671. if co:
  672. env["HTTP_COOKIE"] = co
  673. proto = self.headers.get("Git-Protocol")
  674. if proto:
  675. env["GIT_PROTOCOL"] = proto
  676. # XXX Other HTTP_* headers
  677. # Since we're setting the env in the parent, provide empty
  678. # values to override previously set values
  679. for k in (
  680. "QUERY_STRING",
  681. "REMOTE_HOST",
  682. "CONTENT_LENGTH",
  683. "HTTP_USER_AGENT",
  684. "HTTP_COOKIE",
  685. "HTTP_REFERER",
  686. ):
  687. env.setdefault(k, "")
  688. self.wfile.write(b"HTTP/1.1 200 Script output follows\r\n")
  689. self.wfile.write((f"Server: {self.server.server_name}\r\n").encode("ascii"))
  690. self.wfile.write((f"Date: {self.date_time_string()}\r\n").encode("ascii"))
  691. decoded_query = query.replace("+", " ")
  692. try:
  693. nbytes = int(length)
  694. except (TypeError, ValueError):
  695. nbytes = -1
  696. if self.command.lower() == "post":
  697. if nbytes > 0:
  698. data = self.rfile.read(nbytes)
  699. elif self.headers.get("transfer-encoding") == "chunked":
  700. chunks = []
  701. while True:
  702. line = self.rfile.readline()
  703. length = int(line.rstrip(), 16)
  704. chunk = self.rfile.read(length + 2)
  705. chunks.append(chunk[:-2])
  706. if length == 0:
  707. break
  708. data = b"".join(chunks)
  709. env["CONTENT_LENGTH"] = str(len(data))
  710. else:
  711. raise AssertionError
  712. else:
  713. data = None
  714. env["CONTENT_LENGTH"] = "0"
  715. # throw away additional data [see bug #427345]
  716. while select.select([self.rfile._sock], [], [], 0)[0]:
  717. if not self.rfile._sock.recv(1):
  718. break
  719. args = ["http-backend"]
  720. if "=" not in decoded_query:
  721. args.append(decoded_query)
  722. stdout = run_git_or_fail(args, input=data, env=env, stderr=subprocess.PIPE)
  723. self.wfile.write(stdout)
  724. class HTTPGitServer(http.server.HTTPServer):
  725. allow_reuse_address = True
  726. def __init__(self, server_address, root_path) -> None:
  727. http.server.HTTPServer.__init__(self, server_address, GitHTTPRequestHandler)
  728. self.root_path = root_path
  729. self.server_name = "localhost"
  730. def get_url(self) -> str:
  731. return f"http://{self.server_name}:{self.server_port}/"
  732. class DulwichHttpClientTest(CompatTestCase, DulwichClientTestBase):
  733. min_git_version = (1, 7, 0, 2)
  734. def setUp(self) -> None:
  735. CompatTestCase.setUp(self)
  736. DulwichClientTestBase.setUp(self)
  737. self._httpd = HTTPGitServer(("localhost", 0), self.gitroot)
  738. self.addCleanup(self._httpd.shutdown)
  739. threading.Thread(target=self._httpd.serve_forever).start()
  740. run_git_or_fail(["config", "http.uploadpack", "true"], cwd=self.dest)
  741. run_git_or_fail(["config", "http.receivepack", "true"], cwd=self.dest)
  742. def tearDown(self) -> None:
  743. DulwichClientTestBase.tearDown(self)
  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