test_mysql.py 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597
  1. import logging
  2. import pytest
  3. from flexmock import flexmock
  4. from borgmatic.hooks.data_source import mysql as module
  5. def test_database_names_to_dump_passes_through_name():
  6. environment = flexmock()
  7. names = module.database_names_to_dump(
  8. {'name': 'foo'},
  9. {},
  10. 'root',
  11. 'trustsome1',
  12. environment,
  13. dry_run=False,
  14. )
  15. assert names == ('foo',)
  16. def test_database_names_to_dump_with_non_all_name_and_skip_names_warns():
  17. environment = flexmock()
  18. flexmock(module.logger).should_receive('warning').once()
  19. names = module.database_names_to_dump(
  20. {'name': 'foo', 'skip_names': ('foo', 'bar')},
  21. {},
  22. 'root',
  23. 'trustsome1',
  24. environment,
  25. dry_run=False,
  26. )
  27. assert names == ('foo',)
  28. def test_database_names_to_dump_bails_for_dry_run():
  29. environment = flexmock()
  30. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  31. 'resolve_credential',
  32. ).replace_with(lambda value, config: value)
  33. flexmock(module).should_receive('execute_command_and_capture_output').never()
  34. names = module.database_names_to_dump(
  35. {'name': 'all'},
  36. {},
  37. 'root',
  38. 'trustsome1',
  39. environment,
  40. dry_run=True,
  41. )
  42. assert names == ()
  43. def test_database_names_to_dump_queries_mysql_for_database_names():
  44. environment = flexmock()
  45. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  46. 'resolve_credential',
  47. ).replace_with(lambda value, config: value)
  48. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  49. 'parse_extra_options',
  50. ).and_return((), None)
  51. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  52. 'make_defaults_file_options',
  53. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  54. flexmock(module).should_receive('execute_command_and_capture_output').with_args(
  55. (
  56. 'mysql',
  57. '--defaults-extra-file=/dev/fd/99',
  58. '--skip-column-names',
  59. '--batch',
  60. '--execute',
  61. 'show schemas',
  62. ),
  63. environment=environment,
  64. ).and_return('foo\nbar\nmysql\n').once()
  65. names = module.database_names_to_dump(
  66. {'name': 'all'},
  67. {},
  68. 'root',
  69. 'trustsome1',
  70. environment,
  71. dry_run=False,
  72. )
  73. assert names == ('foo', 'bar')
  74. def test_database_names_to_dump_with_database_name_all_and_skip_names_filters_out_unwanted_databases():
  75. environment = flexmock()
  76. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  77. 'resolve_credential',
  78. ).replace_with(lambda value, config: value)
  79. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  80. 'parse_extra_options'
  81. ).and_return((), None)
  82. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  83. 'make_defaults_file_options'
  84. ).with_args(
  85. 'root',
  86. 'trustsome1',
  87. None,
  88. ).and_return(('--defaults-extra-file=/dev/fd/99',))
  89. flexmock(module).should_receive('execute_command_and_capture_output').with_args(
  90. (
  91. 'mysql',
  92. '--defaults-extra-file=/dev/fd/99',
  93. '--skip-column-names',
  94. '--batch',
  95. '--execute',
  96. 'show schemas',
  97. ),
  98. environment=environment,
  99. ).and_return('foo\nbar\nbaz\nmysql\n').once()
  100. names = module.database_names_to_dump(
  101. {'name': 'all', 'skip_names': ('foo', 'bar')},
  102. {},
  103. 'root',
  104. 'trustsome1',
  105. environment,
  106. dry_run=False,
  107. )
  108. assert names == ('baz',)
  109. def test_database_names_to_dump_with_environment_password_transport_skips_defaults_file_and_passes_user_flag():
  110. environment = flexmock()
  111. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  112. 'resolve_credential',
  113. ).replace_with(lambda value, config: value)
  114. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  115. 'parse_extra_options',
  116. ).and_return((), None)
  117. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  118. 'make_defaults_file_options',
  119. ).never()
  120. flexmock(module).should_receive('execute_command_and_capture_output').with_args(
  121. (
  122. 'mysql',
  123. '--user',
  124. 'root',
  125. '--skip-column-names',
  126. '--batch',
  127. '--execute',
  128. 'show schemas',
  129. ),
  130. environment=environment,
  131. ).and_return('foo\nbar\nmysql\n').once()
  132. names = module.database_names_to_dump(
  133. {'name': 'all', 'password_transport': 'environment'},
  134. {},
  135. 'root',
  136. 'trustsome1',
  137. environment,
  138. dry_run=False,
  139. )
  140. assert names == ('foo', 'bar')
  141. def test_database_names_to_dump_runs_mysql_with_tls():
  142. environment = flexmock()
  143. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  144. 'resolve_credential',
  145. ).replace_with(lambda value, config: value)
  146. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  147. 'parse_extra_options',
  148. ).and_return((), None)
  149. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  150. 'make_defaults_file_options',
  151. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  152. flexmock(module).should_receive('execute_command_and_capture_output').with_args(
  153. (
  154. 'mysql',
  155. '--defaults-extra-file=/dev/fd/99',
  156. '--ssl',
  157. '--skip-column-names',
  158. '--batch',
  159. '--execute',
  160. 'show schemas',
  161. ),
  162. environment=environment,
  163. ).and_return('foo\nbar\nmysql\n').once()
  164. names = module.database_names_to_dump(
  165. {'name': 'all', 'tls': True},
  166. {},
  167. 'root',
  168. 'trustsome1',
  169. environment,
  170. dry_run=False,
  171. )
  172. assert names == ('foo', 'bar')
  173. def test_database_names_to_dump_runs_mysql_without_tls():
  174. environment = flexmock()
  175. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  176. 'resolve_credential',
  177. ).replace_with(lambda value, config: value)
  178. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  179. 'parse_extra_options',
  180. ).and_return((), None)
  181. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  182. 'make_defaults_file_options',
  183. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  184. flexmock(module).should_receive('execute_command_and_capture_output').with_args(
  185. (
  186. 'mysql',
  187. '--defaults-extra-file=/dev/fd/99',
  188. '--skip-ssl',
  189. '--skip-column-names',
  190. '--batch',
  191. '--execute',
  192. 'show schemas',
  193. ),
  194. environment=environment,
  195. ).and_return('foo\nbar\nmysql\n').once()
  196. names = module.database_names_to_dump(
  197. {'name': 'all', 'tls': False},
  198. {},
  199. 'root',
  200. 'trustsome1',
  201. environment,
  202. dry_run=False,
  203. )
  204. assert names == ('foo', 'bar')
  205. def test_use_streaming_true_for_any_databases():
  206. assert module.use_streaming(
  207. databases=[flexmock(), flexmock()],
  208. config=flexmock(),
  209. )
  210. def test_use_streaming_false_for_no_databases():
  211. assert not module.use_streaming(databases=[], config=flexmock())
  212. def test_dump_data_sources_dumps_each_database():
  213. databases = [{'name': 'foo'}, {'name': 'bar'}]
  214. processes = [flexmock(), flexmock()]
  215. flexmock(module).should_receive('make_dump_path').and_return('')
  216. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  217. 'resolve_credential',
  218. ).and_return(None)
  219. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  220. flexmock(module).should_receive('database_names_to_dump').with_args(
  221. database=databases[0],
  222. config={},
  223. username=None,
  224. password=None,
  225. environment={'USER': 'root'},
  226. dry_run=False,
  227. ).and_return(('foo',))
  228. flexmock(module).should_receive('database_names_to_dump').with_args(
  229. database=databases[1],
  230. config={},
  231. username=None,
  232. password=None,
  233. environment={'USER': 'root'},
  234. dry_run=False,
  235. ).and_return(('bar',))
  236. for name, process in zip(('foo', 'bar'), processes):
  237. flexmock(module).should_receive('execute_dump_command').with_args(
  238. database={'name': name},
  239. config={},
  240. username=None,
  241. password=None,
  242. dump_path=object,
  243. database_names=(name,),
  244. environment={'USER': 'root'},
  245. dry_run=object,
  246. dry_run_label=object,
  247. ).and_return(process).once()
  248. flexmock(module.dump).should_receive('write_data_source_dumps_metadata').with_args(
  249. '/run/borgmatic',
  250. 'mysql_databases',
  251. [
  252. module.borgmatic.actions.restore.Dump('mysql_databases', 'foo'),
  253. module.borgmatic.actions.restore.Dump('mysql_databases', 'bar'),
  254. ],
  255. ).once()
  256. flexmock(module.borgmatic.hooks.data_source.config).should_receive('inject_pattern').with_args(
  257. object,
  258. module.borgmatic.borg.pattern.Pattern(
  259. '/run/borgmatic/mysql_databases',
  260. source=module.borgmatic.borg.pattern.Pattern_source.HOOK,
  261. ),
  262. ).once()
  263. assert (
  264. module.dump_data_sources(
  265. databases,
  266. {},
  267. config_paths=('test.yaml',),
  268. borgmatic_runtime_directory='/run/borgmatic',
  269. patterns=[],
  270. dry_run=False,
  271. )
  272. == processes
  273. )
  274. def test_dump_data_sources_dumps_with_password():
  275. database = {'name': 'foo', 'username': 'root', 'password': 'trustsome1'}
  276. process = flexmock()
  277. flexmock(module).should_receive('make_dump_path').and_return('')
  278. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  279. 'resolve_credential',
  280. ).replace_with(lambda value, config: value)
  281. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  282. flexmock(module).should_receive('database_names_to_dump').with_args(
  283. database=database,
  284. config={},
  285. username='root',
  286. password='trustsome1',
  287. environment={'USER': 'root'},
  288. dry_run=False,
  289. ).and_return(('foo',))
  290. flexmock(module).should_receive('execute_dump_command').with_args(
  291. database=database,
  292. config={},
  293. username='root',
  294. password='trustsome1',
  295. dump_path=object,
  296. database_names=('foo',),
  297. environment={'USER': 'root'},
  298. dry_run=object,
  299. dry_run_label=object,
  300. ).and_return(process).once()
  301. flexmock(module.dump).should_receive('write_data_source_dumps_metadata').with_args(
  302. '/run/borgmatic',
  303. 'mysql_databases',
  304. [
  305. module.borgmatic.actions.restore.Dump('mysql_databases', 'foo'),
  306. ],
  307. ).once()
  308. flexmock(module.borgmatic.hooks.data_source.config).should_receive('inject_pattern').with_args(
  309. object,
  310. module.borgmatic.borg.pattern.Pattern(
  311. '/run/borgmatic/mysql_databases',
  312. source=module.borgmatic.borg.pattern.Pattern_source.HOOK,
  313. ),
  314. ).once()
  315. assert module.dump_data_sources(
  316. [database],
  317. {},
  318. config_paths=('test.yaml',),
  319. borgmatic_runtime_directory='/run/borgmatic',
  320. patterns=[],
  321. dry_run=False,
  322. ) == [process]
  323. def test_dump_data_sources_dumps_with_environment_password_transport_passes_password_environment_variable():
  324. database = {
  325. 'name': 'foo',
  326. 'username': 'root',
  327. 'password': 'trustsome1',
  328. 'password_transport': 'environment',
  329. }
  330. process = flexmock()
  331. flexmock(module).should_receive('make_dump_path').and_return('')
  332. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  333. 'resolve_credential',
  334. ).replace_with(lambda value, config: value)
  335. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  336. flexmock(module).should_receive('database_names_to_dump').with_args(
  337. database=database,
  338. config={},
  339. username='root',
  340. password='trustsome1',
  341. environment={'USER': 'root', 'MYSQL_PWD': 'trustsome1'},
  342. dry_run=False,
  343. ).and_return(('foo',))
  344. flexmock(module).should_receive('execute_dump_command').with_args(
  345. database=database,
  346. config={},
  347. username='root',
  348. password='trustsome1',
  349. dump_path=object,
  350. database_names=('foo',),
  351. environment={'USER': 'root', 'MYSQL_PWD': 'trustsome1'},
  352. dry_run=object,
  353. dry_run_label=object,
  354. ).and_return(process).once()
  355. flexmock(module.dump).should_receive('write_data_source_dumps_metadata').with_args(
  356. '/run/borgmatic',
  357. 'mysql_databases',
  358. [
  359. module.borgmatic.actions.restore.Dump('mysql_databases', 'foo'),
  360. ],
  361. ).once()
  362. flexmock(module.borgmatic.hooks.data_source.config).should_receive('inject_pattern').with_args(
  363. object,
  364. module.borgmatic.borg.pattern.Pattern(
  365. '/run/borgmatic/mysql_databases',
  366. source=module.borgmatic.borg.pattern.Pattern_source.HOOK,
  367. ),
  368. ).once()
  369. assert module.dump_data_sources(
  370. [database],
  371. {},
  372. config_paths=('test.yaml',),
  373. borgmatic_runtime_directory='/run/borgmatic',
  374. patterns=[],
  375. dry_run=False,
  376. ) == [process]
  377. def test_dump_data_sources_dumps_all_databases_at_once():
  378. databases = [{'name': 'all'}]
  379. process = flexmock()
  380. flexmock(module).should_receive('make_dump_path').and_return('')
  381. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  382. 'resolve_credential',
  383. ).and_return(None)
  384. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  385. flexmock(module).should_receive('database_names_to_dump').and_return(('foo', 'bar'))
  386. flexmock(module).should_receive('execute_dump_command').with_args(
  387. database={'name': 'all'},
  388. config={},
  389. username=None,
  390. password=None,
  391. dump_path=object,
  392. database_names=('foo', 'bar'),
  393. environment={'USER': 'root'},
  394. dry_run=object,
  395. dry_run_label=object,
  396. ).and_return(process).once()
  397. flexmock(module.dump).should_receive('write_data_source_dumps_metadata').with_args(
  398. '/run/borgmatic',
  399. 'mysql_databases',
  400. [
  401. module.borgmatic.actions.restore.Dump('mysql_databases', 'all'),
  402. ],
  403. ).once()
  404. flexmock(module.borgmatic.hooks.data_source.config).should_receive('inject_pattern').with_args(
  405. object,
  406. module.borgmatic.borg.pattern.Pattern(
  407. '/run/borgmatic/mysql_databases',
  408. source=module.borgmatic.borg.pattern.Pattern_source.HOOK,
  409. ),
  410. ).once()
  411. assert module.dump_data_sources(
  412. databases,
  413. {},
  414. config_paths=('test.yaml',),
  415. borgmatic_runtime_directory='/run/borgmatic',
  416. patterns=[],
  417. dry_run=False,
  418. ) == [process]
  419. def test_dump_data_sources_dumps_all_databases_separately_when_format_configured():
  420. databases = [{'name': 'all', 'format': 'sql'}]
  421. processes = [flexmock(), flexmock()]
  422. flexmock(module).should_receive('make_dump_path').and_return('')
  423. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  424. 'resolve_credential',
  425. ).and_return(None)
  426. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  427. flexmock(module).should_receive('database_names_to_dump').and_return(('foo', 'bar'))
  428. for name, process in zip(('foo', 'bar'), processes):
  429. flexmock(module).should_receive('execute_dump_command').with_args(
  430. database={'name': name, 'format': 'sql'},
  431. config={},
  432. username=None,
  433. password=None,
  434. dump_path=object,
  435. database_names=(name,),
  436. environment={'USER': 'root'},
  437. dry_run=object,
  438. dry_run_label=object,
  439. ).and_return(process).once()
  440. flexmock(module.dump).should_receive('write_data_source_dumps_metadata').with_args(
  441. '/run/borgmatic',
  442. 'mysql_databases',
  443. [
  444. module.borgmatic.actions.restore.Dump('mysql_databases', 'foo'),
  445. module.borgmatic.actions.restore.Dump('mysql_databases', 'bar'),
  446. ],
  447. ).once()
  448. flexmock(module.borgmatic.hooks.data_source.config).should_receive('inject_pattern').with_args(
  449. object,
  450. module.borgmatic.borg.pattern.Pattern(
  451. '/run/borgmatic/mysql_databases',
  452. source=module.borgmatic.borg.pattern.Pattern_source.HOOK,
  453. ),
  454. ).once()
  455. assert (
  456. module.dump_data_sources(
  457. databases,
  458. {},
  459. config_paths=('test.yaml',),
  460. borgmatic_runtime_directory='/run/borgmatic',
  461. patterns=[],
  462. dry_run=False,
  463. )
  464. == processes
  465. )
  466. def test_dump_data_sources_errors_for_missing_all_databases():
  467. databases = [{'name': 'all'}]
  468. flexmock(module).should_receive('make_dump_path').and_return('')
  469. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  470. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  471. 'resolve_credential',
  472. ).replace_with(lambda value, config: value)
  473. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return(
  474. 'databases/localhost/all',
  475. )
  476. flexmock(module).should_receive('database_names_to_dump').and_return(())
  477. flexmock(module.borgmatic.hooks.data_source.config).should_receive('inject_pattern').never()
  478. with pytest.raises(ValueError):
  479. assert module.dump_data_sources(
  480. databases,
  481. {},
  482. config_paths=('test.yaml',),
  483. borgmatic_runtime_directory='/run/borgmatic',
  484. patterns=[],
  485. dry_run=False,
  486. )
  487. def test_dump_data_sources_does_not_error_for_missing_all_databases_with_dry_run():
  488. databases = [{'name': 'all'}]
  489. flexmock(module).should_receive('make_dump_path').and_return('')
  490. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  491. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  492. 'resolve_credential',
  493. ).replace_with(lambda value, config: value)
  494. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return(
  495. 'databases/localhost/all',
  496. )
  497. flexmock(module).should_receive('database_names_to_dump').and_return(())
  498. flexmock(module.borgmatic.hooks.data_source.config).should_receive('inject_pattern').never()
  499. assert (
  500. module.dump_data_sources(
  501. databases,
  502. {},
  503. config_paths=('test.yaml',),
  504. borgmatic_runtime_directory='/run/borgmatic',
  505. patterns=[],
  506. dry_run=True,
  507. )
  508. == []
  509. )
  510. def test_database_names_to_dump_runs_mysql_with_list_options():
  511. database = {'name': 'all', 'list_options': '--defaults-extra-file=my.cnf --skip-ssl'}
  512. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  513. 'parse_extra_options',
  514. ).and_return(('--skip-ssl',), 'my.cnf')
  515. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  516. 'make_defaults_file_options',
  517. ).with_args('root', 'trustsome1', 'my.cnf').and_return(('--defaults-extra-file=/dev/fd/99',))
  518. flexmock(module).should_receive('execute_command_and_capture_output').with_args(
  519. (
  520. 'mysql',
  521. '--defaults-extra-file=/dev/fd/99',
  522. '--skip-ssl',
  523. '--skip-column-names',
  524. '--batch',
  525. '--execute',
  526. 'show schemas',
  527. ),
  528. environment=None,
  529. ).and_return('foo\nbar').once()
  530. assert module.database_names_to_dump(database, {}, 'root', 'trustsome1', None, '') == (
  531. 'foo',
  532. 'bar',
  533. )
  534. def test_database_names_to_dump_runs_non_default_mysql_with_list_options():
  535. database = {
  536. 'name': 'all',
  537. 'list_options': '--defaults-extra-file=my.cnf --skip-ssl',
  538. 'mysql_command': 'custom_mysql',
  539. }
  540. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  541. 'parse_extra_options',
  542. ).and_return(('--skip-ssl',), 'my.cnf')
  543. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  544. 'make_defaults_file_options',
  545. ).with_args('root', 'trustsome1', 'my.cnf').and_return(('--defaults-extra-file=/dev/fd/99',))
  546. flexmock(module).should_receive('execute_command_and_capture_output').with_args(
  547. environment=None,
  548. full_command=(
  549. 'custom_mysql', # Custom MySQL command
  550. '--defaults-extra-file=/dev/fd/99',
  551. '--skip-ssl',
  552. '--skip-column-names',
  553. '--batch',
  554. '--execute',
  555. 'show schemas',
  556. ),
  557. ).and_return('foo\nbar').once()
  558. assert module.database_names_to_dump(database, {}, 'root', 'trustsome1', None, '') == (
  559. 'foo',
  560. 'bar',
  561. )
  562. def test_execute_dump_command_runs_mysqldump():
  563. process = flexmock()
  564. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  565. flexmock(module.os.path).should_receive('exists').and_return(False)
  566. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  567. 'resolve_credential',
  568. ).replace_with(lambda value, config: value)
  569. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  570. 'parse_extra_options',
  571. ).and_return((), None)
  572. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  573. 'make_defaults_file_options',
  574. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  575. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  576. flexmock(module).should_receive('execute_command').with_args(
  577. (
  578. 'mysqldump',
  579. '--defaults-extra-file=/dev/fd/99',
  580. '--add-drop-database',
  581. '--databases',
  582. 'foo',
  583. '--result-file',
  584. 'dump',
  585. ),
  586. environment=None,
  587. run_to_completion=False,
  588. ).and_return(process).once()
  589. assert (
  590. module.execute_dump_command(
  591. database={'name': 'foo'},
  592. config={},
  593. username='root',
  594. password='trustsome1',
  595. dump_path=flexmock(),
  596. database_names=('foo',),
  597. environment=None,
  598. dry_run=False,
  599. dry_run_label='',
  600. )
  601. == process
  602. )
  603. def test_execute_dump_command_with_environment_password_transport_skips_defaults_file_and_passes_user_flag():
  604. process = flexmock()
  605. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  606. flexmock(module.os.path).should_receive('exists').and_return(False)
  607. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  608. 'resolve_credential',
  609. ).replace_with(lambda value, config: value)
  610. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  611. 'parse_extra_options',
  612. ).and_return((), None)
  613. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  614. 'make_defaults_file_options',
  615. ).never()
  616. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  617. flexmock(module).should_receive('execute_command').with_args(
  618. (
  619. 'mysqldump',
  620. '--add-drop-database',
  621. '--user',
  622. 'root',
  623. '--databases',
  624. 'foo',
  625. '--result-file',
  626. 'dump',
  627. ),
  628. environment=None,
  629. run_to_completion=False,
  630. ).and_return(process).once()
  631. assert (
  632. module.execute_dump_command(
  633. database={'name': 'foo', 'password_transport': 'environment'},
  634. config={},
  635. username='root',
  636. password='trustsome1',
  637. dump_path=flexmock(),
  638. database_names=('foo',),
  639. environment=None,
  640. dry_run=False,
  641. dry_run_label='',
  642. )
  643. == process
  644. )
  645. def test_execute_dump_command_runs_mysqldump_without_add_drop_database():
  646. process = flexmock()
  647. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  648. flexmock(module.os.path).should_receive('exists').and_return(False)
  649. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  650. 'resolve_credential',
  651. ).replace_with(lambda value, config: value)
  652. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  653. 'parse_extra_options',
  654. ).and_return((), None)
  655. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  656. 'make_defaults_file_options',
  657. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  658. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  659. flexmock(module).should_receive('execute_command').with_args(
  660. (
  661. 'mysqldump',
  662. '--defaults-extra-file=/dev/fd/99',
  663. '--databases',
  664. 'foo',
  665. '--result-file',
  666. 'dump',
  667. ),
  668. environment=None,
  669. run_to_completion=False,
  670. ).and_return(process).once()
  671. assert (
  672. module.execute_dump_command(
  673. database={'name': 'foo', 'add_drop_database': False},
  674. config={},
  675. username='root',
  676. password='trustsome1',
  677. dump_path=flexmock(),
  678. database_names=('foo',),
  679. environment=None,
  680. dry_run=False,
  681. dry_run_label='',
  682. )
  683. == process
  684. )
  685. def test_execute_dump_command_runs_mysqldump_with_hostname_and_port():
  686. process = flexmock()
  687. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  688. flexmock(module.os.path).should_receive('exists').and_return(False)
  689. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  690. 'resolve_credential',
  691. ).replace_with(lambda value, config: value)
  692. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  693. 'parse_extra_options',
  694. ).and_return((), None)
  695. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  696. 'make_defaults_file_options',
  697. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  698. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  699. flexmock(module).should_receive('execute_command').with_args(
  700. (
  701. 'mysqldump',
  702. '--defaults-extra-file=/dev/fd/99',
  703. '--add-drop-database',
  704. '--host',
  705. 'database.example.org',
  706. '--port',
  707. '5433',
  708. '--protocol',
  709. 'tcp',
  710. '--databases',
  711. 'foo',
  712. '--result-file',
  713. 'dump',
  714. ),
  715. environment=None,
  716. run_to_completion=False,
  717. ).and_return(process).once()
  718. assert (
  719. module.execute_dump_command(
  720. database={'name': 'foo', 'hostname': 'database.example.org', 'port': 5433},
  721. config={},
  722. username='root',
  723. password='trustsome1',
  724. dump_path=flexmock(),
  725. database_names=('foo',),
  726. environment=None,
  727. dry_run=False,
  728. dry_run_label='',
  729. )
  730. == process
  731. )
  732. def test_execute_dump_command_runs_mysqldump_with_tls():
  733. process = flexmock()
  734. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  735. flexmock(module.os.path).should_receive('exists').and_return(False)
  736. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  737. 'resolve_credential',
  738. ).replace_with(lambda value, config: value)
  739. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  740. 'parse_extra_options',
  741. ).and_return((), None)
  742. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  743. 'make_defaults_file_options',
  744. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  745. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  746. flexmock(module).should_receive('execute_command').with_args(
  747. (
  748. 'mysqldump',
  749. '--defaults-extra-file=/dev/fd/99',
  750. '--add-drop-database',
  751. '--ssl',
  752. '--databases',
  753. 'foo',
  754. '--result-file',
  755. 'dump',
  756. ),
  757. environment=None,
  758. run_to_completion=False,
  759. ).and_return(process).once()
  760. assert (
  761. module.execute_dump_command(
  762. database={'name': 'foo', 'tls': True},
  763. config={},
  764. username='root',
  765. password='trustsome1',
  766. dump_path=flexmock(),
  767. database_names=('foo',),
  768. environment=None,
  769. dry_run=False,
  770. dry_run_label='',
  771. )
  772. == process
  773. )
  774. def test_execute_dump_command_runs_mysqldump_without_tls():
  775. process = flexmock()
  776. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  777. flexmock(module.os.path).should_receive('exists').and_return(False)
  778. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  779. 'resolve_credential',
  780. ).replace_with(lambda value, config: value)
  781. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  782. 'parse_extra_options',
  783. ).and_return((), None)
  784. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  785. 'make_defaults_file_options',
  786. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  787. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  788. flexmock(module).should_receive('execute_command').with_args(
  789. (
  790. 'mysqldump',
  791. '--defaults-extra-file=/dev/fd/99',
  792. '--add-drop-database',
  793. '--skip-ssl',
  794. '--databases',
  795. 'foo',
  796. '--result-file',
  797. 'dump',
  798. ),
  799. environment=None,
  800. run_to_completion=False,
  801. ).and_return(process).once()
  802. assert (
  803. module.execute_dump_command(
  804. database={'name': 'foo', 'tls': False},
  805. config={},
  806. username='root',
  807. password='trustsome1',
  808. dump_path=flexmock(),
  809. database_names=('foo',),
  810. environment=None,
  811. dry_run=False,
  812. dry_run_label='',
  813. )
  814. == process
  815. )
  816. def test_execute_dump_command_runs_mysqldump_with_username_and_password():
  817. process = flexmock()
  818. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  819. flexmock(module.os.path).should_receive('exists').and_return(False)
  820. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  821. 'resolve_credential',
  822. ).replace_with(lambda value, config: value)
  823. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  824. 'parse_extra_options',
  825. ).and_return((), None)
  826. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  827. 'make_defaults_file_options',
  828. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  829. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  830. flexmock(module).should_receive('execute_command').with_args(
  831. (
  832. 'mysqldump',
  833. '--defaults-extra-file=/dev/fd/99',
  834. '--add-drop-database',
  835. '--databases',
  836. 'foo',
  837. '--result-file',
  838. 'dump',
  839. ),
  840. environment={},
  841. run_to_completion=False,
  842. ).and_return(process).once()
  843. assert (
  844. module.execute_dump_command(
  845. database={'name': 'foo', 'username': 'root', 'password': 'trustsome1'},
  846. config={},
  847. username='root',
  848. password='trustsome1',
  849. dump_path=flexmock(),
  850. database_names=('foo',),
  851. environment={},
  852. dry_run=False,
  853. dry_run_label='',
  854. )
  855. == process
  856. )
  857. def test_execute_dump_command_runs_mysqldump_with_options():
  858. process = flexmock()
  859. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  860. flexmock(module.os.path).should_receive('exists').and_return(False)
  861. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  862. 'resolve_credential',
  863. ).replace_with(lambda value, config: value)
  864. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  865. 'parse_extra_options',
  866. ).and_return(('--stuff=such',), None)
  867. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  868. 'make_defaults_file_options',
  869. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  870. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  871. flexmock(module).should_receive('execute_command').with_args(
  872. (
  873. 'mysqldump',
  874. '--defaults-extra-file=/dev/fd/99',
  875. '--stuff=such',
  876. '--add-drop-database',
  877. '--databases',
  878. 'foo',
  879. '--result-file',
  880. 'dump',
  881. ),
  882. environment=None,
  883. run_to_completion=False,
  884. ).and_return(process).once()
  885. assert (
  886. module.execute_dump_command(
  887. database={'name': 'foo', 'options': '--stuff=such'},
  888. config={},
  889. username='root',
  890. password='trustsome1',
  891. dump_path=flexmock(),
  892. database_names=('foo',),
  893. environment=None,
  894. dry_run=False,
  895. dry_run_label='',
  896. )
  897. == process
  898. )
  899. def test_execute_dump_command_runs_non_default_mysqldump():
  900. process = flexmock()
  901. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  902. flexmock(module.os.path).should_receive('exists').and_return(False)
  903. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  904. 'resolve_credential',
  905. ).replace_with(lambda value, config: value)
  906. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  907. 'parse_extra_options',
  908. ).and_return((), None)
  909. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  910. 'make_defaults_file_options',
  911. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  912. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  913. flexmock(module).should_receive('execute_command').with_args(
  914. (
  915. 'custom_mysqldump', # Custom MySQL dump command
  916. '--defaults-extra-file=/dev/fd/99',
  917. '--add-drop-database',
  918. '--databases',
  919. 'foo',
  920. '--result-file',
  921. 'dump',
  922. ),
  923. environment=None,
  924. run_to_completion=False,
  925. ).and_return(process).once()
  926. assert (
  927. module.execute_dump_command(
  928. database={
  929. 'name': 'foo',
  930. 'mysql_dump_command': 'custom_mysqldump',
  931. }, # Custom MySQL dump command specified
  932. config={},
  933. username='root',
  934. password='trustsome1',
  935. dump_path=flexmock(),
  936. database_names=('foo',),
  937. environment=None,
  938. dry_run=False,
  939. dry_run_label='',
  940. )
  941. == process
  942. )
  943. def test_execute_dump_command_with_duplicate_dump_skips_mysqldump():
  944. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  945. flexmock(module.os.path).should_receive('exists').and_return(True)
  946. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  947. 'parse_extra_options',
  948. ).and_return((), None)
  949. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  950. 'make_defaults_file_options',
  951. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  952. flexmock(module.dump).should_receive('create_named_pipe_for_dump').never()
  953. flexmock(module).should_receive('execute_command').never()
  954. assert (
  955. module.execute_dump_command(
  956. database={'name': 'foo'},
  957. config={},
  958. username='root',
  959. password='trustsome1',
  960. dump_path=flexmock(),
  961. database_names=('foo',),
  962. environment=None,
  963. dry_run=True,
  964. dry_run_label='SO DRY',
  965. )
  966. is None
  967. )
  968. def test_execute_dump_command_with_dry_run_skips_mysqldump():
  969. flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
  970. flexmock(module.os.path).should_receive('exists').and_return(False)
  971. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  972. 'resolve_credential',
  973. ).replace_with(lambda value, config: value)
  974. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  975. 'parse_extra_options',
  976. ).and_return((), None)
  977. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  978. 'make_defaults_file_options',
  979. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  980. flexmock(module.dump).should_receive('create_named_pipe_for_dump')
  981. flexmock(module).should_receive('execute_command').never()
  982. assert (
  983. module.execute_dump_command(
  984. database={'name': 'foo'},
  985. config={},
  986. username='root',
  987. password='trustsome1',
  988. dump_path=flexmock(),
  989. database_names=('foo',),
  990. environment=None,
  991. dry_run=True,
  992. dry_run_label='SO DRY',
  993. )
  994. is None
  995. )
  996. def test_restore_data_source_dump_runs_mysql_to_restore():
  997. hook_config = [{'name': 'foo'}, {'name': 'bar'}]
  998. extract_process = flexmock(stdout=flexmock())
  999. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1000. 'resolve_credential',
  1001. ).replace_with(lambda value, config: value)
  1002. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1003. 'parse_extra_options',
  1004. ).and_return((), None)
  1005. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1006. 'make_defaults_file_options',
  1007. ).with_args(None, None, None).and_return(())
  1008. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1009. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1010. ('mysql', '--batch'),
  1011. processes=[extract_process],
  1012. output_log_level=logging.DEBUG,
  1013. input_file=extract_process.stdout,
  1014. environment={'USER': 'root'},
  1015. ).once()
  1016. module.restore_data_source_dump(
  1017. hook_config,
  1018. {},
  1019. data_source={'name': 'foo'},
  1020. dry_run=False,
  1021. extract_process=extract_process,
  1022. connection_params={
  1023. 'hostname': None,
  1024. 'port': None,
  1025. 'username': None,
  1026. 'password': None,
  1027. },
  1028. borgmatic_runtime_directory='/run/borgmatic',
  1029. )
  1030. def test_restore_data_source_dump_runs_mysql_with_options():
  1031. hook_config = [{'name': 'foo', 'restore_options': '--harder'}]
  1032. extract_process = flexmock(stdout=flexmock())
  1033. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1034. 'resolve_credential',
  1035. ).replace_with(lambda value, config: value)
  1036. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1037. 'parse_extra_options',
  1038. ).and_return(('--harder',), None)
  1039. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1040. 'make_defaults_file_options',
  1041. ).with_args(None, None, None).and_return(())
  1042. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1043. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1044. ('mysql', '--harder', '--batch'),
  1045. processes=[extract_process],
  1046. output_log_level=logging.DEBUG,
  1047. input_file=extract_process.stdout,
  1048. environment={'USER': 'root'},
  1049. ).once()
  1050. module.restore_data_source_dump(
  1051. hook_config,
  1052. {},
  1053. data_source=hook_config[0],
  1054. dry_run=False,
  1055. extract_process=extract_process,
  1056. connection_params={
  1057. 'hostname': None,
  1058. 'port': None,
  1059. 'username': None,
  1060. 'password': None,
  1061. },
  1062. borgmatic_runtime_directory='/run/borgmatic',
  1063. )
  1064. def test_restore_data_source_dump_runs_non_default_mysql_with_options():
  1065. hook_config = [{'name': 'foo', 'mysql_command': 'custom_mysql', 'restore_options': '--harder'}]
  1066. extract_process = flexmock(stdout=flexmock())
  1067. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1068. 'resolve_credential',
  1069. ).replace_with(lambda value, config: value)
  1070. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1071. 'parse_extra_options',
  1072. ).and_return(('--harder',), None)
  1073. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1074. 'make_defaults_file_options',
  1075. ).with_args(None, None, None).and_return(())
  1076. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1077. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1078. ('custom_mysql', '--harder', '--batch'),
  1079. processes=[extract_process],
  1080. output_log_level=logging.DEBUG,
  1081. input_file=extract_process.stdout,
  1082. environment={'USER': 'root'},
  1083. ).once()
  1084. module.restore_data_source_dump(
  1085. hook_config,
  1086. {},
  1087. data_source=hook_config[0],
  1088. dry_run=False,
  1089. extract_process=extract_process,
  1090. connection_params={
  1091. 'hostname': None,
  1092. 'port': None,
  1093. 'username': None,
  1094. 'password': None,
  1095. },
  1096. borgmatic_runtime_directory='/run/borgmatic',
  1097. )
  1098. def test_restore_data_source_dump_runs_mysql_with_hostname_and_port():
  1099. hook_config = [{'name': 'foo', 'hostname': 'database.example.org', 'port': 5433}]
  1100. extract_process = flexmock(stdout=flexmock())
  1101. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1102. 'resolve_credential',
  1103. ).replace_with(lambda value, config: value)
  1104. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1105. 'parse_extra_options',
  1106. ).and_return((), None)
  1107. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1108. 'make_defaults_file_options',
  1109. ).with_args(None, None, None).and_return(())
  1110. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1111. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1112. (
  1113. 'mysql',
  1114. '--batch',
  1115. '--host',
  1116. 'database.example.org',
  1117. '--port',
  1118. '5433',
  1119. '--protocol',
  1120. 'tcp',
  1121. ),
  1122. processes=[extract_process],
  1123. output_log_level=logging.DEBUG,
  1124. input_file=extract_process.stdout,
  1125. environment={'USER': 'root'},
  1126. ).once()
  1127. module.restore_data_source_dump(
  1128. hook_config,
  1129. {},
  1130. data_source=hook_config[0],
  1131. dry_run=False,
  1132. extract_process=extract_process,
  1133. connection_params={
  1134. 'hostname': None,
  1135. 'port': None,
  1136. 'username': None,
  1137. 'password': None,
  1138. },
  1139. borgmatic_runtime_directory='/run/borgmatic',
  1140. )
  1141. def test_restore_data_source_dump_runs_mysql_with_tls():
  1142. hook_config = [{'name': 'foo', 'tls': True}]
  1143. extract_process = flexmock(stdout=flexmock())
  1144. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1145. 'resolve_credential',
  1146. ).replace_with(lambda value, config: value)
  1147. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1148. 'parse_extra_options',
  1149. ).and_return((), None)
  1150. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1151. 'make_defaults_file_options',
  1152. ).with_args(None, None, None).and_return(())
  1153. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1154. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1155. (
  1156. 'mysql',
  1157. '--batch',
  1158. '--ssl',
  1159. ),
  1160. processes=[extract_process],
  1161. output_log_level=logging.DEBUG,
  1162. input_file=extract_process.stdout,
  1163. environment={'USER': 'root'},
  1164. ).once()
  1165. module.restore_data_source_dump(
  1166. hook_config,
  1167. {},
  1168. data_source=hook_config[0],
  1169. dry_run=False,
  1170. extract_process=extract_process,
  1171. connection_params={
  1172. 'hostname': None,
  1173. 'port': None,
  1174. 'username': None,
  1175. 'password': None,
  1176. },
  1177. borgmatic_runtime_directory='/run/borgmatic',
  1178. )
  1179. def test_restore_data_source_dump_runs_mysql_without_tls():
  1180. hook_config = [{'name': 'foo', 'tls': False}]
  1181. extract_process = flexmock(stdout=flexmock())
  1182. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1183. 'resolve_credential',
  1184. ).replace_with(lambda value, config: value)
  1185. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1186. 'parse_extra_options',
  1187. ).and_return((), None)
  1188. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1189. 'make_defaults_file_options',
  1190. ).with_args(None, None, None).and_return(())
  1191. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1192. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1193. (
  1194. 'mysql',
  1195. '--batch',
  1196. '--skip-ssl',
  1197. ),
  1198. processes=[extract_process],
  1199. output_log_level=logging.DEBUG,
  1200. input_file=extract_process.stdout,
  1201. environment={'USER': 'root'},
  1202. ).once()
  1203. module.restore_data_source_dump(
  1204. hook_config,
  1205. {},
  1206. data_source=hook_config[0],
  1207. dry_run=False,
  1208. extract_process=extract_process,
  1209. connection_params={
  1210. 'hostname': None,
  1211. 'port': None,
  1212. 'username': None,
  1213. 'password': None,
  1214. },
  1215. borgmatic_runtime_directory='/run/borgmatic',
  1216. )
  1217. def test_restore_data_source_dump_runs_mysql_with_username_and_password():
  1218. hook_config = [{'name': 'foo', 'username': 'root', 'password': 'trustsome1'}]
  1219. extract_process = flexmock(stdout=flexmock())
  1220. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1221. 'resolve_credential',
  1222. ).replace_with(lambda value, config: value)
  1223. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1224. 'parse_extra_options',
  1225. ).and_return((), None)
  1226. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1227. 'make_defaults_file_options',
  1228. ).with_args('root', 'trustsome1', None).and_return(('--defaults-extra-file=/dev/fd/99',))
  1229. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1230. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1231. ('mysql', '--defaults-extra-file=/dev/fd/99', '--batch'),
  1232. processes=[extract_process],
  1233. output_log_level=logging.DEBUG,
  1234. input_file=extract_process.stdout,
  1235. environment={'USER': 'root'},
  1236. ).once()
  1237. module.restore_data_source_dump(
  1238. hook_config,
  1239. {},
  1240. data_source=hook_config[0],
  1241. dry_run=False,
  1242. extract_process=extract_process,
  1243. connection_params={
  1244. 'hostname': None,
  1245. 'port': None,
  1246. 'username': None,
  1247. 'password': None,
  1248. },
  1249. borgmatic_runtime_directory='/run/borgmatic',
  1250. )
  1251. def test_restore_data_source_with_environment_password_transport_skips_defaults_file_and_passes_user_flag():
  1252. hook_config = [
  1253. {
  1254. 'name': 'foo',
  1255. 'username': 'root',
  1256. 'password': 'trustsome1',
  1257. 'password_transport': 'environment',
  1258. },
  1259. ]
  1260. extract_process = flexmock(stdout=flexmock())
  1261. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1262. 'resolve_credential',
  1263. ).replace_with(lambda value, config: value)
  1264. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1265. 'parse_extra_options',
  1266. ).and_return((), None)
  1267. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1268. 'make_defaults_file_options',
  1269. ).never()
  1270. flexmock(module.os).should_receive('environ').and_return(
  1271. {'USER': 'root', 'MYSQL_PWD': 'trustsome1'},
  1272. )
  1273. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1274. ('mysql', '--batch', '--user', 'root'),
  1275. processes=[extract_process],
  1276. output_log_level=logging.DEBUG,
  1277. input_file=extract_process.stdout,
  1278. environment={'USER': 'root', 'MYSQL_PWD': 'trustsome1'},
  1279. ).once()
  1280. module.restore_data_source_dump(
  1281. hook_config,
  1282. {},
  1283. data_source=hook_config[0],
  1284. dry_run=False,
  1285. extract_process=extract_process,
  1286. connection_params={
  1287. 'hostname': None,
  1288. 'port': None,
  1289. 'username': None,
  1290. 'password': None,
  1291. },
  1292. borgmatic_runtime_directory='/run/borgmatic',
  1293. )
  1294. def test_restore_data_source_dump_with_connection_params_uses_connection_params_for_restore():
  1295. hook_config = [
  1296. {
  1297. 'name': 'foo',
  1298. 'username': 'root',
  1299. 'password': 'trustsome1',
  1300. 'restore_hostname': 'restorehost',
  1301. 'restore_port': 'restoreport',
  1302. 'restore_username': 'restoreusername',
  1303. 'restore_password': 'restorepassword',
  1304. },
  1305. ]
  1306. extract_process = flexmock(stdout=flexmock())
  1307. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1308. 'resolve_credential',
  1309. ).replace_with(lambda value, config: value)
  1310. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1311. 'parse_extra_options',
  1312. ).and_return((), None)
  1313. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1314. 'make_defaults_file_options',
  1315. ).with_args('cliusername', 'clipassword', None).and_return(
  1316. ('--defaults-extra-file=/dev/fd/99',),
  1317. )
  1318. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1319. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1320. (
  1321. 'mysql',
  1322. '--defaults-extra-file=/dev/fd/99',
  1323. '--batch',
  1324. '--host',
  1325. 'clihost',
  1326. '--port',
  1327. 'cliport',
  1328. '--protocol',
  1329. 'tcp',
  1330. ),
  1331. processes=[extract_process],
  1332. output_log_level=logging.DEBUG,
  1333. input_file=extract_process.stdout,
  1334. environment={'USER': 'root'},
  1335. ).once()
  1336. module.restore_data_source_dump(
  1337. hook_config,
  1338. {},
  1339. data_source={'name': 'foo'},
  1340. dry_run=False,
  1341. extract_process=extract_process,
  1342. connection_params={
  1343. 'hostname': 'clihost',
  1344. 'port': 'cliport',
  1345. 'username': 'cliusername',
  1346. 'password': 'clipassword',
  1347. },
  1348. borgmatic_runtime_directory='/run/borgmatic',
  1349. )
  1350. def test_restore_data_source_dump_without_connection_params_uses_restore_params_in_config_for_restore():
  1351. hook_config = [
  1352. {
  1353. 'name': 'foo',
  1354. 'username': 'root',
  1355. 'password': 'trustsome1',
  1356. 'hostname': 'dbhost',
  1357. 'port': 'dbport',
  1358. 'tls': True,
  1359. 'restore_username': 'restoreuser',
  1360. 'restore_password': 'restorepass',
  1361. 'restore_hostname': 'restorehost',
  1362. 'restore_port': 'restoreport',
  1363. 'restore_tls': False,
  1364. },
  1365. ]
  1366. extract_process = flexmock(stdout=flexmock())
  1367. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1368. 'resolve_credential',
  1369. ).replace_with(lambda value, config: value)
  1370. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1371. 'parse_extra_options',
  1372. ).and_return((), None)
  1373. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1374. 'make_defaults_file_options',
  1375. ).with_args('restoreuser', 'restorepass', None).and_return(
  1376. ('--defaults-extra-file=/dev/fd/99',),
  1377. )
  1378. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1379. flexmock(module).should_receive('execute_command_with_processes').with_args(
  1380. (
  1381. 'mysql',
  1382. '--defaults-extra-file=/dev/fd/99',
  1383. '--batch',
  1384. '--host',
  1385. 'restorehost',
  1386. '--port',
  1387. 'restoreport',
  1388. '--protocol',
  1389. 'tcp',
  1390. '--skip-ssl',
  1391. ),
  1392. processes=[extract_process],
  1393. output_log_level=logging.DEBUG,
  1394. input_file=extract_process.stdout,
  1395. environment={'USER': 'root'},
  1396. ).once()
  1397. module.restore_data_source_dump(
  1398. hook_config,
  1399. {},
  1400. data_source=hook_config[0],
  1401. dry_run=False,
  1402. extract_process=extract_process,
  1403. connection_params={
  1404. 'hostname': None,
  1405. 'port': None,
  1406. 'username': None,
  1407. 'password': None,
  1408. },
  1409. borgmatic_runtime_directory='/run/borgmatic',
  1410. )
  1411. def test_restore_data_source_dump_with_dry_run_skips_restore():
  1412. hook_config = [{'name': 'foo'}]
  1413. flexmock(module.borgmatic.hooks.credential.parse).should_receive(
  1414. 'resolve_credential',
  1415. ).replace_with(lambda value, config: value)
  1416. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1417. 'parse_extra_options',
  1418. ).and_return((), None)
  1419. flexmock(module.borgmatic.hooks.data_source.mariadb).should_receive(
  1420. 'make_defaults_file_options',
  1421. ).with_args(None, None, None).and_return(())
  1422. flexmock(module.os).should_receive('environ').and_return({'USER': 'root'})
  1423. flexmock(module).should_receive('execute_command_with_processes').never()
  1424. module.restore_data_source_dump(
  1425. hook_config,
  1426. {},
  1427. data_source={'name': 'foo'},
  1428. dry_run=True,
  1429. extract_process=flexmock(),
  1430. connection_params={
  1431. 'hostname': None,
  1432. 'port': None,
  1433. 'username': None,
  1434. 'password': None,
  1435. },
  1436. borgmatic_runtime_directory='/run/borgmatic',
  1437. )