test_client.py 99 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757
  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 published by the Free Software Foundation; version 2.0
  7. # or (at your option) any later version. You can redistribute it and/or
  8. # modify it under the terms of either of these two licenses.
  9. #
  10. # Unless required by applicable law or agreed to in writing, software
  11. # distributed under the License is distributed on an "AS IS" BASIS,
  12. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. # See the License for the specific language governing permissions and
  14. # limitations under the License.
  15. #
  16. # You should have received a copy of the licenses; if not, see
  17. # <http://www.gnu.org/licenses/> for a copy of the GNU General Public License
  18. # and <http://www.apache.org/licenses/LICENSE-2.0> for a copy of the Apache
  19. # License, Version 2.0.
  20. #
  21. 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.bundle import create_bundle_from_repo, write_bundle
  35. from dulwich.client import (
  36. BundleClient,
  37. FetchPackResult,
  38. GitProtocolError,
  39. HangupException,
  40. HttpGitClient,
  41. InvalidWants,
  42. LocalGitClient,
  43. PLinkSSHVendor,
  44. ReportStatusParser,
  45. SendPackError,
  46. SSHGitClient,
  47. StrangeHostname,
  48. SubprocessSSHVendor,
  49. TCPGitClient,
  50. TraditionalGitClient,
  51. Urllib3HttpGitClient,
  52. _extract_symrefs_and_agent,
  53. _remote_error_from_stderr,
  54. _win32_url_to_path,
  55. check_wants,
  56. default_urllib3_manager,
  57. get_credentials_from_store,
  58. get_transport_and_path,
  59. get_transport_and_path_from_url,
  60. parse_rsync_url,
  61. )
  62. from dulwich.config import ConfigDict
  63. from dulwich.objects import Blob, Commit, Tree
  64. from dulwich.pack import pack_objects_to_data, write_pack_data, write_pack_objects
  65. from dulwich.protocol import DEFAULT_GIT_PROTOCOL_VERSION_FETCH, TCP_GIT_PORT, Protocol
  66. from dulwich.repo import MemoryRepo, Repo
  67. from dulwich.tests.utils import open_repo, setup_warning_catcher, tear_down_repo
  68. from . import TestCase, skipIf
  69. class DummyClient(TraditionalGitClient):
  70. def __init__(self, can_read, read, write) -> None:
  71. self.can_read = can_read
  72. self.read = read
  73. self.write = write
  74. TraditionalGitClient.__init__(self)
  75. def _connect(self, service, path, protocol_version=None):
  76. return Protocol(self.read, self.write), self.can_read, None
  77. class DummyPopen:
  78. def __init__(self, *args, **kwards) -> None:
  79. self.stdin = BytesIO(b"stdin")
  80. self.stdout = BytesIO(b"stdout")
  81. self.stderr = BytesIO(b"stderr")
  82. self.returncode = 0
  83. self.args = args
  84. self.kwargs = kwards
  85. def communicate(self, *args, **kwards):
  86. return ("Running", "")
  87. def wait(self, *args, **kwards) -> bool:
  88. return False
  89. # TODO(durin42): add unit-level tests of GitClient
  90. class GitClientTests(TestCase):
  91. def setUp(self) -> None:
  92. super().setUp()
  93. self.rout = BytesIO()
  94. self.rin = BytesIO()
  95. self.client = DummyClient(lambda x: True, self.rin.read, self.rout.write)
  96. def test_caps(self) -> None:
  97. agent_cap = "agent=dulwich/{}.{}.{}".format(*dulwich.__version__).encode(
  98. "ascii"
  99. )
  100. self.assertEqual(
  101. {
  102. b"multi_ack",
  103. b"side-band-64k",
  104. b"ofs-delta",
  105. b"thin-pack",
  106. b"multi_ack_detailed",
  107. b"shallow",
  108. agent_cap,
  109. },
  110. set(self.client._fetch_capabilities),
  111. )
  112. self.assertEqual(
  113. {
  114. b"delete-refs",
  115. b"ofs-delta",
  116. b"report-status",
  117. b"side-band-64k",
  118. agent_cap,
  119. },
  120. set(self.client._send_capabilities),
  121. )
  122. def test_archive_ack(self) -> None:
  123. self.rin.write(b"0009NACK\n0000")
  124. self.rin.seek(0)
  125. self.client.archive(b"bla", b"HEAD", None, None)
  126. self.assertEqual(self.rout.getvalue(), b"0011argument HEAD0000")
  127. def test_fetch_empty(self) -> None:
  128. self.rin.write(b"0000")
  129. self.rin.seek(0)
  130. def check_heads(heads, **kwargs):
  131. self.assertEqual(heads, {})
  132. return []
  133. ret = self.client.fetch_pack(b"/", check_heads, None, None)
  134. self.assertEqual({}, ret.refs)
  135. self.assertEqual({}, ret.symrefs)
  136. def test_fetch_pack_ignores_magic_ref(self) -> None:
  137. self.rin.write(
  138. b"00000000000000000000000000000000000000000000 capabilities^{}"
  139. b"\x00 multi_ack "
  140. b"thin-pack side-band side-band-64k ofs-delta shallow no-progress "
  141. b"include-tag\n"
  142. b"0000"
  143. )
  144. self.rin.seek(0)
  145. def check_heads(heads, **kwargs):
  146. self.assertEqual({}, heads)
  147. return []
  148. ret = self.client.fetch_pack(b"bla", check_heads, None, None, None)
  149. self.assertEqual({}, ret.refs)
  150. self.assertEqual({}, ret.symrefs)
  151. self.assertEqual(self.rout.getvalue(), b"0000")
  152. def test_fetch_pack_none(self) -> None:
  153. self.rin.write(
  154. b"008855dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7 HEAD\x00multi_ack "
  155. b"thin-pack side-band side-band-64k ofs-delta shallow no-progress "
  156. b"include-tag\n"
  157. b"0000"
  158. )
  159. self.rin.seek(0)
  160. ret = self.client.fetch_pack(
  161. b"bla", lambda heads, depth=None: [], None, None, None
  162. )
  163. self.assertEqual(
  164. {b"HEAD": b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7"}, ret.refs
  165. )
  166. self.assertEqual({}, ret.symrefs)
  167. self.assertEqual(self.rout.getvalue(), b"0000")
  168. def test_handle_upload_pack_head_deepen_since(self) -> None:
  169. # Test that deepen-since command is properly sent
  170. from dulwich.client import _handle_upload_pack_head
  171. self.rin.write(b"0008NAK\n0000")
  172. self.rin.seek(0)
  173. class DummyGraphWalker:
  174. def __iter__(self):
  175. return self
  176. def __next__(self):
  177. return None
  178. proto = Protocol(self.rin.read, self.rout.write)
  179. capabilities = [b"shallow", b"deepen-since"]
  180. wants = [b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7"]
  181. graph_walker = DummyGraphWalker()
  182. _handle_upload_pack_head(
  183. proto=proto,
  184. capabilities=capabilities,
  185. graph_walker=graph_walker,
  186. wants=wants,
  187. can_read=None,
  188. depth=None,
  189. protocol_version=0,
  190. shallow_since="2023-01-01T00:00:00Z",
  191. )
  192. # Verify the deepen-since command was sent
  193. output = self.rout.getvalue()
  194. self.assertIn(b"deepen-since 2023-01-01T00:00:00Z\n", output)
  195. def test_handle_upload_pack_head_deepen_not(self) -> None:
  196. # Test that deepen-not command is properly sent
  197. from dulwich.client import _handle_upload_pack_head
  198. self.rin.write(b"0008NAK\n0000")
  199. self.rin.seek(0)
  200. class DummyGraphWalker:
  201. def __iter__(self):
  202. return self
  203. def __next__(self):
  204. return None
  205. proto = Protocol(self.rin.read, self.rout.write)
  206. capabilities = [b"shallow", b"deepen-not"]
  207. wants = [b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7"]
  208. graph_walker = DummyGraphWalker()
  209. _handle_upload_pack_head(
  210. proto=proto,
  211. capabilities=capabilities,
  212. graph_walker=graph_walker,
  213. wants=wants,
  214. can_read=None,
  215. depth=None,
  216. protocol_version=0,
  217. shallow_exclude=["refs/heads/excluded"],
  218. )
  219. # Verify the deepen-not command was sent
  220. output = self.rout.getvalue()
  221. self.assertIn(b"deepen-not refs/heads/excluded\n", output)
  222. def test_handle_upload_pack_head_deepen_not_multiple(self) -> None:
  223. # Test that multiple deepen-not commands are properly sent
  224. from dulwich.client import _handle_upload_pack_head
  225. self.rin.write(b"0008NAK\n0000")
  226. self.rin.seek(0)
  227. class DummyGraphWalker:
  228. def __iter__(self):
  229. return self
  230. def __next__(self):
  231. return None
  232. proto = Protocol(self.rin.read, self.rout.write)
  233. capabilities = [b"shallow", b"deepen-not"]
  234. wants = [b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7"]
  235. graph_walker = DummyGraphWalker()
  236. _handle_upload_pack_head(
  237. proto=proto,
  238. capabilities=capabilities,
  239. graph_walker=graph_walker,
  240. wants=wants,
  241. can_read=None,
  242. depth=None,
  243. protocol_version=0,
  244. shallow_exclude=["refs/heads/excluded1", "refs/heads/excluded2"],
  245. )
  246. # Verify both deepen-not commands were sent
  247. output = self.rout.getvalue()
  248. self.assertIn(b"deepen-not refs/heads/excluded1\n", output)
  249. self.assertIn(b"deepen-not refs/heads/excluded2\n", output)
  250. def test_handle_upload_pack_head_deepen_since_and_not(self) -> None:
  251. # Test that deepen-since and deepen-not can be used together
  252. from dulwich.client import _handle_upload_pack_head
  253. self.rin.write(b"0008NAK\n0000")
  254. self.rin.seek(0)
  255. class DummyGraphWalker:
  256. def __iter__(self):
  257. return self
  258. def __next__(self):
  259. return None
  260. proto = Protocol(self.rin.read, self.rout.write)
  261. capabilities = [b"shallow", b"deepen-since", b"deepen-not"]
  262. wants = [b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7"]
  263. graph_walker = DummyGraphWalker()
  264. _handle_upload_pack_head(
  265. proto=proto,
  266. capabilities=capabilities,
  267. graph_walker=graph_walker,
  268. wants=wants,
  269. can_read=None,
  270. depth=None,
  271. protocol_version=0,
  272. shallow_since="2023-01-01T00:00:00Z",
  273. shallow_exclude=["refs/heads/excluded"],
  274. )
  275. # Verify both deepen-since and deepen-not commands were sent
  276. output = self.rout.getvalue()
  277. self.assertIn(b"deepen-since 2023-01-01T00:00:00Z\n", output)
  278. self.assertIn(b"deepen-not refs/heads/excluded\n", output)
  279. def test_send_pack_no_sideband64k_with_update_ref_error(self) -> None:
  280. # No side-bank-64k reported by server shouldn't try to parse
  281. # side band data
  282. pkts = [
  283. b"55dcc6bf963f922e1ed5c4bbaaefcfacef57b1d7 capabilities^{}"
  284. b"\x00 report-status delete-refs ofs-delta\n",
  285. b"",
  286. b"unpack ok",
  287. b"ng refs/foo/bar pre-receive hook declined",
  288. b"",
  289. ]
  290. for pkt in pkts:
  291. if pkt == b"":
  292. self.rin.write(b"0000")
  293. else:
  294. self.rin.write(("%04x" % (len(pkt) + 4)).encode("ascii") + pkt)
  295. self.rin.seek(0)
  296. tree = Tree()
  297. commit = Commit()
  298. commit.tree = tree
  299. commit.parents = []
  300. commit.author = commit.committer = b"test user"
  301. commit.commit_time = commit.author_time = 1174773719
  302. commit.commit_timezone = commit.author_timezone = 0
  303. commit.encoding = b"UTF-8"
  304. commit.message = b"test message"
  305. def update_refs(refs):
  306. return {
  307. b"refs/foo/bar": commit.id,
  308. }
  309. def generate_pack_data(have, want, *, ofs_delta=False, progress=None):
  310. return pack_objects_to_data(
  311. [
  312. (commit, None),
  313. (tree, b""),
  314. ]
  315. )
  316. result = self.client.send_pack("blah", update_refs, generate_pack_data)
  317. self.assertEqual(
  318. {b"refs/foo/bar": "pre-receive hook declined"}, result.ref_status
  319. )
  320. self.assertEqual({b"refs/foo/bar": commit.id}, result.refs)
  321. def test_send_pack_none(self) -> None:
  322. # Set ref to current value
  323. self.rin.write(
  324. b"0078310ca9477129b8586fa2afc779c1f57cf64bba6c "
  325. b"refs/heads/master\x00 report-status delete-refs "
  326. b"side-band-64k quiet ofs-delta\n"
  327. b"0000"
  328. )
  329. self.rin.seek(0)
  330. def update_refs(refs):
  331. return {b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c"}
  332. def generate_pack_data(have, want, *, ofs_delta=False, progress=None):
  333. return 0, []
  334. self.client.send_pack(b"/", update_refs, generate_pack_data)
  335. self.assertEqual(self.rout.getvalue(), b"0000")
  336. def test_send_pack_keep_and_delete(self) -> None:
  337. self.rin.write(
  338. b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
  339. b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
  340. b"003f310ca9477129b8586fa2afc779c1f57cf64bba6c refs/heads/keepme\n"
  341. b"0000000eunpack ok\n"
  342. b"0019ok refs/heads/master\n"
  343. b"0000"
  344. )
  345. self.rin.seek(0)
  346. def update_refs(refs):
  347. return {b"refs/heads/master": b"0" * 40}
  348. def generate_pack_data(have, want, *, ofs_delta=False, progress=None):
  349. return 0, []
  350. self.client.send_pack(b"/", update_refs, generate_pack_data)
  351. self.assertEqual(
  352. self.rout.getvalue(),
  353. b"008b310ca9477129b8586fa2afc779c1f57cf64bba6c "
  354. b"0000000000000000000000000000000000000000 "
  355. b"refs/heads/master\x00delete-refs ofs-delta report-status0000",
  356. )
  357. def test_send_pack_delete_only(self) -> None:
  358. self.rin.write(
  359. b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
  360. b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
  361. b"0000000eunpack ok\n"
  362. b"0019ok refs/heads/master\n"
  363. b"0000"
  364. )
  365. self.rin.seek(0)
  366. def update_refs(refs):
  367. return {b"refs/heads/master": b"0" * 40}
  368. def generate_pack_data(have, want, *, ofs_delta=False, progress=None):
  369. return 0, []
  370. self.client.send_pack(b"/", update_refs, generate_pack_data)
  371. self.assertEqual(
  372. self.rout.getvalue(),
  373. b"008b310ca9477129b8586fa2afc779c1f57cf64bba6c "
  374. b"0000000000000000000000000000000000000000 "
  375. b"refs/heads/master\x00delete-refs ofs-delta report-status0000",
  376. )
  377. def test_send_pack_new_ref_only(self) -> None:
  378. self.rin.write(
  379. b"0063310ca9477129b8586fa2afc779c1f57cf64bba6c "
  380. b"refs/heads/master\x00report-status delete-refs ofs-delta\n"
  381. b"0000000eunpack ok\n"
  382. b"0019ok refs/heads/blah12\n"
  383. b"0000"
  384. )
  385. self.rin.seek(0)
  386. def update_refs(refs):
  387. return {
  388. b"refs/heads/blah12": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
  389. b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
  390. }
  391. def generate_pack_data(have, want, *, ofs_delta=False, progress=None):
  392. return 0, []
  393. f = BytesIO()
  394. write_pack_objects(f.write, [])
  395. self.client.send_pack("/", update_refs, generate_pack_data)
  396. self.assertEqual(
  397. self.rout.getvalue(),
  398. b"008b0000000000000000000000000000000000000000 "
  399. b"310ca9477129b8586fa2afc779c1f57cf64bba6c "
  400. b"refs/heads/blah12\x00delete-refs ofs-delta report-status0000"
  401. + f.getvalue(),
  402. )
  403. def test_send_pack_new_ref(self) -> None:
  404. self.rin.write(
  405. b"0064310ca9477129b8586fa2afc779c1f57cf64bba6c "
  406. b"refs/heads/master\x00 report-status delete-refs ofs-delta\n"
  407. b"0000000eunpack ok\n"
  408. b"0019ok refs/heads/blah12\n"
  409. b"0000"
  410. )
  411. self.rin.seek(0)
  412. tree = Tree()
  413. commit = Commit()
  414. commit.tree = tree
  415. commit.parents = []
  416. commit.author = commit.committer = b"test user"
  417. commit.commit_time = commit.author_time = 1174773719
  418. commit.commit_timezone = commit.author_timezone = 0
  419. commit.encoding = b"UTF-8"
  420. commit.message = b"test message"
  421. def update_refs(refs):
  422. return {
  423. b"refs/heads/blah12": commit.id,
  424. b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c",
  425. }
  426. def generate_pack_data(have, want, *, ofs_delta=False, progress=None):
  427. return pack_objects_to_data(
  428. [
  429. (commit, None),
  430. (tree, b""),
  431. ]
  432. )
  433. f = BytesIO()
  434. count, records = generate_pack_data(None, None)
  435. write_pack_data(f.write, records, num_records=count)
  436. self.client.send_pack(b"/", update_refs, generate_pack_data)
  437. self.assertEqual(
  438. self.rout.getvalue(),
  439. b"008b0000000000000000000000000000000000000000 "
  440. + commit.id
  441. + b" refs/heads/blah12\x00delete-refs ofs-delta report-status0000"
  442. + f.getvalue(),
  443. )
  444. def test_send_pack_no_deleteref_delete_only(self) -> None:
  445. pkts = [
  446. b"310ca9477129b8586fa2afc779c1f57cf64bba6c refs/heads/master"
  447. b"\x00 report-status ofs-delta\n",
  448. b"",
  449. b"",
  450. ]
  451. for pkt in pkts:
  452. if pkt == b"":
  453. self.rin.write(b"0000")
  454. else:
  455. self.rin.write(("%04x" % (len(pkt) + 4)).encode("ascii") + pkt)
  456. self.rin.seek(0)
  457. def update_refs(refs):
  458. return {b"refs/heads/master": b"0" * 40}
  459. def generate_pack_data(have, want, *, ofs_delta=False, progress=None):
  460. return 0, []
  461. result = self.client.send_pack(b"/", update_refs, generate_pack_data)
  462. self.assertEqual(
  463. result.ref_status,
  464. {b"refs/heads/master": "remote does not support deleting refs"},
  465. )
  466. self.assertEqual(
  467. result.refs,
  468. {b"refs/heads/master": b"310ca9477129b8586fa2afc779c1f57cf64bba6c"},
  469. )
  470. self.assertEqual(self.rout.getvalue(), b"0000")
  471. class TestGetTransportAndPath(TestCase):
  472. def test_tcp(self) -> None:
  473. c, path = get_transport_and_path("git://foo.com/bar/baz")
  474. self.assertIsInstance(c, TCPGitClient)
  475. self.assertEqual("foo.com", c._host)
  476. self.assertEqual(TCP_GIT_PORT, c._port)
  477. self.assertEqual("/bar/baz", path)
  478. def test_tcp_port(self) -> None:
  479. c, path = get_transport_and_path("git://foo.com:1234/bar/baz")
  480. self.assertIsInstance(c, TCPGitClient)
  481. self.assertEqual("foo.com", c._host)
  482. self.assertEqual(1234, c._port)
  483. self.assertEqual("/bar/baz", path)
  484. def test_tcp_ipv6(self) -> None:
  485. c, path = get_transport_and_path("git://[::1]/bar/baz")
  486. self.assertIsInstance(c, TCPGitClient)
  487. self.assertEqual("::1", c._host)
  488. self.assertEqual(TCP_GIT_PORT, c._port)
  489. self.assertEqual("/bar/baz", path)
  490. def test_tcp_ipv6_port(self) -> None:
  491. c, path = get_transport_and_path("git://[2001:db8::1]:1234/bar/baz")
  492. self.assertIsInstance(c, TCPGitClient)
  493. self.assertEqual("2001:db8::1", c._host)
  494. self.assertEqual(1234, c._port)
  495. self.assertEqual("/bar/baz", path)
  496. def test_git_ssh_explicit(self) -> None:
  497. c, path = get_transport_and_path("git+ssh://foo.com/bar/baz")
  498. self.assertIsInstance(c, SSHGitClient)
  499. self.assertEqual("foo.com", c.host)
  500. self.assertEqual(None, c.port)
  501. self.assertEqual(None, c.username)
  502. self.assertEqual("/bar/baz", path)
  503. def test_ssh_explicit(self) -> None:
  504. c, path = get_transport_and_path("ssh://foo.com/bar/baz")
  505. self.assertIsInstance(c, SSHGitClient)
  506. self.assertEqual("foo.com", c.host)
  507. self.assertEqual(None, c.port)
  508. self.assertEqual(None, c.username)
  509. self.assertEqual("/bar/baz", path)
  510. def test_ssh_port_explicit(self) -> None:
  511. c, path = get_transport_and_path("git+ssh://foo.com:1234/bar/baz")
  512. self.assertIsInstance(c, SSHGitClient)
  513. self.assertEqual("foo.com", c.host)
  514. self.assertEqual(1234, c.port)
  515. self.assertEqual("/bar/baz", path)
  516. def test_username_and_port_explicit_unknown_scheme(self) -> None:
  517. c, path = get_transport_and_path("unknown://git@server:7999/dply/stuff.git")
  518. self.assertIsInstance(c, SSHGitClient)
  519. self.assertEqual("unknown", c.host)
  520. self.assertEqual("//git@server:7999/dply/stuff.git", path)
  521. def test_username_and_port_explicit(self) -> None:
  522. c, path = get_transport_and_path("ssh://git@server:7999/dply/stuff.git")
  523. self.assertIsInstance(c, SSHGitClient)
  524. self.assertEqual("git", c.username)
  525. self.assertEqual("server", c.host)
  526. self.assertEqual(7999, c.port)
  527. self.assertEqual("/dply/stuff.git", path)
  528. def test_ssh_abspath_doubleslash(self) -> None:
  529. c, path = get_transport_and_path("git+ssh://foo.com//bar/baz")
  530. self.assertIsInstance(c, SSHGitClient)
  531. self.assertEqual("foo.com", c.host)
  532. self.assertEqual(None, c.port)
  533. self.assertEqual(None, c.username)
  534. self.assertEqual("//bar/baz", path)
  535. def test_ssh_port(self) -> None:
  536. c, path = get_transport_and_path("git+ssh://foo.com:1234/bar/baz")
  537. self.assertIsInstance(c, SSHGitClient)
  538. self.assertEqual("foo.com", c.host)
  539. self.assertEqual(1234, c.port)
  540. self.assertEqual("/bar/baz", path)
  541. def test_ssh_implicit(self) -> None:
  542. c, path = get_transport_and_path("foo:/bar/baz")
  543. self.assertIsInstance(c, SSHGitClient)
  544. self.assertEqual("foo", c.host)
  545. self.assertEqual(None, c.port)
  546. self.assertEqual(None, c.username)
  547. self.assertEqual("/bar/baz", path)
  548. def test_ssh_host(self) -> None:
  549. c, path = get_transport_and_path("foo.com:/bar/baz")
  550. self.assertIsInstance(c, SSHGitClient)
  551. self.assertEqual("foo.com", c.host)
  552. self.assertEqual(None, c.port)
  553. self.assertEqual(None, c.username)
  554. self.assertEqual("/bar/baz", path)
  555. def test_ssh_user_host(self) -> None:
  556. c, path = get_transport_and_path("user@foo.com:/bar/baz")
  557. self.assertIsInstance(c, SSHGitClient)
  558. self.assertEqual("foo.com", c.host)
  559. self.assertEqual(None, c.port)
  560. self.assertEqual("user", c.username)
  561. self.assertEqual("/bar/baz", path)
  562. def test_ssh_relpath(self) -> None:
  563. c, path = get_transport_and_path("foo:bar/baz")
  564. self.assertIsInstance(c, SSHGitClient)
  565. self.assertEqual("foo", c.host)
  566. self.assertEqual(None, c.port)
  567. self.assertEqual(None, c.username)
  568. self.assertEqual("bar/baz", path)
  569. def test_ssh_host_relpath(self) -> None:
  570. c, path = get_transport_and_path("foo.com:bar/baz")
  571. self.assertIsInstance(c, SSHGitClient)
  572. self.assertEqual("foo.com", c.host)
  573. self.assertEqual(None, c.port)
  574. self.assertEqual(None, c.username)
  575. self.assertEqual("bar/baz", path)
  576. def test_ssh_user_host_relpath(self) -> None:
  577. c, path = get_transport_and_path("user@foo.com:bar/baz")
  578. self.assertIsInstance(c, SSHGitClient)
  579. self.assertEqual("foo.com", c.host)
  580. self.assertEqual(None, c.port)
  581. self.assertEqual("user", c.username)
  582. self.assertEqual("bar/baz", path)
  583. def test_local(self) -> None:
  584. c, path = get_transport_and_path("foo.bar/baz")
  585. self.assertIsInstance(c, LocalGitClient)
  586. self.assertEqual("foo.bar/baz", path)
  587. def test_ssh_with_config(self) -> None:
  588. # Test that core.sshCommand from config is passed to SSHGitClient
  589. from dulwich.config import ConfigDict
  590. config = ConfigDict()
  591. c, _path = get_transport_and_path(
  592. "ssh://git@github.com/user/repo.git", config=config
  593. )
  594. self.assertIsInstance(c, SSHGitClient)
  595. self.assertEqual(c.ssh_command, "ssh") # Now defaults to "ssh"
  596. config.set((b"core",), b"sshCommand", b"custom-ssh -o CustomOption=yes")
  597. c, _path = get_transport_and_path(
  598. "ssh://git@github.com/user/repo.git", config=config
  599. )
  600. self.assertIsInstance(c, SSHGitClient)
  601. self.assertEqual("custom-ssh -o CustomOption=yes", c.ssh_command)
  602. # Test rsync-style URL also gets the config
  603. c, _path = get_transport_and_path("git@github.com:user/repo.git", config=config)
  604. self.assertIsInstance(c, SSHGitClient)
  605. self.assertEqual("custom-ssh -o CustomOption=yes", c.ssh_command)
  606. @skipIf(sys.platform != "win32", "Behaviour only happens on windows.")
  607. def test_local_abs_windows_path(self) -> None:
  608. c, path = get_transport_and_path("C:\\foo.bar\\baz")
  609. self.assertIsInstance(c, LocalGitClient)
  610. self.assertEqual("C:\\foo.bar\\baz", path)
  611. def test_error(self) -> None:
  612. # Need to use a known urlparse.uses_netloc URL scheme to get the
  613. # expected parsing of the URL on Python versions less than 2.6.5
  614. c, _path = get_transport_and_path("prospero://bar/baz")
  615. self.assertIsInstance(c, SSHGitClient)
  616. def test_http(self) -> None:
  617. url = "https://github.com/jelmer/dulwich"
  618. c, path = get_transport_and_path(url)
  619. self.assertIsInstance(c, HttpGitClient)
  620. self.assertEqual("/jelmer/dulwich", path)
  621. def test_http_auth(self) -> None:
  622. url = "https://user:passwd@github.com/jelmer/dulwich"
  623. c, path = get_transport_and_path(url)
  624. self.assertIsInstance(c, HttpGitClient)
  625. self.assertEqual("/jelmer/dulwich", path)
  626. self.assertEqual("user", c._username)
  627. self.assertEqual("passwd", c._password)
  628. def test_http_auth_with_username(self) -> None:
  629. url = "https://github.com/jelmer/dulwich"
  630. c, path = get_transport_and_path(url, username="user2", password="blah")
  631. self.assertIsInstance(c, HttpGitClient)
  632. self.assertEqual("/jelmer/dulwich", path)
  633. self.assertEqual("user2", c._username)
  634. self.assertEqual("blah", c._password)
  635. def test_http_auth_with_username_and_in_url(self) -> None:
  636. url = "https://user:passwd@github.com/jelmer/dulwich"
  637. c, path = get_transport_and_path(url, username="user2", password="blah")
  638. self.assertIsInstance(c, HttpGitClient)
  639. self.assertEqual("/jelmer/dulwich", path)
  640. # Explicitly provided credentials should override URL credentials
  641. self.assertEqual("user2", c._username)
  642. self.assertEqual("blah", c._password)
  643. def test_http_no_auth(self) -> None:
  644. url = "https://github.com/jelmer/dulwich"
  645. c, path = get_transport_and_path(url)
  646. self.assertIsInstance(c, HttpGitClient)
  647. self.assertEqual("/jelmer/dulwich", path)
  648. self.assertIs(None, c._username)
  649. self.assertIs(None, c._password)
  650. def test_ssh_with_key_filename_and_ssh_command(self) -> None:
  651. # Test that key_filename and ssh_command are passed through to SSHGitClient
  652. c, path = get_transport_and_path(
  653. "ssh://git@github.com/user/repo.git",
  654. key_filename="/path/to/id_rsa",
  655. ssh_command="custom-ssh -o StrictHostKeyChecking=no",
  656. )
  657. self.assertIsInstance(c, SSHGitClient)
  658. self.assertEqual("/user/repo.git", path)
  659. self.assertEqual("/path/to/id_rsa", c.key_filename)
  660. self.assertEqual("custom-ssh -o StrictHostKeyChecking=no", c.ssh_command)
  661. class TestGetTransportAndPathFromUrl(TestCase):
  662. def test_tcp(self) -> None:
  663. c, path = get_transport_and_path_from_url("git://foo.com/bar/baz")
  664. self.assertIsInstance(c, TCPGitClient)
  665. self.assertEqual("foo.com", c._host)
  666. self.assertEqual(TCP_GIT_PORT, c._port)
  667. self.assertEqual("/bar/baz", path)
  668. def test_tcp_port(self) -> None:
  669. c, path = get_transport_and_path_from_url("git://foo.com:1234/bar/baz")
  670. self.assertIsInstance(c, TCPGitClient)
  671. self.assertEqual("foo.com", c._host)
  672. self.assertEqual(1234, c._port)
  673. self.assertEqual("/bar/baz", path)
  674. def test_ssh_explicit(self) -> None:
  675. c, path = get_transport_and_path_from_url("git+ssh://foo.com/bar/baz")
  676. self.assertIsInstance(c, SSHGitClient)
  677. self.assertEqual("foo.com", c.host)
  678. self.assertEqual(None, c.port)
  679. self.assertEqual(None, c.username)
  680. self.assertEqual("/bar/baz", path)
  681. def test_ssh_port_explicit(self) -> None:
  682. c, path = get_transport_and_path_from_url("git+ssh://foo.com:1234/bar/baz")
  683. self.assertIsInstance(c, SSHGitClient)
  684. self.assertEqual("foo.com", c.host)
  685. self.assertEqual(1234, c.port)
  686. self.assertEqual("/bar/baz", path)
  687. def test_ssh_homepath(self) -> None:
  688. c, path = get_transport_and_path_from_url("git+ssh://foo.com/~/bar/baz")
  689. self.assertIsInstance(c, SSHGitClient)
  690. self.assertEqual("foo.com", c.host)
  691. self.assertEqual(None, c.port)
  692. self.assertEqual(None, c.username)
  693. self.assertEqual("/~/bar/baz", path)
  694. def test_ssh_port_homepath(self) -> None:
  695. c, path = get_transport_and_path_from_url("git+ssh://foo.com:1234/~/bar/baz")
  696. self.assertIsInstance(c, SSHGitClient)
  697. self.assertEqual("foo.com", c.host)
  698. self.assertEqual(1234, c.port)
  699. self.assertEqual("/~/bar/baz", path)
  700. def test_ssh_host_relpath(self) -> None:
  701. self.assertRaises(
  702. ValueError, get_transport_and_path_from_url, "foo.com:bar/baz"
  703. )
  704. def test_ssh_user_host_relpath(self) -> None:
  705. self.assertRaises(
  706. ValueError, get_transport_and_path_from_url, "user@foo.com:bar/baz"
  707. )
  708. def test_local_path(self) -> None:
  709. self.assertRaises(ValueError, get_transport_and_path_from_url, "foo.bar/baz")
  710. def test_error(self) -> None:
  711. # Need to use a known urlparse.uses_netloc URL scheme to get the
  712. # expected parsing of the URL on Python versions less than 2.6.5
  713. self.assertRaises(
  714. ValueError, get_transport_and_path_from_url, "prospero://bar/baz"
  715. )
  716. def test_http(self) -> None:
  717. url = "https://github.com/jelmer/dulwich"
  718. c, path = get_transport_and_path_from_url(url)
  719. self.assertIsInstance(c, HttpGitClient)
  720. self.assertEqual("https://github.com", c.get_url(b"/"))
  721. self.assertEqual("/jelmer/dulwich", path)
  722. def test_http_port(self) -> None:
  723. url = "https://github.com:9090/jelmer/dulwich"
  724. c, path = get_transport_and_path_from_url(url)
  725. self.assertEqual("https://github.com:9090", c.get_url(b"/"))
  726. self.assertIsInstance(c, HttpGitClient)
  727. self.assertEqual("/jelmer/dulwich", path)
  728. @patch("os.name", "posix")
  729. @patch("sys.platform", "linux")
  730. def test_file(self) -> None:
  731. c, path = get_transport_and_path_from_url("file:///home/jelmer/foo")
  732. self.assertIsInstance(c, LocalGitClient)
  733. self.assertEqual("/home/jelmer/foo", path)
  734. def test_win32_url_to_path(self):
  735. def check(url, expected):
  736. parsed = urlparse(url)
  737. self.assertEqual(_win32_url_to_path(parsed), expected)
  738. check("file:C:/foo.bar/baz", "C:\\foo.bar\\baz")
  739. check("file:/C:/foo.bar/baz", "C:\\foo.bar\\baz")
  740. check("file://C:/foo.bar/baz", "C:\\foo.bar\\baz")
  741. check("file:///C:/foo.bar/baz", "C:\\foo.bar\\baz")
  742. @patch("os.name", "nt")
  743. @patch("sys.platform", "win32")
  744. def test_file_win(self) -> None:
  745. expected = "C:\\foo.bar\\baz"
  746. for file_url in [
  747. "file:C:/foo.bar/baz",
  748. "file:/C:/foo.bar/baz",
  749. "file://C:/foo.bar/baz",
  750. "file:///C:/foo.bar/baz",
  751. ]:
  752. c, path = get_transport_and_path(file_url)
  753. self.assertIsInstance(c, LocalGitClient)
  754. self.assertEqual(path, expected)
  755. for remote_url in [
  756. "file://host.example.com/C:/foo.bar/baz"
  757. "file://host.example.com/C:/foo.bar/baz"
  758. "file:////host.example/foo.bar/baz",
  759. ]:
  760. with self.assertRaises(NotImplementedError):
  761. c, path = get_transport_and_path(remote_url)
  762. class TestSSHVendor:
  763. def __init__(self) -> None:
  764. self.host = None
  765. self.command = ""
  766. self.username = None
  767. self.port = None
  768. self.password = None
  769. self.key_filename = None
  770. def run_command(
  771. self,
  772. host,
  773. command,
  774. username=None,
  775. port=None,
  776. password=None,
  777. key_filename=None,
  778. ssh_command=None,
  779. protocol_version=None,
  780. ):
  781. self.host = host
  782. self.command = command
  783. self.username = username
  784. self.port = port
  785. self.password = password
  786. self.key_filename = key_filename
  787. self.ssh_command = ssh_command
  788. self.protocol_version = protocol_version
  789. class Subprocess:
  790. pass
  791. Subprocess.read = lambda: None
  792. Subprocess.write = lambda: None
  793. Subprocess.close = lambda: None
  794. Subprocess.can_read = lambda: None
  795. return Subprocess()
  796. class SSHGitClientTests(TestCase):
  797. def setUp(self) -> None:
  798. super().setUp()
  799. self.server = TestSSHVendor()
  800. self.real_vendor = client.get_ssh_vendor
  801. client.get_ssh_vendor = lambda: self.server
  802. self.client = SSHGitClient("git.samba.org")
  803. def tearDown(self) -> None:
  804. super().tearDown()
  805. client.get_ssh_vendor = self.real_vendor
  806. def test_get_url(self) -> None:
  807. path = "/tmp/repo.git"
  808. c = SSHGitClient("git.samba.org")
  809. url = c.get_url(path)
  810. self.assertEqual("ssh://git.samba.org/tmp/repo.git", url)
  811. def test_get_url_with_username_and_port(self) -> None:
  812. path = "/tmp/repo.git"
  813. c = SSHGitClient("git.samba.org", port=2222, username="user")
  814. url = c.get_url(path)
  815. self.assertEqual("ssh://user@git.samba.org:2222/tmp/repo.git", url)
  816. def test_default_command(self) -> None:
  817. self.assertEqual(b"git-upload-pack", self.client._get_cmd_path(b"upload-pack"))
  818. def test_alternative_command_path(self) -> None:
  819. self.client.alternative_paths[b"upload-pack"] = b"/usr/lib/git/git-upload-pack"
  820. self.assertEqual(
  821. b"/usr/lib/git/git-upload-pack",
  822. self.client._get_cmd_path(b"upload-pack"),
  823. )
  824. def test_alternative_command_path_spaces(self) -> None:
  825. self.client.alternative_paths[b"upload-pack"] = (
  826. b"/usr/lib/git/git-upload-pack -ibla"
  827. )
  828. self.assertEqual(
  829. b"/usr/lib/git/git-upload-pack -ibla",
  830. self.client._get_cmd_path(b"upload-pack"),
  831. )
  832. def test_connect(self) -> None:
  833. server = self.server
  834. client = self.client
  835. client.username = b"username"
  836. client.port = 1337
  837. client._connect(b"command", b"/path/to/repo")
  838. self.assertEqual(b"username", server.username)
  839. self.assertEqual(1337, server.port)
  840. self.assertEqual(b"git-command '/path/to/repo'", server.command)
  841. client._connect(b"relative-command", b"/~/path/to/repo")
  842. self.assertEqual(b"git-relative-command '~/path/to/repo'", server.command)
  843. def test_ssh_command_precedence(self) -> None:
  844. self.overrideEnv("GIT_SSH", "/path/to/ssh")
  845. test_client = SSHGitClient("git.samba.org")
  846. self.assertEqual(test_client.ssh_command, "/path/to/ssh")
  847. self.overrideEnv("GIT_SSH_COMMAND", "/path/to/ssh -o Option=Value")
  848. test_client = SSHGitClient("git.samba.org")
  849. self.assertEqual(test_client.ssh_command, "/path/to/ssh -o Option=Value")
  850. test_client = SSHGitClient("git.samba.org", ssh_command="ssh -o Option1=Value1")
  851. self.assertEqual(test_client.ssh_command, "ssh -o Option1=Value1")
  852. def test_ssh_command_config(self) -> None:
  853. # Test core.sshCommand config setting
  854. from dulwich.config import ConfigDict
  855. # No config, no environment - should default to "ssh"
  856. self.overrideEnv("GIT_SSH", None)
  857. self.overrideEnv("GIT_SSH_COMMAND", None)
  858. test_client = SSHGitClient("git.samba.org")
  859. self.assertEqual(test_client.ssh_command, "ssh")
  860. # Config with core.sshCommand
  861. config = ConfigDict()
  862. config.set((b"core",), b"sshCommand", b"ssh -o StrictHostKeyChecking=no")
  863. test_client = SSHGitClient("git.samba.org", config=config)
  864. self.assertEqual(test_client.ssh_command, "ssh -o StrictHostKeyChecking=no")
  865. # ssh_command parameter takes precedence over config
  866. test_client = SSHGitClient(
  867. "git.samba.org", config=config, ssh_command="custom-ssh"
  868. )
  869. self.assertEqual(test_client.ssh_command, "custom-ssh")
  870. # Environment variables take precedence over config when no ssh_command parameter
  871. self.overrideEnv("GIT_SSH_COMMAND", "/usr/bin/ssh -v")
  872. test_client = SSHGitClient("git.samba.org", config=config)
  873. self.assertEqual(test_client.ssh_command, "/usr/bin/ssh -v")
  874. def test_ssh_kwargs_passed_to_vendor(self) -> None:
  875. # Test that ssh_command and other kwargs are actually passed to the SSH vendor
  876. server = self.server
  877. client = self.client
  878. # Set custom ssh_command
  879. client.ssh_command = "custom-ssh-wrapper.sh -o Option=Value"
  880. client.password = "test-password"
  881. client.key_filename = "/path/to/key"
  882. # Connect and verify all kwargs are passed through
  883. client._connect(b"upload-pack", b"/path/to/repo")
  884. self.assertEqual(server.ssh_command, "custom-ssh-wrapper.sh -o Option=Value")
  885. self.assertEqual(server.password, "test-password")
  886. self.assertEqual(server.key_filename, "/path/to/key")
  887. class ReportStatusParserTests(TestCase):
  888. def test_invalid_pack(self) -> None:
  889. parser = ReportStatusParser()
  890. parser.handle_packet(b"unpack error - foo bar")
  891. parser.handle_packet(b"ok refs/foo/bar")
  892. parser.handle_packet(None)
  893. self.assertRaises(SendPackError, list, parser.check())
  894. def test_update_refs_error(self) -> None:
  895. parser = ReportStatusParser()
  896. parser.handle_packet(b"unpack ok")
  897. parser.handle_packet(b"ng refs/foo/bar need to pull")
  898. parser.handle_packet(None)
  899. self.assertEqual([(b"refs/foo/bar", "need to pull")], list(parser.check()))
  900. def test_ok(self) -> None:
  901. parser = ReportStatusParser()
  902. parser.handle_packet(b"unpack ok")
  903. parser.handle_packet(b"ok refs/foo/bar")
  904. parser.handle_packet(None)
  905. self.assertEqual([(b"refs/foo/bar", None)], list(parser.check()))
  906. class LocalGitClientTests(TestCase):
  907. def test_get_url(self) -> None:
  908. path = "/tmp/repo.git"
  909. c = LocalGitClient()
  910. url = c.get_url(path)
  911. self.assertEqual("file:///tmp/repo.git", url)
  912. def test_fetch_into_empty(self) -> None:
  913. c = LocalGitClient()
  914. target = tempfile.mkdtemp()
  915. self.addCleanup(shutil.rmtree, target)
  916. t = Repo.init_bare(target)
  917. self.addCleanup(t.close)
  918. s = open_repo("a.git")
  919. self.addCleanup(tear_down_repo, s)
  920. self.assertEqual(s.get_refs(), c.fetch(s.path, t).refs)
  921. def test_clone(self) -> None:
  922. c = LocalGitClient()
  923. s = open_repo("a.git")
  924. self.addCleanup(tear_down_repo, s)
  925. target = tempfile.mkdtemp()
  926. self.addCleanup(shutil.rmtree, target)
  927. result_repo = c.clone(s.path, target, mkdir=False)
  928. self.addCleanup(result_repo.close)
  929. expected = dict(s.get_refs())
  930. expected[b"refs/remotes/origin/HEAD"] = expected[b"HEAD"]
  931. expected[b"refs/remotes/origin/master"] = expected[b"refs/heads/master"]
  932. self.assertEqual(expected, result_repo.get_refs())
  933. def test_fetch_empty(self) -> None:
  934. c = LocalGitClient()
  935. s = open_repo("a.git")
  936. self.addCleanup(tear_down_repo, s)
  937. out = BytesIO()
  938. walker = {}
  939. ret = c.fetch_pack(
  940. s.path,
  941. lambda heads, depth=None: [],
  942. graph_walker=walker,
  943. pack_data=out.write,
  944. )
  945. self.assertEqual(
  946. {
  947. b"HEAD": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
  948. b"refs/heads/master": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
  949. b"refs/tags/mytag": b"28237f4dc30d0d462658d6b937b08a0f0b6ef55a",
  950. b"refs/tags/mytag-packed": b"b0931cadc54336e78a1d980420e3268903b57a50",
  951. },
  952. ret.refs,
  953. )
  954. self.assertEqual({b"HEAD": b"refs/heads/master"}, ret.symrefs)
  955. self.assertEqual(
  956. b"PACK\x00\x00\x00\x02\x00\x00\x00\x00\x02\x9d\x08"
  957. b"\x82;\xd8\xa8\xea\xb5\x10\xadj\xc7\\\x82<\xfd>\xd3\x1e",
  958. out.getvalue(),
  959. )
  960. def test_fetch_pack_none(self) -> None:
  961. c = LocalGitClient()
  962. s = open_repo("a.git")
  963. self.addCleanup(tear_down_repo, s)
  964. out = BytesIO()
  965. walker = MemoryRepo().get_graph_walker()
  966. ret = c.fetch_pack(
  967. s.path,
  968. lambda heads, depth=None: [b"a90fa2d900a17e99b433217e988c4eb4a2e9a097"],
  969. graph_walker=walker,
  970. pack_data=out.write,
  971. )
  972. self.assertEqual({b"HEAD": b"refs/heads/master"}, ret.symrefs)
  973. self.assertEqual(
  974. {
  975. b"HEAD": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
  976. b"refs/heads/master": b"a90fa2d900a17e99b433217e988c4eb4a2e9a097",
  977. b"refs/tags/mytag": b"28237f4dc30d0d462658d6b937b08a0f0b6ef55a",
  978. b"refs/tags/mytag-packed": b"b0931cadc54336e78a1d980420e3268903b57a50",
  979. },
  980. ret.refs,
  981. )
  982. # Hardcoding is not ideal, but we'll fix that some other day..
  983. self.assertTrue(
  984. out.getvalue().startswith(b"PACK\x00\x00\x00\x02\x00\x00\x00\x07")
  985. )
  986. def test_send_pack_without_changes(self) -> None:
  987. local = open_repo("a.git")
  988. self.addCleanup(tear_down_repo, local)
  989. target = open_repo("a.git")
  990. self.addCleanup(tear_down_repo, target)
  991. self.send_and_verify(b"master", local, target)
  992. def test_send_pack_with_changes(self) -> None:
  993. local = open_repo("a.git")
  994. self.addCleanup(tear_down_repo, local)
  995. target_path = tempfile.mkdtemp()
  996. self.addCleanup(shutil.rmtree, target_path)
  997. with Repo.init_bare(target_path) as target:
  998. self.send_and_verify(b"master", local, target)
  999. def test_get_refs(self) -> None:
  1000. local = open_repo("refs.git")
  1001. self.addCleanup(tear_down_repo, local)
  1002. client = LocalGitClient()
  1003. result = client.get_refs(local.path)
  1004. self.assertDictEqual(local.refs.as_dict(), result.refs)
  1005. # Check that symrefs are detected correctly
  1006. self.assertIn(b"HEAD", result.symrefs)
  1007. def send_and_verify(self, branch, local, target) -> None:
  1008. """Send branch from local to remote repository and verify it worked."""
  1009. client = LocalGitClient()
  1010. ref_name = b"refs/heads/" + branch
  1011. result = client.send_pack(
  1012. target.path,
  1013. lambda _: {ref_name: local.refs[ref_name]},
  1014. local.generate_pack_data,
  1015. )
  1016. self.assertEqual(local.refs[ref_name], result.refs[ref_name])
  1017. self.assertIs(None, result.agent)
  1018. self.assertEqual({}, result.ref_status)
  1019. obj_local = local.get_object(result.refs[ref_name])
  1020. obj_target = target.get_object(result.refs[ref_name])
  1021. self.assertEqual(obj_local, obj_target)
  1022. class BundleClientTests(TestCase):
  1023. def setUp(self) -> None:
  1024. super().setUp()
  1025. self.tempdir = tempfile.mkdtemp()
  1026. self.addCleanup(shutil.rmtree, self.tempdir)
  1027. def _create_test_bundle(self):
  1028. """Create a test bundle file and return its path."""
  1029. # Create a simple repository
  1030. repo = MemoryRepo()
  1031. # Create some objects
  1032. blob = Blob.from_string(b"Hello world")
  1033. repo.object_store.add_object(blob)
  1034. tree = Tree()
  1035. tree.add(b"hello.txt", 0o100644, blob.id)
  1036. repo.object_store.add_object(tree)
  1037. commit = Commit()
  1038. commit.tree = tree.id
  1039. commit.message = b"Initial commit"
  1040. commit.author = commit.committer = b"Test User <test@example.com>"
  1041. commit.commit_time = commit.author_time = 1234567890
  1042. commit.commit_timezone = commit.author_timezone = 0
  1043. repo.object_store.add_object(commit)
  1044. repo.refs[b"refs/heads/master"] = commit.id
  1045. # Create bundle
  1046. bundle = create_bundle_from_repo(repo)
  1047. # Write bundle to file
  1048. bundle_path = os.path.join(self.tempdir, "test.bundle")
  1049. with open(bundle_path, "wb") as f:
  1050. write_bundle(f, bundle)
  1051. return bundle_path, repo
  1052. def test_is_bundle_file(self) -> None:
  1053. """Test bundle file detection."""
  1054. bundle_path, _ = self._create_test_bundle()
  1055. # Test positive case
  1056. self.assertTrue(BundleClient._is_bundle_file(bundle_path))
  1057. # Test negative case - regular file
  1058. regular_file = os.path.join(self.tempdir, "regular.txt")
  1059. with open(regular_file, "w") as f:
  1060. f.write("not a bundle")
  1061. self.assertFalse(BundleClient._is_bundle_file(regular_file))
  1062. # Test negative case - non-existent file
  1063. self.assertFalse(BundleClient._is_bundle_file("/non/existent/file"))
  1064. def test_get_refs(self) -> None:
  1065. """Test getting refs from bundle."""
  1066. bundle_path, _ = self._create_test_bundle()
  1067. client = BundleClient()
  1068. result = client.get_refs(bundle_path)
  1069. self.assertIn(b"refs/heads/master", result.refs)
  1070. self.assertEqual(result.symrefs, {})
  1071. def test_fetch_pack(self) -> None:
  1072. """Test fetching pack from bundle."""
  1073. bundle_path, _source_repo = self._create_test_bundle()
  1074. client = BundleClient()
  1075. pack_data = BytesIO()
  1076. def determine_wants(refs):
  1077. return list(refs.values())
  1078. class MockGraphWalker:
  1079. def next(self):
  1080. return None
  1081. def ack(self, sha):
  1082. pass
  1083. result = client.fetch_pack(
  1084. bundle_path, determine_wants, MockGraphWalker(), pack_data.write
  1085. )
  1086. # Verify we got refs back
  1087. self.assertIn(b"refs/heads/master", result.refs)
  1088. # Verify pack data was written
  1089. self.assertGreater(len(pack_data.getvalue()), 0)
  1090. def test_fetch(self) -> None:
  1091. """Test fetching from bundle into target repo."""
  1092. bundle_path, _source_repo = self._create_test_bundle()
  1093. client = BundleClient()
  1094. target_repo = MemoryRepo()
  1095. result = client.fetch(bundle_path, target_repo)
  1096. # Verify refs were imported
  1097. self.assertIn(b"refs/heads/master", result.refs)
  1098. # Verify objects were imported
  1099. master_id = result.refs[b"refs/heads/master"]
  1100. self.assertIn(master_id, target_repo.object_store)
  1101. # Verify the commit object is correct
  1102. commit = target_repo.object_store[master_id]
  1103. self.assertEqual(commit.message, b"Initial commit")
  1104. def test_send_pack_not_supported(self) -> None:
  1105. """Test that send_pack raises NotImplementedError."""
  1106. bundle_path, _ = self._create_test_bundle()
  1107. client = BundleClient()
  1108. with self.assertRaises(NotImplementedError):
  1109. client.send_pack(bundle_path, None, None)
  1110. def test_get_transport_and_path_bundle(self) -> None:
  1111. """Test that get_transport_and_path detects bundle files."""
  1112. bundle_path, _ = self._create_test_bundle()
  1113. client, path = get_transport_and_path(bundle_path)
  1114. self.assertIsInstance(client, BundleClient)
  1115. self.assertEqual(path, bundle_path)
  1116. class HttpGitClientTests(TestCase):
  1117. def test_get_url(self) -> None:
  1118. base_url = "https://github.com/jelmer/dulwich"
  1119. path = "/jelmer/dulwich"
  1120. c = HttpGitClient(base_url)
  1121. url = c.get_url(path)
  1122. self.assertEqual("https://github.com/jelmer/dulwich", url)
  1123. def test_get_url_bytes_path(self) -> None:
  1124. base_url = "https://github.com/jelmer/dulwich"
  1125. path_bytes = b"/jelmer/dulwich"
  1126. c = HttpGitClient(base_url)
  1127. url = c.get_url(path_bytes)
  1128. self.assertEqual("https://github.com/jelmer/dulwich", url)
  1129. def test_get_url_with_username_and_passwd(self) -> None:
  1130. base_url = "https://github.com/jelmer/dulwich"
  1131. path = "/jelmer/dulwich"
  1132. c = HttpGitClient(base_url, username="USERNAME", password="PASSWD")
  1133. url = c.get_url(path)
  1134. self.assertEqual("https://github.com/jelmer/dulwich", url)
  1135. def test_init_username_passwd_set(self) -> None:
  1136. url = "https://github.com/jelmer/dulwich"
  1137. c = HttpGitClient(url, config=None, username="user", password="passwd")
  1138. self.assertEqual("user", c._username)
  1139. self.assertEqual("passwd", c._password)
  1140. basic_auth = c.pool_manager.headers["authorization"]
  1141. auth_string = "{}:{}".format("user", "passwd")
  1142. b64_credentials = base64.b64encode(auth_string.encode("latin1"))
  1143. expected_basic_auth = "Basic {}".format(b64_credentials.decode("latin1"))
  1144. self.assertEqual(basic_auth, expected_basic_auth)
  1145. def test_init_username_set_no_password(self) -> None:
  1146. url = "https://github.com/jelmer/dulwich"
  1147. c = HttpGitClient(url, config=None, username="user")
  1148. self.assertEqual("user", c._username)
  1149. self.assertIsNone(c._password)
  1150. basic_auth = c.pool_manager.headers["authorization"]
  1151. auth_string = b"user:"
  1152. b64_credentials = base64.b64encode(auth_string)
  1153. expected_basic_auth = f"Basic {b64_credentials.decode('ascii')}"
  1154. self.assertEqual(basic_auth, expected_basic_auth)
  1155. def test_init_no_username_passwd(self) -> None:
  1156. url = "https://github.com/jelmer/dulwich"
  1157. c = HttpGitClient(url, config=None)
  1158. self.assertIs(None, c._username)
  1159. self.assertIs(None, c._password)
  1160. self.assertNotIn("authorization", c.pool_manager.headers)
  1161. def test_from_parsedurl_username_only(self) -> None:
  1162. username = "user"
  1163. url = f"https://{username}@github.com/jelmer/dulwich"
  1164. c = HttpGitClient.from_parsedurl(urlparse(url))
  1165. self.assertEqual(c._username, username)
  1166. self.assertEqual(c._password, None)
  1167. basic_auth = c.pool_manager.headers["authorization"]
  1168. auth_string = username.encode("ascii") + b":"
  1169. b64_credentials = base64.b64encode(auth_string)
  1170. expected_basic_auth = f"Basic {b64_credentials.decode('ascii')}"
  1171. self.assertEqual(basic_auth, expected_basic_auth)
  1172. def test_from_parsedurl_on_url_with_quoted_credentials(self) -> None:
  1173. original_username = "john|the|first"
  1174. quoted_username = urlquote(original_username)
  1175. original_password = "Ya#1$2%3"
  1176. quoted_password = urlquote(original_password)
  1177. url = f"https://{quoted_username}:{quoted_password}@github.com/jelmer/dulwich"
  1178. c = HttpGitClient.from_parsedurl(urlparse(url))
  1179. self.assertEqual(original_username, c._username)
  1180. self.assertEqual(original_password, c._password)
  1181. basic_auth = c.pool_manager.headers["authorization"]
  1182. auth_string = f"{original_username}:{original_password}"
  1183. b64_credentials = base64.b64encode(auth_string.encode("latin1"))
  1184. expected_basic_auth = "Basic {}".format(b64_credentials.decode("latin1"))
  1185. self.assertEqual(basic_auth, expected_basic_auth)
  1186. def test_url_redirect_location(self) -> None:
  1187. from urllib3.response import HTTPResponse
  1188. test_data = {
  1189. "https://gitlab.com/inkscape/inkscape/": {
  1190. "location": "https://gitlab.com/inkscape/inkscape.git/",
  1191. "redirect_url": "https://gitlab.com/inkscape/inkscape.git/",
  1192. "refs_data": (
  1193. b"001e# service=git-upload-pack\n00000032"
  1194. b"fb2bebf4919a011f0fd7cec085443d0031228e76 "
  1195. b"HEAD\n0000"
  1196. ),
  1197. },
  1198. "https://github.com/jelmer/dulwich/": {
  1199. "location": "https://github.com/jelmer/dulwich/",
  1200. "redirect_url": "https://github.com/jelmer/dulwich/",
  1201. "refs_data": (
  1202. b"001e# service=git-upload-pack\n00000032"
  1203. b"3ff25e09724aa4d86ea5bca7d5dd0399a3c8bfcf "
  1204. b"HEAD\n0000"
  1205. ),
  1206. },
  1207. # check for absolute-path URI reference as location
  1208. "https://codeberg.org/ashwinvis/radicale-sh.git/": {
  1209. "location": "/ashwinvis/radicale-auth-sh/",
  1210. "redirect_url": "https://codeberg.org/ashwinvis/radicale-auth-sh/",
  1211. "refs_data": (
  1212. b"001e# service=git-upload-pack\n00000032"
  1213. b"470f8603768b608fc988675de2fae8f963c21158 "
  1214. b"HEAD\n0000"
  1215. ),
  1216. },
  1217. }
  1218. tail = "info/refs?service=git-upload-pack"
  1219. # we need to mock urllib3.PoolManager as this test will fail
  1220. # otherwise without an active internet connection
  1221. class PoolManagerMock:
  1222. def __init__(self) -> None:
  1223. self.headers: dict[str, str] = {}
  1224. def request(
  1225. self,
  1226. method,
  1227. url,
  1228. fields=None,
  1229. headers=None,
  1230. redirect=True,
  1231. preload_content=True,
  1232. ):
  1233. base_url = url[: -len(tail)]
  1234. redirect_base_url = test_data[base_url]["location"]
  1235. redirect_url = redirect_base_url + tail
  1236. headers = {
  1237. "Content-Type": "application/x-git-upload-pack-advertisement"
  1238. }
  1239. body = test_data[base_url]["refs_data"]
  1240. # urllib3 handles automatic redirection by default
  1241. status = 200
  1242. request_url = redirect_url
  1243. # simulate urllib3 behavior when redirect parameter is False
  1244. if redirect is False:
  1245. request_url = url
  1246. if redirect_base_url != base_url:
  1247. body = b""
  1248. headers["location"] = test_data[base_url]["location"]
  1249. status = 301
  1250. return HTTPResponse(
  1251. body=BytesIO(body),
  1252. headers=headers,
  1253. request_method=method,
  1254. request_url=request_url,
  1255. preload_content=preload_content,
  1256. status=status,
  1257. )
  1258. pool_manager = PoolManagerMock()
  1259. for base_url in test_data.keys():
  1260. # instantiate HttpGitClient with mocked pool manager
  1261. c = HttpGitClient(base_url, pool_manager=pool_manager, config=None)
  1262. # call method that detects url redirection
  1263. _, _, processed_url, _, _ = c._discover_references(
  1264. b"git-upload-pack", base_url
  1265. )
  1266. # send the same request as the method above without redirection
  1267. resp = c.pool_manager.request("GET", base_url + tail, redirect=False)
  1268. # check expected behavior of urllib3
  1269. redirect_location = resp.get_redirect_location()
  1270. if resp.status == 200:
  1271. self.assertFalse(redirect_location)
  1272. if redirect_location:
  1273. # check that url redirection has been correctly detected
  1274. self.assertEqual(processed_url, test_data[base_url]["redirect_url"])
  1275. else:
  1276. # check also the no redirection case
  1277. self.assertEqual(processed_url, base_url)
  1278. def test_smart_request_content_type_with_directive_check(self) -> None:
  1279. from urllib3.response import HTTPResponse
  1280. # we need to mock urllib3.PoolManager as this test will fail
  1281. # otherwise without an active internet connection
  1282. class PoolManagerMock:
  1283. def __init__(self) -> None:
  1284. self.headers: dict[str, str] = {}
  1285. def request(
  1286. self,
  1287. method,
  1288. url,
  1289. fields=None,
  1290. headers=None,
  1291. redirect=True,
  1292. preload_content=True,
  1293. ):
  1294. return HTTPResponse(
  1295. headers={
  1296. "Content-Type": "application/x-git-upload-pack-result; charset=utf-8"
  1297. },
  1298. request_method=method,
  1299. request_url=url,
  1300. preload_content=preload_content,
  1301. status=200,
  1302. )
  1303. clone_url = "https://hacktivis.me/git/blog.git/"
  1304. client = HttpGitClient(clone_url, pool_manager=PoolManagerMock(), config=None)
  1305. self.assertTrue(client._smart_request("git-upload-pack", clone_url, data=None))
  1306. def test_urllib3_protocol_error(self) -> None:
  1307. from urllib3.exceptions import ProtocolError
  1308. from urllib3.response import HTTPResponse
  1309. error_msg = "protocol error"
  1310. # we need to mock urllib3.PoolManager as this test will fail
  1311. # otherwise without an active internet connection
  1312. class PoolManagerMock:
  1313. def __init__(self) -> None:
  1314. self.headers: dict[str, str] = {}
  1315. def request(
  1316. self,
  1317. method,
  1318. url,
  1319. fields=None,
  1320. headers=None,
  1321. redirect=True,
  1322. preload_content=True,
  1323. ):
  1324. response = HTTPResponse(
  1325. headers={"Content-Type": "application/x-git-upload-pack-result"},
  1326. request_method=method,
  1327. request_url=url,
  1328. preload_content=preload_content,
  1329. status=200,
  1330. )
  1331. def read(self) -> NoReturn:
  1332. raise ProtocolError(error_msg)
  1333. # override HTTPResponse.read to throw urllib3.exceptions.ProtocolError
  1334. response.read = read
  1335. return response
  1336. def check_heads(heads, **kwargs):
  1337. self.assertEqual(heads, {})
  1338. return []
  1339. clone_url = "https://git.example.org/user/project.git/"
  1340. client = HttpGitClient(clone_url, pool_manager=PoolManagerMock(), config=None)
  1341. with self.assertRaises(GitProtocolError, msg=error_msg):
  1342. client.fetch_pack(b"/", check_heads, None, None)
  1343. def test_fetch_pack_dumb_http(self) -> None:
  1344. import zlib
  1345. from urllib3.response import HTTPResponse
  1346. # Mock responses for dumb HTTP
  1347. info_refs_content = (
  1348. b"0123456789abcdef0123456789abcdef01234567\trefs/heads/master\n"
  1349. )
  1350. head_content = b"ref: refs/heads/master"
  1351. # Create a blob object for testing
  1352. blob_content = b"Hello, dumb HTTP!"
  1353. blob_sha = b"0123456789abcdef0123456789abcdef01234567"
  1354. blob_hex = blob_sha.decode("ascii")
  1355. blob_obj_data = (
  1356. b"blob " + str(len(blob_content)).encode() + b"\x00" + blob_content
  1357. )
  1358. blob_compressed = zlib.compress(blob_obj_data)
  1359. responses = {
  1360. "/HEAD": {
  1361. "status": 200,
  1362. "content": head_content,
  1363. "content_type": "text/plain",
  1364. },
  1365. "/git-upload-pack": {
  1366. "status": 404,
  1367. "content": b"Not Found",
  1368. "content_type": "text/plain",
  1369. },
  1370. "/info/refs": {
  1371. "status": 200,
  1372. "content": info_refs_content,
  1373. "content_type": "text/plain",
  1374. },
  1375. f"/objects/{blob_hex[:2]}/{blob_hex[2:]}": {
  1376. "status": 200,
  1377. "content": blob_compressed,
  1378. "content_type": "application/octet-stream",
  1379. },
  1380. }
  1381. class PoolManagerMock:
  1382. def __init__(self) -> None:
  1383. self.headers: dict[str, str] = {}
  1384. def request(
  1385. self,
  1386. method,
  1387. url,
  1388. fields=None,
  1389. headers=None,
  1390. redirect=True,
  1391. preload_content=True,
  1392. ):
  1393. # Extract path from URL
  1394. from urllib.parse import urlparse
  1395. parsed = urlparse(url)
  1396. path = parsed.path.rstrip("/")
  1397. # Find matching response
  1398. for pattern, resp_data in responses.items():
  1399. if path.endswith(pattern):
  1400. return HTTPResponse(
  1401. body=BytesIO(resp_data["content"]),
  1402. headers={
  1403. "Content-Type": resp_data.get(
  1404. "content_type", "text/plain"
  1405. )
  1406. },
  1407. request_method=method,
  1408. request_url=url,
  1409. preload_content=preload_content,
  1410. status=resp_data["status"],
  1411. )
  1412. # Default 404
  1413. return HTTPResponse(
  1414. body=BytesIO(b"Not Found"),
  1415. headers={"Content-Type": "text/plain"},
  1416. request_method=method,
  1417. request_url=url,
  1418. preload_content=preload_content,
  1419. status=404,
  1420. )
  1421. def determine_wants(heads, **kwargs):
  1422. # heads contains the refs with SHA values, just return the SHA we want
  1423. return [heads[b"refs/heads/master"]]
  1424. received_data = []
  1425. def pack_data_handler(data):
  1426. # Collect pack data
  1427. received_data.append(data)
  1428. clone_url = "https://git.example.org/repo.git/"
  1429. client = HttpGitClient(clone_url, pool_manager=PoolManagerMock(), config=None)
  1430. # Mock graph walker that says we don't have anything
  1431. class MockGraphWalker:
  1432. def ack(self, sha):
  1433. return []
  1434. graph_walker = MockGraphWalker()
  1435. result = client.fetch_pack(
  1436. b"/", determine_wants, graph_walker, pack_data_handler
  1437. )
  1438. # Verify we got the refs
  1439. expected_sha = blob_hex.encode("ascii")
  1440. self.assertEqual({b"refs/heads/master": expected_sha}, result.refs)
  1441. # Verify we received pack data
  1442. self.assertTrue(len(received_data) > 0)
  1443. pack_data = b"".join(received_data)
  1444. self.assertTrue(len(pack_data) > 0)
  1445. # The pack should be valid pack format
  1446. self.assertTrue(pack_data.startswith(b"PACK"))
  1447. # Pack header: PACK + version (4 bytes) + num objects (4 bytes)
  1448. self.assertEqual(pack_data[4:8], b"\x00\x00\x00\x02") # version 2
  1449. self.assertEqual(pack_data[8:12], b"\x00\x00\x00\x01") # 1 object
  1450. def test_timeout_configuration(self) -> None:
  1451. """Test that timeout parameter is properly configured."""
  1452. url = "https://github.com/jelmer/dulwich"
  1453. timeout = 30
  1454. c = HttpGitClient(url, timeout=timeout)
  1455. self.assertEqual(c._timeout, timeout)
  1456. def test_timeout_from_config(self) -> None:
  1457. """Test that timeout can be configured via git config."""
  1458. from dulwich.config import ConfigDict
  1459. url = "https://github.com/jelmer/dulwich"
  1460. config = ConfigDict()
  1461. config.set((b"http",), b"timeout", b"25")
  1462. c = HttpGitClient(url, config=config)
  1463. # The timeout should be set on the pool manager
  1464. # Since we can't easily access the timeout from the pool manager,
  1465. # we just verify the client was created successfully
  1466. self.assertIsNotNone(c.pool_manager)
  1467. def test_timeout_parameter_precedence(self) -> None:
  1468. """Test that explicit timeout parameter takes precedence over config."""
  1469. from dulwich.config import ConfigDict
  1470. url = "https://github.com/jelmer/dulwich"
  1471. config = ConfigDict()
  1472. config.set((b"http",), b"timeout", b"25")
  1473. c = HttpGitClient(url, config=config, timeout=15)
  1474. self.assertEqual(c._timeout, 15)
  1475. def test_http_extra_headers_from_config(self) -> None:
  1476. """Test that http.extraHeader config values are applied."""
  1477. from dulwich.config import ConfigDict
  1478. url = "https://github.com/jelmer/dulwich"
  1479. config = ConfigDict()
  1480. # Set a single extra header
  1481. config.set((b"http",), b"extraHeader", b"X-Custom-Header: test-value")
  1482. c = HttpGitClient(url, config=config)
  1483. # Check that the header was added to the pool manager
  1484. self.assertIn("X-Custom-Header", c.pool_manager.headers)
  1485. self.assertEqual(c.pool_manager.headers["X-Custom-Header"], "test-value")
  1486. def test_http_multiple_extra_headers_from_config(self) -> None:
  1487. """Test that multiple http.extraHeader config values are applied."""
  1488. from dulwich.config import ConfigDict
  1489. url = "https://github.com/jelmer/dulwich"
  1490. config = ConfigDict()
  1491. # Set multiple extra headers
  1492. config.set((b"http",), b"extraHeader", b"X-Header-1: value1")
  1493. config.add((b"http",), b"extraHeader", b"X-Header-2: value2")
  1494. config.add((b"http",), b"extraHeader", b"Authorization: Bearer token123")
  1495. c = HttpGitClient(url, config=config)
  1496. # Check that all headers were added to the pool manager
  1497. self.assertIn("X-Header-1", c.pool_manager.headers)
  1498. self.assertEqual(c.pool_manager.headers["X-Header-1"], "value1")
  1499. self.assertIn("X-Header-2", c.pool_manager.headers)
  1500. self.assertEqual(c.pool_manager.headers["X-Header-2"], "value2")
  1501. self.assertIn("Authorization", c.pool_manager.headers)
  1502. self.assertEqual(c.pool_manager.headers["Authorization"], "Bearer token123")
  1503. def test_http_extra_headers_per_url_config(self) -> None:
  1504. """Test that per-URL http.extraHeader config values are applied (issue #882)."""
  1505. from dulwich.config import ConfigDict
  1506. url = "https://github.com/jelmer/dulwich"
  1507. config = ConfigDict()
  1508. # Set URL-specific extra header
  1509. config.set(
  1510. (b"http", b"https://github.com/"),
  1511. b"extraHeader",
  1512. b"Authorization: basic token123",
  1513. )
  1514. c = HttpGitClient(url, config=config)
  1515. # Check that the header was added to the pool manager
  1516. self.assertIn("Authorization", c.pool_manager.headers)
  1517. self.assertEqual(c.pool_manager.headers["Authorization"], "basic token123")
  1518. def test_http_extra_headers_url_specificity(self) -> None:
  1519. """Test that more specific URL configs override less specific ones."""
  1520. from dulwich.config import ConfigDict
  1521. url = "https://github.com/jelmer/dulwich"
  1522. config = ConfigDict()
  1523. # Set global header
  1524. config.set((b"http",), b"extraHeader", b"X-Global: global-value")
  1525. # Set host-specific header (overrides global)
  1526. config.set(
  1527. (b"http", b"https://github.com/"), b"extraHeader", b"X-Global: github-value"
  1528. )
  1529. config.add(
  1530. (b"http", b"https://github.com/"),
  1531. b"extraHeader",
  1532. b"Authorization: Bearer token123",
  1533. )
  1534. c = HttpGitClient(url, config=config)
  1535. # More specific setting should win
  1536. self.assertEqual(c.pool_manager.headers["X-Global"], "github-value")
  1537. self.assertEqual(c.pool_manager.headers["Authorization"], "Bearer token123")
  1538. def test_http_extra_headers_multiple_url_configs(self) -> None:
  1539. """Test that different URLs can have different extra headers."""
  1540. from dulwich.config import ConfigDict
  1541. config = ConfigDict()
  1542. # Set different headers for different URLs
  1543. config.set(
  1544. (b"http", b"https://github.com/"),
  1545. b"extraHeader",
  1546. b"Authorization: Bearer github-token",
  1547. )
  1548. config.set(
  1549. (b"http", b"https://gitlab.com/"),
  1550. b"extraHeader",
  1551. b"Authorization: Bearer gitlab-token",
  1552. )
  1553. # Test GitHub URL
  1554. c1 = HttpGitClient("https://github.com/user/repo", config=config)
  1555. self.assertEqual(
  1556. c1.pool_manager.headers["Authorization"], "Bearer github-token"
  1557. )
  1558. # Test GitLab URL
  1559. c2 = HttpGitClient("https://gitlab.com/user/repo", config=config)
  1560. self.assertEqual(
  1561. c2.pool_manager.headers["Authorization"], "Bearer gitlab-token"
  1562. )
  1563. def test_http_extra_headers_no_match(self) -> None:
  1564. """Test that non-matching URL configs don't apply."""
  1565. from dulwich.config import ConfigDict
  1566. url = "https://example.com/repo"
  1567. config = ConfigDict()
  1568. # Set header only for GitHub
  1569. config.set(
  1570. (b"http", b"https://github.com/"),
  1571. b"extraHeader",
  1572. b"Authorization: Bearer token123",
  1573. )
  1574. c = HttpGitClient(url, config=config)
  1575. # Authorization header should not be present for example.com
  1576. self.assertNotIn("Authorization", c.pool_manager.headers)
  1577. def test_http_extra_headers_invalid_format(self) -> None:
  1578. """Test that invalid extra headers trigger warnings."""
  1579. import logging
  1580. from dulwich.config import ConfigDict
  1581. url = "https://github.com/jelmer/dulwich"
  1582. config = ConfigDict()
  1583. # Set valid header
  1584. config.set((b"http",), b"extraHeader", b"X-Valid: valid-value")
  1585. # Set invalid headers (no colon-space separator)
  1586. config.add((b"http",), b"extraHeader", b"X-Invalid-No-Separator")
  1587. # Set empty header
  1588. config.add((b"http",), b"extraHeader", b"")
  1589. # Set another valid header to verify we continue processing
  1590. config.add((b"http",), b"extraHeader", b"X-Another-Valid: another-value")
  1591. with self.assertLogs("dulwich.client", level=logging.WARNING) as cm:
  1592. c = HttpGitClient(url, config=config)
  1593. # Check that warnings were logged
  1594. self.assertEqual(len(cm.output), 2)
  1595. self.assertIn("missing ': ' separator", cm.output[0])
  1596. self.assertIn("empty http.extraHeader", cm.output[1])
  1597. # Valid headers should still be applied
  1598. self.assertIn("X-Valid", c.pool_manager.headers)
  1599. self.assertEqual(c.pool_manager.headers["X-Valid"], "valid-value")
  1600. self.assertIn("X-Another-Valid", c.pool_manager.headers)
  1601. self.assertEqual(c.pool_manager.headers["X-Another-Valid"], "another-value")
  1602. # Invalid header should not be present
  1603. self.assertNotIn("X-Invalid-No-Separator", c.pool_manager.headers)
  1604. def test_get_url_preserves_credentials_from_url(self) -> None:
  1605. """Test that credentials from URL are preserved in get_url() (issue #1925)."""
  1606. # When credentials come from the URL (not passed explicitly),
  1607. # they should be included in get_url() so they're saved to git config
  1608. username = "ghp_token123"
  1609. url = f"https://{username}@github.com/jelmer/dulwich"
  1610. path = "/jelmer/dulwich"
  1611. c = HttpGitClient.from_parsedurl(urlparse(url))
  1612. reconstructed_url = c.get_url(path)
  1613. # Credentials should be preserved in the URL
  1614. self.assertIn(username, reconstructed_url)
  1615. self.assertEqual(
  1616. f"https://{username}@github.com/jelmer/dulwich", reconstructed_url
  1617. )
  1618. def test_get_url_preserves_credentials_with_password_from_url(self) -> None:
  1619. """Test that username:password from URL are preserved in get_url()."""
  1620. username = "user"
  1621. password = "pass"
  1622. url = f"https://{username}:{password}@github.com/jelmer/dulwich"
  1623. path = "/jelmer/dulwich"
  1624. c = HttpGitClient.from_parsedurl(urlparse(url))
  1625. reconstructed_url = c.get_url(path)
  1626. # Both username and password should be preserved
  1627. self.assertIn(username, reconstructed_url)
  1628. self.assertIn(password, reconstructed_url)
  1629. self.assertEqual(
  1630. f"https://{username}:{password}@github.com/jelmer/dulwich",
  1631. reconstructed_url,
  1632. )
  1633. def test_get_url_preserves_special_chars_in_credentials(self) -> None:
  1634. """Test that special characters in credentials are properly escaped."""
  1635. # URL-encoded credentials with special characters
  1636. original_username = "user@domain"
  1637. original_password = "p@ss:word"
  1638. quoted_username = urlquote(original_username, safe="")
  1639. quoted_password = urlquote(original_password, safe="")
  1640. url = f"https://{quoted_username}:{quoted_password}@github.com/jelmer/dulwich"
  1641. path = "/jelmer/dulwich"
  1642. c = HttpGitClient.from_parsedurl(urlparse(url))
  1643. reconstructed_url = c.get_url(path)
  1644. # The reconstructed URL should have properly escaped credentials
  1645. self.assertIn(quoted_username, reconstructed_url)
  1646. self.assertIn(quoted_password, reconstructed_url)
  1647. # Verify the URL is valid by parsing it back
  1648. parsed = urlparse(reconstructed_url)
  1649. from urllib.parse import unquote
  1650. self.assertEqual(unquote(parsed.username), original_username)
  1651. self.assertEqual(unquote(parsed.password), original_password)
  1652. def test_get_url_explicit_credentials_not_in_url(self) -> None:
  1653. """Test that explicitly passed credentials are NOT included in get_url()."""
  1654. # When credentials are passed explicitly (not from URL),
  1655. # they should NOT appear in get_url() for security
  1656. base_url = "https://github.com/jelmer/dulwich"
  1657. path = "/jelmer/dulwich"
  1658. username = "explicit_user"
  1659. password = "explicit_pass"
  1660. c = HttpGitClient(base_url, username=username, password=password)
  1661. url = c.get_url(path)
  1662. # Credentials should NOT be in the URL
  1663. self.assertNotIn(username, url)
  1664. self.assertNotIn(password, url)
  1665. self.assertEqual("https://github.com/jelmer/dulwich", url)
  1666. def test_pool_manager_parameter(self) -> None:
  1667. """Test that pool_manager parameter is properly passed through."""
  1668. import urllib3
  1669. # Create a custom pool manager
  1670. custom_pool_manager = urllib3.PoolManager()
  1671. # Test with get_transport_and_path_from_url
  1672. url = "https://github.com/jelmer/dulwich"
  1673. client, _path = get_transport_and_path_from_url(
  1674. url, pool_manager=custom_pool_manager
  1675. )
  1676. # Verify the client is an HTTP client and has our custom pool manager
  1677. self.assertIsInstance(client, HttpGitClient)
  1678. self.assertIs(client.pool_manager, custom_pool_manager)
  1679. # Test with get_transport_and_path
  1680. client2, _path2 = get_transport_and_path(url, pool_manager=custom_pool_manager)
  1681. # Verify the client is an HTTP client and has our custom pool manager
  1682. self.assertIsInstance(client2, HttpGitClient)
  1683. self.assertIs(client2.pool_manager, custom_pool_manager)
  1684. def test_urllib3_subclass_support(self) -> None:
  1685. """Test that subclasses of Urllib3HttpGitClient are properly supported.
  1686. This test verifies that the bug fix for commit d1f41c5c works correctly.
  1687. Previously, the code used `cls is Urllib3HttpGitClient` which failed for
  1688. subclasses. Now it uses `issubclass(cls, Urllib3HttpGitClient)` which
  1689. correctly handles subclasses.
  1690. """
  1691. # Create a custom subclass of Urllib3HttpGitClient
  1692. class CustomUrllib3HttpGitClient(Urllib3HttpGitClient):
  1693. def __init__(self, *args, **kwargs):
  1694. super().__init__(*args, **kwargs)
  1695. self.custom_attribute = "custom_value"
  1696. # Test with AbstractHttpGitClient.from_parsedurl directly
  1697. # This is how subclasses use the client
  1698. from urllib.parse import urlparse
  1699. parsed = urlparse("https://github.com/jelmer/dulwich")
  1700. config = ConfigDict()
  1701. client = CustomUrllib3HttpGitClient.from_parsedurl(parsed, config=config)
  1702. # Verify the client is our custom subclass
  1703. self.assertIsInstance(client, CustomUrllib3HttpGitClient)
  1704. self.assertIsInstance(client, Urllib3HttpGitClient)
  1705. self.assertEqual("custom_value", client.custom_attribute)
  1706. # Verify the config was passed through (this was the bug - it wasn't passed to subclasses before)
  1707. self.assertIsNotNone(client.config)
  1708. class TCPGitClientTests(TestCase):
  1709. def test_get_url(self) -> None:
  1710. host = "github.com"
  1711. path = "/jelmer/dulwich"
  1712. c = TCPGitClient(host)
  1713. url = c.get_url(path)
  1714. self.assertEqual("git://github.com/jelmer/dulwich", url)
  1715. def test_get_url_with_port(self) -> None:
  1716. host = "github.com"
  1717. path = "/jelmer/dulwich"
  1718. port = 9090
  1719. c = TCPGitClient(host, port=port)
  1720. url = c.get_url(path)
  1721. self.assertEqual("git://github.com:9090/jelmer/dulwich", url)
  1722. def test_get_url_with_ipv6(self) -> None:
  1723. host = "::1"
  1724. path = "/jelmer/dulwich"
  1725. c = TCPGitClient(host)
  1726. url = c.get_url(path)
  1727. self.assertEqual("git://[::1]/jelmer/dulwich", url)
  1728. def test_get_url_with_ipv6_and_port(self) -> None:
  1729. host = "2001:db8::1"
  1730. path = "/jelmer/dulwich"
  1731. port = 9090
  1732. c = TCPGitClient(host, port=port)
  1733. url = c.get_url(path)
  1734. self.assertEqual("git://[2001:db8::1]:9090/jelmer/dulwich", url)
  1735. def test_get_url_with_ipv6_default_port(self) -> None:
  1736. host = "2001:db8::1"
  1737. path = "/jelmer/dulwich"
  1738. port = TCP_GIT_PORT # Default port should not be included in URL
  1739. c = TCPGitClient(host, port=port)
  1740. url = c.get_url(path)
  1741. self.assertEqual("git://[2001:db8::1]/jelmer/dulwich", url)
  1742. class DefaultUrllib3ManagerTest(TestCase):
  1743. def test_no_config(self) -> None:
  1744. manager = default_urllib3_manager(config=None)
  1745. self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_REQUIRED")
  1746. def test_config_no_proxy(self) -> None:
  1747. import urllib3
  1748. manager = default_urllib3_manager(config=ConfigDict())
  1749. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1750. self.assertIsInstance(manager, urllib3.PoolManager)
  1751. def test_config_no_proxy_custom_cls(self) -> None:
  1752. import urllib3
  1753. class CustomPoolManager(urllib3.PoolManager):
  1754. pass
  1755. manager = default_urllib3_manager(
  1756. config=ConfigDict(), pool_manager_cls=CustomPoolManager
  1757. )
  1758. self.assertIsInstance(manager, CustomPoolManager)
  1759. def test_config_ssl(self) -> None:
  1760. config = ConfigDict()
  1761. config.set(b"http", b"sslVerify", b"true")
  1762. manager = default_urllib3_manager(config=config)
  1763. self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_REQUIRED")
  1764. def test_config_no_ssl(self) -> None:
  1765. config = ConfigDict()
  1766. config.set(b"http", b"sslVerify", b"false")
  1767. manager = default_urllib3_manager(config=config)
  1768. self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_NONE")
  1769. def test_config_proxy(self) -> None:
  1770. import urllib3
  1771. config = ConfigDict()
  1772. config.set(b"http", b"proxy", b"http://localhost:3128/")
  1773. manager = default_urllib3_manager(config=config)
  1774. self.assertIsInstance(manager, urllib3.ProxyManager)
  1775. self.assertTrue(hasattr(manager, "proxy"))
  1776. self.assertEqual(manager.proxy.scheme, "http")
  1777. self.assertEqual(manager.proxy.host, "localhost")
  1778. self.assertEqual(manager.proxy.port, 3128)
  1779. def test_environment_proxy(self) -> None:
  1780. import urllib3
  1781. config = ConfigDict()
  1782. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1783. manager = default_urllib3_manager(config=config)
  1784. self.assertIsInstance(manager, urllib3.ProxyManager)
  1785. self.assertTrue(hasattr(manager, "proxy"))
  1786. self.assertEqual(manager.proxy.scheme, "http")
  1787. self.assertEqual(manager.proxy.host, "myproxy")
  1788. self.assertEqual(manager.proxy.port, 8080)
  1789. def test_environment_empty_proxy(self) -> None:
  1790. import urllib3
  1791. config = ConfigDict()
  1792. self.overrideEnv("http_proxy", "")
  1793. manager = default_urllib3_manager(config=config)
  1794. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1795. self.assertIsInstance(manager, urllib3.PoolManager)
  1796. def test_environment_no_proxy_1(self) -> None:
  1797. import urllib3
  1798. config = ConfigDict()
  1799. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1800. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh")
  1801. base_url = "http://xyz.abc.def.gh:8080/path/port"
  1802. manager = default_urllib3_manager(config=config, base_url=base_url)
  1803. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1804. self.assertIsInstance(manager, urllib3.PoolManager)
  1805. def test_environment_no_proxy_2(self) -> None:
  1806. import urllib3
  1807. config = ConfigDict()
  1808. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1809. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1810. base_url = "http://ample.com/path/port"
  1811. manager = default_urllib3_manager(config=config, base_url=base_url)
  1812. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1813. self.assertIsInstance(manager, urllib3.PoolManager)
  1814. def test_environment_no_proxy_3(self) -> None:
  1815. import urllib3
  1816. config = ConfigDict()
  1817. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1818. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1819. base_url = "http://ample.com:80/path/port"
  1820. manager = default_urllib3_manager(config=config, base_url=base_url)
  1821. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1822. self.assertIsInstance(manager, urllib3.PoolManager)
  1823. def test_environment_no_proxy_4(self) -> None:
  1824. import urllib3
  1825. config = ConfigDict()
  1826. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1827. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1828. base_url = "http://www.ample.com/path/port"
  1829. manager = default_urllib3_manager(config=config, base_url=base_url)
  1830. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1831. self.assertIsInstance(manager, urllib3.PoolManager)
  1832. def test_environment_no_proxy_5(self) -> None:
  1833. import urllib3
  1834. config = ConfigDict()
  1835. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1836. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1837. base_url = "http://www.example.com/path/port"
  1838. manager = default_urllib3_manager(config=config, base_url=base_url)
  1839. self.assertIsInstance(manager, urllib3.ProxyManager)
  1840. self.assertTrue(hasattr(manager, "proxy"))
  1841. self.assertEqual(manager.proxy.scheme, "http")
  1842. self.assertEqual(manager.proxy.host, "myproxy")
  1843. self.assertEqual(manager.proxy.port, 8080)
  1844. def test_environment_no_proxy_6(self) -> None:
  1845. import urllib3
  1846. config = ConfigDict()
  1847. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1848. self.overrideEnv("no_proxy", "xyz,abc.def.gh,abc.gh,ample.com")
  1849. base_url = "http://ample.com.org/path/port"
  1850. manager = default_urllib3_manager(config=config, base_url=base_url)
  1851. self.assertIsInstance(manager, urllib3.ProxyManager)
  1852. self.assertTrue(hasattr(manager, "proxy"))
  1853. self.assertEqual(manager.proxy.scheme, "http")
  1854. self.assertEqual(manager.proxy.host, "myproxy")
  1855. self.assertEqual(manager.proxy.port, 8080)
  1856. def test_environment_no_proxy_ipv4_address_1(self) -> None:
  1857. import urllib3
  1858. config = ConfigDict()
  1859. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1860. self.overrideEnv("no_proxy", "xyz,abc.def.gh,192.168.0.10,ample.com")
  1861. base_url = "http://192.168.0.10/path/port"
  1862. manager = default_urllib3_manager(config=config, base_url=base_url)
  1863. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1864. self.assertIsInstance(manager, urllib3.PoolManager)
  1865. def test_environment_no_proxy_ipv4_address_2(self) -> None:
  1866. import urllib3
  1867. config = ConfigDict()
  1868. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1869. self.overrideEnv("no_proxy", "xyz,abc.def.gh,192.168.0.10,ample.com")
  1870. base_url = "http://192.168.0.10:8888/path/port"
  1871. manager = default_urllib3_manager(config=config, base_url=base_url)
  1872. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1873. self.assertIsInstance(manager, urllib3.PoolManager)
  1874. def test_environment_no_proxy_ipv4_address_3(self) -> None:
  1875. import urllib3
  1876. config = ConfigDict()
  1877. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1878. self.overrideEnv(
  1879. "no_proxy", "xyz,abc.def.gh,ff80:1::/64,192.168.0.0/24,ample.com"
  1880. )
  1881. base_url = "http://192.168.0.10/path/port"
  1882. manager = default_urllib3_manager(config=config, base_url=base_url)
  1883. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1884. self.assertIsInstance(manager, urllib3.PoolManager)
  1885. def test_environment_no_proxy_ipv6_address_1(self) -> None:
  1886. import urllib3
  1887. config = ConfigDict()
  1888. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1889. self.overrideEnv("no_proxy", "xyz,abc.def.gh,ff80:1::affe,ample.com")
  1890. base_url = "http://[ff80:1::affe]/path/port"
  1891. manager = default_urllib3_manager(config=config, base_url=base_url)
  1892. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1893. self.assertIsInstance(manager, urllib3.PoolManager)
  1894. def test_environment_no_proxy_ipv6_address_2(self) -> None:
  1895. import urllib3
  1896. config = ConfigDict()
  1897. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1898. self.overrideEnv("no_proxy", "xyz,abc.def.gh,ff80:1::affe,ample.com")
  1899. base_url = "http://[ff80:1::affe]:1234/path/port"
  1900. manager = default_urllib3_manager(config=config, base_url=base_url)
  1901. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1902. self.assertIsInstance(manager, urllib3.PoolManager)
  1903. def test_environment_no_proxy_ipv6_address_3(self) -> None:
  1904. import urllib3
  1905. config = ConfigDict()
  1906. self.overrideEnv("http_proxy", "http://myproxy:8080")
  1907. self.overrideEnv(
  1908. "no_proxy", "xyz,abc.def.gh,192.168.0.0/24,ff80:1::/64,ample.com"
  1909. )
  1910. base_url = "http://[ff80:1::affe]/path/port"
  1911. manager = default_urllib3_manager(config=config, base_url=base_url)
  1912. self.assertNotIsInstance(manager, urllib3.ProxyManager)
  1913. self.assertIsInstance(manager, urllib3.PoolManager)
  1914. def test_config_proxy_custom_cls(self) -> None:
  1915. import urllib3
  1916. class CustomProxyManager(urllib3.ProxyManager):
  1917. pass
  1918. config = ConfigDict()
  1919. config.set(b"http", b"proxy", b"http://localhost:3128/")
  1920. manager = default_urllib3_manager(
  1921. config=config, proxy_manager_cls=CustomProxyManager
  1922. )
  1923. self.assertIsInstance(manager, CustomProxyManager)
  1924. def test_config_proxy_creds(self) -> None:
  1925. import urllib3
  1926. config = ConfigDict()
  1927. config.set(b"http", b"proxy", b"http://jelmer:example@localhost:3128/")
  1928. manager = default_urllib3_manager(config=config)
  1929. assert isinstance(manager, urllib3.ProxyManager)
  1930. self.assertEqual(
  1931. manager.proxy_headers, {"proxy-authorization": "Basic amVsbWVyOmV4YW1wbGU="}
  1932. )
  1933. def test_config_no_verify_ssl(self) -> None:
  1934. manager = default_urllib3_manager(config=None, cert_reqs="CERT_NONE")
  1935. self.assertEqual(manager.connection_pool_kw["cert_reqs"], "CERT_NONE")
  1936. def test_timeout_parameter(self) -> None:
  1937. """Test that timeout parameter is passed to urllib3 manager."""
  1938. timeout = 30
  1939. manager = default_urllib3_manager(config=None, timeout=timeout)
  1940. self.assertEqual(manager.connection_pool_kw["timeout"], timeout)
  1941. def test_timeout_from_config(self) -> None:
  1942. """Test that timeout can be configured via git config."""
  1943. from dulwich.config import ConfigDict
  1944. config = ConfigDict()
  1945. config.set((b"http",), b"timeout", b"25")
  1946. manager = default_urllib3_manager(config=config)
  1947. self.assertEqual(manager.connection_pool_kw["timeout"], 25)
  1948. def test_timeout_parameter_precedence(self) -> None:
  1949. """Test that explicit timeout parameter takes precedence over config."""
  1950. from dulwich.config import ConfigDict
  1951. config = ConfigDict()
  1952. config.set((b"http",), b"timeout", b"25")
  1953. manager = default_urllib3_manager(config=config, timeout=15)
  1954. self.assertEqual(manager.connection_pool_kw["timeout"], 15)
  1955. class SubprocessSSHVendorTests(TestCase):
  1956. def setUp(self) -> None:
  1957. # Monkey Patch client subprocess popen
  1958. self._orig_popen = dulwich.client.subprocess.Popen
  1959. dulwich.client.subprocess.Popen = DummyPopen
  1960. def tearDown(self) -> None:
  1961. dulwich.client.subprocess.Popen = self._orig_popen
  1962. def test_run_command_dashes(self) -> None:
  1963. vendor = SubprocessSSHVendor()
  1964. self.assertRaises(
  1965. StrangeHostname,
  1966. vendor.run_command,
  1967. "--weird-host",
  1968. "git-clone-url",
  1969. )
  1970. def test_run_command_password(self) -> None:
  1971. vendor = SubprocessSSHVendor()
  1972. self.assertRaises(
  1973. NotImplementedError,
  1974. vendor.run_command,
  1975. "host",
  1976. "git-clone-url",
  1977. password="12345",
  1978. )
  1979. def test_run_command_password_and_privkey(self) -> None:
  1980. vendor = SubprocessSSHVendor()
  1981. self.assertRaises(
  1982. NotImplementedError,
  1983. vendor.run_command,
  1984. "host",
  1985. "git-clone-url",
  1986. password="12345",
  1987. key_filename="/tmp/id_rsa",
  1988. )
  1989. def test_run_command_with_port_username_and_privkey(self) -> None:
  1990. expected = [
  1991. "ssh",
  1992. "-x",
  1993. "-p",
  1994. "2200",
  1995. "-i",
  1996. "/tmp/id_rsa",
  1997. ]
  1998. if DEFAULT_GIT_PROTOCOL_VERSION_FETCH:
  1999. expected += [
  2000. "-o",
  2001. f"SetEnv GIT_PROTOCOL=version={DEFAULT_GIT_PROTOCOL_VERSION_FETCH}",
  2002. ]
  2003. expected += [
  2004. "user@host",
  2005. "git-clone-url",
  2006. ]
  2007. vendor = SubprocessSSHVendor()
  2008. command = vendor.run_command(
  2009. "host",
  2010. "git-clone-url",
  2011. username="user",
  2012. port="2200",
  2013. key_filename="/tmp/id_rsa",
  2014. )
  2015. args = command.proc.args
  2016. self.assertListEqual(expected, args[0])
  2017. def test_run_with_ssh_command(self) -> None:
  2018. expected = [
  2019. "/path/to/ssh",
  2020. "-o",
  2021. "Option=Value",
  2022. "-x",
  2023. ]
  2024. if DEFAULT_GIT_PROTOCOL_VERSION_FETCH:
  2025. expected += [
  2026. "-o",
  2027. f"SetEnv GIT_PROTOCOL=version={DEFAULT_GIT_PROTOCOL_VERSION_FETCH}",
  2028. ]
  2029. expected += [
  2030. "host",
  2031. "git-clone-url",
  2032. ]
  2033. vendor = SubprocessSSHVendor()
  2034. command = vendor.run_command(
  2035. "host",
  2036. "git-clone-url",
  2037. ssh_command="/path/to/ssh -o Option=Value",
  2038. )
  2039. args = command.proc.args
  2040. self.assertListEqual(expected, args[0])
  2041. class PLinkSSHVendorTests(TestCase):
  2042. def setUp(self) -> None:
  2043. # Monkey Patch client subprocess popen
  2044. self._orig_popen = dulwich.client.subprocess.Popen
  2045. dulwich.client.subprocess.Popen = DummyPopen
  2046. def tearDown(self) -> None:
  2047. dulwich.client.subprocess.Popen = self._orig_popen
  2048. def test_run_command_dashes(self) -> None:
  2049. vendor = PLinkSSHVendor()
  2050. self.assertRaises(
  2051. StrangeHostname,
  2052. vendor.run_command,
  2053. "--weird-host",
  2054. "git-clone-url",
  2055. )
  2056. def test_run_command_password_and_privkey(self) -> None:
  2057. vendor = PLinkSSHVendor()
  2058. warnings.simplefilter("always", UserWarning)
  2059. self.addCleanup(warnings.resetwarnings)
  2060. warnings_list, restore_warnings = setup_warning_catcher()
  2061. self.addCleanup(restore_warnings)
  2062. command = vendor.run_command(
  2063. "host",
  2064. "git-clone-url",
  2065. password="12345",
  2066. key_filename="/tmp/id_rsa",
  2067. )
  2068. expected_warning = UserWarning(
  2069. "Invoking PLink with a password exposes the password in the process list."
  2070. )
  2071. for w in warnings_list:
  2072. if type(w) is type(expected_warning) and w.args == expected_warning.args:
  2073. break
  2074. else:
  2075. raise AssertionError(
  2076. f"Expected warning {expected_warning!r} not in {warnings_list!r}"
  2077. )
  2078. args = command.proc.args
  2079. if sys.platform == "win32":
  2080. binary = ["plink.exe", "-ssh"]
  2081. else:
  2082. binary = ["plink", "-ssh"]
  2083. expected = [
  2084. *binary,
  2085. "-pw",
  2086. "12345",
  2087. "-i",
  2088. "/tmp/id_rsa",
  2089. "host",
  2090. "git-clone-url",
  2091. ]
  2092. self.assertListEqual(expected, args[0])
  2093. def test_run_command_password(self) -> None:
  2094. if sys.platform == "win32":
  2095. binary = ["plink.exe", "-ssh"]
  2096. else:
  2097. binary = ["plink", "-ssh"]
  2098. expected = [*binary, "-pw", "12345", "host", "git-clone-url"]
  2099. vendor = PLinkSSHVendor()
  2100. warnings.simplefilter("always", UserWarning)
  2101. self.addCleanup(warnings.resetwarnings)
  2102. warnings_list, restore_warnings = setup_warning_catcher()
  2103. self.addCleanup(restore_warnings)
  2104. command = vendor.run_command("host", "git-clone-url", password="12345")
  2105. expected_warning = UserWarning(
  2106. "Invoking PLink with a password exposes the password in the process list."
  2107. )
  2108. for w in warnings_list:
  2109. if type(w) is type(expected_warning) and w.args == expected_warning.args:
  2110. break
  2111. else:
  2112. raise AssertionError(
  2113. f"Expected warning {expected_warning!r} not in {warnings_list!r}"
  2114. )
  2115. args = command.proc.args
  2116. self.assertListEqual(expected, args[0])
  2117. def test_run_command_with_port_username_and_privkey(self) -> None:
  2118. if sys.platform == "win32":
  2119. binary = ["plink.exe", "-ssh"]
  2120. else:
  2121. binary = ["plink", "-ssh"]
  2122. expected = [
  2123. *binary,
  2124. "-P",
  2125. "2200",
  2126. "-i",
  2127. "/tmp/id_rsa",
  2128. "user@host",
  2129. "git-clone-url",
  2130. ]
  2131. vendor = PLinkSSHVendor()
  2132. command = vendor.run_command(
  2133. "host",
  2134. "git-clone-url",
  2135. username="user",
  2136. port="2200",
  2137. key_filename="/tmp/id_rsa",
  2138. )
  2139. args = command.proc.args
  2140. self.assertListEqual(expected, args[0])
  2141. def test_run_with_ssh_command(self) -> None:
  2142. expected = [
  2143. "/path/to/plink",
  2144. "-ssh",
  2145. "host",
  2146. "git-clone-url",
  2147. ]
  2148. vendor = PLinkSSHVendor()
  2149. command = vendor.run_command(
  2150. "host",
  2151. "git-clone-url",
  2152. ssh_command="/path/to/plink",
  2153. )
  2154. args = command.proc.args
  2155. self.assertListEqual(expected, args[0])
  2156. class RsyncUrlTests(TestCase):
  2157. def test_simple(self) -> None:
  2158. self.assertEqual(parse_rsync_url("foo:bar/path"), (None, "foo", "bar/path"))
  2159. self.assertEqual(
  2160. parse_rsync_url("user@foo:bar/path"), ("user", "foo", "bar/path")
  2161. )
  2162. def test_path(self) -> None:
  2163. self.assertRaises(ValueError, parse_rsync_url, "/path")
  2164. class CheckWantsTests(TestCase):
  2165. def test_fine(self) -> None:
  2166. check_wants(
  2167. [b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
  2168. {b"refs/heads/blah": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
  2169. )
  2170. def test_missing(self) -> None:
  2171. self.assertRaises(
  2172. InvalidWants,
  2173. check_wants,
  2174. [b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
  2175. {b"refs/heads/blah": b"3f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
  2176. )
  2177. def test_annotated(self) -> None:
  2178. self.assertRaises(
  2179. InvalidWants,
  2180. check_wants,
  2181. [b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"],
  2182. {
  2183. b"refs/heads/blah": b"3f3dc7a53fb752a6961d3a56683df46d4d3bf262",
  2184. b"refs/heads/blah^{}": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262",
  2185. },
  2186. )
  2187. class FetchPackResultTests(TestCase):
  2188. def test_eq(self) -> None:
  2189. self.assertEqual(
  2190. FetchPackResult(
  2191. {b"refs/heads/master": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
  2192. {},
  2193. b"user/agent",
  2194. ),
  2195. FetchPackResult(
  2196. {b"refs/heads/master": b"2f3dc7a53fb752a6961d3a56683df46d4d3bf262"},
  2197. {},
  2198. b"user/agent",
  2199. ),
  2200. )
  2201. class GitCredentialStoreTests(TestCase):
  2202. @classmethod
  2203. def setUpClass(cls) -> None:
  2204. with tempfile.NamedTemporaryFile(delete=False) as f:
  2205. f.write(b"https://user:pass@example.org\n")
  2206. cls.fname = f.name
  2207. @classmethod
  2208. def tearDownClass(cls) -> None:
  2209. os.unlink(cls.fname)
  2210. def test_nonmatching_scheme(self) -> None:
  2211. result = list(
  2212. get_credentials_from_store("http", "example.org", fnames=[self.fname])
  2213. )
  2214. self.assertEqual(result, [])
  2215. def test_nonmatching_hostname(self) -> None:
  2216. result = list(
  2217. get_credentials_from_store("https", "noentry.org", fnames=[self.fname])
  2218. )
  2219. self.assertEqual(result, [])
  2220. def test_match_without_username(self) -> None:
  2221. result = list(
  2222. get_credentials_from_store("https", "example.org", fnames=[self.fname])
  2223. )
  2224. self.assertEqual(result, [("user", "pass")])
  2225. def test_match_with_matching_username(self) -> None:
  2226. result = list(
  2227. get_credentials_from_store(
  2228. "https", "example.org", "user", fnames=[self.fname]
  2229. )
  2230. )
  2231. self.assertEqual(result, [("user", "pass")])
  2232. def test_no_match_with_nonmatching_username(self) -> None:
  2233. result = list(
  2234. get_credentials_from_store(
  2235. "https", "example.org", "otheruser", fnames=[self.fname]
  2236. )
  2237. )
  2238. self.assertEqual(result, [])
  2239. class RemoteErrorFromStderrTests(TestCase):
  2240. def test_nothing(self) -> None:
  2241. self.assertEqual(_remote_error_from_stderr(None), HangupException())
  2242. def test_error_line(self) -> None:
  2243. b = BytesIO(
  2244. b"""\
  2245. This is some random output.
  2246. ERROR: This is the actual error
  2247. with a tail
  2248. """
  2249. )
  2250. self.assertEqual(
  2251. _remote_error_from_stderr(b),
  2252. GitProtocolError("This is the actual error"),
  2253. )
  2254. def test_no_error_line(self) -> None:
  2255. b = BytesIO(
  2256. b"""\
  2257. This is output without an error line.
  2258. And this line is just random noise, too.
  2259. """
  2260. )
  2261. self.assertEqual(
  2262. _remote_error_from_stderr(b),
  2263. HangupException(
  2264. [
  2265. b"This is output without an error line.",
  2266. b"And this line is just random noise, too.",
  2267. ]
  2268. ),
  2269. )
  2270. class TestExtractAgentAndSymrefs(TestCase):
  2271. def test_extract_agent_and_symrefs(self) -> None:
  2272. (symrefs, agent) = _extract_symrefs_and_agent(
  2273. [b"agent=git/2.31.1", b"symref=HEAD:refs/heads/master"]
  2274. )
  2275. self.assertEqual(agent, b"git/2.31.1")
  2276. self.assertEqual(symrefs, {b"HEAD": b"refs/heads/master"})