test_client.py 80 KB

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