test_client.py 83 KB

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