test_client.py 68 KB

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