test_client.py 75 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126
  1. # test_client.py -- Tests for the git protocol, client side
  2. # Copyright (C) 2009 Jelmer Vernooij <jelmer@jelmer.uk>
  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 public 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. import base64
  22. import os
  23. import shutil
  24. import sys
  25. import tempfile
  26. import warnings
  27. from io import BytesIO
  28. from typing import NoReturn
  29. from unittest.mock import patch
  30. from urllib.parse import quote as urlquote
  31. from urllib.parse import urlparse
  32. import dulwich
  33. from dulwich import client
  34. from dulwich.client import (
  35. FetchPackResult,
  36. GitProtocolError,
  37. HangupException,
  38. HttpGitClient,
  39. InvalidWants,
  40. LocalGitClient,
  41. PLinkSSHVendor,
  42. ReportStatusParser,
  43. SendPackError,
  44. SSHGitClient,
  45. StrangeHostname,
  46. SubprocessSSHVendor,
  47. TCPGitClient,
  48. TraditionalGitClient,
  49. _extract_symrefs_and_agent,
  50. _remote_error_from_stderr,
  51. _win32_url_to_path,
  52. check_wants,
  53. default_urllib3_manager,
  54. get_credentials_from_store,
  55. get_transport_and_path,
  56. get_transport_and_path_from_url,
  57. parse_rsync_url,
  58. )
  59. from dulwich.config import ConfigDict
  60. from dulwich.objects import Commit, Tree
  61. from dulwich.pack import pack_objects_to_data, write_pack_data, write_pack_objects
  62. from dulwich.protocol import DEFAULT_GIT_PROTOCOL_VERSION_FETCH, TCP_GIT_PORT, Protocol
  63. from dulwich.repo import MemoryRepo, Repo
  64. from dulwich.tests.utils import open_repo, setup_warning_catcher, tear_down_repo
  65. from . import TestCase, skipIf
  66. class DummyClient(TraditionalGitClient):
  67. def __init__(self, can_read, read, write) -> None:
  68. self.can_read = can_read
  69. self.read = read
  70. self.write = write
  71. TraditionalGitClient.__init__(self)
  72. def _connect(self, service, path, protocol_version=None):
  73. return Protocol(self.read, self.write), self.can_read, None
  74. class DummyPopen:
  75. def __init__(self, *args, **kwards) -> None:
  76. self.stdin = BytesIO(b"stdin")
  77. self.stdout = BytesIO(b"stdout")
  78. self.stderr = BytesIO(b"stderr")
  79. self.returncode = 0
  80. self.args = args
  81. self.kwargs = kwards
  82. def communicate(self, *args, **kwards):
  83. return ("Running", "")
  84. def wait(self, *args, **kwards) -> bool:
  85. return False
  86. # TODO(durin42): add unit-level tests of GitClient
  87. class GitClientTests(TestCase):
  88. def setUp(self) -> None:
  89. super().setUp()
  90. self.rout = BytesIO()
  91. self.rin = BytesIO()
  92. self.client = DummyClient(lambda x: True, self.rin.read, self.rout.write)
  93. def test_caps(self) -> None:
  94. agent_cap = "agent=dulwich/{}.{}.{}".format(*dulwich.__version__).encode(
  95. "ascii"
  96. )
  97. self.assertEqual(
  98. {
  99. b"multi_ack",
  100. b"side-band-64k",
  101. b"ofs-delta",
  102. b"thin-pack",
  103. b"multi_ack_detailed",
  104. b"shallow",
  105. agent_cap,
  106. },
  107. set(self.client._fetch_capabilities),
  108. )
  109. self.assertEqual(
  110. {
  111. b"delete-refs",
  112. b"ofs-delta",
  113. b"report-status",
  114. b"side-band-64k",
  115. agent_cap,
  116. },
  117. set(self.client._send_capabilities),
  118. )
  119. def test_archive_ack(self) -> None:
  120. self.rin.write(b"0009NACK\n0000")
  121. self.rin.seek(0)
  122. self.client.archive(b"bla", b"HEAD", None, None)
  123. self.assertEqual(self.rout.getvalue(), b"0011argument HEAD0000")
  124. def test_fetch_empty(self) -> None:
  125. self.rin.write(b"0000")
  126. self.rin.seek(0)
  127. def check_heads(heads, **kwargs):
  128. self.assertEqual(heads, {})
  129. return []
  130. ret = self.client.fetch_pack(b"/", check_heads, None, None)
  131. self.assertEqual({}, ret.refs)
  132. self.assertEqual({}, ret.symrefs)
  133. def test_fetch_pack_ignores_magic_ref(self) -> None:
  134. self.rin.write(
  135. b"00000000000000000000000000000000000000000000 capabilities^{}"
  136. b"\x00 multi_ack "
  137. b"thin-pack side-band side-band-64k ofs-delta shallow no-progress "
  138. b"include-tag\n"
  139. b"0000"
  140. )
  141. self.rin.seek(0)
  142. def check_heads(heads, **kwargs):
  143. self.assertEqual({}, heads)
  144. return []
  145. ret = self.client.fetch_pack(b"bla", check_heads, None, None, None)
  146. self.assertEqual({}, ret.refs)
  147. self.assertEqual({}, ret.symrefs)
  148. self.assertEqual(self.rout.getvalue(), b"0000")
  149. def test_fetch_pack_none(self) -> None:
  150. self.rin.write(
  151. b"008855dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7 HEAD\x00multi_ack "
  152. b"thin-pack side-band side-band-64k ofs-delta shallow no-progress "
  153. b"include-tag\n"
  154. b"0000"
  155. )
  156. self.rin.seek(0)
  157. ret = self.client.fetch_pack(
  158. b"bla", lambda heads, **kwargs: [], None, None, None
  159. )
  160. self.assertEqual(
  161. {b"HEAD": b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7"}, ret.refs
  162. )
  163. self.assertEqual({}, ret.symrefs)
  164. self.assertEqual(self.rout.getvalue(), b"0000")
  165. def test_send_pack_no_sideband64k_with_update_ref_error(self) -> None:
  166. # No side-bank-64k reported by server shouldn't try to parse
  167. # side band data
  168. pkts = [
  169. b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7 capabilities^{}"
  170. b"\x00 report-status delete-refs ofs-delta\n",
  171. b"",
  172. b"unpack ok",
  173. b"ng refs/foo/bar pre-receive hook declined",
  174. b"",
  175. ]
  176. for pkt in pkts:
  177. if pkt == b"":
  178. self.rin.write(b"0000")
  179. else:
  180. self.rin.write(("%04x" % (len(pkt) + 4)).encode("ascii") + pkt)
  181. self.rin.seek(0)
  182. tree = Tree()
  183. commit = Commit()
  184. commit.tree = tree
  185. commit.parents = []
  186. commit.author = commit.committer = b"test user"
  187. commit.commit_time = commit.author_time = 1174773719
  188. commit.commit_timezone = commit.author_timezone = 0
  189. commit.encoding = b"UTF-8"
  190. commit.message = b"test message"
  191. def update_refs(refs):
  192. return {
  193. b"refs/foo/bar": commit.id,
  194. }
  195. def generate_pack_data(have, want, ofs_delta=False, progress=None):
  196. return pack_objects_to_data(
  197. [
  198. (commit, None),
  199. (tree, b""),
  200. ]
  201. )
  202. result = self.client.send_pack("blah", update_refs, generate_pack_data)
  203. self.assertEqual(
  204. {b"refs/foo/bar": "pre-receive hook declined"}, result.ref_status
  205. )
  206. self.assertEqual({b"refs/foo/bar": commit.id}, result.refs)
  207. def test_send_pack_none(self) -> None:
  208. # Set ref to current value
  209. self.rin.write(
  210. b"0078310ca9477129b8586fa2afc779c1f57cf64bba6c "
  211. b"refs/heads/master\x00 report-status delete-refs "
  212. b"side-band-64k quiet ofs-delta\n"
  213. b"0000"
  214. )
  215. self.rin.seek(0)
  216. def update_refs(refs):
  217. return {b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c"}
  218. def generate_pack_data(have, want, ofs_delta=False, progress=None):
  219. return 0, []
  220. self.client.send_pack(b"/", update_refs, generate_pack_data)
  221. self.assertEqual(self.rout.getvalue(), b"0000")
  222. def test_send_pack_keep_and_delete(self) -> None:
  223. self.rin.write(
  224. b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
  225. b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
  226. b"003f310ca9477129b8586fa2afc779c1f57cf64bba6c refs/heads/keepme\n"
  227. b"0000000eunpack ok\n"
  228. b"0019ok refs/heads/master\n"
  229. b"0000"
  230. )
  231. self.rin.seek(0)
  232. def update_refs(refs):
  233. return {b"refs/heads/master": b"0" * 40}
  234. def generate_pack_data(have, want, ofs_delta=False, progress=None):
  235. return 0, []
  236. self.client.send_pack(b"/", update_refs, generate_pack_data)
  237. self.assertEqual(
  238. self.rout.getvalue(),
  239. b"008b310ca9477129b8586fa2afc779c1f57cf64bba6c "
  240. b"0000000000000000000000000000000000000000 "
  241. b"refs/heads/master\x00delete-refs ofs-delta report-status0000",
  242. )
  243. def test_send_pack_delete_only(self) -> None:
  244. self.rin.write(
  245. b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
  246. b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
  247. b"0000000eunpack ok\n"
  248. b"0019ok refs/heads/master\n"
  249. b"0000"
  250. )
  251. self.rin.seek(0)
  252. def update_refs(refs):
  253. return {b"refs/heads/master": b"0" * 40}
  254. def generate_pack_data(have, want, ofs_delta=False, progress=None):
  255. return 0, []
  256. self.client.send_pack(b"/", update_refs, generate_pack_data)
  257. self.assertEqual(
  258. self.rout.getvalue(),
  259. b"008b310ca9477129b8586fa2afc779c1f57cf64bba6c "
  260. b"0000000000000000000000000000000000000000 "
  261. b"refs/heads/master\x00delete-refs ofs-delta report-status0000",
  262. )
  263. def test_send_pack_new_ref_only(self) -> None:
  264. self.rin.write(
  265. b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
  266. b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
  267. b"0000000eunpack ok\n"
  268. b"0019ok refs/heads/blah12\n"
  269. b"0000"
  270. )
  271. self.rin.seek(0)
  272. def update_refs(refs):
  273. return {
  274. b"refs/heads/blah12": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
  275. b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
  276. }
  277. def generate_pack_data(have, want, ofs_delta=False, progress=None):
  278. return 0, []
  279. f = BytesIO()
  280. write_pack_objects(f.write, [])
  281. self.client.send_pack("/", update_refs, generate_pack_data)
  282. self.assertEqual(
  283. self.rout.getvalue(),
  284. b"008b0000000000000000000000000000000000000000 "
  285. b"310ca9477129b8586fa2afc779c1f57cf64bba6c "
  286. b"refs/heads/blah12\x00delete-refs ofs-delta report-status0000"
  287. + f.getvalue(),
  288. )
  289. def test_send_pack_new_ref(self) -> None:
  290. self.rin.write(
  291. b"0064310ca9477129b8586fa2afc779c1f57cf64bba6c "
  292. b"refs/heads/master\x00 report-status delete-refs ofs-delta\n"
  293. b"0000000eunpack ok\n"
  294. b"0019ok refs/heads/blah12\n"
  295. b"0000"
  296. )
  297. self.rin.seek(0)
  298. tree = Tree()
  299. commit = Commit()
  300. commit.tree = tree
  301. commit.parents = []
  302. commit.author = commit.committer = b"test user"
  303. commit.commit_time = commit.author_time = 1174773719
  304. commit.commit_timezone = commit.author_timezone = 0
  305. commit.encoding = b"UTF-8"
  306. commit.message = b"test message"
  307. def update_refs(refs):
  308. return {
  309. b"refs/heads/blah12": commit.id,
  310. b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
  311. }
  312. def generate_pack_data(have, want, ofs_delta=False, progress=None):
  313. return pack_objects_to_data(
  314. [
  315. (commit, None),
  316. (tree, b""),
  317. ]
  318. )
  319. f = BytesIO()
  320. count, records = generate_pack_data(None, None)
  321. write_pack_data(f.write, records, num_records=count)
  322. self.client.send_pack(b"/", update_refs, generate_pack_data)
  323. self.assertEqual(
  324. self.rout.getvalue(),
  325. b"008b0000000000000000000000000000000000000000 "
  326. + commit.id
  327. + b" refs/heads/blah12\x00delete-refs ofs-delta report-status0000"
  328. + f.getvalue(),
  329. )
  330. def test_send_pack_no_deleteref_delete_only(self) -> None:
  331. pkts = [
  332. b"310ca9477129b8586fa2afc779c1f57cf64bba6c refs/heads/master"
  333. b"\x00 report-status ofs-delta\n",
  334. b"",
  335. b"",
  336. ]
  337. for pkt in pkts:
  338. if pkt == b"":
  339. self.rin.write(b"0000")
  340. else:
  341. self.rin.write(("%04x" % (len(pkt) + 4)).encode("ascii") + pkt)
  342. self.rin.seek(0)
  343. def update_refs(refs):
  344. return {b"refs/heads/master": b"0" * 40}
  345. def generate_pack_data(have, want, ofs_delta=False, progress=None):
  346. return 0, []
  347. result = self.client.send_pack(b"/", update_refs, generate_pack_data)
  348. self.assertEqual(
  349. result.ref_status,
  350. {b"refs/heads/master": "remote does not support deleting refs"},
  351. )
  352. self.assertEqual(
  353. result.refs,
  354. {b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c"},
  355. )
  356. self.assertEqual(self.rout.getvalue(), b"0000")
  357. class TestGetTransportAndPath(TestCase):
  358. def test_tcp(self) -> None:
  359. c, path = get_transport_and_path("git://foo.com/bar/baz")
  360. self.assertIsInstance(c, TCPGitClient)
  361. self.assertEqual("foo.com", c._host)
  362. self.assertEqual(TCP_GIT_PORT, c._port)
  363. self.assertEqual("/bar/baz", path)
  364. def test_tcp_port(self) -> None:
  365. c, path = get_transport_and_path("git://foo.com:1234/bar/baz")
  366. self.assertIsInstance(c, TCPGitClient)
  367. self.assertEqual("foo.com", c._host)
  368. self.assertEqual(1234, c._port)
  369. self.assertEqual("/bar/baz", path)
  370. def test_git_ssh_explicit(self) -> None:
  371. c, path = get_transport_and_path("git+ssh://foo.com/bar/baz")
  372. self.assertIsInstance(c, SSHGitClient)
  373. self.assertEqual("foo.com", c.host)
  374. self.assertEqual(None, c.port)
  375. self.assertEqual(None, c.username)
  376. self.assertEqual("/bar/baz", path)
  377. def test_ssh_explicit(self) -> None:
  378. c, path = get_transport_and_path("ssh://foo.com/bar/baz")
  379. self.assertIsInstance(c, SSHGitClient)
  380. self.assertEqual("foo.com", c.host)
  381. self.assertEqual(None, c.port)
  382. self.assertEqual(None, c.username)
  383. self.assertEqual("/bar/baz", path)
  384. def test_ssh_port_explicit(self) -> None:
  385. c, path = get_transport_and_path("git+ssh://foo.com:1234/bar/baz")
  386. self.assertIsInstance(c, SSHGitClient)
  387. self.assertEqual("foo.com", c.host)
  388. self.assertEqual(1234, c.port)
  389. self.assertEqual("/bar/baz", path)
  390. def test_username_and_port_explicit_unknown_scheme(self) -> None:
  391. c, path = get_transport_and_path("unknown://git@server:7999/dply/stuff.git")
  392. self.assertIsInstance(c, SSHGitClient)
  393. self.assertEqual("unknown", c.host)
  394. self.assertEqual("//git@server:7999/dply/stuff.git", path)
  395. def test_username_and_port_explicit(self) -> None:
  396. c, path = get_transport_and_path("ssh://git@server:7999/dply/stuff.git")
  397. self.assertIsInstance(c, SSHGitClient)
  398. self.assertEqual("git", c.username)
  399. self.assertEqual("server", c.host)
  400. self.assertEqual(7999, c.port)
  401. self.assertEqual("/dply/stuff.git", path)
  402. def test_ssh_abspath_doubleslash(self) -> None:
  403. c, path = get_transport_and_path("git+ssh://foo.com//bar/baz")
  404. self.assertIsInstance(c, SSHGitClient)
  405. self.assertEqual("foo.com", c.host)
  406. self.assertEqual(None, c.port)
  407. self.assertEqual(None, c.username)
  408. self.assertEqual("//bar/baz", path)
  409. def test_ssh_port(self) -> None:
  410. c, path = get_transport_and_path("git+ssh://foo.com:1234/bar/baz")
  411. self.assertIsInstance(c, SSHGitClient)
  412. self.assertEqual("foo.com", c.host)
  413. self.assertEqual(1234, c.port)
  414. self.assertEqual("/bar/baz", path)
  415. def test_ssh_implicit(self) -> None:
  416. c, path = get_transport_and_path("foo:/bar/baz")
  417. self.assertIsInstance(c, SSHGitClient)
  418. self.assertEqual("foo", c.host)
  419. self.assertEqual(None, c.port)
  420. self.assertEqual(None, c.username)
  421. self.assertEqual("/bar/baz", path)
  422. def test_ssh_host(self) -> None:
  423. c, path = get_transport_and_path("foo.com:/bar/baz")
  424. self.assertIsInstance(c, SSHGitClient)
  425. self.assertEqual("foo.com", c.host)
  426. self.assertEqual(None, c.port)
  427. self.assertEqual(None, c.username)
  428. self.assertEqual("/bar/baz", path)
  429. def test_ssh_user_host(self) -> None:
  430. c, path = get_transport_and_path("user@foo.com:/bar/baz")
  431. self.assertIsInstance(c, SSHGitClient)
  432. self.assertEqual("foo.com", c.host)
  433. self.assertEqual(None, c.port)
  434. self.assertEqual("user", c.username)
  435. self.assertEqual("/bar/baz", path)
  436. def test_ssh_relpath(self) -> None:
  437. c, path = get_transport_and_path("foo:bar/baz")
  438. self.assertIsInstance(c, SSHGitClient)
  439. self.assertEqual("foo", c.host)
  440. self.assertEqual(None, c.port)
  441. self.assertEqual(None, c.username)
  442. self.assertEqual("bar/baz", path)
  443. def test_ssh_host_relpath(self) -> None:
  444. c, path = get_transport_and_path("foo.com:bar/baz")
  445. self.assertIsInstance(c, SSHGitClient)
  446. self.assertEqual("foo.com", c.host)
  447. self.assertEqual(None, c.port)
  448. self.assertEqual(None, c.username)
  449. self.assertEqual("bar/baz", path)
  450. def test_ssh_user_host_relpath(self) -> None:
  451. c, path = get_transport_and_path("user@foo.com:bar/baz")
  452. self.assertIsInstance(c, SSHGitClient)
  453. self.assertEqual("foo.com", c.host)
  454. self.assertEqual(None, c.port)
  455. self.assertEqual("user", c.username)
  456. self.assertEqual("bar/baz", path)
  457. def test_local(self) -> None:
  458. c, path = get_transport_and_path("foo.bar/baz")
  459. self.assertIsInstance(c, LocalGitClient)
  460. self.assertEqual("foo.bar/baz", path)
  461. def test_ssh_with_config(self) -> None:
  462. # Test that core.sshCommand from config is passed to SSHGitClient
  463. from dulwich.config import ConfigDict
  464. config = ConfigDict()
  465. c, path = get_transport_and_path(
  466. "ssh://git@github.com/user/repo.git", config=config
  467. )
  468. self.assertIsInstance(c, SSHGitClient)
  469. self.assertIsNone(c.ssh_command)
  470. config.set((b"core",), b"sshCommand", b"custom-ssh -o CustomOption=yes")
  471. c, path = get_transport_and_path(
  472. "ssh://git@github.com/user/repo.git", config=config
  473. )
  474. self.assertIsInstance(c, SSHGitClient)
  475. self.assertEqual("custom-ssh -o CustomOption=yes", c.ssh_command)
  476. # Test rsync-style URL also gets the config
  477. c, path = get_transport_and_path("git@github.com:user/repo.git", config=config)
  478. self.assertIsInstance(c, SSHGitClient)
  479. self.assertEqual("custom-ssh -o CustomOption=yes", c.ssh_command)
  480. @skipIf(sys.platform != "win32", "Behaviour only happens on windows.")
  481. def test_local_abs_windows_path(self) -> None:
  482. c, path = get_transport_and_path("C:\\foo.bar\\baz")
  483. self.assertIsInstance(c, LocalGitClient)
  484. self.assertEqual("C:\\foo.bar\\baz", path)
  485. def test_error(self) -> None:
  486. # Need to use a known urlparse.uses_netloc URL scheme to get the
  487. # expected parsing of the URL on Python versions less than 2.6.5
  488. c, path = get_transport_and_path("prospero://bar/baz")
  489. self.assertIsInstance(c, SSHGitClient)
  490. def test_http(self) -> None:
  491. url = "https://github.com/jelmer/dulwich"
  492. c, path = get_transport_and_path(url)
  493. self.assertIsInstance(c, HttpGitClient)
  494. self.assertEqual("/jelmer/dulwich", path)
  495. def test_http_auth(self) -> None:
  496. url = "https://user:passwd@github.com/jelmer/dulwich"
  497. c, path = get_transport_and_path(url)
  498. self.assertIsInstance(c, HttpGitClient)
  499. self.assertEqual("/jelmer/dulwich", path)
  500. self.assertEqual("user", c._username)
  501. self.assertEqual("passwd", c._password)
  502. def test_http_auth_with_username(self) -> None:
  503. url = "https://github.com/jelmer/dulwich"
  504. c, path = get_transport_and_path(url, username="user2", password="blah")
  505. self.assertIsInstance(c, HttpGitClient)
  506. self.assertEqual("/jelmer/dulwich", path)
  507. self.assertEqual("user2", c._username)
  508. self.assertEqual("blah", c._password)
  509. def test_http_auth_with_username_and_in_url(self) -> None:
  510. url = "https://user:passwd@github.com/jelmer/dulwich"
  511. c, path = get_transport_and_path(url, username="user2", password="blah")
  512. self.assertIsInstance(c, HttpGitClient)
  513. self.assertEqual("/jelmer/dulwich", path)
  514. self.assertEqual("user", c._username)
  515. self.assertEqual("passwd", c._password)
  516. def test_http_no_auth(self) -> None:
  517. url = "https://github.com/jelmer/dulwich"
  518. c, path = get_transport_and_path(url)
  519. self.assertIsInstance(c, HttpGitClient)
  520. self.assertEqual("/jelmer/dulwich", path)
  521. self.assertIs(None, c._username)
  522. self.assertIs(None, c._password)
  523. class TestGetTransportAndPathFromUrl(TestCase):
  524. def test_tcp(self) -> None:
  525. c, path = get_transport_and_path_from_url("git://foo.com/bar/baz")
  526. self.assertIsInstance(c, TCPGitClient)
  527. self.assertEqual("foo.com", c._host)
  528. self.assertEqual(TCP_GIT_PORT, c._port)
  529. self.assertEqual("/bar/baz", path)
  530. def test_tcp_port(self) -> None:
  531. c, path = get_transport_and_path_from_url("git://foo.com:1234/bar/baz")
  532. self.assertIsInstance(c, TCPGitClient)
  533. self.assertEqual("foo.com", c._host)
  534. self.assertEqual(1234, c._port)
  535. self.assertEqual("/bar/baz", path)
  536. def test_ssh_explicit(self) -> None:
  537. c, path = get_transport_and_path_from_url("git+ssh://foo.com/bar/baz")
  538. self.assertIsInstance(c, SSHGitClient)
  539. self.assertEqual("foo.com", c.host)
  540. self.assertEqual(None, c.port)
  541. self.assertEqual(None, c.username)
  542. self.assertEqual("/bar/baz", path)
  543. def test_ssh_port_explicit(self) -> None:
  544. c, path = get_transport_and_path_from_url("git+ssh://foo.com:1234/bar/baz")
  545. self.assertIsInstance(c, SSHGitClient)
  546. self.assertEqual("foo.com", c.host)
  547. self.assertEqual(1234, c.port)
  548. self.assertEqual("/bar/baz", path)
  549. def test_ssh_homepath(self) -> None:
  550. c, path = get_transport_and_path_from_url("git+ssh://foo.com/~/bar/baz")
  551. self.assertIsInstance(c, SSHGitClient)
  552. self.assertEqual("foo.com", c.host)
  553. self.assertEqual(None, c.port)
  554. self.assertEqual(None, c.username)
  555. self.assertEqual("/~/bar/baz", path)
  556. def test_ssh_port_homepath(self) -> None:
  557. c, path = get_transport_and_path_from_url("git+ssh://foo.com:1234/~/bar/baz")
  558. self.assertIsInstance(c, SSHGitClient)
  559. self.assertEqual("foo.com", c.host)
  560. self.assertEqual(1234, c.port)
  561. self.assertEqual("/~/bar/baz", path)
  562. def test_ssh_host_relpath(self) -> None:
  563. self.assertRaises(
  564. ValueError, get_transport_and_path_from_url, "foo.com:bar/baz"
  565. )
  566. def test_ssh_user_host_relpath(self) -> None:
  567. self.assertRaises(
  568. ValueError, get_transport_and_path_from_url, "user@foo.com:bar/baz"
  569. )
  570. def test_local_path(self) -> None:
  571. self.assertRaises(ValueError, get_transport_and_path_from_url, "foo.bar/baz")
  572. def test_error(self) -> None:
  573. # Need to use a known urlparse.uses_netloc URL scheme to get the
  574. # expected parsing of the URL on Python versions less than 2.6.5
  575. self.assertRaises(
  576. ValueError, get_transport_and_path_from_url, "prospero://bar/baz"
  577. )
  578. def test_http(self) -> None:
  579. url = "https://github.com/jelmer/dulwich"
  580. c, path = get_transport_and_path_from_url(url)
  581. self.assertIsInstance(c, HttpGitClient)
  582. self.assertEqual("https://github.com", c.get_url(b"/"))
  583. self.assertEqual("/jelmer/dulwich", path)
  584. def test_http_port(self) -> None:
  585. url = "https://github.com:9090/jelmer/dulwich"
  586. c, path = get_transport_and_path_from_url(url)
  587. self.assertEqual("https://github.com:9090", c.get_url(b"/"))
  588. self.assertIsInstance(c, HttpGitClient)
  589. self.assertEqual("/jelmer/dulwich", path)
  590. @patch("os.name", "posix")
  591. @patch("sys.platform", "linux")
  592. def test_file(self) -> None:
  593. c, path = get_transport_and_path_from_url("file:///home/jelmer/foo")
  594. self.assertIsInstance(c, LocalGitClient)
  595. self.assertEqual("/home/jelmer/foo", path)
  596. def test_win32_url_to_path(self):
  597. def check(url, expected):
  598. parsed = urlparse(url)
  599. self.assertEqual(_win32_url_to_path(parsed), expected)
  600. check("file:C:/foo.bar/baz", "C:\\foo.bar\\baz")
  601. check("file:/C:/foo.bar/baz", "C:\\foo.bar\\baz")
  602. check("file://C:/foo.bar/baz", "C:\\foo.bar\\baz")
  603. check("file:///C:/foo.bar/baz", "C:\\foo.bar\\baz")
  604. @patch("os.name", "nt")
  605. @patch("sys.platform", "win32")
  606. def test_file_win(self) -> None:
  607. expected = "C:\\foo.bar\\baz"
  608. for file_url in [
  609. "file:C:/foo.bar/baz",
  610. "file:/C:/foo.bar/baz",
  611. "file://C:/foo.bar/baz",
  612. "file:///C:/foo.bar/baz",
  613. ]:
  614. c, path = get_transport_and_path(file_url)
  615. self.assertIsInstance(c, LocalGitClient)
  616. self.assertEqual(path, expected)
  617. for remote_url in [
  618. "file://host.example.com/C:/foo.bar/baz"
  619. "file://host.example.com/C:/foo.bar/baz"
  620. "file:////host.example/foo.bar/baz",
  621. ]:
  622. with self.assertRaises(NotImplementedError):
  623. c, path = get_transport_and_path(remote_url)
  624. class TestSSHVendor:
  625. def __init__(self) -> None:
  626. self.host = None
  627. self.command = ""
  628. self.username = None
  629. self.port = None
  630. self.password = None
  631. self.key_filename = None
  632. def run_command(
  633. self,
  634. host,
  635. command,
  636. username=None,
  637. port=None,
  638. password=None,
  639. key_filename=None,
  640. ssh_command=None,
  641. protocol_version=None,
  642. ):
  643. self.host = host
  644. self.command = command
  645. self.username = username
  646. self.port = port
  647. self.password = password
  648. self.key_filename = key_filename
  649. self.ssh_command = ssh_command
  650. self.protocol_version = protocol_version
  651. class Subprocess:
  652. pass
  653. Subprocess.read = lambda: None
  654. Subprocess.write = lambda: None
  655. Subprocess.close = lambda: None
  656. Subprocess.can_read = lambda: None
  657. return Subprocess()
  658. class SSHGitClientTests(TestCase):
  659. def setUp(self) -> None:
  660. super().setUp()
  661. self.server = TestSSHVendor()
  662. self.real_vendor = client.get_ssh_vendor
  663. client.get_ssh_vendor = lambda: self.server
  664. self.client = SSHGitClient("git.samba.org")
  665. def tearDown(self) -> None:
  666. super().tearDown()
  667. client.get_ssh_vendor = self.real_vendor
  668. def test_get_url(self) -> None:
  669. path = "/tmp/repo.git"
  670. c = SSHGitClient("git.samba.org")
  671. url = c.get_url(path)
  672. self.assertEqual("ssh://git.samba.org/tmp/repo.git", url)
  673. def test_get_url_with_username_and_port(self) -> None:
  674. path = "/tmp/repo.git"
  675. c = SSHGitClient("git.samba.org", port=2222, username="user")
  676. url = c.get_url(path)
  677. self.assertEqual("ssh://user@git.samba.org:2222/tmp/repo.git", url)
  678. def test_default_command(self) -> None:
  679. self.assertEqual(b"git-upload-pack", self.client._get_cmd_path(b"upload-pack"))
  680. def test_alternative_command_path(self) -> None:
  681. self.client.alternative_paths[b"upload-pack"] = b"/usr/lib/git/git-upload-pack"
  682. self.assertEqual(
  683. b"/usr/lib/git/git-upload-pack",
  684. self.client._get_cmd_path(b"upload-pack"),
  685. )
  686. def test_alternative_command_path_spaces(self) -> None:
  687. self.client.alternative_paths[b"upload-pack"] = (
  688. b"/usr/lib/git/git-upload-pack -ibla"
  689. )
  690. self.assertEqual(
  691. b"/usr/lib/git/git-upload-pack -ibla",
  692. self.client._get_cmd_path(b"upload-pack"),
  693. )
  694. def test_connect(self) -> None:
  695. server = self.server
  696. client = self.client
  697. client.username = b"username"
  698. client.port = 1337
  699. client._connect(b"command", b"/path/to/repo")
  700. self.assertEqual(b"username", server.username)
  701. self.assertEqual(1337, server.port)
  702. self.assertEqual("git-command '/path/to/repo'", server.command)
  703. client._connect(b"relative-command", b"/~/path/to/repo")
  704. self.assertEqual("git-relative-command '~/path/to/repo'", server.command)
  705. def test_ssh_command_precedence(self) -> None:
  706. self.overrideEnv("GIT_SSH", "/path/to/ssh")
  707. test_client = SSHGitClient("git.samba.org")
  708. self.assertEqual(test_client.ssh_command, "/path/to/ssh")
  709. self.overrideEnv("GIT_SSH_COMMAND", "/path/to/ssh -o Option=Value")
  710. test_client = SSHGitClient("git.samba.org")
  711. self.assertEqual(test_client.ssh_command, "/path/to/ssh -o Option=Value")
  712. test_client = SSHGitClient("git.samba.org", ssh_command="ssh -o Option1=Value1")
  713. self.assertEqual(test_client.ssh_command, "ssh -o Option1=Value1")
  714. def test_ssh_command_config(self) -> None:
  715. # Test core.sshCommand config setting
  716. from dulwich.config import ConfigDict
  717. # No config, no environment - should be None
  718. self.overrideEnv("GIT_SSH", None)
  719. self.overrideEnv("GIT_SSH_COMMAND", None)
  720. test_client = SSHGitClient("git.samba.org")
  721. self.assertIsNone(test_client.ssh_command)
  722. # Config with core.sshCommand
  723. config = ConfigDict()
  724. config.set((b"core",), b"sshCommand", b"ssh -o StrictHostKeyChecking=no")
  725. test_client = SSHGitClient("git.samba.org", config=config)
  726. self.assertEqual(test_client.ssh_command, "ssh -o StrictHostKeyChecking=no")
  727. # ssh_command parameter takes precedence over config
  728. test_client = SSHGitClient(
  729. "git.samba.org", config=config, ssh_command="custom-ssh"
  730. )
  731. self.assertEqual(test_client.ssh_command, "custom-ssh")
  732. # Environment variables take precedence over config when no ssh_command parameter
  733. self.overrideEnv("GIT_SSH_COMMAND", "/usr/bin/ssh -v")
  734. test_client = SSHGitClient("git.samba.org", config=config)
  735. self.assertEqual(test_client.ssh_command, "/usr/bin/ssh -v")
  736. class ReportStatusParserTests(TestCase):
  737. def test_invalid_pack(self) -> None:
  738. parser = ReportStatusParser()
  739. parser.handle_packet(b"unpack error - foo bar")
  740. parser.handle_packet(b"ok refs/foo/bar")
  741. parser.handle_packet(None)
  742. self.assertRaises(SendPackError, list, parser.check())
  743. def test_update_refs_error(self) -> None:
  744. parser = ReportStatusParser()
  745. parser.handle_packet(b"unpack ok")
  746. parser.handle_packet(b"ng refs/foo/bar need to pull")
  747. parser.handle_packet(None)
  748. self.assertEqual([(b"refs/foo/bar", "need to pull")], list(parser.check()))
  749. def test_ok(self) -> None:
  750. parser = ReportStatusParser()
  751. parser.handle_packet(b"unpack ok")
  752. parser.handle_packet(b"ok refs/foo/bar")
  753. parser.handle_packet(None)
  754. self.assertEqual([(b"refs/foo/bar", None)], list(parser.check()))
  755. class LocalGitClientTests(TestCase):
  756. def test_get_url(self) -> None:
  757. path = "/tmp/repo.git"
  758. c = LocalGitClient()
  759. url = c.get_url(path)
  760. self.assertEqual("file:///tmp/repo.git", url)
  761. def test_fetch_into_empty(self) -> None:
  762. c = LocalGitClient()
  763. target = tempfile.mkdtemp()
  764. self.addCleanup(shutil.rmtree, target)
  765. t = Repo.init_bare(target)
  766. self.addCleanup(t.close)
  767. s = open_repo("a.git")
  768. self.addCleanup(tear_down_repo, s)
  769. self.assertEqual(s.get_refs(), c.fetch(s.path, t).refs)
  770. def test_clone(self) -> None:
  771. c = LocalGitClient()
  772. s = open_repo("a.git")
  773. self.addCleanup(tear_down_repo, s)
  774. target = tempfile.mkdtemp()
  775. self.addCleanup(shutil.rmtree, target)
  776. result_repo = c.clone(s.path, target, mkdir=False)
  777. self.addCleanup(result_repo.close)
  778. expected = dict(s.get_refs())
  779. expected[b"refs/remotes/origin/HEAD"] = expected[b"HEAD"]
  780. expected[b"refs/remotes/origin/master"] = expected[b"refs/heads/master"]
  781. self.assertEqual(expected, result_repo.get_refs())
  782. def test_fetch_empty(self) -> None:
  783. c = LocalGitClient()
  784. s = open_repo("a.git")
  785. self.addCleanup(tear_down_repo, s)
  786. out = BytesIO()
  787. walker = {}
  788. ret = c.fetch_pack(
  789. s.path, lambda heads, **kwargs: [], graph_walker=walker, pack_data=out.write
  790. )
  791. self.assertEqual(
  792. {
  793. b"HEAD": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
  794. b"refs/heads/master": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
  795. b"refs/tags/mytag": b"28237f4dc30d0d462658d6b937b08a0f0b6ef55a",
  796. b"refs/tags/mytag-packed": b"b0931cadc54336e78a1d980420e3268903b57a50",
  797. },
  798. ret.refs,
  799. )
  800. self.assertEqual({b"HEAD": b"refs/heads/master"}, ret.symrefs)
  801. self.assertEqual(
  802. b"PACK\x00\x00\x00\x02\x00\x00\x00\x00\x02\x9d\x08"
  803. b"\x82;\xd8\xa8\xea\xb5\x10\xadj\xc7\\\x82<\xfd>\xd3\x1e",
  804. out.getvalue(),
  805. )
  806. def test_fetch_pack_none(self) -> None:
  807. c = LocalGitClient()
  808. s = open_repo("a.git")
  809. self.addCleanup(tear_down_repo, s)
  810. out = BytesIO()
  811. walker = MemoryRepo().get_graph_walker()
  812. ret = c.fetch_pack(
  813. s.path,
  814. lambda heads, **kwargs: [b"a90fa2d900a17e99b433217e988c4eb4a2e9a097"],
  815. graph_walker=walker,
  816. pack_data=out.write,
  817. )
  818. self.assertEqual({b"HEAD": b"refs/heads/master"}, ret.symrefs)
  819. self.assertEqual(
  820. {
  821. b"HEAD": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
  822. b"refs/heads/master": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
  823. b"refs/tags/mytag": b"28237f4dc30d0d462658d6b937b08a0f0b6ef55a",
  824. b"refs/tags/mytag-packed": b"b0931cadc54336e78a1d980420e3268903b57a50",
  825. },
  826. ret.refs,
  827. )
  828. # Hardcoding is not ideal, but we'll fix that some other day..
  829. self.assertTrue(
  830. out.getvalue().startswith(b"PACK\x00\x00\x00\x02\x00\x00\x00\x07")
  831. )
  832. def test_send_pack_without_changes(self) -> None:
  833. local = open_repo("a.git")
  834. self.addCleanup(tear_down_repo, local)
  835. target = open_repo("a.git")
  836. self.addCleanup(tear_down_repo, target)
  837. self.send_and_verify(b"master", local, target)
  838. def test_send_pack_with_changes(self) -> None:
  839. local = open_repo("a.git")
  840. self.addCleanup(tear_down_repo, local)
  841. target_path = tempfile.mkdtemp()
  842. self.addCleanup(shutil.rmtree, target_path)
  843. with Repo.init_bare(target_path) as target:
  844. self.send_and_verify(b"master", local, target)
  845. def test_get_refs(self) -> None:
  846. local = open_repo("refs.git")
  847. self.addCleanup(tear_down_repo, local)
  848. client = LocalGitClient()
  849. result = client.get_refs(local.path)
  850. self.assertDictEqual(local.refs.as_dict(), result.refs)
  851. # Check that symrefs are detected correctly
  852. self.assertIn(b"HEAD", result.symrefs)
  853. def send_and_verify(self, branch, local, target) -> None:
  854. """Send branch from local to remote repository and verify it worked."""
  855. client = LocalGitClient()
  856. ref_name = b"refs/heads/" + branch
  857. result = client.send_pack(
  858. target.path,
  859. lambda _: {ref_name: local.refs[ref_name]},
  860. local.generate_pack_data,
  861. )
  862. self.assertEqual(local.refs[ref_name], result.refs[ref_name])
  863. self.assertIs(None, result.agent)
  864. self.assertEqual({}, result.ref_status)
  865. obj_local = local.get_object(result.refs[ref_name])
  866. obj_target = target.get_object(result.refs[ref_name])
  867. self.assertEqual(obj_local, obj_target)
  868. class HttpGitClientTests(TestCase):
  869. def test_get_url(self) -> None:
  870. base_url = "https://github.com/jelmer/dulwich"
  871. path = "/jelmer/dulwich"
  872. c = HttpGitClient(base_url)
  873. url = c.get_url(path)
  874. self.assertEqual("https://github.com/jelmer/dulwich", url)
  875. def test_get_url_bytes_path(self) -> None:
  876. base_url = "https://github.com/jelmer/dulwich"
  877. path_bytes = b"/jelmer/dulwich"
  878. c = HttpGitClient(base_url)
  879. url = c.get_url(path_bytes)
  880. self.assertEqual("https://github.com/jelmer/dulwich", url)
  881. def test_get_url_with_username_and_passwd(self) -> None:
  882. base_url = "https://github.com/jelmer/dulwich"
  883. path = "/jelmer/dulwich"
  884. c = HttpGitClient(base_url, username="USERNAME", password="PASSWD")
  885. url = c.get_url(path)
  886. self.assertEqual("https://github.com/jelmer/dulwich", url)
  887. def test_init_username_passwd_set(self) -> None:
  888. url = "https://github.com/jelmer/dulwich"
  889. c = HttpGitClient(url, config=None, username="user", password="passwd")
  890. self.assertEqual("user", c._username)
  891. self.assertEqual("passwd", c._password)
  892. basic_auth = c.pool_manager.headers["authorization"]
  893. auth_string = "{}:{}".format("user", "passwd")
  894. b64_credentials = base64.b64encode(auth_string.encode("latin1"))
  895. expected_basic_auth = "Basic {}".format(b64_credentials.decode("latin1"))
  896. self.assertEqual(basic_auth, expected_basic_auth)
  897. def test_init_username_set_no_password(self) -> None:
  898. url = "https://github.com/jelmer/dulwich"
  899. c = HttpGitClient(url, config=None, username="user")
  900. self.assertEqual("user", c._username)
  901. self.assertIsNone(c._password)
  902. basic_auth = c.pool_manager.headers["authorization"]
  903. auth_string = b"user:"
  904. b64_credentials = base64.b64encode(auth_string)
  905. expected_basic_auth = f"Basic {b64_credentials.decode('ascii')}"
  906. self.assertEqual(basic_auth, expected_basic_auth)
  907. def test_init_no_username_passwd(self) -> None:
  908. url = "https://github.com/jelmer/dulwich"
  909. c = HttpGitClient(url, config=None)
  910. self.assertIs(None, c._username)
  911. self.assertIs(None, c._password)
  912. self.assertNotIn("authorization", c.pool_manager.headers)
  913. def test_from_parsedurl_username_only(self) -> None:
  914. username = "user"
  915. url = f"https://{username}@github.com/jelmer/dulwich"
  916. c = HttpGitClient.from_parsedurl(urlparse(url))
  917. self.assertEqual(c._username, username)
  918. self.assertEqual(c._password, None)
  919. basic_auth = c.pool_manager.headers["authorization"]
  920. auth_string = username.encode("ascii") + b":"
  921. b64_credentials = base64.b64encode(auth_string)
  922. expected_basic_auth = f"Basic {b64_credentials.decode('ascii')}"
  923. self.assertEqual(basic_auth, expected_basic_auth)
  924. def test_from_parsedurl_on_url_with_quoted_credentials(self) -> None:
  925. original_username = "john|the|first"
  926. quoted_username = urlquote(original_username)
  927. original_password = "Ya#1$2%3"
  928. quoted_password = urlquote(original_password)
  929. url = f"https://{quoted_username}:{quoted_password}@github.com/jelmer/dulwich"
  930. c = HttpGitClient.from_parsedurl(urlparse(url))
  931. self.assertEqual(original_username, c._username)
  932. self.assertEqual(original_password, c._password)
  933. basic_auth = c.pool_manager.headers["authorization"]
  934. auth_string = f"{original_username}:{original_password}"
  935. b64_credentials = base64.b64encode(auth_string.encode("latin1"))
  936. expected_basic_auth = "Basic {}".format(b64_credentials.decode("latin1"))
  937. self.assertEqual(basic_auth, expected_basic_auth)
  938. def test_url_redirect_location(self) -> None:
  939. from urllib3.response import HTTPResponse
  940. test_data = {
  941. "https://gitlab.com/inkscape/inkscape/": {
  942. "location": "https://gitlab.com/inkscape/inkscape.git/",
  943. "redirect_url": "https://gitlab.com/inkscape/inkscape.git/",
  944. "refs_data": (
  945. b"001e# service=git-upload-pack\n00000032"
  946. b"fb2bebf4919a011f0fd7cec085443d0031228e76 "
  947. b"HEAD\n0000"
  948. ),
  949. },
  950. "https://github.com/jelmer/dulwich/": {
  951. "location": "https://github.com/jelmer/dulwich/",
  952. "redirect_url": "https://github.com/jelmer/dulwich/",
  953. "refs_data": (
  954. b"001e# service=git-upload-pack\n00000032"
  955. b"3ff25e09724aa4d86ea5bca7d5dd0399a3c8bfcf "
  956. b"HEAD\n0000"
  957. ),
  958. },
  959. # check for absolute-path URI reference as location
  960. "https://codeberg.org/ashwinvis/radicale-sh.git/": {
  961. "location": "/ashwinvis/radicale-auth-sh/",
  962. "redirect_url": "https://codeberg.org/ashwinvis/radicale-auth-sh/",
  963. "refs_data": (
  964. b"001e# service=git-upload-pack\n00000032"
  965. b"470f8603768b608fc988675de2fae8f963c21158 "
  966. b"HEAD\n0000"
  967. ),
  968. },
  969. }
  970. tail = "info/refs?service=git-upload-pack"
  971. # we need to mock urllib3.PoolManager as this test will fail
  972. # otherwise without an active internet connection
  973. class PoolManagerMock:
  974. def __init__(self) -> None:
  975. self.headers: dict[str, str] = {}
  976. def request(
  977. self,
  978. method,
  979. url,
  980. fields=None,
  981. headers=None,
  982. redirect=True,
  983. preload_content=True,
  984. ):
  985. base_url = url[: -len(tail)]
  986. redirect_base_url = test_data[base_url]["location"]
  987. redirect_url = redirect_base_url + tail
  988. headers = {
  989. "Content-Type": "application/x-git-upload-pack-advertisement"
  990. }
  991. body = test_data[base_url]["refs_data"]
  992. # urllib3 handles automatic redirection by default
  993. status = 200
  994. request_url = redirect_url
  995. # simulate urllib3 behavior when redirect parameter is False
  996. if redirect is False:
  997. request_url = url
  998. if redirect_base_url != base_url:
  999. body = b""
  1000. headers["location"] = test_data[base_url]["location"]
  1001. status = 301
  1002. return HTTPResponse(
  1003. body=BytesIO(body),
  1004. headers=headers,
  1005. request_method=method,
  1006. request_url=request_url,
  1007. preload_content=preload_content,
  1008. status=status,
  1009. )
  1010. pool_manager = PoolManagerMock()
  1011. for base_url in test_data.keys():
  1012. # instantiate HttpGitClient with mocked pool manager
  1013. c = HttpGitClient(base_url, pool_manager=pool_manager, config=None)
  1014. # call method that detects url redirection
  1015. _, _, processed_url, _, _ = c._discover_references(
  1016. b"git-upload-pack", base_url
  1017. )
  1018. # send the same request as the method above without redirection
  1019. resp = c.pool_manager.request("GET", base_url + tail, redirect=False)
  1020. # check expected behavior of urllib3
  1021. redirect_location = resp.get_redirect_location()
  1022. if resp.status == 200:
  1023. self.assertFalse(redirect_location)
  1024. if redirect_location:
  1025. # check that url redirection has been correctly detected
  1026. self.assertEqual(processed_url, test_data[base_url]["redirect_url"])
  1027. else:
  1028. # check also the no redirection case
  1029. self.assertEqual(processed_url, base_url)
  1030. def test_smart_request_content_type_with_directive_check(self) -> None:
  1031. from urllib3.response import HTTPResponse
  1032. # we need to mock urllib3.PoolManager as this test will fail
  1033. # otherwise without an active internet connection
  1034. class PoolManagerMock:
  1035. def __init__(self) -> None:
  1036. self.headers: dict[str, str] = {}
  1037. def request(
  1038. self,
  1039. method,
  1040. url,
  1041. fields=None,
  1042. headers=None,
  1043. redirect=True,
  1044. preload_content=True,
  1045. ):
  1046. return HTTPResponse(
  1047. headers={
  1048. "Content-Type": "application/x-git-upload-pack-result; charset=utf-8"
  1049. },
  1050. request_method=method,
  1051. request_url=url,
  1052. preload_content=preload_content,
  1053. status=200,
  1054. )
  1055. clone_url = "https://hacktivis.me/git/blog.git/"
  1056. client = HttpGitClient(clone_url, pool_manager=PoolManagerMock(), config=None)
  1057. self.assertTrue(client._smart_request("git-upload-pack", clone_url, data=None))
  1058. def test_urllib3_protocol_error(self) -> None:
  1059. from urllib3.exceptions import ProtocolError
  1060. from urllib3.response import HTTPResponse
  1061. error_msg = "protocol error"
  1062. # we need to mock urllib3.PoolManager as this test will fail
  1063. # otherwise without an active internet connection
  1064. class PoolManagerMock:
  1065. def __init__(self) -> None:
  1066. self.headers: dict[str, str] = {}
  1067. def request(
  1068. self,
  1069. method,
  1070. url,
  1071. fields=None,
  1072. headers=None,
  1073. redirect=True,
  1074. preload_content=True,
  1075. ):
  1076. response = HTTPResponse(
  1077. headers={"Content-Type": "application/x-git-upload-pack-result"},
  1078. request_method=method,
  1079. request_url=url,
  1080. preload_content=preload_content,
  1081. status=200,
  1082. )
  1083. def read(self) -> NoReturn:
  1084. raise ProtocolError(error_msg)
  1085. # override HTTPResponse.read to throw urllib3.exceptions.ProtocolError
  1086. response.read = read
  1087. return response
  1088. def check_heads(heads, **kwargs):
  1089. self.assertEqual(heads, {})
  1090. return []
  1091. clone_url = "https://git.example.org/user/project.git/"
  1092. client = HttpGitClient(clone_url, pool_manager=PoolManagerMock(), config=None)
  1093. with self.assertRaises(GitProtocolError, msg=error_msg):
  1094. client.fetch_pack(b"/", check_heads, None, None)
  1095. def test_fetch_pack_dumb_http(self) -> None:
  1096. import zlib
  1097. from urllib3.response import HTTPResponse
  1098. # Mock responses for dumb HTTP
  1099. info_refs_content = (
  1100. b"0123456789abcdef0123456789abcdef01234567\trefs/heads/master\n"
  1101. )
  1102. head_content = b"ref: refs/heads/master"
  1103. # Create a blob object for testing
  1104. blob_content = b"Hello, dumb HTTP!"
  1105. blob_sha = b"0123456789abcdef0123456789abcdef01234567"
  1106. blob_hex = blob_sha.decode("ascii")
  1107. blob_obj_data = (
  1108. b"blob " + str(len(blob_content)).encode() + b"\x00" + blob_content
  1109. )
  1110. blob_compressed = zlib.compress(blob_obj_data)
  1111. responses = {
  1112. "/HEAD": {
  1113. "status": 200,
  1114. "content": head_content,
  1115. "content_type": "text/plain",
  1116. },
  1117. "/git-upload-pack": {
  1118. "status": 404,
  1119. "content": b"Not Found",
  1120. "content_type": "text/plain",
  1121. },
  1122. "/info/refs": {
  1123. "status": 200,
  1124. "content": info_refs_content,
  1125. "content_type": "text/plain",
  1126. },
  1127. f"/objects/{blob_hex[:2]}/{blob_hex[2:]}": {
  1128. "status": 200,
  1129. "content": blob_compressed,
  1130. "content_type": "application/octet-stream",
  1131. },
  1132. }
  1133. class PoolManagerMock:
  1134. def __init__(self) -> None:
  1135. self.headers: dict[str, str] = {}
  1136. def request(
  1137. self,
  1138. method,
  1139. url,
  1140. fields=None,
  1141. headers=None,
  1142. redirect=True,
  1143. preload_content=True,
  1144. ):
  1145. # Extract path from URL
  1146. from urllib.parse import urlparse
  1147. parsed = urlparse(url)
  1148. path = parsed.path.rstrip("/")
  1149. # Find matching response
  1150. for pattern, resp_data in responses.items():
  1151. if path.endswith(pattern):
  1152. return HTTPResponse(
  1153. body=BytesIO(resp_data["content"]),
  1154. headers={
  1155. "Content-Type": resp_data.get(
  1156. "content_type", "text/plain"
  1157. )
  1158. },
  1159. request_method=method,
  1160. request_url=url,
  1161. preload_content=preload_content,
  1162. status=resp_data["status"],
  1163. )
  1164. # Default 404
  1165. return HTTPResponse(
  1166. body=BytesIO(b"Not Found"),
  1167. headers={"Content-Type": "text/plain"},
  1168. request_method=method,
  1169. request_url=url,
  1170. preload_content=preload_content,
  1171. status=404,
  1172. )
  1173. def determine_wants(heads, **kwargs):
  1174. # heads contains the refs with SHA values, just return the SHA we want
  1175. return [heads[b"refs/heads/master"]]
  1176. received_data = []
  1177. def pack_data_handler(data):
  1178. # Collect pack data
  1179. received_data.append(data)
  1180. clone_url = "https://git.example.org/repo.git/"
  1181. client = HttpGitClient(clone_url, pool_manager=PoolManagerMock(), config=None)
  1182. # Mock graph walker that says we don't have anything
  1183. class MockGraphWalker:
  1184. def ack(self, sha):
  1185. return []
  1186. graph_walker = MockGraphWalker()
  1187. result = client.fetch_pack(
  1188. b"/", determine_wants, graph_walker, pack_data_handler
  1189. )
  1190. # Verify we got the refs
  1191. expected_sha = blob_hex.encode("ascii")
  1192. self.assertEqual({b"refs/heads/master": expected_sha}, result.refs)
  1193. # Verify we received pack data
  1194. self.assertTrue(len(received_data) > 0)
  1195. pack_data = b"".join(received_data)
  1196. self.assertTrue(len(pack_data) > 0)
  1197. # The pack should be valid pack format
  1198. self.assertTrue(pack_data.startswith(b"PACK"))
  1199. # Pack header: PACK + version (4 bytes) + num objects (4 bytes)
  1200. self.assertEqual(pack_data[4:8], b"\x00\x00\x00\x02") # version 2
  1201. self.assertEqual(pack_data[8:12], b"\x00\x00\x00\x01") # 1 object
  1202. def test_timeout_configuration(self) -> None:
  1203. """Test that timeout parameter is properly configured."""
  1204. url = "https://github.com/jelmer/dulwich"
  1205. timeout = 30
  1206. c = HttpGitClient(url, timeout=timeout)
  1207. self.assertEqual(c._timeout, timeout)
  1208. def test_timeout_from_config(self) -> None:
  1209. """Test that timeout can be configured via git config."""
  1210. from dulwich.config import ConfigDict
  1211. url = "https://github.com/jelmer/dulwich"
  1212. config = ConfigDict()
  1213. config.set((b"http",), b"timeout", b"25")
  1214. c = HttpGitClient(url, config=config)
  1215. # The timeout should be set on the pool manager
  1216. # Since we can't easily access the timeout from the pool manager,
  1217. # we just verify the client was created successfully
  1218. self.assertIsNotNone(c.pool_manager)
  1219. def test_timeout_parameter_precedence(self) -> None:
  1220. """Test that explicit timeout parameter takes precedence over config."""
  1221. from dulwich.config import ConfigDict
  1222. url = "https://github.com/jelmer/dulwich"
  1223. config = ConfigDict()
  1224. config.set((b"http",), b"timeout", b"25")
  1225. c = HttpGitClient(url, config=config, timeout=15)
  1226. self.assertEqual(c._timeout, 15)
  1227. class TCPGitClientTests(TestCase):
  1228. def test_get_url(self) -> None:
  1229. host = "github.com"
  1230. path = "/jelmer/dulwich"
  1231. c = TCPGitClient(host)
  1232. url = c.get_url(path)
  1233. self.assertEqual("git://github.com/jelmer/dulwich", url)
  1234. def test_get_url_with_port(self) -> None:
  1235. host = "github.com"
  1236. path = "/jelmer/dulwich"
  1237. port = 9090
  1238. c = TCPGitClient(host, port=port)
  1239. url = c.get_url(path)
  1240. self.assertEqual("git://github.com:9090/jelmer/dulwich", url)
  1241. class DefaultUrllib3ManagerTest(TestCase):
  1242. def test_no_config(self) -> None:
  1243. manager = default_urllib3_manager(config=None)
  1244. self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_REQUIRED")
  1245. def test_config_no_proxy(self) -> None:
  1246. import urllib3
  1247. manager = default_urllib3_manager(config=ConfigDict())
  1248. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1249. self.assertIsInstance(manager, urllib3.PoolManager)
  1250. def test_config_no_proxy_custom_cls(self) -> None:
  1251. import urllib3
  1252. class CustomPoolManager(urllib3.PoolManager):
  1253. pass
  1254. manager = default_urllib3_manager(
  1255. config=ConfigDict(), pool_manager_cls=CustomPoolManager
  1256. )
  1257. self.assertIsInstance(manager, CustomPoolManager)
  1258. def test_config_ssl(self) -> None:
  1259. config = ConfigDict()
  1260. config.set(b"http", b"sslVerify", b"true")
  1261. manager = default_urllib3_manager(config=config)
  1262. self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_REQUIRED")
  1263. def test_config_no_ssl(self) -> None:
  1264. config = ConfigDict()
  1265. config.set(b"http", b"sslVerify", b"false")
  1266. manager = default_urllib3_manager(config=config)
  1267. self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_NONE")
  1268. def test_config_proxy(self) -> None:
  1269. import urllib3
  1270. config = ConfigDict()
  1271. config.set(b"http", b"proxy", b"http://localhost:3128/")
  1272. manager = default_urllib3_manager(config=config)
  1273. self.assertIsInstance(manager, urllib3.ProxyManager)
  1274. self.assertTrue(hasattr(manager, "proxy"))
  1275. self.assertEqual(manager.proxy.scheme, "http")
  1276. self.assertEqual(manager.proxy.host, "localhost")
  1277. self.assertEqual(manager.proxy.port, 3128)
  1278. def test_environment_proxy(self) -> None:
  1279. import urllib3
  1280. config = ConfigDict()
  1281. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1282. manager = default_urllib3_manager(config=config)
  1283. self.assertIsInstance(manager, urllib3.ProxyManager)
  1284. self.assertTrue(hasattr(manager, "proxy"))
  1285. self.assertEqual(manager.proxy.scheme, "http")
  1286. self.assertEqual(manager.proxy.host, "myproxy")
  1287. self.assertEqual(manager.proxy.port, 8080)
  1288. def test_environment_empty_proxy(self) -> None:
  1289. import urllib3
  1290. config = ConfigDict()
  1291. self.overrideEnv("http_proxy", "")
  1292. manager = default_urllib3_manager(config=config)
  1293. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1294. self.assertIsInstance(manager, urllib3.PoolManager)
  1295. def test_environment_no_proxy_1(self) -> None:
  1296. import urllib3
  1297. config = ConfigDict()
  1298. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1299. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh")
  1300. base_url = "http://xyz.abc.def.gh:8080/path/port"
  1301. manager = default_urllib3_manager(config=config, base_url=base_url)
  1302. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1303. self.assertIsInstance(manager, urllib3.PoolManager)
  1304. def test_environment_no_proxy_2(self) -> None:
  1305. import urllib3
  1306. config = ConfigDict()
  1307. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1308. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1309. base_url = "http://ample.com/path/port"
  1310. manager = default_urllib3_manager(config=config, base_url=base_url)
  1311. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1312. self.assertIsInstance(manager, urllib3.PoolManager)
  1313. def test_environment_no_proxy_3(self) -> None:
  1314. import urllib3
  1315. config = ConfigDict()
  1316. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1317. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1318. base_url = "http://ample.com:80/path/port"
  1319. manager = default_urllib3_manager(config=config, base_url=base_url)
  1320. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1321. self.assertIsInstance(manager, urllib3.PoolManager)
  1322. def test_environment_no_proxy_4(self) -> None:
  1323. import urllib3
  1324. config = ConfigDict()
  1325. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1326. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1327. base_url = "http://www.ample.com/path/port"
  1328. manager = default_urllib3_manager(config=config, base_url=base_url)
  1329. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1330. self.assertIsInstance(manager, urllib3.PoolManager)
  1331. def test_environment_no_proxy_5(self) -> None:
  1332. import urllib3
  1333. config = ConfigDict()
  1334. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1335. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1336. base_url = "http://www.example.com/path/port"
  1337. manager = default_urllib3_manager(config=config, base_url=base_url)
  1338. self.assertIsInstance(manager, urllib3.ProxyManager)
  1339. self.assertTrue(hasattr(manager, "proxy"))
  1340. self.assertEqual(manager.proxy.scheme, "http")
  1341. self.assertEqual(manager.proxy.host, "myproxy")
  1342. self.assertEqual(manager.proxy.port, 8080)
  1343. def test_environment_no_proxy_6(self) -> None:
  1344. import urllib3
  1345. config = ConfigDict()
  1346. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1347. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1348. base_url = "http://ample.com.org/path/port"
  1349. manager = default_urllib3_manager(config=config, base_url=base_url)
  1350. self.assertIsInstance(manager, urllib3.ProxyManager)
  1351. self.assertTrue(hasattr(manager, "proxy"))
  1352. self.assertEqual(manager.proxy.scheme, "http")
  1353. self.assertEqual(manager.proxy.host, "myproxy")
  1354. self.assertEqual(manager.proxy.port, 8080)
  1355. def test_environment_no_proxy_ipv4_address_1(self) -> None:
  1356. import urllib3
  1357. config = ConfigDict()
  1358. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1359. self.overrideEnv("no_proxy", "xyz,abc.def.gh,192.168.0.10,ample.com")
  1360. base_url = "http://192.168.0.10/path/port"
  1361. manager = default_urllib3_manager(config=config, base_url=base_url)
  1362. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1363. self.assertIsInstance(manager, urllib3.PoolManager)
  1364. def test_environment_no_proxy_ipv4_address_2(self) -> None:
  1365. import urllib3
  1366. config = ConfigDict()
  1367. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1368. self.overrideEnv("no_proxy", "xyz,abc.def.gh,192.168.0.10,ample.com")
  1369. base_url = "http://192.168.0.10:8888/path/port"
  1370. manager = default_urllib3_manager(config=config, base_url=base_url)
  1371. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1372. self.assertIsInstance(manager, urllib3.PoolManager)
  1373. def test_environment_no_proxy_ipv4_address_3(self) -> None:
  1374. import urllib3
  1375. config = ConfigDict()
  1376. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1377. self.overrideEnv(
  1378. "no_proxy", "xyz,abc.def.gh,ff80:1::/64,192.168.0.0/24,ample.com"
  1379. )
  1380. base_url = "http://192.168.0.10/path/port"
  1381. manager = default_urllib3_manager(config=config, base_url=base_url)
  1382. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1383. self.assertIsInstance(manager, urllib3.PoolManager)
  1384. def test_environment_no_proxy_ipv6_address_1(self) -> None:
  1385. import urllib3
  1386. config = ConfigDict()
  1387. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1388. self.overrideEnv("no_proxy", "xyz,abc.def.gh,ff80:1::affe,ample.com")
  1389. base_url = "http://[ff80:1::affe]/path/port"
  1390. manager = default_urllib3_manager(config=config, base_url=base_url)
  1391. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1392. self.assertIsInstance(manager, urllib3.PoolManager)
  1393. def test_environment_no_proxy_ipv6_address_2(self) -> None:
  1394. import urllib3
  1395. config = ConfigDict()
  1396. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1397. self.overrideEnv("no_proxy", "xyz,abc.def.gh,ff80:1::affe,ample.com")
  1398. base_url = "http://[ff80:1::affe]:1234/path/port"
  1399. manager = default_urllib3_manager(config=config, base_url=base_url)
  1400. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1401. self.assertIsInstance(manager, urllib3.PoolManager)
  1402. def test_environment_no_proxy_ipv6_address_3(self) -> None:
  1403. import urllib3
  1404. config = ConfigDict()
  1405. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1406. self.overrideEnv(
  1407. "no_proxy", "xyz,abc.def.gh,192.168.0.0/24,ff80:1::/64,ample.com"
  1408. )
  1409. base_url = "http://[ff80:1::affe]/path/port"
  1410. manager = default_urllib3_manager(config=config, base_url=base_url)
  1411. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1412. self.assertIsInstance(manager, urllib3.PoolManager)
  1413. def test_config_proxy_custom_cls(self) -> None:
  1414. import urllib3
  1415. class CustomProxyManager(urllib3.ProxyManager):
  1416. pass
  1417. config = ConfigDict()
  1418. config.set(b"http", b"proxy", b"http://localhost:3128/")
  1419. manager = default_urllib3_manager(
  1420. config=config, proxy_manager_cls=CustomProxyManager
  1421. )
  1422. self.assertIsInstance(manager, CustomProxyManager)
  1423. def test_config_proxy_creds(self) -> None:
  1424. import urllib3
  1425. config = ConfigDict()
  1426. config.set(b"http", b"proxy", b"http://jelmer:example@localhost:3128/")
  1427. manager = default_urllib3_manager(config=config)
  1428. assert isinstance(manager, urllib3.ProxyManager)
  1429. self.assertEqual(
  1430. manager.proxy_headers, {"proxy-authorization": "Basic amVsbWVyOmV4YW1wbGU="}
  1431. )
  1432. def test_config_no_verify_ssl(self) -> None:
  1433. manager = default_urllib3_manager(config=None, cert_reqs="CERT_NONE")
  1434. self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_NONE")
  1435. def test_timeout_parameter(self) -> None:
  1436. """Test that timeout parameter is passed to urllib3 manager."""
  1437. timeout = 30
  1438. manager = default_urllib3_manager(config=None, timeout=timeout)
  1439. self.assertEqual(manager.connection_pool_kw["timeout"], timeout)
  1440. def test_timeout_from_config(self) -> None:
  1441. """Test that timeout can be configured via git config."""
  1442. from dulwich.config import ConfigDict
  1443. config = ConfigDict()
  1444. config.set((b"http",), b"timeout", b"25")
  1445. manager = default_urllib3_manager(config=config)
  1446. self.assertEqual(manager.connection_pool_kw["timeout"], 25)
  1447. def test_timeout_parameter_precedence(self) -> None:
  1448. """Test that explicit timeout parameter takes precedence over config."""
  1449. from dulwich.config import ConfigDict
  1450. config = ConfigDict()
  1451. config.set((b"http",), b"timeout", b"25")
  1452. manager = default_urllib3_manager(config=config, timeout=15)
  1453. self.assertEqual(manager.connection_pool_kw["timeout"], 15)
  1454. class SubprocessSSHVendorTests(TestCase):
  1455. def setUp(self) -> None:
  1456. # Monkey Patch client subprocess popen
  1457. self._orig_popen = dulwich.client.subprocess.Popen
  1458. dulwich.client.subprocess.Popen = DummyPopen
  1459. def tearDown(self) -> None:
  1460. dulwich.client.subprocess.Popen = self._orig_popen
  1461. def test_run_command_dashes(self) -> None:
  1462. vendor = SubprocessSSHVendor()
  1463. self.assertRaises(
  1464. StrangeHostname,
  1465. vendor.run_command,
  1466. "--weird-host",
  1467. "git-clone-url",
  1468. )
  1469. def test_run_command_password(self) -> None:
  1470. vendor = SubprocessSSHVendor()
  1471. self.assertRaises(
  1472. NotImplementedError,
  1473. vendor.run_command,
  1474. "host",
  1475. "git-clone-url",
  1476. password="12345",
  1477. )
  1478. def test_run_command_password_and_privkey(self) -> None:
  1479. vendor = SubprocessSSHVendor()
  1480. self.assertRaises(
  1481. NotImplementedError,
  1482. vendor.run_command,
  1483. "host",
  1484. "git-clone-url",
  1485. password="12345",
  1486. key_filename="/tmp/id_rsa",
  1487. )
  1488. def test_run_command_with_port_username_and_privkey(self) -> None:
  1489. expected = [
  1490. "ssh",
  1491. "-x",
  1492. "-p",
  1493. "2200",
  1494. "-i",
  1495. "/tmp/id_rsa",
  1496. ]
  1497. if DEFAULT_GIT_PROTOCOL_VERSION_FETCH:
  1498. expected += [
  1499. "-o",
  1500. f"SetEnv GIT_PROTOCOL=version={DEFAULT_GIT_PROTOCOL_VERSION_FETCH}",
  1501. ]
  1502. expected += [
  1503. "user@host",
  1504. "git-clone-url",
  1505. ]
  1506. vendor = SubprocessSSHVendor()
  1507. command = vendor.run_command(
  1508. "host",
  1509. "git-clone-url",
  1510. username="user",
  1511. port="2200",
  1512. key_filename="/tmp/id_rsa",
  1513. )
  1514. args = command.proc.args
  1515. self.assertListEqual(expected, args[0])
  1516. def test_run_with_ssh_command(self) -> None:
  1517. expected = [
  1518. "/path/to/ssh",
  1519. "-o",
  1520. "Option=Value",
  1521. "-x",
  1522. ]
  1523. if DEFAULT_GIT_PROTOCOL_VERSION_FETCH:
  1524. expected += [
  1525. "-o",
  1526. f"SetEnv GIT_PROTOCOL=version={DEFAULT_GIT_PROTOCOL_VERSION_FETCH}",
  1527. ]
  1528. expected += [
  1529. "host",
  1530. "git-clone-url",
  1531. ]
  1532. vendor = SubprocessSSHVendor()
  1533. command = vendor.run_command(
  1534. "host",
  1535. "git-clone-url",
  1536. ssh_command="/path/to/ssh -o Option=Value",
  1537. )
  1538. args = command.proc.args
  1539. self.assertListEqual(expected, args[0])
  1540. class PLinkSSHVendorTests(TestCase):
  1541. def setUp(self) -> None:
  1542. # Monkey Patch client subprocess popen
  1543. self._orig_popen = dulwich.client.subprocess.Popen
  1544. dulwich.client.subprocess.Popen = DummyPopen
  1545. def tearDown(self) -> None:
  1546. dulwich.client.subprocess.Popen = self._orig_popen
  1547. def test_run_command_dashes(self) -> None:
  1548. vendor = PLinkSSHVendor()
  1549. self.assertRaises(
  1550. StrangeHostname,
  1551. vendor.run_command,
  1552. "--weird-host",
  1553. "git-clone-url",
  1554. )
  1555. def test_run_command_password_and_privkey(self) -> None:
  1556. vendor = PLinkSSHVendor()
  1557. warnings.simplefilter("always", UserWarning)
  1558. self.addCleanup(warnings.resetwarnings)
  1559. warnings_list, restore_warnings = setup_warning_catcher()
  1560. self.addCleanup(restore_warnings)
  1561. command = vendor.run_command(
  1562. "host",
  1563. "git-clone-url",
  1564. password="12345",
  1565. key_filename="/tmp/id_rsa",
  1566. )
  1567. expected_warning = UserWarning(
  1568. "Invoking PLink with a password exposes the password in the process list."
  1569. )
  1570. for w in warnings_list:
  1571. if type(w) is type(expected_warning) and w.args == expected_warning.args:
  1572. break
  1573. else:
  1574. raise AssertionError(
  1575. f"Expected warning {expected_warning!r} not in {warnings_list!r}"
  1576. )
  1577. args = command.proc.args
  1578. if sys.platform == "win32":
  1579. binary = ["plink.exe", "-ssh"]
  1580. else:
  1581. binary = ["plink", "-ssh"]
  1582. expected = [
  1583. *binary,
  1584. "-pw",
  1585. "12345",
  1586. "-i",
  1587. "/tmp/id_rsa",
  1588. "host",
  1589. "git-clone-url",
  1590. ]
  1591. self.assertListEqual(expected, args[0])
  1592. def test_run_command_password(self) -> None:
  1593. if sys.platform == "win32":
  1594. binary = ["plink.exe", "-ssh"]
  1595. else:
  1596. binary = ["plink", "-ssh"]
  1597. expected = [*binary, "-pw", "12345", "host", "git-clone-url"]
  1598. vendor = PLinkSSHVendor()
  1599. warnings.simplefilter("always", UserWarning)
  1600. self.addCleanup(warnings.resetwarnings)
  1601. warnings_list, restore_warnings = setup_warning_catcher()
  1602. self.addCleanup(restore_warnings)
  1603. command = vendor.run_command("host", "git-clone-url", password="12345")
  1604. expected_warning = UserWarning(
  1605. "Invoking PLink with a password exposes the password in the process list."
  1606. )
  1607. for w in warnings_list:
  1608. if type(w) is type(expected_warning) and w.args == expected_warning.args:
  1609. break
  1610. else:
  1611. raise AssertionError(
  1612. f"Expected warning {expected_warning!r} not in {warnings_list!r}"
  1613. )
  1614. args = command.proc.args
  1615. self.assertListEqual(expected, args[0])
  1616. def test_run_command_with_port_username_and_privkey(self) -> None:
  1617. if sys.platform == "win32":
  1618. binary = ["plink.exe", "-ssh"]
  1619. else:
  1620. binary = ["plink", "-ssh"]
  1621. expected = [
  1622. *binary,
  1623. "-P",
  1624. "2200",
  1625. "-i",
  1626. "/tmp/id_rsa",
  1627. "user@host",
  1628. "git-clone-url",
  1629. ]
  1630. vendor = PLinkSSHVendor()
  1631. command = vendor.run_command(
  1632. "host",
  1633. "git-clone-url",
  1634. username="user",
  1635. port="2200",
  1636. key_filename="/tmp/id_rsa",
  1637. )
  1638. args = command.proc.args
  1639. self.assertListEqual(expected, args[0])
  1640. def test_run_with_ssh_command(self) -> None:
  1641. expected = [
  1642. "/path/to/plink",
  1643. "-ssh",
  1644. "host",
  1645. "git-clone-url",
  1646. ]
  1647. vendor = PLinkSSHVendor()
  1648. command = vendor.run_command(
  1649. "host",
  1650. "git-clone-url",
  1651. ssh_command="/path/to/plink",
  1652. )
  1653. args = command.proc.args
  1654. self.assertListEqual(expected, args[0])
  1655. class RsyncUrlTests(TestCase):
  1656. def test_simple(self) -> None:
  1657. self.assertEqual(parse_rsync_url("foo:bar/path"), (None, "foo", "bar/path"))
  1658. self.assertEqual(
  1659. parse_rsync_url("user@foo:bar/path"), ("user", "foo", "bar/path")
  1660. )
  1661. def test_path(self) -> None:
  1662. self.assertRaises(ValueError, parse_rsync_url, "/path")
  1663. class CheckWantsTests(TestCase):
  1664. def test_fine(self) -> None:
  1665. check_wants(
  1666. [b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
  1667. {b"refs/heads/blah": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
  1668. )
  1669. def test_missing(self) -> None:
  1670. self.assertRaises(
  1671. InvalidWants,
  1672. check_wants,
  1673. [b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
  1674. {b"refs/heads/blah": b"3f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
  1675. )
  1676. def test_annotated(self) -> None:
  1677. self.assertRaises(
  1678. InvalidWants,
  1679. check_wants,
  1680. [b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
  1681. {
  1682. b"refs/heads/blah": b"3f3dc7a53fb752a6961d3a56683df46d4d3bf262",
  1683. b"refs/heads/blah^{}": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262",
  1684. },
  1685. )
  1686. class FetchPackResultTests(TestCase):
  1687. def test_eq(self) -> None:
  1688. self.assertEqual(
  1689. FetchPackResult(
  1690. {b"refs/heads/master": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
  1691. {},
  1692. b"user/agent",
  1693. ),
  1694. FetchPackResult(
  1695. {b"refs/heads/master": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
  1696. {},
  1697. b"user/agent",
  1698. ),
  1699. )
  1700. class GitCredentialStoreTests(TestCase):
  1701. @classmethod
  1702. def setUpClass(cls) -> None:
  1703. with tempfile.NamedTemporaryFile(delete=False) as f:
  1704. f.write(b"https://user:pass@example.org\n")
  1705. cls.fname = f.name
  1706. @classmethod
  1707. def tearDownClass(cls) -> None:
  1708. os.unlink(cls.fname)
  1709. def test_nonmatching_scheme(self) -> None:
  1710. self.assertEqual(
  1711. get_credentials_from_store(b"http", b"example.org", fnames=[self.fname]),
  1712. None,
  1713. )
  1714. def test_nonmatching_hostname(self) -> None:
  1715. self.assertEqual(
  1716. get_credentials_from_store(b"https", b"noentry.org", fnames=[self.fname]),
  1717. None,
  1718. )
  1719. def test_match_without_username(self) -> None:
  1720. self.assertEqual(
  1721. get_credentials_from_store(b"https", b"example.org", fnames=[self.fname]),
  1722. (b"user", b"pass"),
  1723. )
  1724. def test_match_with_matching_username(self) -> None:
  1725. self.assertEqual(
  1726. get_credentials_from_store(
  1727. b"https", b"example.org", b"user", fnames=[self.fname]
  1728. ),
  1729. (b"user", b"pass"),
  1730. )
  1731. def test_no_match_with_nonmatching_username(self) -> None:
  1732. self.assertEqual(
  1733. get_credentials_from_store(
  1734. b"https", b"example.org", b"otheruser", fnames=[self.fname]
  1735. ),
  1736. None,
  1737. )
  1738. class RemoteErrorFromStderrTests(TestCase):
  1739. def test_nothing(self) -> None:
  1740. self.assertEqual(_remote_error_from_stderr(None), HangupException())
  1741. def test_error_line(self) -> None:
  1742. b = BytesIO(
  1743. b"""\
  1744. This is some random output.
  1745. ERROR: This is the actual error
  1746. with a tail
  1747. """
  1748. )
  1749. self.assertEqual(
  1750. _remote_error_from_stderr(b),
  1751. GitProtocolError("This is the actual error"),
  1752. )
  1753. def test_no_error_line(self) -> None:
  1754. b = BytesIO(
  1755. b"""\
  1756. This is output without an error line.
  1757. And this line is just random noise, too.
  1758. """
  1759. )
  1760. self.assertEqual(
  1761. _remote_error_from_stderr(b),
  1762. HangupException(
  1763. [
  1764. b"This is output without an error line.",
  1765. b"And this line is just random noise, too.",
  1766. ]
  1767. ),
  1768. )
  1769. class TestExtractAgentAndSymrefs(TestCase):
  1770. def test_extract_agent_and_symrefs(self) -> None:
  1771. (symrefs, agent) = _extract_symrefs_and_agent(
  1772. [b"agent=git/2.31.1", b"symref=HEAD:refs/heads/master"]
  1773. )
  1774. self.assertEqual(agent, b"git/2.31.1")
  1775. self.assertEqual(symrefs, {b"HEAD": b"refs/heads/master"})