test_client.py 27 KB

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