test_client.py 60 KB

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