test_client.py 31 KB

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