forked from borgmatic-collective/borgmatic
Compare commits
744 Commits
Author | SHA1 | Date | |
---|---|---|---|
df4668754d | |||
08d6f83b2e | |||
c58f510054 | |||
c2879d054a | |||
f821d2c909 | |||
1ef2218919 | |||
177c958572 | |||
b5ab1ff0cd | |||
70a978b83d | |||
2037810c6b | |||
de304f83de | |||
5752373009 | |||
fecae39fcd | |||
38bc4fbfe2 | |||
92ed7573d4 | |||
80f0e92462 | |||
5f10b1b2ca | |||
4f83b1e6b3 | |||
15d5a687fb | |||
eb1fce3787 | |||
7f735cbe59 | |||
a690ea4016 | |||
7a110c7acd | |||
407bb33359 | |||
4b7f7bba04 | |||
cfdc0a1f2a | |||
f926055e67 | |||
058af95d70 | |||
54facdc391 | |||
2e4c0cc7e7 | |||
cb2fd7c5e8 | |||
94133cc8b1 | |||
dcec89be90 | |||
fefd5d1d0e | |||
163c37d77f | |||
b0e49ebce0 | |||
7e51c41ebf | |||
f9182514d8 | |||
7700b87b60 | |||
75bdbe6087 | |||
d243a8c836 | |||
4c2eb2bfe3 | |||
89ce060dbd | |||
ad7dcb4615 | |||
6680aece5a | |||
57eb93760f | |||
f21a2c06e3 | |||
2212539cb0 | |||
36d10fecb1 | |||
3ecd0e731e | |||
ecf5a7e294 | |||
893fbcf9ff | |||
f8f6560502 | |||
8c301ba688 | |||
035e96156a | |||
a08c7fc77a | |||
cf9e387811 | |||
e37224606a | |||
9647301b99 | |||
a0e5dbff96 | |||
86117edccf | |||
440f3eeb63 | |||
181051eae1 | |||
ec0ee971ed | |||
b83ffa0cf6 | |||
cf88665d37 | |||
b233adba63 | |||
018f5e3315 | |||
284f26b49d | |||
11b437794e | |||
0665b50d57 | |||
0586b80e5b | |||
272a7b4866 | |||
98d4a59459 | |||
744139cf97 | |||
1339509e9b | |||
e14f61415b | |||
98cf8f7e20 | |||
5f16b64639 | |||
fe62a81151 | |||
585b1573ae | |||
141ba2771d | |||
a527f76d08 | |||
a97c68b4c8 | |||
ef07005a75 | |||
43c7c3b6be | |||
2f6ad9d173 | |||
16bc0de3fb | |||
458d157e62 | |||
40c3a28620 | |||
60107f1ee8 | |||
a1153a21fa | |||
b6cb7da98e | |||
9e3d19a406 | |||
2b755d8ade | |||
925f99cfef | |||
c9f20eb260 | |||
f4744826fe | |||
5586aab967 | |||
6fa5dff79b | |||
75d11aa9cd | |||
ad1d104d65 | |||
009062128d | |||
e9813d2539 | |||
f9998b50e8 | |||
5f921a7f80 | |||
abf2b3a8c7 | |||
34f3c2bb16 | |||
4d79f582df | |||
63198088c4 | |||
3c22a8ec16 | |||
ca49109ce7 | |||
6a7f71f92f | |||
5f3dc1cfb0 | |||
f2023aed22 | |||
a03c2744e5 | |||
![]() |
4176532317 | ||
9d6025e902 | |||
cf739bc997 | |||
84823dfb91 | |||
20cf0f7089 | |||
67af0f5734 | |||
e80e0a253c | |||
72587a3b72 | |||
8b49a59aff | |||
e120dff9ff | |||
257678b66f | |||
422c5e32f4 | |||
c34ad7dde7 | |||
fdb353d358 | |||
3b99f7c75a | |||
8b9abc6cf8 | |||
da034c316a | |||
08d01d8bcd | |||
eef69e23ee | |||
26bb54a9dd | |||
715e2ac127 | |||
f39cea4abf | |||
22101bdd49 | |||
13cf863d89 | |||
dcf25fa041 | |||
12b75f9075 | |||
9baf06a2f7 | |||
![]() |
56302e22cd | ||
6cc93c4eb9 | |||
2da43239f6 | |||
4beef36d3c | |||
eacfbd742b | |||
82a85986b6 | |||
ef448e2dd1 | |||
c3efe1b90e | |||
d85c1ee216 | |||
b47088067c | |||
c5732aa4fc | |||
a0323d9d6c | |||
8ad7b473f1 | |||
895a0ccb3c | |||
257ab77bea | |||
dccaa4014b | |||
![]() |
2f3c0bec5b | ||
487d8ffd32 | |||
30523a7c89 | |||
77b1907d03 | |||
09594c85bf | |||
e07efdf68f | |||
1fed44f905 | |||
c687dafdd2 | |||
3eff2c4248 | |||
d94fdb6faf | |||
a83282faf0 | |||
e7169f6fb2 | |||
9587fc2366 | |||
5f06884d5a | |||
f011431463 | |||
9e14f209f1 | |||
9d34d2eec5 | |||
7a9625cd44 | |||
4763c323d0 | |||
eaa22be3db | |||
a587e207f9 | |||
db8079b699 | |||
5a989826a1 | |||
21f4266273 | |||
e7252c7545 | |||
86011c8418 | |||
f3295ccb4a | |||
cacb81f086 | |||
06c2154e6a | |||
ac1e1a9407 | |||
10933fd55b | |||
af422ad705 | |||
d9d35491fb | |||
b540e63c0e | |||
5a56208922 | |||
5912769273 | |||
bac2aabe66 | |||
9f3328781b | |||
0205748db8 | |||
d0a8251ad2 | |||
32019ea8f3 | |||
fa9a061033 | |||
b3d2560563 | |||
4b4f56da42 | |||
b96d1898f7 | |||
099a712e53 | |||
9e2674ea5a | |||
7e419ec995 | |||
a3edf757ee | |||
e576403b64 | |||
7313430178 | |||
962daaa8b9 | |||
cd51e9c1ea | |||
6dca7c1c15 | |||
fd8c56c6be | |||
065057c966 | |||
c04517f843 | |||
5d80c366fb | |||
193dd93de2 | |||
8a94b9e2f1 | |||
3c8f6040e2 | |||
14e2a6b89d | |||
e607de7df1 | |||
e9bd5f4e1d | |||
175003ff9b | |||
b8d349d048 | |||
f6f06551f0 | |||
69771fe7ce | |||
c5c3e2e0ce | |||
8491b2c416 | |||
962267b3c5 | |||
562f4a281b | |||
6b09ca8022 | |||
f2ce2f387f | |||
782a9bb70a | |||
88adb5b3de | |||
59465b256d | |||
adfb89ee65 | |||
c11dcdef0a | |||
8a2514915c | |||
4d7a2876a5 | |||
309f67e860 | |||
0ad7b4f408 | |||
1f415a24b8 | |||
5c941600a6 | |||
5e0283b391 | |||
ac0b23901b | |||
cde50a75e9 | |||
521c0eb600 | |||
bc5dc2253c | |||
973ab01afb | |||
9413a19eca | |||
0055de08a4 | |||
04fb351a11 | |||
e913cddcd1 | |||
da78929415 | |||
18b3b569d0 | |||
054bd52482 | |||
2453ecad42 | |||
cedf562a7e | |||
5b991b88dd | |||
d2fa205476 | |||
ecd9e62147 | |||
003d4eac93 | |||
e8dbca9d68 | |||
bd9d592560 | |||
196a226a7e | |||
a3f47a6418 | |||
d29667ca3c | |||
7d18f59079 | |||
ab351548d2 | |||
48b6a1679a | |||
9cafc16052 | |||
fbbfc684ce | |||
13a37a1d9b | |||
9cf27fa4ba | |||
e2c95327fb | |||
f60e97d5bf | |||
44f9ab95f9 | |||
bb6004fc4f | |||
b242078f54 | |||
c3004c6090 | |||
b9a11e860d | |||
37a0a0c421 | |||
325b561296 | |||
b62017be4b | |||
8debcbeaba | |||
35a11559ac | |||
e4e455ee45 | |||
23809e9060 | |||
bb0dd14f69 | |||
308c96aeb5 | |||
62a2f5a1d0 | |||
e8c862659c | |||
69611681e2 | |||
9e0df595c8 | |||
68d90e1e40 | |||
248500c7be | |||
3addb60fb8 | |||
01fffab898 | |||
bc93401a70 | |||
1b90da5bf1 | |||
803fc25848 | |||
248f82d6f6 | |||
87c6e5b349 | |||
147516ae3f | |||
b10aee3070 | |||
6098005f5d | |||
7b8be800a4 | |||
1a21eb03cd | |||
e2d82e9bba | |||
384182172a | |||
9016dcc418 | |||
e53dd3da87 | |||
6c87608548 | |||
ee2ebb79b8 | |||
89602d1614 | |||
c294e78715 | |||
9152fed249 | |||
8389851f2f | |||
bbc7f0596c | |||
82d851d891 | |||
62b6f13299 | |||
b7423c488e | |||
1d7c7eaaa7 | |||
a9386b7a87 | |||
205e5b1524 | |||
67f4d43aec | |||
e15bec30e6 | |||
230cf6adc4 | |||
8e8e64d920 | |||
f558cb3156 | |||
41924f2400 | |||
670bdffb3c | |||
691d4f887a | |||
beb899d6fb | |||
0f9756e739 | |||
d84f1ec616 | |||
ef409ad23c | |||
d370ff958d | |||
197920d9ef | |||
425f260a22 | |||
3315555d06 | |||
6475345a8f | |||
f90d30e0e1 | |||
8384eaefb1 | |||
dcb90bba50 | |||
dc56fd33a0 | |||
2d761dd86b | |||
f82631e3bb | |||
4b024daae0 | |||
6a1d1a2e59 | |||
206a9c9607 | |||
a6425b8867 | |||
b5d9398910 | |||
a185eb73b0 | |||
e80f27f922 | |||
1a5b3c9e4e | |||
b3f70434df | |||
c61d63b235 | |||
ba0899660d | |||
15cabb93ca | |||
ce6daff12f | |||
caf654366c | |||
bb60b25399 | |||
74aa28e027 | |||
4f49b345af | |||
1784ca5910 | |||
8f4cce5fa5 | |||
518aeabb2a | |||
341bd4118d | |||
b222f6a60b | |||
c0aaba6891 | |||
a7f81d538d | |||
4c60bf84d7 | |||
dbb778a4d6 | |||
f4a169fdf3 | |||
3d41ed3a34 | |||
0283f9ae2a | |||
d556a23f97 | |||
f98d07e8d8 | |||
09f59ad97d | |||
24be6272ed | |||
5a9bb4b97f | |||
6a2eb1f157 | |||
99473c30a8 | |||
f512d1e460 | |||
96adee444b | |||
8b7996dfda | |||
2241de11c0 | |||
84c21b062f | |||
76138faaf3 | |||
9299841a5b | |||
35b5c62ca6 | |||
05b989347c | |||
00e9bb011a | |||
833796d1c4 | |||
ee32b076eb | |||
e3425f48be | |||
79b094d035 | |||
b45e45f161 | |||
b10148844b | |||
ba845d4008 | |||
645d29b040 | |||
49b4d371ce | |||
1bc7bb4971 | |||
e66e449c3b | |||
8eb05b840a | |||
f0fc638284 | |||
c6126a9226 | |||
62b11ba16b | |||
403ae0f698 | |||
92a2230a07 | |||
b3b08ee6d7 | |||
15ef37d89f | |||
e84bac29e5 | |||
1a956e8b05 | |||
4aae7968b8 | |||
66964f613c | |||
614c1bf2e4 | |||
aa770b98f9 | |||
453b78c852 | |||
0657106893 | |||
43c532bc57 | |||
efb81fc2c1 | |||
c8f4344f89 | |||
a047f856a1 | |||
d732059979 | |||
ccfdd6806f | |||
aa564ac5fe | |||
77dbb5c499 | |||
e623f401b9 | |||
372622fbb1 | |||
469e0ccace | |||
59a6ce1462 | |||
5a7a1747f2 | |||
b557d635fd | |||
d59b9b817f | |||
16ac4824a5 | |||
3592ec3ddf | |||
8f3039be23 | |||
b4a38d8be9 | |||
d962376a9d | |||
193731a017 | |||
bbc3e9d717 | |||
639e88262e | |||
f12a10d888 | |||
28efc85660 | |||
f1fd2e88dd | |||
700f8e9d9c | |||
f04036e4a7 | |||
062453af51 | |||
b7fe2a5031 | |||
ca689505e5 | |||
9ff5ea5240 | |||
359afe5318 | |||
0b397a5bf9 | |||
a60d7fd173 | |||
f7e4024fca | |||
98e3a81fcf | |||
9c77ebb016 | |||
23f478ce74 | |||
d265b6ed6f | |||
77c3161c77 | |||
2e658cfa56 | |||
412d18f218 | |||
8060586d8b | |||
25b3db72a0 | |||
5678f3a96e | |||
28b152aedd | |||
0009471f67 | |||
a62ac42cca | |||
68ee9687f5 | |||
32395e47f9 | |||
8aaba9bb0a | |||
96aca4f446 | |||
22b84a2fea | |||
5962fd473e | |||
7e64f415ba | |||
ae12ccd8e6 | |||
3cefeaa229 | |||
71b75800cd | |||
9ca31530a0 | |||
b555fcb956 | |||
5829196b70 | |||
a14870ce48 | |||
ee5c25f3bd | |||
da0f5a34f2 | |||
065be1d9d4 | |||
f2f6fb537a | |||
7ff994a964 | |||
08edecacae | |||
1e03046d9a | |||
c9bf52ee45 | |||
f947525fca | |||
7f7b89d79c | |||
499e42df35 | |||
4302a07c9b | |||
1721c05d2e | |||
8a31c27078 | |||
d6e1cef356 | |||
f82bf619ff | |||
02eeca1fc2 | |||
4e78cf1b95 | |||
9e9a7c50e5 | |||
51bc53e5ca | |||
b85538c54c | |||
bb5028e484 | |||
53ee0fcfad | |||
5f8c79dd16 | |||
0a6f5452f4 | |||
269fac074b | |||
3b21ce4ce8 | |||
8bb7631f50 | |||
9f5769f87b | |||
991e08f16d | |||
1ee56805f1 | |||
25506b8d2c | |||
28e62d824b | |||
7ee37a890e | |||
8cb5a42a9e | |||
5dbb71709c | |||
1c67db5d62 | |||
96d4a8ee45 | |||
81e167959b | |||
f273e82d74 | |||
17f122bfe5 | |||
f0f43174c6 | |||
dfccc1b94a | |||
195024e505 | |||
19a00371f5 | |||
874fba7672 | |||
50b0a9ce38 | |||
8802f6888e | |||
ebe5c5e839 | |||
613f6c602c | |||
4a94c2c9bf | |||
08843d51d9 | |||
ea9213cb03 | |||
1ea4433aa9 | |||
2fea429d78 | |||
264cebd2b1 | |||
4c0e2cab78 | |||
31a2ac914a | |||
d6ef0df50d | |||
cc60a71210 | |||
4cd7556a34 | |||
b4b1fa939d | |||
16d7131fb7 | |||
091d60c226 | |||
0fbdf8d860 | |||
192bfe46a9 | |||
080c3afa0d | |||
9bc2322f9a | |||
a9a65ebe54 | |||
616eb6b6da | |||
00d1dea94e | |||
127ad1dd1f | |||
fc58ba5763 | |||
7e6bee84b0 | |||
01811e03ba | |||
9712d00680 | |||
275e99d0b9 | |||
b9328e6d42 | |||
2934d0902c | |||
1ad43ad4b5 | |||
32ab17fa46 | |||
6054ced931 | |||
1412038ed3 | |||
![]() |
fa8bc285c8 | ||
f256908b27 | |||
3f78ac4085 | |||
5f595f7ac3 | |||
b27e625a77 | |||
fc2c181b74 | |||
010b82d6d8 | |||
aaf3462d17 | |||
f709125110 | |||
3512191f3e | |||
06b5d81baa | |||
9d71bf916e | |||
59fe01b56d | |||
08e358e27f | |||
ce22d2d302 | |||
2d08a63e60 | |||
98c6aa6443 | |||
edd79ed86c | |||
d96f2239c1 | |||
67a349ae44 | |||
dcefded0fa | |||
1bcdebd1cc | |||
7a8e0e89dd | |||
489ae080e5 | |||
0e3da7be63 | |||
c5ffb76dfa | |||
61c7b8f13c | |||
3e8e38011b | |||
4fa4fccab7 | |||
d0d3a39833 | |||
8bef1c698b | |||
acbbd6670a | |||
b336b9bedf | |||
ec9def4e71 | |||
a136fda92d | |||
b511e679ae | |||
f56fdab7a9 | |||
ff1f4dc09c | |||
141474ff07 | |||
8c0eea7229 | |||
19e95628c3 | |||
4d01e53414 | |||
a082cb87cb | |||
1c51a8e229 | |||
d14a8df71a | |||
739a58fe47 | |||
af3431d6ae | |||
9851abc2e1 | |||
61ce6f0473 | |||
78e8bb6c8c | |||
af95134cd2 | |||
d6dfb8753a | |||
1bc003560a | |||
aeaf69f49e | |||
e83ad9e1e4 | |||
f42890430c | |||
6f300b0079 | |||
9bec029b4f | |||
08afad5d81 | |||
a01dc62468 | |||
8b61225b13 | |||
66d2f49f18 | |||
0a72c67c6c | |||
ab64b7ef67 | |||
1e3a3bf1e7 | |||
7a2f287918 | |||
8a63c49498 | |||
3b5ede8044 | |||
bd235f0426 | |||
09183464cd | |||
ca6fd6b061 | |||
dd9a64f4b6 | |||
23e7f27ee4 | |||
f9ef52f9a5 | |||
3f17c355ca | |||
c83fae5e5b | |||
39ad8f64c4 | |||
e86d223bbf | |||
86587ab2dc | |||
58c95d8015 | |||
6351747da5 | |||
55c153409e | |||
b115fb2fbe | |||
31d04d9ee3 | |||
f803836416 | |||
997f60b3e6 | |||
c84b26499b | |||
214ae81cbb | |||
d17b2c74db | |||
fb9677230b | |||
0db137efdf | |||
e6605c868d | |||
bdfe4b61eb | |||
ca4461820d | |||
7605838bfe | |||
7a784b8eba | |||
![]() |
3e22414613 | ||
![]() |
5f87ea3ec5 | ||
![]() |
a8aeace5b5 | ||
![]() |
480addd7ce | ||
![]() |
ce0ce4cd1c | ||
![]() |
7de9260b0d | ||
![]() |
cdbe6cdf3a | ||
95dcc20d5f | |||
49e0494924 | |||
![]() |
5fad2bd408 | ||
c6829782a3 | |||
8cec7c74d8 | |||
d3086788eb | |||
8d860ea02c | |||
b343363bb8 | |||
9db31bd1e9 | |||
d88bcc8be9 | |||
332f7c4bb6 | |||
5d19d86e4a | |||
044ae7869a | |||
62ae82f2c0 | |||
66194b7304 | |||
98e429594e | |||
4fcfddbe08 | |||
f442aeae9c | |||
e211863cba | |||
45256ae33f | |||
1573d68fe2 | |||
69f6695253 | |||
a7c055264d | |||
db18364a73 | |||
22498ebd4c | |||
e1f02d9fa5 | |||
9ec220c600 | |||
cf0275a3ed | |||
c71eb60cd2 | |||
675e54ba9f | |||
1793ad74bd | |||
767a7d900b | |||
903507bd03 | |||
b6cf7d2adc | |||
a071e02d20 | |||
3aa88085ed | |||
af1cc27988 | |||
dbf8301c19 | |||
2a306bef12 | |||
2a36a2a312 | |||
d7a07f0428 | |||
da321e180d | |||
c6582e1171 | |||
9b83afe491 | |||
2814ac3642 | |||
8a9d5d93f5 | |||
783a6d3b45 | |||
95575c3450 | |||
9b071ff92f | |||
d80e716822 | |||
418ebc8843 | |||
f5a448c7c2 | |||
37ac542b31 | |||
![]() |
8c7d7e3e41 | ||
b811f125b2 | |||
061f3e7917 | |||
6055918907 | |||
4a90e090ad | |||
301b29ee11 | |||
c1eb210253 | |||
30cca62d09 | |||
113c0e7616 | |||
0e6b2c6773 | |||
22c750b949 | |||
504cce39a1 | |||
6c4abb6803 | |||
![]() |
fd7ad86daa | ||
6f3b23c79d | |||
4838f5e810 | |||
116f1ab989 | |||
5e15c9f2bc | |||
![]() |
3720f22234 | ||
![]() |
1fdec480d6 |
56
.drone.yml
56
.drone.yml
|
@ -1,56 +0,0 @@
|
||||||
kind: pipeline
|
|
||||||
name: python-3-8-alpine-3-13
|
|
||||||
|
|
||||||
services:
|
|
||||||
- name: postgresql
|
|
||||||
image: postgres:13.1-alpine
|
|
||||||
environment:
|
|
||||||
POSTGRES_PASSWORD: test
|
|
||||||
POSTGRES_DB: test
|
|
||||||
- name: mysql
|
|
||||||
image: mariadb:10.5
|
|
||||||
environment:
|
|
||||||
MYSQL_ROOT_PASSWORD: test
|
|
||||||
MYSQL_DATABASE: test
|
|
||||||
- name: mongodb
|
|
||||||
image: mongo:5.0.5
|
|
||||||
environment:
|
|
||||||
MONGO_INITDB_ROOT_USERNAME: root
|
|
||||||
MONGO_INITDB_ROOT_PASSWORD: test
|
|
||||||
|
|
||||||
clone:
|
|
||||||
skip_verify: true
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: build
|
|
||||||
image: alpine:3.13
|
|
||||||
pull: always
|
|
||||||
commands:
|
|
||||||
- scripts/run-full-tests
|
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: documentation
|
|
||||||
|
|
||||||
clone:
|
|
||||||
skip_verify: true
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: build
|
|
||||||
image: plugins/docker
|
|
||||||
settings:
|
|
||||||
username:
|
|
||||||
from_secret: docker_username
|
|
||||||
password:
|
|
||||||
from_secret: docker_password
|
|
||||||
registry: projects.torsion.org
|
|
||||||
repo: projects.torsion.org/borgmatic-collective/borgmatic
|
|
||||||
tags: docs
|
|
||||||
dockerfile: docs/Dockerfile
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
repo:
|
|
||||||
- borgmatic-collective/borgmatic
|
|
||||||
branch:
|
|
||||||
- master
|
|
||||||
event:
|
|
||||||
- push
|
|
|
@ -1,4 +1,5 @@
|
||||||
const pluginSyntaxHighlight = require("@11ty/eleventy-plugin-syntaxhighlight");
|
const pluginSyntaxHighlight = require("@11ty/eleventy-plugin-syntaxhighlight");
|
||||||
|
const codeClipboard = require("eleventy-plugin-code-clipboard");
|
||||||
const inclusiveLangPlugin = require("@11ty/eleventy-plugin-inclusive-language");
|
const inclusiveLangPlugin = require("@11ty/eleventy-plugin-inclusive-language");
|
||||||
const navigationPlugin = require("@11ty/eleventy-navigation");
|
const navigationPlugin = require("@11ty/eleventy-navigation");
|
||||||
|
|
||||||
|
@ -6,6 +7,7 @@ module.exports = function(eleventyConfig) {
|
||||||
eleventyConfig.addPlugin(pluginSyntaxHighlight);
|
eleventyConfig.addPlugin(pluginSyntaxHighlight);
|
||||||
eleventyConfig.addPlugin(inclusiveLangPlugin);
|
eleventyConfig.addPlugin(inclusiveLangPlugin);
|
||||||
eleventyConfig.addPlugin(navigationPlugin);
|
eleventyConfig.addPlugin(navigationPlugin);
|
||||||
|
eleventyConfig.addPlugin(codeClipboard);
|
||||||
|
|
||||||
let markdownIt = require("markdown-it");
|
let markdownIt = require("markdown-it");
|
||||||
let markdownItAnchor = require("markdown-it-anchor");
|
let markdownItAnchor = require("markdown-it-anchor");
|
||||||
|
@ -31,6 +33,7 @@ module.exports = function(eleventyConfig) {
|
||||||
markdownIt(markdownItOptions)
|
markdownIt(markdownItOptions)
|
||||||
.use(markdownItAnchor, markdownItAnchorOptions)
|
.use(markdownItAnchor, markdownItAnchorOptions)
|
||||||
.use(markdownItReplaceLink)
|
.use(markdownItReplaceLink)
|
||||||
|
.use(codeClipboard.markdownItCopyButton)
|
||||||
);
|
);
|
||||||
|
|
||||||
eleventyConfig.addPassthroughCopy({"docs/static": "static"});
|
eleventyConfig.addPassthroughCopy({"docs/static": "static"});
|
||||||
|
|
|
@ -1,35 +0,0 @@
|
||||||
#### What I'm trying to do and why
|
|
||||||
|
|
||||||
#### Steps to reproduce (if a bug)
|
|
||||||
|
|
||||||
Include (sanitized) borgmatic configuration files if applicable.
|
|
||||||
|
|
||||||
#### Actual behavior (if a bug)
|
|
||||||
|
|
||||||
Include (sanitized) `--verbosity 2` output if applicable.
|
|
||||||
|
|
||||||
#### Expected behavior (if a bug)
|
|
||||||
|
|
||||||
#### Other notes / implementation ideas
|
|
||||||
|
|
||||||
#### Environment
|
|
||||||
|
|
||||||
**borgmatic version:** [version here]
|
|
||||||
|
|
||||||
Use `sudo borgmatic --version` or `sudo pip show borgmatic | grep ^Version`
|
|
||||||
|
|
||||||
**borgmatic installation method:** [e.g., Debian package, Docker container, etc.]
|
|
||||||
|
|
||||||
**Borg version:** [version here]
|
|
||||||
|
|
||||||
Use `sudo borg --version`
|
|
||||||
|
|
||||||
**Python version:** [version here]
|
|
||||||
|
|
||||||
Use `python3 --version`
|
|
||||||
|
|
||||||
**Database version (if applicable):** [version here]
|
|
||||||
|
|
||||||
Use `psql --version` or `mysql --version` on client and server.
|
|
||||||
|
|
||||||
**operating system and version:** [OS here]
|
|
77
.gitea/issue_template/bug_template.yaml
Normal file
77
.gitea/issue_template/bug_template.yaml
Normal file
|
@ -0,0 +1,77 @@
|
||||||
|
name: "Bug or question/support"
|
||||||
|
about: "For filing a bug or getting support"
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: problem
|
||||||
|
attributes:
|
||||||
|
label: What I'm trying to do and why
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: repro_steps
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Include (sanitized) borgmatic configuration files if applicable.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: actual_behavior
|
||||||
|
attributes:
|
||||||
|
label: Actual behavior
|
||||||
|
description: Include (sanitized) `--verbosity 2` output if applicable.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: expected_behavior
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: notes
|
||||||
|
attributes:
|
||||||
|
label: Other notes / implementation ideas
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: borgmatic_version
|
||||||
|
attributes:
|
||||||
|
label: borgmatic version
|
||||||
|
description: Use `sudo borgmatic --version` or `sudo pip show borgmatic | grep ^Version`
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: borgmatic_install_method
|
||||||
|
attributes:
|
||||||
|
label: borgmatic installation method
|
||||||
|
description: e.g., pip install, Debian package, container, etc.
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: borg_version
|
||||||
|
attributes:
|
||||||
|
label: Borg version
|
||||||
|
description: Use `sudo borg --version`
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: python_version
|
||||||
|
attributes:
|
||||||
|
label: Python version
|
||||||
|
description: Use `python3 --version`
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: database_version
|
||||||
|
attributes:
|
||||||
|
label: Database version (if applicable)
|
||||||
|
description: Use `psql --version` / `mysql --version` / `mongodump --version` / `sqlite3 --version`
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: operating_system_version
|
||||||
|
attributes:
|
||||||
|
label: Operating system and version
|
||||||
|
description: On Linux, use `cat /etc/os-release`
|
||||||
|
validations:
|
||||||
|
required: false
|
1
.gitea/issue_template/config.yaml
Normal file
1
.gitea/issue_template/config.yaml
Normal file
|
@ -0,0 +1 @@
|
||||||
|
blank_issues_enabled: true
|
15
.gitea/issue_template/feature_template.yaml
Normal file
15
.gitea/issue_template/feature_template.yaml
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
name: "Feature"
|
||||||
|
about: "For filing a feature request or idea"
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: request
|
||||||
|
attributes:
|
||||||
|
label: What I'd like to do and why
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: notes
|
||||||
|
attributes:
|
||||||
|
label: Other notes / implementation ideas
|
||||||
|
validations:
|
||||||
|
required: false
|
28
.gitea/workflows/build.yaml
Normal file
28
.gitea/workflows/build.yaml
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
name: build
|
||||||
|
run-name: ${{ gitea.actor }} is building
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: host
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- run: scripts/run-end-to-end-tests
|
||||||
|
|
||||||
|
docs:
|
||||||
|
needs: [test]
|
||||||
|
runs-on: host
|
||||||
|
env:
|
||||||
|
IMAGE_NAME: projects.torsion.org/borgmatic-collective/borgmatic:docs
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- run: podman login --username "$USERNAME" --password "$PASSWORD" projects.torsion.org
|
||||||
|
env:
|
||||||
|
USERNAME: "${{ secrets.REGISTRY_USERNAME }}"
|
||||||
|
PASSWORD: "${{ secrets.REGISTRY_PASSWORD }}"
|
||||||
|
- run: podman build --tag "$IMAGE_NAME" --file docs/Dockerfile --storage-opt "overlay.mount_program=/usr/bin/fuse-overlayfs" .
|
||||||
|
- run: podman push "$IMAGE_NAME"
|
373
NEWS
373
NEWS
|
@ -1,8 +1,365 @@
|
||||||
1.7.6.dev0
|
1.8.12.dev0
|
||||||
* #438, #560: Optionally dump "all" PostgreSQL databases to separate files instead of one combined
|
* #860: Fix interaction between environment variable interpolation in constants and shell escaping.
|
||||||
dump file, allowing more convenient restores of individual databases. You can enable this by
|
* #863: When color output is disabled (explicitly or implicitly), don't prefix each log line with
|
||||||
specifying the database dump "format" option when the database is named "all".
|
the log level.
|
||||||
|
* #866: Fix "Argument list too long" error in the "spot" check when checking hundreds of thousands
|
||||||
|
of files at once.
|
||||||
|
* #874: Add the configured repository label as "repository_label" to the interpolated variables
|
||||||
|
passed to before/after command hooks.
|
||||||
|
* In the "spot" check, don't try to hash symlinked directories.
|
||||||
|
|
||||||
|
1.8.11
|
||||||
|
* #815: Add optional Healthchecks auto-provisioning via "create_slug" option.
|
||||||
|
* #851: Fix lack of file extraction when using "extract --strip-components all" on a path with a
|
||||||
|
leading slash.
|
||||||
|
* #854: Fix a traceback when the "data" consistency check is used.
|
||||||
|
* #857: Fix a traceback with "check --only spot" when the "spot" check is unconfigured.
|
||||||
|
|
||||||
|
1.8.10
|
||||||
|
* #656 (beta): Add a "spot" consistency check that compares file counts and contents between your
|
||||||
|
source files and the latest archive, ensuring they fall within configured tolerances. This can
|
||||||
|
catch problems like incorrect excludes, inadvertent deletes, files changed by malware, etc. See
|
||||||
|
the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#spot-check
|
||||||
|
* #779: When "--match-archives *" is used with "check" action, don't skip Borg's orphaned objects
|
||||||
|
check.
|
||||||
|
* #842: When a command hook exits with a soft failure, ping the log and finish states for any
|
||||||
|
configured monitoring hooks.
|
||||||
|
* #843: Add documentation link to Loki dashboard for borgmatic:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#loki-hook
|
||||||
|
* #847: Fix "--json" error when Borg includes non-JSON warnings in JSON output.
|
||||||
|
* #848: SECURITY: Mask the password when logging a MongoDB dump or restore command.
|
||||||
|
* Fix handling of the NO_COLOR environment variable to ignore an empty value.
|
||||||
|
* Add documentation about backing up containerized databases by configuring borgmatic to exec into
|
||||||
|
a container to run a dump command:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#containers
|
||||||
|
|
||||||
|
1.8.9
|
||||||
|
* #311: Add custom dump/restore command options for MySQL and MariaDB.
|
||||||
|
* #811: Add an "access_token" option to the ntfy monitoring hook for authenticating
|
||||||
|
without username/password.
|
||||||
|
* #827: When the "--json" flag is given, suppress console escape codes so as not to
|
||||||
|
interfere with JSON output.
|
||||||
|
* #829: Fix "--override" values containing deprecated section headers not actually overriding
|
||||||
|
configuration options under deprecated section headers.
|
||||||
|
* #835: Add support for the NO_COLOR environment variable. See the documentation for more
|
||||||
|
information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/set-up-backups/#colored-output
|
||||||
|
* #839: Add log sending for the Apprise logging hook, enabled by default. See the documentation for
|
||||||
|
more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#apprise-hook
|
||||||
|
* #839: Document a potentially breaking shell quoting edge case within error hooks:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#error-hooks
|
||||||
|
* #840: When running the "rcreate" action and the repository already exists but with a different
|
||||||
|
encryption mode than requested, error.
|
||||||
|
* Switch from Drone to Gitea Actions for continuous integration.
|
||||||
|
* Rename scripts/run-end-to-end-dev-tests to scripts/run-end-to-end-tests and use it in both dev
|
||||||
|
and CI for better dev-CI parity.
|
||||||
|
* Clarify documentation about restoring a database: borgmatic does not create the database upon
|
||||||
|
restore.
|
||||||
|
|
||||||
|
1.8.8
|
||||||
|
* #370: For the PostgreSQL hook, pass the "PGSSLMODE" environment variable through to Borg when the
|
||||||
|
database's configuration omits the "ssl_mode" option.
|
||||||
|
* #818: Allow the "--repository" flag to match across multiple configuration files.
|
||||||
|
* #820: Fix broken repository detection in the "rcreate" action with Borg 1.4. The issue did not
|
||||||
|
occur with other versions of Borg.
|
||||||
|
* #822: Fix broken escaping logic in the PostgreSQL hook's "pg_dump_command" option.
|
||||||
|
* SECURITY: Prevent additional shell injection attacks within the PostgreSQL hook.
|
||||||
|
|
||||||
|
1.8.7
|
||||||
|
* #736: Store included configuration files within each backup archive in support of the "config
|
||||||
|
bootstrap" action. Previously, only top-level configuration files were stored.
|
||||||
|
* #798: Elevate specific Borg warnings to errors or squash errors to
|
||||||
|
* warnings. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/customize-warnings-and-errors/
|
||||||
|
* #810: SECURITY: Prevent shell injection attacks within the PostgreSQL hook, the MongoDB hook, the
|
||||||
|
SQLite hook, the "borgmatic borg" action, and command hook variable/constant interpolation.
|
||||||
|
* #814: Fix a traceback when providing an invalid "--override" value for a list option.
|
||||||
|
|
||||||
|
1.8.6
|
||||||
|
* #767: Add an "--ssh-command" flag to the "config bootstrap" action for setting a custom SSH
|
||||||
|
command, as no configuration is available (including the "ssh_command" option) until
|
||||||
|
bootstrapping completes.
|
||||||
|
* #794: Fix a traceback when the "repositories" option contains both strings and key/value pairs.
|
||||||
|
* #800: Add configured repository labels to the JSON output for all actions.
|
||||||
|
* #802: The "check --force" flag now runs checks even if "check" is in "skip_actions".
|
||||||
|
* #804: Validate the configured action names in the "skip_actions" option.
|
||||||
|
* #807: Stream SQLite databases directly to Borg instead of dumping to an intermediate file.
|
||||||
|
* When logging commands that borgmatic executes, log the environment variables that
|
||||||
|
borgmatic sets for those commands. (But don't log their values, since they often contain
|
||||||
|
passwords.)
|
||||||
|
|
||||||
|
1.8.5
|
||||||
|
* #701: Add a "skip_actions" option to skip running particular actions, handy for append-only or
|
||||||
|
checkless configurations. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/set-up-backups/#skipping-actions
|
||||||
|
* #701: Deprecate the "disabled" value for the "checks" option in favor of the new "skip_actions"
|
||||||
|
option.
|
||||||
|
* #745: Constants now apply to included configuration, not just the file doing the includes. As a
|
||||||
|
side effect of this change, constants no longer apply to option names and only substitute into
|
||||||
|
configuration values.
|
||||||
|
* #779: Add a "--match-archives" flag to the "check" action for selecting the archives to check,
|
||||||
|
overriding the existing "archive_name_format" and "match_archives" options in configuration.
|
||||||
|
* #779: Only parse "--override" values as complex data types when they're for options of those
|
||||||
|
types.
|
||||||
|
* #782: Fix environment variable interpolation within configured repository paths.
|
||||||
|
* #782: Add configuration constant overriding via the existing "--override" flag.
|
||||||
|
* #783: Upgrade ruamel.yaml dependency to support version 0.18.x.
|
||||||
|
* #784: Drop support for Python 3.7, which has been end-of-lifed.
|
||||||
|
|
||||||
|
1.8.4
|
||||||
|
* #715: Add a monitoring hook for sending backup status to a variety of monitoring services via the
|
||||||
|
Apprise library. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#apprise-hook
|
||||||
|
* #748: When an archive filter causes no matching archives for the "rlist" or "info"
|
||||||
|
actions, warn the user and suggest how to remove the filter.
|
||||||
|
* #768: Fix a traceback when an invalid command-line flag or action is used.
|
||||||
|
* #771: Fix normalization of deprecated sections ("location:", "storage:", "hooks:", etc.) to
|
||||||
|
support empty sections without erroring.
|
||||||
|
* #774: Disallow the "--dry-run" flag with the "borg" action, as borgmatic can't guarantee the Borg
|
||||||
|
command won't have side effects.
|
||||||
|
|
||||||
|
1.8.3
|
||||||
|
* #665: BREAKING: Simplify logging logic as follows: Syslog verbosity is now disabled by
|
||||||
|
default, but setting the "--syslog-verbosity" flag enables it regardless of whether you're at an
|
||||||
|
interactive console. Additionally, "--log-file-verbosity" and "--monitoring-verbosity" now
|
||||||
|
default to 1 (info about steps borgmatic is taking) instead of 0. And both syslog logging and
|
||||||
|
file logging can be enabled simultaneously.
|
||||||
|
* #743: Add a monitoring hook for sending backup status and logs to Grafana Loki. See the
|
||||||
|
documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#loki-hook
|
||||||
|
* #753: When "archive_name_format" is not set, filter archives using the default archive name
|
||||||
|
format.
|
||||||
|
* #754: Fix error handling to log command output as one record per line instead of truncating
|
||||||
|
too-long output and swallowing the end of some Borg error messages.
|
||||||
|
* #757: Update documentation so "sudo borgmatic" works for pipx borgmatic installations.
|
||||||
|
* #761: Fix for borgmatic not stopping Borg immediately when the user presses ctrl-C.
|
||||||
|
* Update documentation to recommend installing/upgrading borgmatic with pipx instead of pip. See the
|
||||||
|
documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/set-up-backups/#installation
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/upgrade/#upgrading-borgmatic
|
||||||
|
|
||||||
|
1.8.2
|
||||||
|
* #345: Add "key export" action to export a copy of the repository key for safekeeping in case
|
||||||
|
the original goes missing or gets damaged.
|
||||||
|
* #727: Add a MariaDB database hook that uses native MariaDB commands instead of the deprecated
|
||||||
|
MySQL ones. Be aware though that any existing backups made with the "mysql_databases:" hook are
|
||||||
|
only restorable with a "mysql_databases:" configuration.
|
||||||
|
* #738: Fix for potential data loss (data not getting restored) in which the database "restore"
|
||||||
|
action didn't actually restore anything and indicated success anyway.
|
||||||
|
* Remove the deprecated use of the MongoDB hook's "--db" flag for database restoration.
|
||||||
|
* Add source code reference documentation for getting oriented with the borgmatic code as a
|
||||||
|
developer: https://torsion.org/borgmatic/docs/reference/source-code/
|
||||||
|
|
||||||
|
1.8.1
|
||||||
|
* #326: Add documentation for restoring a database to an alternate host:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#restore-to-an-alternate-host
|
||||||
|
* #697: Add documentation for "bootstrap" action:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/extract-a-backup/#extract-the-configuration-files-used-to-create-an-archive
|
||||||
|
* #725: Add "store_config_files" option for disabling the automatic backup of configuration files
|
||||||
|
used by the "config bootstrap" action.
|
||||||
|
* #728: Fix for "prune" action error when using the "keep_exclude_tags" option.
|
||||||
|
* #730: Fix for Borg's interactive prompt on the "check --repair" action automatically getting
|
||||||
|
answered "NO" even when the "check_i_know_what_i_am_doing" option isn't set.
|
||||||
|
* #732: Include multiple configuration files with a single "!include". See the documentation for
|
||||||
|
more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#multiple-merge-includes
|
||||||
|
* #734: Omit "--glob-archives" or "--match-archives" Borg flag when its value would be "*" (meaning
|
||||||
|
all archives).
|
||||||
|
|
||||||
|
1.8.0
|
||||||
|
* #575: BREAKING: For the "borgmatic borg" action, instead of implicitly injecting
|
||||||
|
repository/archive into the resulting Borg command-line, pass repository to Borg via an
|
||||||
|
environment variable and make archive available for explicit use in your commands. See the
|
||||||
|
documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/run-arbitrary-borg-commands/
|
||||||
|
* #719: Fix an error when running "borg key export" through borgmatic.
|
||||||
|
* #720: Fix an error when dumping a database and the "exclude_nodump" option is set.
|
||||||
|
* #724: Add "check_i_know_what_i_am_doing" option to bypass Borg confirmation prompt when running
|
||||||
|
"check --repair".
|
||||||
|
* When merging two configuration files, error gracefully if the two files do not adhere to the same
|
||||||
|
format.
|
||||||
|
* #721: Remove configuration sections ("location:", "storage:", "hooks:", etc.), while still
|
||||||
|
keeping deprecated support for them. Now, all options are at the same level, and you don't need
|
||||||
|
to worry about commenting/uncommenting section headers when you change an option (if you remove
|
||||||
|
your sections first).
|
||||||
|
* #721: BREAKING: The retention prefix and the consistency prefix can no longer have different
|
||||||
|
values (unless one is not set).
|
||||||
|
* #721: BREAKING: The storage umask and the hooks umask can no longer have different values (unless
|
||||||
|
one is not set).
|
||||||
|
* BREAKING: Flags like "--config" that previously took multiple values now need to be given once
|
||||||
|
per value, e.g. "--config first.yaml --config second.yaml" instead of "--config first.yaml
|
||||||
|
second.yaml". This prevents argument parsing errors on ambiguous commands.
|
||||||
|
* BREAKING: Remove the deprecated (and silently ignored) "--successful" flag on the "list" action,
|
||||||
|
as newer versions of Borg list successful (non-checkpoint) archives by default.
|
||||||
|
* All deprecated configuration option values now generate warning logs.
|
||||||
|
* Remove the deprecated (and non-functional) "--excludes" flag in favor of excludes within
|
||||||
|
configuration.
|
||||||
|
* Fix an error when logging too-long command output during error handling. Now, long command output
|
||||||
|
is truncated before logging.
|
||||||
|
|
||||||
|
1.7.15
|
||||||
|
* #326: Add configuration options and command-line flags for backing up a database from one
|
||||||
|
location while restoring it somewhere else.
|
||||||
|
* #399: Add a documentation troubleshooting note for MySQL/MariaDB authentication errors.
|
||||||
|
* #529: Remove upgrade-borgmatic-config command for upgrading borgmatic 1.1.0 INI-style
|
||||||
|
configuration.
|
||||||
|
* #529: Deprecate generate-borgmatic-config in favor of new "config generate" action.
|
||||||
|
* #529: Deprecate validate-borgmatic-config in favor of new "config validate" action.
|
||||||
|
* #697, #712, #716: Extract borgmatic configuration from backup via new "config bootstrap"
|
||||||
|
action—even when borgmatic has no configuration yet!
|
||||||
|
* #669: Add sample systemd user service for running borgmatic as a non-root user.
|
||||||
|
* #711, #713: Fix an error when "data" check time files are accessed without getting upgraded
|
||||||
|
first.
|
||||||
|
|
||||||
|
1.7.14
|
||||||
|
* #484: Add a new verbosity level (-2) to disable output entirely (for console, syslog, log file,
|
||||||
|
or monitoring), so not even errors are shown.
|
||||||
|
* #688: Tweak archive check probing logic to use the newest timestamp found when multiple exist.
|
||||||
|
* #659: Add Borg 2 date-based matching flags to various actions for archive selection.
|
||||||
|
* #703: Fix an error when loading the configuration schema on Fedora Linux.
|
||||||
|
* #704: Fix "check" action error when repository and archive checks are configured but the archive
|
||||||
|
check gets skipped due to the configured frequency.
|
||||||
|
* #706: Fix "--archive latest" on "list" and "info" actions that only worked on the first of
|
||||||
|
multiple configured repositories.
|
||||||
|
|
||||||
|
1.7.13
|
||||||
|
* #375: Restore particular PostgreSQL schemas from a database dump via "borgmatic restore --schema"
|
||||||
|
flag. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#restore-particular-schemas
|
||||||
|
* #678: Fix error from PostgreSQL when dumping a database with a "format" of "plain".
|
||||||
|
* #678: Fix PostgreSQL hook to support "psql_command" and "pg_restore_command" options containing
|
||||||
|
commands with arguments.
|
||||||
|
* #678: Fix calls to psql in PostgreSQL hook to ignore "~/.psqlrc", whose settings can break
|
||||||
|
database dumping.
|
||||||
|
* #680: Add support for logging each log line as a JSON object via global "--log-json" flag.
|
||||||
|
* #682: Fix "source_directories_must_exist" option to expand globs and tildes in source directories.
|
||||||
|
* #684: Rename "master" development branch to "main" to use more inclusive language. You'll need to
|
||||||
|
update your development checkouts accordingly.
|
||||||
|
* #686: Add fish shell completion script so you can tab-complete on the borgmatic command-line. See
|
||||||
|
the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/set-up-backups/#shell-completion
|
||||||
|
* #687: Fix borgmatic error when not finding the configuration schema for certain "pip install
|
||||||
|
--editable" development installs.
|
||||||
|
* #688: Fix archive checks being skipped even when particular archives haven't been checked
|
||||||
|
recently. This occurred when using multiple borgmatic configuration files with different
|
||||||
|
"archive_name_format"s, for instance.
|
||||||
|
* #691: Fix error in "borgmatic restore" action when the configured repository path is relative
|
||||||
|
instead of absolute.
|
||||||
|
* #694: Run "borgmatic borg" action without capturing output so interactive prompts and flags like
|
||||||
|
"--progress" still work.
|
||||||
|
|
||||||
|
1.7.12
|
||||||
|
* #413: Add "log_file" context to command hooks so your scripts can consume the borgmatic log file.
|
||||||
|
See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
|
||||||
|
* #666, #670: Fix error when running the "info" action with the "--match-archives" or "--archive"
|
||||||
|
flags. Also fix the "--match-archives"/"--archive" flags to correctly override the
|
||||||
|
"match_archives" configuration option for the "transfer", "list", "rlist", and "info" actions.
|
||||||
|
* #668: Fix error when running the "prune" action with both "archive_name_format" and "prefix"
|
||||||
|
options set.
|
||||||
|
* #672: Selectively shallow merge certain mappings or sequences when including configuration files.
|
||||||
|
See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#shallow-merge
|
||||||
|
* #672: Selectively omit list values when including configuration files. See the documentation for
|
||||||
|
more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#list-merge
|
||||||
|
* #673: View the results of configuration file merging via "validate-borgmatic-config --show" flag.
|
||||||
|
See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#debugging-includes
|
||||||
|
* Add optional support for running end-to-end tests and building documentation with rootless Podman
|
||||||
|
instead of Docker.
|
||||||
|
|
||||||
|
1.7.11
|
||||||
|
* #479, #588: BREAKING: Automatically use the "archive_name_format" option to filter which archives
|
||||||
|
get used for borgmatic actions that operate on multiple archives. Override this behavior with the
|
||||||
|
new "match_archives" option in the storage section. This change is "breaking" in that it silently
|
||||||
|
changes which archives get considered for "rlist", "prune", "check", etc. See the documentation
|
||||||
|
for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#archive-naming
|
||||||
|
* #479, #588: The "prefix" options have been deprecated in favor of the new "archive_name_format"
|
||||||
|
auto-matching behavior and the "match_archives" option.
|
||||||
|
* #658: Add "--log-file-format" flag for customizing the log message format. See the documentation
|
||||||
|
for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#logging-to-file
|
||||||
|
* #662: Fix regression in which the "check_repositories" option failed to match repositories.
|
||||||
|
* #663: Fix regression in which the "transfer" action produced a traceback.
|
||||||
|
* Add spellchecking of source code during test runs.
|
||||||
|
|
||||||
|
1.7.10
|
||||||
|
* #396: When a database command errors, display and log the error message instead of swallowing it.
|
||||||
|
* #501: Optionally error if a source directory does not exist via "source_directories_must_exist"
|
||||||
|
option in borgmatic's location configuration.
|
||||||
|
* #576: Add support for "file://" paths within "repositories" option.
|
||||||
|
* #612: Define and use custom constants in borgmatic configuration files. See the documentation for
|
||||||
|
more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#constant-interpolation
|
||||||
|
* #618: Add support for BORG_FILES_CACHE_TTL environment variable via "borg_files_cache_ttl" option
|
||||||
|
in borgmatic's storage configuration.
|
||||||
|
* #623: Fix confusing message when an error occurs running actions for a configuration file.
|
||||||
|
* #635: Add optional repository labels so you can select a repository via "--repository yourlabel"
|
||||||
|
at the command-line. See the configuration reference for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/reference/configuration/
|
||||||
|
* #649: Add documentation on backing up a database running in a container:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#containers
|
||||||
|
* #655: Fix error when databases are configured and a source directory doesn't exist.
|
||||||
|
* Add code style plugins to enforce use of Python f-strings and prevent single-letter variables.
|
||||||
|
To join in the pedantry, refresh your test environment with "tox --recreate".
|
||||||
|
* Rename scripts/run-full-dev-tests to scripts/run-end-to-end-dev-tests and make it run end-to-end
|
||||||
|
tests only. Continue using tox to run unit and integration tests.
|
||||||
|
|
||||||
|
1.7.9
|
||||||
|
* #295: Add a SQLite database dump/restore hook.
|
||||||
|
* #304: Change the default action order when no actions are specified on the command-line to:
|
||||||
|
"create", "prune", "compact", "check". If you'd like to retain the old ordering ("prune" and
|
||||||
|
"compact" first), then specify actions explicitly on the command-line.
|
||||||
|
* #304: Run any command-line actions in the order specified instead of using a fixed ordering.
|
||||||
|
* #564: Add "--repository" flag to all actions where it makes sense, so you can run borgmatic on
|
||||||
|
a single configured repository instead of all of them.
|
||||||
|
* #628: Add a Healthchecks "log" state to send borgmatic logs to Healthchecks without signalling
|
||||||
|
success or failure.
|
||||||
|
* #647: Add "--strip-components all" feature on the "extract" action to remove leading path
|
||||||
|
components of files you extract. Must be used with the "--path" flag.
|
||||||
|
* Add support for Python 3.11.
|
||||||
|
|
||||||
|
1.7.8
|
||||||
|
* #620: With the "create" action and the "--list" ("--files") flag, only show excluded files at
|
||||||
|
verbosity 2.
|
||||||
|
* #621: Add optional authentication to the ntfy monitoring hook.
|
||||||
|
* With the "create" action, only one of "--list" ("--files") and "--progress" flags can be used.
|
||||||
|
This lines up with the new behavior in Borg 2.0.0b5.
|
||||||
|
* Internally support new Borg 2.0.0b5 "--filter" status characters / item flags for the "create"
|
||||||
|
action.
|
||||||
|
* Fix the "create" action with the "--dry-run" flag querying for databases when a PostgreSQL/MySQL
|
||||||
|
"all" database is configured. Now, these queries are skipped due to the dry run.
|
||||||
|
* Add "--repository" flag to the "rcreate" action to optionally select one configured repository to
|
||||||
|
create.
|
||||||
|
* Add "--progress" flag to the "transfer" action, new in Borg 2.0.0b5.
|
||||||
|
* Add "checkpoint_volume" configuration option to creates checkpoints every specified number of
|
||||||
|
bytes during a long-running backup, new in Borg 2.0.0b5.
|
||||||
|
|
||||||
|
1.7.7
|
||||||
|
* #642: Add MySQL database hook "add_drop_database" configuration option to control whether dumped
|
||||||
|
MySQL databases get dropped right before restore.
|
||||||
|
* #643: Fix for potential data loss (data not getting backed up) when dumping large "directory"
|
||||||
|
format PostgreSQL/MongoDB databases. Prior to the fix, these dumps would not finish writing to
|
||||||
|
disk before Borg consumed them. Now, the dumping process completes before Borg starts. This only
|
||||||
|
applies to "directory" format databases; other formats still stream to Borg without using
|
||||||
|
temporary disk space.
|
||||||
|
* Fix MongoDB "directory" format to work with mongodump/mongorestore without error. Prior to this
|
||||||
|
fix, only the "archive" format worked.
|
||||||
|
|
||||||
|
1.7.6
|
||||||
|
* #393, #438, #560: Optionally dump "all" PostgreSQL/MySQL databases to separate files instead of
|
||||||
|
one combined dump file, allowing more convenient restores of individual databases. You can enable
|
||||||
|
this by specifying the database dump "format" option when the database is named "all".
|
||||||
* #602: Fix logs that interfere with JSON output by making warnings go to stderr instead of stdout.
|
* #602: Fix logs that interfere with JSON output by making warnings go to stderr instead of stdout.
|
||||||
|
* #622: Fix traceback when include merging configuration files on ARM64.
|
||||||
|
* #629: Skip warning about excluded special files when no special files have been excluded.
|
||||||
|
* #630: Add configuration options for database command customization: "list_options",
|
||||||
|
"restore_options", and "analyze_options" for PostgreSQL, "restore_options" for MySQL, and
|
||||||
|
"restore_options" for MongoDB.
|
||||||
|
|
||||||
1.7.5
|
1.7.5
|
||||||
* #311: Override PostgreSQL dump/restore commands via configuration options.
|
* #311: Override PostgreSQL dump/restore commands via configuration options.
|
||||||
|
@ -257,7 +614,7 @@
|
||||||
* #398: Clarify canonical home of borgmatic in documentation.
|
* #398: Clarify canonical home of borgmatic in documentation.
|
||||||
* #406: Clarify that spaces in path names should not be backslashed in path names.
|
* #406: Clarify that spaces in path names should not be backslashed in path names.
|
||||||
* #423: Fix error handling to error loudly when Borg gets killed due to running out of memory!
|
* #423: Fix error handling to error loudly when Borg gets killed due to running out of memory!
|
||||||
* Fix build so as not to attempt to build and push documentation for a non-master branch.
|
* Fix build so as not to attempt to build and push documentation for a non-main branch.
|
||||||
* "Fix" build failure with Alpine Edge by switching from Edge to Alpine 3.13.
|
* "Fix" build failure with Alpine Edge by switching from Edge to Alpine 3.13.
|
||||||
* Move #borgmatic IRC channel from Freenode to Libera Chat due to Freenode takeover drama.
|
* Move #borgmatic IRC channel from Freenode to Libera Chat due to Freenode takeover drama.
|
||||||
IRC connection info: https://torsion.org/borgmatic/#issues
|
IRC connection info: https://torsion.org/borgmatic/#issues
|
||||||
|
@ -320,7 +677,7 @@
|
||||||
configuration schema descriptions.
|
configuration schema descriptions.
|
||||||
|
|
||||||
1.5.6
|
1.5.6
|
||||||
* #292: Allow before_backup and similiar hooks to exit with a soft failure without altering the
|
* #292: Allow before_backup and similar hooks to exit with a soft failure without altering the
|
||||||
monitoring status on Healthchecks or other providers. Support this by waiting to ping monitoring
|
monitoring status on Healthchecks or other providers. Support this by waiting to ping monitoring
|
||||||
services with a "start" status until after before_* hooks finish. Failures in before_* hooks
|
services with a "start" status until after before_* hooks finish. Failures in before_* hooks
|
||||||
still trigger a monitoring "fail" status.
|
still trigger a monitoring "fail" status.
|
||||||
|
@ -389,7 +746,7 @@
|
||||||
* For "list" and "info" actions, show repository names even at verbosity 0.
|
* For "list" and "info" actions, show repository names even at verbosity 0.
|
||||||
|
|
||||||
1.4.22
|
1.4.22
|
||||||
* #276, #285: Disable colored output when "--json" flag is used, so as to produce valid JSON ouput.
|
* #276, #285: Disable colored output when "--json" flag is used, so as to produce valid JSON output.
|
||||||
* After a backup of a database dump in directory format, properly remove the dump directory.
|
* After a backup of a database dump in directory format, properly remove the dump directory.
|
||||||
* In "borgmatic --help", don't expand $HOME in listing of default "--config" paths.
|
* In "borgmatic --help", don't expand $HOME in listing of default "--config" paths.
|
||||||
|
|
||||||
|
@ -761,7 +1118,7 @@
|
||||||
* #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
|
* #77: Skip non-"*.yaml" config filenames in /etc/borgmatic.d/ so as not to parse backup files,
|
||||||
editor swap files, etc.
|
editor swap files, etc.
|
||||||
* #81: Document user-defined hooks run before/after backup, or on error.
|
* #81: Document user-defined hooks run before/after backup, or on error.
|
||||||
* Add code style guidelines to the documention.
|
* Add code style guidelines to the documentation.
|
||||||
|
|
||||||
1.2.0
|
1.2.0
|
||||||
* #61: Support for Borg --list option via borgmatic command-line to list all archives.
|
* #61: Support for Borg --list option via borgmatic command-line to list all archives.
|
||||||
|
|
109
README.md
109
README.md
|
@ -11,68 +11,64 @@ borgmatic is simple, configuration-driven backup software for servers and
|
||||||
workstations. Protect your files with client-side encryption. Backup your
|
workstations. Protect your files with client-side encryption. Backup your
|
||||||
databases too. Monitor it all with integrated third-party services.
|
databases too. Monitor it all with integrated third-party services.
|
||||||
|
|
||||||
The canonical home of borgmatic is at <a href="https://torsion.org/borgmatic">https://torsion.org/borgmatic</a>.
|
The canonical home of borgmatic is at <a href="https://torsion.org/borgmatic">https://torsion.org/borgmatic/</a>
|
||||||
|
|
||||||
Here's an example configuration file:
|
Here's an example configuration file:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
location:
|
# List of source directories to backup.
|
||||||
# List of source directories to backup.
|
source_directories:
|
||||||
source_directories:
|
- /home
|
||||||
- /home
|
- /etc
|
||||||
- /etc
|
|
||||||
|
|
||||||
# Paths of local or remote repositories to backup to.
|
# Paths of local or remote repositories to backup to.
|
||||||
repositories:
|
repositories:
|
||||||
- ssh://1234@usw-s001.rsync.net/./backups.borg
|
- path: ssh://k8pDxu32@k8pDxu32.repo.borgbase.com/./repo
|
||||||
- ssh://k8pDxu32@k8pDxu32.repo.borgbase.com/./repo
|
label: borgbase
|
||||||
- /var/lib/backups/local.borg
|
- path: /var/lib/backups/local.borg
|
||||||
|
label: local
|
||||||
|
|
||||||
retention:
|
# Retention policy for how many backups to keep.
|
||||||
# Retention policy for how many backups to keep.
|
keep_daily: 7
|
||||||
keep_daily: 7
|
keep_weekly: 4
|
||||||
keep_weekly: 4
|
keep_monthly: 6
|
||||||
keep_monthly: 6
|
|
||||||
|
|
||||||
consistency:
|
# List of checks to run to validate your backups.
|
||||||
# List of checks to run to validate your backups.
|
checks:
|
||||||
checks:
|
- name: repository
|
||||||
- name: repository
|
- name: archives
|
||||||
- name: archives
|
frequency: 2 weeks
|
||||||
frequency: 2 weeks
|
|
||||||
|
|
||||||
hooks:
|
# Custom preparation scripts to run.
|
||||||
# Custom preparation scripts to run.
|
before_backup:
|
||||||
before_backup:
|
- prepare-for-backup.sh
|
||||||
- prepare-for-backup.sh
|
|
||||||
|
|
||||||
# Databases to dump and include in backups.
|
# Databases to dump and include in backups.
|
||||||
postgresql_databases:
|
postgresql_databases:
|
||||||
- name: users
|
- name: users
|
||||||
|
|
||||||
# Third-party services to notify you if backups aren't happening.
|
# Third-party services to notify you if backups aren't happening.
|
||||||
healthchecks: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
|
healthchecks:
|
||||||
|
ping_url: https://hc-ping.com/be067061-cf96-4412-8eae-62b0c50d6a8c
|
||||||
```
|
```
|
||||||
|
|
||||||
Want to see borgmatic in action? Check out the <a
|
|
||||||
href="https://asciinema.org/a/203761?autoplay=1" target="_blank">screencast</a>.
|
|
||||||
|
|
||||||
<a href="https://asciinema.org/a/203761?autoplay=1" target="_blank"><img src="https://asciinema.org/a/203761.png" width="480"></a>
|
|
||||||
|
|
||||||
borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
|
borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
|
||||||
|
|
||||||
## Integrations
|
## Integrations
|
||||||
|
|
||||||
<a href="https://www.postgresql.org/"><img src="docs/static/postgresql.png" alt="PostgreSQL" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://www.postgresql.org/"><img src="docs/static/postgresql.png" alt="PostgreSQL" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://www.mysql.com/"><img src="docs/static/mysql.png" alt="MySQL" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://www.mysql.com/"><img src="docs/static/mysql.png" alt="MySQL" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://mariadb.com/"><img src="docs/static/mariadb.png" alt="MariaDB" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://mariadb.com/"><img src="docs/static/mariadb.png" alt="MariaDB" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://www.mongodb.com/"><img src="docs/static/mongodb.png" alt="MongoDB" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://www.mongodb.com/"><img src="docs/static/mongodb.png" alt="MongoDB" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://healthchecks.io/"><img src="docs/static/healthchecks.png" alt="Healthchecks" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://sqlite.org/"><img src="docs/static/sqlite.png" alt="SQLite" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://cronitor.io/"><img src="docs/static/cronitor.png" alt="Cronitor" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://healthchecks.io/"><img src="docs/static/healthchecks.png" alt="Healthchecks" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://cronhub.io/"><img src="docs/static/cronhub.png" alt="Cronhub" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://cronitor.io/"><img src="docs/static/cronitor.png" alt="Cronitor" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://www.pagerduty.com/"><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://cronhub.io/"><img src="docs/static/cronhub.png" alt="Cronhub" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://ntfy.sh/"><img src="docs/static/ntfy.png" alt="ntfy" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://www.pagerduty.com/"><img src="docs/static/pagerduty.png" alt="PagerDuty" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
<a href="https://www.borgbase.com/?utm_source=borgmatic"><img src="docs/static/borgbase.png" alt="BorgBase" height="60px" style="margin-bottom:20px;"></a>
|
<a href="https://ntfy.sh/"><img src="docs/static/ntfy.png" alt="ntfy" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
|
<a href="https://grafana.com/oss/loki/"><img src="docs/static/loki.png" alt="Loki" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
|
<a href="https://github.com/caronc/apprise/wiki"><img src="docs/static/apprise.png" alt="Apprise" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
|
<a href="https://www.borgbase.com/?utm_source=borgmatic"><img src="docs/static/borgbase.png" alt="BorgBase" height="60px" style="margin-bottom:20px; margin-right:20px;"></a>
|
||||||
|
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
@ -80,8 +76,8 @@ borgmatic is powered by [Borg Backup](https://www.borgbackup.org/).
|
||||||
Your first step is to [install and configure
|
Your first step is to [install and configure
|
||||||
borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/).
|
borgmatic](https://torsion.org/borgmatic/docs/how-to/set-up-backups/).
|
||||||
|
|
||||||
For additional documentation, check out the links above for <a
|
For additional documentation, check out the links above (left panel on wide screens)
|
||||||
href="https://torsion.org/borgmatic/#documentation">borgmatic how-to and
|
for <a href="https://torsion.org/borgmatic/#documentation">borgmatic how-to and
|
||||||
reference guides</a>.
|
reference guides</a>.
|
||||||
|
|
||||||
|
|
||||||
|
@ -89,16 +85,15 @@ reference guides</a>.
|
||||||
|
|
||||||
Need somewhere to store your encrypted off-site backups? The following hosting
|
Need somewhere to store your encrypted off-site backups? The following hosting
|
||||||
providers include specific support for Borg/borgmatic—and fund borgmatic
|
providers include specific support for Borg/borgmatic—and fund borgmatic
|
||||||
development and hosting when you use these links to sign up. (These are
|
development and hosting when you use these referral links to sign up:
|
||||||
referral links, but without any tracking scripts or cookies.)
|
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li class="referral"><a href="https://www.borgbase.com/?utm_source=borgmatic">BorgBase</a>: Borg hosting service with support for monitoring, 2FA, and append-only repos</li>
|
<li class="referral"><a href="https://www.borgbase.com/?utm_source=borgmatic">BorgBase</a>: Borg hosting service with support for monitoring, 2FA, and append-only repos</li>
|
||||||
|
<li class="referral"><a href="https://hetzner.cloud/?ref=v9dOJ98Ic9I8">Hetzner</a>: A "storage box" that includes support for Borg</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
Additionally, [rsync.net](https://www.rsync.net/products/borg.html) and
|
Additionally, rsync.net has a compatible storage offering, but does not fund
|
||||||
[Hetzner](https://www.hetzner.com/storage/storage-box) have compatible storage
|
borgmatic development or hosting.
|
||||||
offerings, but do not currently fund borgmatic development or hosting.
|
|
||||||
|
|
||||||
## Support and contributing
|
## Support and contributing
|
||||||
|
|
||||||
|
@ -119,10 +114,7 @@ issues.
|
||||||
|
|
||||||
### Social
|
### Social
|
||||||
|
|
||||||
Check out the [Borg subreddit](https://www.reddit.com/r/BorgBackup/) for
|
Follow [borgmatic on Mastodon](https://fosstodon.org/@borgmatic).
|
||||||
general Borg and borgmatic discussion and support.
|
|
||||||
|
|
||||||
Also follow [borgmatic on Mastodon](https://fosstodon.org/@borgmatic).
|
|
||||||
|
|
||||||
|
|
||||||
### Chat
|
### Chat
|
||||||
|
@ -162,6 +154,3 @@ general, contributions are very welcome. We don't bite!
|
||||||
Also, please check out the [borgmatic development
|
Also, please check out the [borgmatic development
|
||||||
how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
|
how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
|
||||||
info on cloning source code, running tests, etc.
|
info on cloning source code, running tests, etc.
|
||||||
|
|
||||||
<a href="https://build.torsion.org/borgmatic-collective/borgmatic" alt="build status">![Build Status](https://build.torsion.org/api/badges/borgmatic-collective/borgmatic/status.svg?ref=refs/heads/master)</a>
|
|
||||||
|
|
||||||
|
|
|
@ -7,8 +7,8 @@ permalink: security-policy/index.html
|
||||||
|
|
||||||
While we want to hear about security vulnerabilities in all versions of
|
While we want to hear about security vulnerabilities in all versions of
|
||||||
borgmatic, security fixes are only made to the most recently released version.
|
borgmatic, security fixes are only made to the most recently released version.
|
||||||
It's simply not practical for our small volunteer effort to maintain multiple
|
It's not practical for our small volunteer effort to maintain multiple release
|
||||||
release branches and put out separate security patches for each.
|
branches and put out separate security patches for each.
|
||||||
|
|
||||||
## Reporting a vulnerability
|
## Reporting a vulnerability
|
||||||
|
|
||||||
|
|
0
borgmatic/actions/__init__.py
Normal file
0
borgmatic/actions/__init__.py
Normal file
9
borgmatic/actions/arguments.py
Normal file
9
borgmatic/actions/arguments.py
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
import argparse
|
||||||
|
|
||||||
|
|
||||||
|
def update_arguments(arguments, **updates):
|
||||||
|
'''
|
||||||
|
Given an argparse.Namespace instance of command-line arguments and one or more keyword argument
|
||||||
|
updates to perform, return a copy of the arguments with those updates applied.
|
||||||
|
'''
|
||||||
|
return argparse.Namespace(**dict(vars(arguments), **updates))
|
45
borgmatic/actions/borg.py
Normal file
45
borgmatic/actions/borg.py
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.borg
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_borg(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
borg_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "borg" action for the given repository.
|
||||||
|
'''
|
||||||
|
if borg_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, borg_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Running arbitrary Borg command'
|
||||||
|
)
|
||||||
|
archive_name = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
borg_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
borgmatic.borg.borg.run_arbitrary_borg(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
options=borg_arguments.options,
|
||||||
|
archive=archive_name,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
34
borgmatic/actions/break_lock.py
Normal file
34
borgmatic/actions/break_lock.py
Normal file
|
@ -0,0 +1,34 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.break_lock
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_break_lock(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
break_lock_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "break-lock" action for the given repository.
|
||||||
|
'''
|
||||||
|
if break_lock_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, break_lock_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Breaking repository and cache locks'
|
||||||
|
)
|
||||||
|
borgmatic.borg.break_lock.break_lock(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
699
borgmatic/actions/check.py
Normal file
699
borgmatic/actions/check.py
Normal file
|
@ -0,0 +1,699 @@
|
||||||
|
import datetime
|
||||||
|
import hashlib
|
||||||
|
import itertools
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import pathlib
|
||||||
|
import random
|
||||||
|
|
||||||
|
import borgmatic.borg.check
|
||||||
|
import borgmatic.borg.create
|
||||||
|
import borgmatic.borg.environment
|
||||||
|
import borgmatic.borg.extract
|
||||||
|
import borgmatic.borg.list
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.borg.state
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.execute
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
DEFAULT_CHECKS = (
|
||||||
|
{'name': 'repository', 'frequency': '1 month'},
|
||||||
|
{'name': 'archives', 'frequency': '1 month'},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def parse_checks(config, only_checks=None):
|
||||||
|
'''
|
||||||
|
Given a configuration dict with a "checks" sequence of dicts and an optional list of override
|
||||||
|
checks, return a tuple of named checks to run.
|
||||||
|
|
||||||
|
For example, given a config of:
|
||||||
|
|
||||||
|
{'checks': ({'name': 'repository'}, {'name': 'archives'})}
|
||||||
|
|
||||||
|
This will be returned as:
|
||||||
|
|
||||||
|
('repository', 'archives')
|
||||||
|
|
||||||
|
If no "checks" option is present in the config, return the DEFAULT_CHECKS. If a checks value
|
||||||
|
has a name of "disabled", return an empty tuple, meaning that no checks should be run.
|
||||||
|
'''
|
||||||
|
checks = only_checks or tuple(
|
||||||
|
check_config['name'] for check_config in (config.get('checks', None) or DEFAULT_CHECKS)
|
||||||
|
)
|
||||||
|
checks = tuple(check.lower() for check in checks)
|
||||||
|
|
||||||
|
if 'disabled' in checks:
|
||||||
|
logger.warning(
|
||||||
|
'The "disabled" value for the "checks" option is deprecated and will be removed from a future release; use "skip_actions" instead'
|
||||||
|
)
|
||||||
|
if len(checks) > 1:
|
||||||
|
logger.warning(
|
||||||
|
'Multiple checks are configured, but one of them is "disabled"; not running any checks'
|
||||||
|
)
|
||||||
|
return ()
|
||||||
|
|
||||||
|
return checks
|
||||||
|
|
||||||
|
|
||||||
|
def parse_frequency(frequency):
|
||||||
|
'''
|
||||||
|
Given a frequency string with a number and a unit of time, return a corresponding
|
||||||
|
datetime.timedelta instance or None if the frequency is None or "always".
|
||||||
|
|
||||||
|
For instance, given "3 weeks", return datetime.timedelta(weeks=3)
|
||||||
|
|
||||||
|
Raise ValueError if the given frequency cannot be parsed.
|
||||||
|
'''
|
||||||
|
if not frequency:
|
||||||
|
return None
|
||||||
|
|
||||||
|
frequency = frequency.strip().lower()
|
||||||
|
|
||||||
|
if frequency == 'always':
|
||||||
|
return None
|
||||||
|
|
||||||
|
try:
|
||||||
|
number, time_unit = frequency.split(' ')
|
||||||
|
number = int(number)
|
||||||
|
except ValueError:
|
||||||
|
raise ValueError(f"Could not parse consistency check frequency '{frequency}'")
|
||||||
|
|
||||||
|
if not time_unit.endswith('s'):
|
||||||
|
time_unit += 's'
|
||||||
|
|
||||||
|
if time_unit == 'months':
|
||||||
|
number *= 30
|
||||||
|
time_unit = 'days'
|
||||||
|
elif time_unit == 'years':
|
||||||
|
number *= 365
|
||||||
|
time_unit = 'days'
|
||||||
|
|
||||||
|
try:
|
||||||
|
return datetime.timedelta(**{time_unit: number})
|
||||||
|
except TypeError:
|
||||||
|
raise ValueError(f"Could not parse consistency check frequency '{frequency}'")
|
||||||
|
|
||||||
|
|
||||||
|
def filter_checks_on_frequency(
|
||||||
|
config,
|
||||||
|
borg_repository_id,
|
||||||
|
checks,
|
||||||
|
force,
|
||||||
|
archives_check_id=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a configuration dict with a "checks" sequence of dicts, a Borg repository ID, a sequence
|
||||||
|
of checks, whether to force checks to run, and an ID for the archives check potentially being
|
||||||
|
run (if any), filter down those checks based on the configured "frequency" for each check as
|
||||||
|
compared to its check time file.
|
||||||
|
|
||||||
|
In other words, a check whose check time file's timestamp is too new (based on the configured
|
||||||
|
frequency) will get cut from the returned sequence of checks. Example:
|
||||||
|
|
||||||
|
config = {
|
||||||
|
'checks': [
|
||||||
|
{
|
||||||
|
'name': 'archives',
|
||||||
|
'frequency': '2 weeks',
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
When this function is called with that config and "archives" in checks, "archives" will get
|
||||||
|
filtered out of the returned result if its check time file is newer than 2 weeks old, indicating
|
||||||
|
that it's not yet time to run that check again.
|
||||||
|
|
||||||
|
Raise ValueError if a frequency cannot be parsed.
|
||||||
|
'''
|
||||||
|
if not checks:
|
||||||
|
return checks
|
||||||
|
|
||||||
|
filtered_checks = list(checks)
|
||||||
|
|
||||||
|
if force:
|
||||||
|
return tuple(filtered_checks)
|
||||||
|
|
||||||
|
for check_config in config.get('checks', DEFAULT_CHECKS):
|
||||||
|
check = check_config['name']
|
||||||
|
if checks and check not in checks:
|
||||||
|
continue
|
||||||
|
|
||||||
|
frequency_delta = parse_frequency(check_config.get('frequency'))
|
||||||
|
if not frequency_delta:
|
||||||
|
continue
|
||||||
|
|
||||||
|
check_time = probe_for_check_time(config, borg_repository_id, check, archives_check_id)
|
||||||
|
if not check_time:
|
||||||
|
continue
|
||||||
|
|
||||||
|
# If we've not yet reached the time when the frequency dictates we're ready for another
|
||||||
|
# check, skip this check.
|
||||||
|
if datetime.datetime.now() < check_time + frequency_delta:
|
||||||
|
remaining = check_time + frequency_delta - datetime.datetime.now()
|
||||||
|
logger.info(
|
||||||
|
f'Skipping {check} check due to configured frequency; {remaining} until next check (use --force to check anyway)'
|
||||||
|
)
|
||||||
|
filtered_checks.remove(check)
|
||||||
|
|
||||||
|
return tuple(filtered_checks)
|
||||||
|
|
||||||
|
|
||||||
|
def make_archives_check_id(archive_filter_flags):
|
||||||
|
'''
|
||||||
|
Given a sequence of flags to filter archives, return a unique hash corresponding to those
|
||||||
|
particular flags. If there are no flags, return None.
|
||||||
|
'''
|
||||||
|
if not archive_filter_flags:
|
||||||
|
return None
|
||||||
|
|
||||||
|
return hashlib.sha256(' '.join(archive_filter_flags).encode()).hexdigest()
|
||||||
|
|
||||||
|
|
||||||
|
def make_check_time_path(config, borg_repository_id, check_type, archives_check_id=None):
|
||||||
|
'''
|
||||||
|
Given a configuration dict, a Borg repository ID, the name of a check type ("repository",
|
||||||
|
"archives", etc.), and a unique hash of the archives filter flags, return a path for recording
|
||||||
|
that check's time (the time of that check last occurring).
|
||||||
|
'''
|
||||||
|
borgmatic_source_directory = os.path.expanduser(
|
||||||
|
config.get(
|
||||||
|
'borgmatic_source_directory', borgmatic.borg.state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
if check_type in ('archives', 'data'):
|
||||||
|
return os.path.join(
|
||||||
|
borgmatic_source_directory,
|
||||||
|
'checks',
|
||||||
|
borg_repository_id,
|
||||||
|
check_type,
|
||||||
|
archives_check_id if archives_check_id else 'all',
|
||||||
|
)
|
||||||
|
|
||||||
|
return os.path.join(
|
||||||
|
borgmatic_source_directory,
|
||||||
|
'checks',
|
||||||
|
borg_repository_id,
|
||||||
|
check_type,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def write_check_time(path): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Record a check time of now as the modification time of the given path.
|
||||||
|
'''
|
||||||
|
logger.debug(f'Writing check time at {path}')
|
||||||
|
|
||||||
|
os.makedirs(os.path.dirname(path), mode=0o700, exist_ok=True)
|
||||||
|
pathlib.Path(path, mode=0o600).touch()
|
||||||
|
|
||||||
|
|
||||||
|
def read_check_time(path):
|
||||||
|
'''
|
||||||
|
Return the check time based on the modification time of the given path. Return None if the path
|
||||||
|
doesn't exist.
|
||||||
|
'''
|
||||||
|
logger.debug(f'Reading check time from {path}')
|
||||||
|
|
||||||
|
try:
|
||||||
|
return datetime.datetime.fromtimestamp(os.stat(path).st_mtime)
|
||||||
|
except FileNotFoundError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def probe_for_check_time(config, borg_repository_id, check, archives_check_id):
|
||||||
|
'''
|
||||||
|
Given a configuration dict, a Borg repository ID, the name of a check type ("repository",
|
||||||
|
"archives", etc.), and a unique hash of the archives filter flags, return a the corresponding
|
||||||
|
check time or None if such a check time does not exist.
|
||||||
|
|
||||||
|
When the check type is "archives" or "data", this function probes two different paths to find
|
||||||
|
the check time, e.g.:
|
||||||
|
|
||||||
|
~/.borgmatic/checks/1234567890/archives/9876543210
|
||||||
|
~/.borgmatic/checks/1234567890/archives/all
|
||||||
|
|
||||||
|
... and returns the maximum modification time of the files found (if any). The first path
|
||||||
|
represents a more specific archives check time (a check on a subset of archives), and the second
|
||||||
|
is a fallback to the last "all" archives check.
|
||||||
|
|
||||||
|
For other check types, this function reads from a single check time path, e.g.:
|
||||||
|
|
||||||
|
~/.borgmatic/checks/1234567890/repository
|
||||||
|
'''
|
||||||
|
check_times = (
|
||||||
|
read_check_time(group[0])
|
||||||
|
for group in itertools.groupby(
|
||||||
|
(
|
||||||
|
make_check_time_path(config, borg_repository_id, check, archives_check_id),
|
||||||
|
make_check_time_path(config, borg_repository_id, check),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
return max(check_time for check_time in check_times if check_time)
|
||||||
|
except ValueError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade_check_times(config, borg_repository_id):
|
||||||
|
'''
|
||||||
|
Given a configuration dict and a Borg repository ID, upgrade any corresponding check times on
|
||||||
|
disk from old-style paths to new-style paths.
|
||||||
|
|
||||||
|
Currently, the only upgrade performed is renaming an archive or data check path that looks like:
|
||||||
|
|
||||||
|
~/.borgmatic/checks/1234567890/archives
|
||||||
|
|
||||||
|
to:
|
||||||
|
|
||||||
|
~/.borgmatic/checks/1234567890/archives/all
|
||||||
|
'''
|
||||||
|
for check_type in ('archives', 'data'):
|
||||||
|
new_path = make_check_time_path(config, borg_repository_id, check_type, 'all')
|
||||||
|
old_path = os.path.dirname(new_path)
|
||||||
|
temporary_path = f'{old_path}.temp'
|
||||||
|
|
||||||
|
if not os.path.isfile(old_path) and not os.path.isfile(temporary_path):
|
||||||
|
continue
|
||||||
|
|
||||||
|
logger.debug(f'Upgrading archives check time from {old_path} to {new_path}')
|
||||||
|
|
||||||
|
try:
|
||||||
|
os.rename(old_path, temporary_path)
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
os.mkdir(old_path)
|
||||||
|
os.rename(temporary_path, new_path)
|
||||||
|
|
||||||
|
|
||||||
|
def collect_spot_check_source_paths(
|
||||||
|
repository, config, local_borg_version, global_arguments, local_path, remote_path
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a repository configuration dict, a configuration dict, the local Borg version, global
|
||||||
|
arguments as an argparse.Namespace instance, the local Borg path, and the remote Borg path,
|
||||||
|
collect the source paths that Borg would use in an actual create (but only include files).
|
||||||
|
'''
|
||||||
|
stream_processes = any(
|
||||||
|
borgmatic.hooks.dispatch.call_hooks(
|
||||||
|
'use_streaming',
|
||||||
|
config,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES,
|
||||||
|
).values()
|
||||||
|
)
|
||||||
|
|
||||||
|
(create_flags, create_positional_arguments, pattern_file, exclude_file) = (
|
||||||
|
borgmatic.borg.create.make_base_create_command(
|
||||||
|
dry_run=True,
|
||||||
|
repository_path=repository['path'],
|
||||||
|
config=config,
|
||||||
|
config_paths=(),
|
||||||
|
local_borg_version=local_borg_version,
|
||||||
|
global_arguments=global_arguments,
|
||||||
|
borgmatic_source_directories=(),
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
list_files=True,
|
||||||
|
stream_processes=stream_processes,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
borg_environment = borgmatic.borg.environment.make_environment(config)
|
||||||
|
|
||||||
|
try:
|
||||||
|
working_directory = os.path.expanduser(config.get('working_directory'))
|
||||||
|
except TypeError:
|
||||||
|
working_directory = None
|
||||||
|
|
||||||
|
paths_output = borgmatic.execute.execute_command_and_capture_output(
|
||||||
|
create_flags + create_positional_arguments,
|
||||||
|
capture_stderr=True,
|
||||||
|
working_directory=working_directory,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
|
)
|
||||||
|
|
||||||
|
paths = tuple(
|
||||||
|
path_line.split(' ', 1)[1]
|
||||||
|
for path_line in paths_output.split('\n')
|
||||||
|
if path_line and path_line.startswith('- ') or path_line.startswith('+ ')
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(path for path in paths if os.path.isfile(path))
|
||||||
|
|
||||||
|
|
||||||
|
BORG_DIRECTORY_FILE_TYPE = 'd'
|
||||||
|
|
||||||
|
|
||||||
|
def collect_spot_check_archive_paths(
|
||||||
|
repository, archive, config, local_borg_version, global_arguments, local_path, remote_path
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a repository configuration dict, the name of the latest archive, a configuration dict, the
|
||||||
|
local Borg version, global arguments as an argparse.Namespace instance, the local Borg path, and
|
||||||
|
the remote Borg path, collect the paths from the given archive (but only include files and
|
||||||
|
symlinks).
|
||||||
|
'''
|
||||||
|
borgmatic_source_directory = os.path.expanduser(
|
||||||
|
config.get(
|
||||||
|
'borgmatic_source_directory', borgmatic.borg.state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
path
|
||||||
|
for line in borgmatic.borg.list.capture_archive_listing(
|
||||||
|
repository['path'],
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
path_format='{type} /{path}{NL}', # noqa: FS003
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
for (file_type, path) in (line.split(' ', 1),)
|
||||||
|
if file_type != BORG_DIRECTORY_FILE_TYPE
|
||||||
|
if pathlib.Path(borgmatic_source_directory) not in pathlib.Path(path).parents
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
SAMPLE_PATHS_SUBSET_COUNT = 10000
|
||||||
|
|
||||||
|
|
||||||
|
def compare_spot_check_hashes(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
log_label,
|
||||||
|
source_paths,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a repository configuration dict, the name of the latest archive, a configuration dict, the
|
||||||
|
local Borg version, global arguments as an argparse.Namespace instance, the local Borg path, the
|
||||||
|
remote Borg path, a log label, and spot check source paths, compare the hashes for a sampling of
|
||||||
|
the source paths with hashes from corresponding paths in the given archive. Return a sequence of
|
||||||
|
the paths that fail that hash comparison.
|
||||||
|
'''
|
||||||
|
# Based on the configured sample percentage, come up with a list of random sample files from the
|
||||||
|
# source directories.
|
||||||
|
spot_check_config = next(check for check in config['checks'] if check['name'] == 'spot')
|
||||||
|
sample_count = max(
|
||||||
|
int(len(source_paths) * (min(spot_check_config['data_sample_percentage'], 100) / 100)), 1
|
||||||
|
)
|
||||||
|
source_sample_paths = tuple(random.sample(source_paths, sample_count))
|
||||||
|
existing_source_sample_paths = {
|
||||||
|
source_path for source_path in source_sample_paths if os.path.exists(source_path)
|
||||||
|
}
|
||||||
|
logger.debug(
|
||||||
|
f'{log_label}: Sampling {sample_count} source paths (~{spot_check_config["data_sample_percentage"]}%) for spot check'
|
||||||
|
)
|
||||||
|
|
||||||
|
source_sample_paths_iterator = iter(source_sample_paths)
|
||||||
|
source_hashes = {}
|
||||||
|
archive_hashes = {}
|
||||||
|
|
||||||
|
# Only hash a few thousand files at a time (a subset of the total paths) to avoid an "Argument
|
||||||
|
# list too long" shell error.
|
||||||
|
while True:
|
||||||
|
# Hash each file in the sample paths (if it exists).
|
||||||
|
source_sample_paths_subset = tuple(
|
||||||
|
itertools.islice(source_sample_paths_iterator, SAMPLE_PATHS_SUBSET_COUNT)
|
||||||
|
)
|
||||||
|
if not source_sample_paths_subset:
|
||||||
|
break
|
||||||
|
|
||||||
|
hash_output = borgmatic.execute.execute_command_and_capture_output(
|
||||||
|
(spot_check_config.get('xxh64sum_command', 'xxh64sum'),)
|
||||||
|
+ tuple(
|
||||||
|
path for path in source_sample_paths_subset if path in existing_source_sample_paths
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
source_hashes.update(
|
||||||
|
**dict(
|
||||||
|
(reversed(line.split(' ', 1)) for line in hash_output.splitlines()),
|
||||||
|
# Represent non-existent files as having empty hashes so the comparison below still works.
|
||||||
|
**{
|
||||||
|
path: ''
|
||||||
|
for path in source_sample_paths_subset
|
||||||
|
if path not in existing_source_sample_paths
|
||||||
|
},
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
# Get the hash for each file in the archive.
|
||||||
|
archive_hashes.update(
|
||||||
|
**dict(
|
||||||
|
reversed(line.split(' ', 1))
|
||||||
|
for line in borgmatic.borg.list.capture_archive_listing(
|
||||||
|
repository['path'],
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
list_paths=source_sample_paths_subset,
|
||||||
|
path_format='{xxh64} /{path}{NL}', # noqa: FS003
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
if line
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
# Compare the source hashes with the archive hashes to see how many match.
|
||||||
|
failing_paths = []
|
||||||
|
|
||||||
|
for path, source_hash in source_hashes.items():
|
||||||
|
archive_hash = archive_hashes.get(path)
|
||||||
|
|
||||||
|
if archive_hash is not None and archive_hash == source_hash:
|
||||||
|
continue
|
||||||
|
|
||||||
|
failing_paths.append(path)
|
||||||
|
|
||||||
|
return tuple(failing_paths)
|
||||||
|
|
||||||
|
|
||||||
|
def spot_check(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a repository dict, a loaded configuration dict, the local Borg version, global arguments
|
||||||
|
as an argparse.Namespace instance, the local Borg path, and the remote Borg path, perform a spot
|
||||||
|
check for the latest archive in the given repository.
|
||||||
|
|
||||||
|
A spot check compares file counts and also the hashes for a random sampling of source files on
|
||||||
|
disk to those stored in the latest archive. If any differences are beyond configured tolerances,
|
||||||
|
then the check fails.
|
||||||
|
'''
|
||||||
|
log_label = f'{repository.get("label", repository["path"])}'
|
||||||
|
logger.debug(f'{log_label}: Running spot check')
|
||||||
|
|
||||||
|
try:
|
||||||
|
spot_check_config = next(
|
||||||
|
check for check in config.get('checks', ()) if check.get('name') == 'spot'
|
||||||
|
)
|
||||||
|
except StopIteration:
|
||||||
|
raise ValueError('Cannot run spot check because it is unconfigured')
|
||||||
|
|
||||||
|
if spot_check_config['data_tolerance_percentage'] > spot_check_config['data_sample_percentage']:
|
||||||
|
raise ValueError(
|
||||||
|
'The data_tolerance_percentage must be less than or equal to the data_sample_percentage'
|
||||||
|
)
|
||||||
|
|
||||||
|
source_paths = collect_spot_check_source_paths(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_label}: {len(source_paths)} total source paths for spot check')
|
||||||
|
|
||||||
|
archive = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
'latest',
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_label}: Using archive {archive} for spot check')
|
||||||
|
|
||||||
|
archive_paths = collect_spot_check_archive_paths(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_label}: {len(archive_paths)} total archive paths for spot check')
|
||||||
|
|
||||||
|
# Calculate the percentage delta between the source paths count and the archive paths count, and
|
||||||
|
# compare that delta to the configured count tolerance percentage.
|
||||||
|
count_delta_percentage = abs(len(source_paths) - len(archive_paths)) / len(source_paths) * 100
|
||||||
|
|
||||||
|
if count_delta_percentage > spot_check_config['count_tolerance_percentage']:
|
||||||
|
logger.debug(
|
||||||
|
f'{log_label}: Paths in source paths but not latest archive: {", ".join(set(source_paths) - set(archive_paths)) or "none"}'
|
||||||
|
)
|
||||||
|
logger.debug(
|
||||||
|
f'{log_label}: Paths in latest archive but not source paths: {", ".join(set(archive_paths) - set(source_paths)) or "none"}'
|
||||||
|
)
|
||||||
|
raise ValueError(
|
||||||
|
f'Spot check failed: {count_delta_percentage:.2f}% file count delta between source paths and latest archive (tolerance is {spot_check_config["count_tolerance_percentage"]}%)'
|
||||||
|
)
|
||||||
|
|
||||||
|
failing_paths = compare_spot_check_hashes(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
log_label,
|
||||||
|
source_paths,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Error if the percentage of failing hashes exceeds the configured tolerance percentage.
|
||||||
|
logger.debug(f'{log_label}: {len(failing_paths)} non-matching spot check hashes')
|
||||||
|
data_tolerance_percentage = spot_check_config['data_tolerance_percentage']
|
||||||
|
failing_percentage = (len(failing_paths) / len(source_paths)) * 100
|
||||||
|
|
||||||
|
if failing_percentage > data_tolerance_percentage:
|
||||||
|
logger.debug(
|
||||||
|
f'{log_label}: Source paths with data not matching the latest archive: {", ".join(failing_paths)}'
|
||||||
|
)
|
||||||
|
raise ValueError(
|
||||||
|
f'Spot check failed: {failing_percentage:.2f}% of source paths with data not matching the latest archive (tolerance is {data_tolerance_percentage}%)'
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
f'{log_label}: Spot check passed with a {count_delta_percentage:.2f}% file count delta and a {failing_percentage:.2f}% file data delta'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_check(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
check_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "check" action for the given repository.
|
||||||
|
|
||||||
|
Raise ValueError if the Borg repository ID cannot be determined.
|
||||||
|
'''
|
||||||
|
if check_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, check_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('before_check'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-check',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(f'{repository.get("label", repository["path"])}: Running consistency checks')
|
||||||
|
repository_id = borgmatic.borg.check.get_repository_id(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
upgrade_check_times(config, repository_id)
|
||||||
|
configured_checks = parse_checks(config, check_arguments.only_checks)
|
||||||
|
archive_filter_flags = borgmatic.borg.check.make_archive_filter_flags(
|
||||||
|
local_borg_version, config, configured_checks, check_arguments
|
||||||
|
)
|
||||||
|
archives_check_id = make_archives_check_id(archive_filter_flags)
|
||||||
|
checks = filter_checks_on_frequency(
|
||||||
|
config,
|
||||||
|
repository_id,
|
||||||
|
configured_checks,
|
||||||
|
check_arguments.force,
|
||||||
|
archives_check_id,
|
||||||
|
)
|
||||||
|
borg_specific_checks = set(checks).intersection({'repository', 'archives', 'data'})
|
||||||
|
|
||||||
|
if borg_specific_checks:
|
||||||
|
borgmatic.borg.check.check_archives(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
check_arguments,
|
||||||
|
global_arguments,
|
||||||
|
borg_specific_checks,
|
||||||
|
archive_filter_flags,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
for check in borg_specific_checks:
|
||||||
|
write_check_time(make_check_time_path(config, repository_id, check, archives_check_id))
|
||||||
|
|
||||||
|
if 'extract' in checks:
|
||||||
|
borgmatic.borg.extract.extract_last_archive_dry_run(
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
repository['path'],
|
||||||
|
config.get('lock_wait'),
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
write_check_time(make_check_time_path(config, repository_id, 'extract'))
|
||||||
|
|
||||||
|
if 'spot' in checks:
|
||||||
|
spot_check(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
write_check_time(make_check_time_path(config, repository_id, 'spot'))
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('after_check'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-check',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
66
borgmatic/actions/compact.py
Normal file
66
borgmatic/actions/compact.py
Normal file
|
@ -0,0 +1,66 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.compact
|
||||||
|
import borgmatic.borg.feature
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_compact(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
compact_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "compact" action for the given repository.
|
||||||
|
'''
|
||||||
|
if compact_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, compact_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('before_compact'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-compact',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
if borgmatic.borg.feature.available(borgmatic.borg.feature.Feature.COMPACT, local_borg_version):
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Compacting segments{dry_run_label}'
|
||||||
|
)
|
||||||
|
borgmatic.borg.compact.compact_segments(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
progress=compact_arguments.progress,
|
||||||
|
cleanup_commits=compact_arguments.cleanup_commits,
|
||||||
|
threshold=compact_arguments.threshold,
|
||||||
|
)
|
||||||
|
else: # pragma: nocover
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Skipping compact (only available/needed in Borg 1.2+)'
|
||||||
|
)
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('after_compact'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-compact',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
0
borgmatic/actions/config/__init__.py
Normal file
0
borgmatic/actions/config/__init__.py
Normal file
103
borgmatic/actions/config/bootstrap.py
Normal file
103
borgmatic/actions/config/bootstrap.py
Normal file
|
@ -0,0 +1,103 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
import borgmatic.borg.extract
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
from borgmatic.borg.state import DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def get_config_paths(bootstrap_arguments, global_arguments, local_borg_version):
|
||||||
|
'''
|
||||||
|
Given the bootstrap arguments as an argparse.Namespace (containing the repository and archive
|
||||||
|
name, borgmatic source directory, destination directory, and whether to strip components), the
|
||||||
|
global arguments as an argparse.Namespace (containing the dry run flag and the local borg
|
||||||
|
version), return the config paths from the manifest.json file in the borgmatic source directory
|
||||||
|
after extracting it from the repository.
|
||||||
|
|
||||||
|
Raise ValueError if the manifest JSON is missing, can't be decoded, or doesn't contain the
|
||||||
|
expected configuration path data.
|
||||||
|
'''
|
||||||
|
borgmatic_source_directory = (
|
||||||
|
bootstrap_arguments.borgmatic_source_directory or DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
borgmatic_manifest_path = os.path.expanduser(
|
||||||
|
os.path.join(borgmatic_source_directory, 'bootstrap', 'manifest.json')
|
||||||
|
)
|
||||||
|
config = {'ssh_command': bootstrap_arguments.ssh_command}
|
||||||
|
|
||||||
|
extract_process = borgmatic.borg.extract.extract_archive(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
bootstrap_arguments.repository,
|
||||||
|
borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
bootstrap_arguments.repository,
|
||||||
|
bootstrap_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
),
|
||||||
|
[borgmatic_manifest_path],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
extract_to_stdout=True,
|
||||||
|
)
|
||||||
|
manifest_json = extract_process.stdout.read()
|
||||||
|
|
||||||
|
if not manifest_json:
|
||||||
|
raise ValueError(
|
||||||
|
'Cannot read configuration paths from archive due to missing bootstrap manifest'
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
manifest_data = json.loads(manifest_json)
|
||||||
|
except json.JSONDecodeError as error:
|
||||||
|
raise ValueError(
|
||||||
|
f'Cannot read configuration paths from archive due to invalid bootstrap manifest JSON: {error}'
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
return manifest_data['config_paths']
|
||||||
|
except KeyError:
|
||||||
|
raise ValueError(
|
||||||
|
'Cannot read configuration paths from archive due to invalid bootstrap manifest'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_bootstrap(bootstrap_arguments, global_arguments, local_borg_version):
|
||||||
|
'''
|
||||||
|
Run the "bootstrap" action for the given repository.
|
||||||
|
|
||||||
|
Raise ValueError if the bootstrap configuration could not be loaded.
|
||||||
|
Raise CalledProcessError or OSError if Borg could not be run.
|
||||||
|
'''
|
||||||
|
manifest_config_paths = get_config_paths(
|
||||||
|
bootstrap_arguments, global_arguments, local_borg_version
|
||||||
|
)
|
||||||
|
config = {'ssh_command': bootstrap_arguments.ssh_command}
|
||||||
|
|
||||||
|
logger.info(f"Bootstrapping config paths: {', '.join(manifest_config_paths)}")
|
||||||
|
|
||||||
|
borgmatic.borg.extract.extract_archive(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
bootstrap_arguments.repository,
|
||||||
|
borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
bootstrap_arguments.repository,
|
||||||
|
bootstrap_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
),
|
||||||
|
[config_path.lstrip(os.path.sep) for config_path in manifest_config_paths],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
extract_to_stdout=False,
|
||||||
|
destination_path=bootstrap_arguments.destination,
|
||||||
|
strip_components=bootstrap_arguments.strip_components,
|
||||||
|
progress=bootstrap_arguments.progress,
|
||||||
|
)
|
48
borgmatic/actions/config/generate.py
Normal file
48
borgmatic/actions/config/generate.py
Normal file
|
@ -0,0 +1,48 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.config.generate
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.logger
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_generate(generate_arguments, global_arguments):
|
||||||
|
'''
|
||||||
|
Given the generate arguments and the global arguments, each as an argparse.Namespace instance,
|
||||||
|
run the "generate" action.
|
||||||
|
|
||||||
|
Raise FileExistsError if a file already exists at the destination path and the generate
|
||||||
|
arguments do not have overwrite set.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
dry_run_label = ' (dry run; not actually writing anything)' if global_arguments.dry_run else ''
|
||||||
|
|
||||||
|
logger.answer(
|
||||||
|
f'Generating a configuration file at: {generate_arguments.destination_filename}{dry_run_label}'
|
||||||
|
)
|
||||||
|
|
||||||
|
borgmatic.config.generate.generate_sample_configuration(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
generate_arguments.source_filename,
|
||||||
|
generate_arguments.destination_filename,
|
||||||
|
borgmatic.config.validate.schema_filename(),
|
||||||
|
overwrite=generate_arguments.overwrite,
|
||||||
|
)
|
||||||
|
|
||||||
|
if generate_arguments.source_filename:
|
||||||
|
logger.answer(
|
||||||
|
f'''
|
||||||
|
Merged in the contents of configuration file at: {generate_arguments.source_filename}
|
||||||
|
To review the changes made, run:
|
||||||
|
|
||||||
|
diff --unified {generate_arguments.source_filename} {generate_arguments.destination_filename}'''
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.answer(
|
||||||
|
'''
|
||||||
|
This includes all available configuration options with example values, the few
|
||||||
|
required options as indicated. Please edit the file to suit your needs.
|
||||||
|
|
||||||
|
If you ever need help: https://torsion.org/borgmatic/#issues'''
|
||||||
|
)
|
25
borgmatic/actions/config/validate.py
Normal file
25
borgmatic/actions/config/validate.py
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.config.generate
|
||||||
|
import borgmatic.logger
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_validate(validate_arguments, configs):
|
||||||
|
'''
|
||||||
|
Given the validate arguments as an argparse.Namespace instance and a dict of configuration
|
||||||
|
filename to corresponding parsed configuration, run the "validate" action.
|
||||||
|
|
||||||
|
Most of the validation is actually performed implicitly by the standard borgmatic configuration
|
||||||
|
loading machinery prior to here, so this function mainly exists to support additional validate
|
||||||
|
flags like "--show".
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
|
||||||
|
if validate_arguments.show:
|
||||||
|
for config_path, config in configs.items():
|
||||||
|
if len(configs) > 1:
|
||||||
|
logger.answer('---')
|
||||||
|
|
||||||
|
logger.answer(borgmatic.config.generate.render_configuration(config))
|
132
borgmatic/actions/create.py
Normal file
132
borgmatic/actions/create.py
Normal file
|
@ -0,0 +1,132 @@
|
||||||
|
import importlib.metadata
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
import borgmatic.actions.json
|
||||||
|
import borgmatic.borg.create
|
||||||
|
import borgmatic.borg.state
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
import borgmatic.hooks.dispatch
|
||||||
|
import borgmatic.hooks.dump
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def create_borgmatic_manifest(config, config_paths, dry_run):
|
||||||
|
'''
|
||||||
|
Create a borgmatic manifest file to store the paths to the configuration files used to create
|
||||||
|
the archive.
|
||||||
|
'''
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic_source_directory = config.get(
|
||||||
|
'borgmatic_source_directory', borgmatic.borg.state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
|
||||||
|
borgmatic_manifest_path = os.path.expanduser(
|
||||||
|
os.path.join(borgmatic_source_directory, 'bootstrap', 'manifest.json')
|
||||||
|
)
|
||||||
|
|
||||||
|
if not os.path.exists(borgmatic_manifest_path):
|
||||||
|
os.makedirs(os.path.dirname(borgmatic_manifest_path), exist_ok=True)
|
||||||
|
|
||||||
|
with open(borgmatic_manifest_path, 'w') as config_list_file:
|
||||||
|
json.dump(
|
||||||
|
{
|
||||||
|
'borgmatic_version': importlib.metadata.version('borgmatic'),
|
||||||
|
'config_paths': config_paths,
|
||||||
|
},
|
||||||
|
config_list_file,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_create(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
config_paths,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
create_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "create" action for the given repository.
|
||||||
|
|
||||||
|
If create_arguments.json is True, yield the JSON output from creating the archive.
|
||||||
|
'''
|
||||||
|
if create_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, create_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('before_backup'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-backup',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
logger.info(f'{repository.get("label", repository["path"])}: Creating archive{dry_run_label}')
|
||||||
|
borgmatic.hooks.dispatch.call_hooks_even_if_unconfigured(
|
||||||
|
'remove_data_source_dumps',
|
||||||
|
config,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
active_dumps = borgmatic.hooks.dispatch.call_hooks(
|
||||||
|
'dump_data_sources',
|
||||||
|
config,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
if config.get('store_config_files', True):
|
||||||
|
create_borgmatic_manifest(
|
||||||
|
config,
|
||||||
|
config_paths,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
stream_processes = [process for processes in active_dumps.values() for process in processes]
|
||||||
|
|
||||||
|
json_output = borgmatic.borg.create.create_archive(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
config_paths,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
progress=create_arguments.progress,
|
||||||
|
stats=create_arguments.stats,
|
||||||
|
json=create_arguments.json,
|
||||||
|
list_files=create_arguments.list_files,
|
||||||
|
stream_processes=stream_processes,
|
||||||
|
)
|
||||||
|
if json_output:
|
||||||
|
yield borgmatic.actions.json.parse_json(json_output, repository.get('label'))
|
||||||
|
|
||||||
|
borgmatic.hooks.dispatch.call_hooks_even_if_unconfigured(
|
||||||
|
'remove_data_source_dumps',
|
||||||
|
config,
|
||||||
|
config_filename,
|
||||||
|
borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('after_backup'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-backup',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
33
borgmatic/actions/export_key.py
Normal file
33
borgmatic/actions/export_key.py
Normal file
|
@ -0,0 +1,33 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.export_key
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_export_key(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
export_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "key export" action for the given repository.
|
||||||
|
'''
|
||||||
|
if export_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, export_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(f'{repository.get("label", repository["path"])}: Exporting repository key')
|
||||||
|
borgmatic.borg.export_key.export_key(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
export_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
50
borgmatic/actions/export_tar.py
Normal file
50
borgmatic/actions/export_tar.py
Normal file
|
@ -0,0 +1,50 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.export_tar
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_export_tar(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
export_tar_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "export-tar" action for the given repository.
|
||||||
|
'''
|
||||||
|
if export_tar_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, export_tar_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(
|
||||||
|
f'{repository["path"]}: Exporting archive {export_tar_arguments.archive} as tar file'
|
||||||
|
)
|
||||||
|
borgmatic.borg.export_tar.export_tar_archive(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
export_tar_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
export_tar_arguments.paths,
|
||||||
|
export_tar_arguments.destination,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
tar_filter=export_tar_arguments.tar_filter,
|
||||||
|
list_files=export_tar_arguments.list_files,
|
||||||
|
strip_components=export_tar_arguments.strip_components,
|
||||||
|
)
|
68
borgmatic/actions/extract.py
Normal file
68
borgmatic/actions/extract.py
Normal file
|
@ -0,0 +1,68 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.extract
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_extract(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
extract_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "extract" action for the given repository.
|
||||||
|
'''
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('before_extract'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-extract',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
if extract_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, extract_arguments.repository
|
||||||
|
):
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Extracting archive {extract_arguments.archive}'
|
||||||
|
)
|
||||||
|
borgmatic.borg.extract.extract_archive(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
extract_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
extract_arguments.paths,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
destination_path=extract_arguments.destination,
|
||||||
|
strip_components=extract_arguments.strip_components,
|
||||||
|
progress=extract_arguments.progress,
|
||||||
|
)
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('after_extract'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-extract',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
52
borgmatic/actions/info.py
Normal file
52
borgmatic/actions/info.py
Normal file
|
@ -0,0 +1,52 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.actions.arguments
|
||||||
|
import borgmatic.actions.json
|
||||||
|
import borgmatic.borg.info
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_info(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
info_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "info" action for the given repository and archive.
|
||||||
|
|
||||||
|
If info_arguments.json is True, yield the JSON output from the info for the archive.
|
||||||
|
'''
|
||||||
|
if info_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, info_arguments.repository
|
||||||
|
):
|
||||||
|
if not info_arguments.json:
|
||||||
|
logger.answer(
|
||||||
|
f'{repository.get("label", repository["path"])}: Displaying archive summary information'
|
||||||
|
)
|
||||||
|
archive_name = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
info_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
json_output = borgmatic.borg.info.display_archives_info(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
borgmatic.actions.arguments.update_arguments(info_arguments, archive=archive_name),
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
if json_output:
|
||||||
|
yield borgmatic.actions.json.parse_json(json_output, repository.get('label'))
|
30
borgmatic/actions/json.py
Normal file
30
borgmatic/actions/json.py
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def parse_json(borg_json_output, label):
|
||||||
|
'''
|
||||||
|
Given a Borg JSON output string, parse it as JSON into a dict. Inject the given borgmatic
|
||||||
|
repository label into it and return the dict.
|
||||||
|
|
||||||
|
Raise JSONDecodeError if the JSON output cannot be parsed.
|
||||||
|
'''
|
||||||
|
lines = borg_json_output.splitlines()
|
||||||
|
start_line_index = 0
|
||||||
|
|
||||||
|
# Scan forward to find the first line starting with "{" and assume that's where the JSON starts.
|
||||||
|
for line_index, line in enumerate(lines):
|
||||||
|
if line.startswith('{'):
|
||||||
|
start_line_index = line_index
|
||||||
|
break
|
||||||
|
|
||||||
|
json_data = json.loads('\n'.join(lines[start_line_index:]))
|
||||||
|
|
||||||
|
if 'repository' not in json_data:
|
||||||
|
return json_data
|
||||||
|
|
||||||
|
json_data['repository']['label'] = label or ''
|
||||||
|
|
||||||
|
return json_data
|
53
borgmatic/actions/list.py
Normal file
53
borgmatic/actions/list.py
Normal file
|
@ -0,0 +1,53 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.actions.arguments
|
||||||
|
import borgmatic.actions.json
|
||||||
|
import borgmatic.borg.list
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_list(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
list_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "list" action for the given repository and archive.
|
||||||
|
|
||||||
|
If list_arguments.json is True, yield the JSON output from listing the archive.
|
||||||
|
'''
|
||||||
|
if list_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, list_arguments.repository
|
||||||
|
):
|
||||||
|
if not list_arguments.json:
|
||||||
|
if list_arguments.find_paths: # pragma: no cover
|
||||||
|
logger.answer(f'{repository.get("label", repository["path"])}: Searching archives')
|
||||||
|
elif not list_arguments.archive: # pragma: no cover
|
||||||
|
logger.answer(f'{repository.get("label", repository["path"])}: Listing archives')
|
||||||
|
|
||||||
|
archive_name = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
list_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
json_output = borgmatic.borg.list.list_archive(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
borgmatic.actions.arguments.update_arguments(list_arguments, archive=archive_name),
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
if json_output:
|
||||||
|
yield borgmatic.actions.json.parse_json(json_output, repository.get('label'))
|
49
borgmatic/actions/mount.py
Normal file
49
borgmatic/actions/mount.py
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.mount
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_mount(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
mount_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "mount" action for the given repository.
|
||||||
|
'''
|
||||||
|
if mount_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, mount_arguments.repository
|
||||||
|
):
|
||||||
|
if mount_arguments.archive:
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Mounting archive {mount_arguments.archive}'
|
||||||
|
)
|
||||||
|
else: # pragma: nocover
|
||||||
|
logger.info(f'{repository.get("label", repository["path"])}: Mounting repository')
|
||||||
|
|
||||||
|
borgmatic.borg.mount.mount_archive(
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
mount_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
mount_arguments,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
56
borgmatic/actions/prune.py
Normal file
56
borgmatic/actions/prune.py
Normal file
|
@ -0,0 +1,56 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.prune
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_prune(
|
||||||
|
config_filename,
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
hook_context,
|
||||||
|
local_borg_version,
|
||||||
|
prune_arguments,
|
||||||
|
global_arguments,
|
||||||
|
dry_run_label,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "prune" action for the given repository.
|
||||||
|
'''
|
||||||
|
if prune_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, prune_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('before_prune'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-prune',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
logger.info(f'{repository.get("label", repository["path"])}: Pruning archives{dry_run_label}')
|
||||||
|
borgmatic.borg.prune.prune_archives(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
prune_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
borgmatic.hooks.command.execute_hook(
|
||||||
|
config.get('after_prune'),
|
||||||
|
config.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-prune',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
41
borgmatic/actions/rcreate.py
Normal file
41
borgmatic/actions/rcreate.py
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.rcreate
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_rcreate(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
rcreate_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "rcreate" action for the given repository.
|
||||||
|
'''
|
||||||
|
if rcreate_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, rcreate_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
logger.info(f'{repository.get("label", repository["path"])}: Creating repository')
|
||||||
|
borgmatic.borg.rcreate.create_repository(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
rcreate_arguments.encryption_mode,
|
||||||
|
rcreate_arguments.source_repository,
|
||||||
|
rcreate_arguments.copy_crypt_key,
|
||||||
|
rcreate_arguments.append_only,
|
||||||
|
rcreate_arguments.storage_quota,
|
||||||
|
rcreate_arguments.make_parent_dirs,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
380
borgmatic/actions/restore.py
Normal file
380
borgmatic/actions/restore.py
Normal file
|
@ -0,0 +1,380 @@
|
||||||
|
import copy
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
import borgmatic.borg.extract
|
||||||
|
import borgmatic.borg.list
|
||||||
|
import borgmatic.borg.mount
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.borg.state
|
||||||
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.hooks.dispatch
|
||||||
|
import borgmatic.hooks.dump
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
UNSPECIFIED_HOOK = object()
|
||||||
|
|
||||||
|
|
||||||
|
def get_configured_data_source(
|
||||||
|
config,
|
||||||
|
archive_data_source_names,
|
||||||
|
hook_name,
|
||||||
|
data_source_name,
|
||||||
|
configuration_data_source_name=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Find the first data source with the given hook name and data source name in the configuration
|
||||||
|
dict and the given archive data source names dict (from hook name to data source names contained
|
||||||
|
in a particular backup archive). If UNSPECIFIED_HOOK is given as the hook name, search all data
|
||||||
|
source hooks for the named data source. If a configuration data source name is given, use that
|
||||||
|
instead of the data source name to lookup the data source in the given hooks configuration.
|
||||||
|
|
||||||
|
Return the found data source as a tuple of (found hook name, data source configuration dict) or
|
||||||
|
(None, None) if not found.
|
||||||
|
'''
|
||||||
|
if not configuration_data_source_name:
|
||||||
|
configuration_data_source_name = data_source_name
|
||||||
|
|
||||||
|
if hook_name == UNSPECIFIED_HOOK:
|
||||||
|
hooks_to_search = {
|
||||||
|
hook_name: value
|
||||||
|
for (hook_name, value) in config.items()
|
||||||
|
if hook_name in borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
try:
|
||||||
|
hooks_to_search = {hook_name: config[hook_name]}
|
||||||
|
except KeyError:
|
||||||
|
return (None, None)
|
||||||
|
|
||||||
|
return next(
|
||||||
|
(
|
||||||
|
(name, hook_data_source)
|
||||||
|
for (name, hook) in hooks_to_search.items()
|
||||||
|
for hook_data_source in hook
|
||||||
|
if hook_data_source['name'] == configuration_data_source_name
|
||||||
|
and data_source_name in archive_data_source_names.get(name, [])
|
||||||
|
),
|
||||||
|
(None, None),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def restore_single_data_source(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
archive_name,
|
||||||
|
hook_name,
|
||||||
|
data_source,
|
||||||
|
connection_params,
|
||||||
|
): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Given (among other things) an archive name, a data source hook name, the hostname, port,
|
||||||
|
username/password as connection params, and a configured data source configuration dict, restore
|
||||||
|
that data source from the archive.
|
||||||
|
'''
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Restoring data source {data_source["name"]}'
|
||||||
|
)
|
||||||
|
|
||||||
|
dump_pattern = borgmatic.hooks.dispatch.call_hooks(
|
||||||
|
'make_data_source_dump_pattern',
|
||||||
|
config,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES,
|
||||||
|
data_source['name'],
|
||||||
|
)[hook_name]
|
||||||
|
|
||||||
|
# Kick off a single data source extract to stdout.
|
||||||
|
extract_process = borgmatic.borg.extract.extract_archive(
|
||||||
|
dry_run=global_arguments.dry_run,
|
||||||
|
repository=repository['path'],
|
||||||
|
archive=archive_name,
|
||||||
|
paths=borgmatic.hooks.dump.convert_glob_patterns_to_borg_patterns([dump_pattern]),
|
||||||
|
config=config,
|
||||||
|
local_borg_version=local_borg_version,
|
||||||
|
global_arguments=global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
destination_path='/',
|
||||||
|
# A directory format dump isn't a single file, and therefore can't extract
|
||||||
|
# to stdout. In this case, the extract_process return value is None.
|
||||||
|
extract_to_stdout=bool(data_source.get('format') != 'directory'),
|
||||||
|
)
|
||||||
|
|
||||||
|
# Run a single data source restore, consuming the extract stdout (if any).
|
||||||
|
borgmatic.hooks.dispatch.call_hooks(
|
||||||
|
function_name='restore_data_source_dump',
|
||||||
|
config=config,
|
||||||
|
log_prefix=repository['path'],
|
||||||
|
hook_names=[hook_name],
|
||||||
|
data_source=data_source,
|
||||||
|
dry_run=global_arguments.dry_run,
|
||||||
|
extract_process=extract_process,
|
||||||
|
connection_params=connection_params,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def collect_archive_data_source_names(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a resolved archive name, a configuration dict, the
|
||||||
|
local Borg version, global_arguments an argparse.Namespace, and local and remote Borg paths,
|
||||||
|
query the archive for the names of data sources it contains as dumps and return them as a dict
|
||||||
|
from hook name to a sequence of data source names.
|
||||||
|
'''
|
||||||
|
borgmatic_source_directory = os.path.expanduser(
|
||||||
|
config.get(
|
||||||
|
'borgmatic_source_directory', borgmatic.borg.state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
).lstrip('/')
|
||||||
|
dump_paths = borgmatic.borg.list.capture_archive_listing(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
list_paths=[
|
||||||
|
os.path.expanduser(
|
||||||
|
borgmatic.hooks.dump.make_data_source_dump_path(borgmatic_source_directory, pattern)
|
||||||
|
)
|
||||||
|
for pattern in ('*_databases/*/*',)
|
||||||
|
],
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Determine the data source names corresponding to the dumps found in the archive and
|
||||||
|
# add them to restore_names.
|
||||||
|
archive_data_source_names = {}
|
||||||
|
|
||||||
|
for dump_path in dump_paths:
|
||||||
|
try:
|
||||||
|
(hook_name, _, data_source_name) = dump_path.split(
|
||||||
|
borgmatic_source_directory + os.path.sep, 1
|
||||||
|
)[1].split(os.path.sep)[0:3]
|
||||||
|
except (ValueError, IndexError):
|
||||||
|
logger.warning(
|
||||||
|
f'{repository}: Ignoring invalid data source dump path "{dump_path}" in archive {archive}'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
if data_source_name not in archive_data_source_names.get(hook_name, []):
|
||||||
|
archive_data_source_names.setdefault(hook_name, []).extend([data_source_name])
|
||||||
|
|
||||||
|
return archive_data_source_names
|
||||||
|
|
||||||
|
|
||||||
|
def find_data_sources_to_restore(requested_data_source_names, archive_data_source_names):
|
||||||
|
'''
|
||||||
|
Given a sequence of requested data source names to restore and a dict of hook name to the names
|
||||||
|
of data sources found in an archive, return an expanded sequence of data source names to
|
||||||
|
restore, replacing "all" with actual data source names as appropriate.
|
||||||
|
|
||||||
|
Raise ValueError if any of the requested data source names cannot be found in the archive.
|
||||||
|
'''
|
||||||
|
# A map from data source hook name to the data source names to restore for that hook.
|
||||||
|
restore_names = (
|
||||||
|
{UNSPECIFIED_HOOK: requested_data_source_names}
|
||||||
|
if requested_data_source_names
|
||||||
|
else {UNSPECIFIED_HOOK: ['all']}
|
||||||
|
)
|
||||||
|
|
||||||
|
# If "all" is in restore_names, then replace it with the names of dumps found within the
|
||||||
|
# archive.
|
||||||
|
if 'all' in restore_names[UNSPECIFIED_HOOK]:
|
||||||
|
restore_names[UNSPECIFIED_HOOK].remove('all')
|
||||||
|
|
||||||
|
for hook_name, data_source_names in archive_data_source_names.items():
|
||||||
|
restore_names.setdefault(hook_name, []).extend(data_source_names)
|
||||||
|
|
||||||
|
# If a data source is to be restored as part of "all", then remove it from restore names
|
||||||
|
# so it doesn't get restored twice.
|
||||||
|
for data_source_name in data_source_names:
|
||||||
|
if data_source_name in restore_names[UNSPECIFIED_HOOK]:
|
||||||
|
restore_names[UNSPECIFIED_HOOK].remove(data_source_name)
|
||||||
|
|
||||||
|
if not restore_names[UNSPECIFIED_HOOK]:
|
||||||
|
restore_names.pop(UNSPECIFIED_HOOK)
|
||||||
|
|
||||||
|
combined_restore_names = set(
|
||||||
|
name for data_source_names in restore_names.values() for name in data_source_names
|
||||||
|
)
|
||||||
|
combined_archive_data_source_names = set(
|
||||||
|
name
|
||||||
|
for data_source_names in archive_data_source_names.values()
|
||||||
|
for name in data_source_names
|
||||||
|
)
|
||||||
|
|
||||||
|
missing_names = sorted(set(combined_restore_names) - combined_archive_data_source_names)
|
||||||
|
if missing_names:
|
||||||
|
joined_names = ', '.join(f'"{name}"' for name in missing_names)
|
||||||
|
raise ValueError(
|
||||||
|
f"Cannot restore data source{'s' if len(missing_names) > 1 else ''} {joined_names} missing from archive"
|
||||||
|
)
|
||||||
|
|
||||||
|
return restore_names
|
||||||
|
|
||||||
|
|
||||||
|
def ensure_data_sources_found(restore_names, remaining_restore_names, found_names):
|
||||||
|
'''
|
||||||
|
Given a dict from hook name to data source names to restore, a dict from hook name to remaining
|
||||||
|
data source names to restore, and a sequence of found (actually restored) data source names,
|
||||||
|
raise ValueError if requested data source to restore were missing from the archive and/or
|
||||||
|
configuration.
|
||||||
|
'''
|
||||||
|
combined_restore_names = set(
|
||||||
|
name
|
||||||
|
for data_source_names in tuple(restore_names.values())
|
||||||
|
+ tuple(remaining_restore_names.values())
|
||||||
|
for name in data_source_names
|
||||||
|
)
|
||||||
|
|
||||||
|
if not combined_restore_names and not found_names:
|
||||||
|
raise ValueError('No data sources were found to restore')
|
||||||
|
|
||||||
|
missing_names = sorted(set(combined_restore_names) - set(found_names))
|
||||||
|
if missing_names:
|
||||||
|
joined_names = ', '.join(f'"{name}"' for name in missing_names)
|
||||||
|
raise ValueError(
|
||||||
|
f"Cannot restore data source{'s' if len(missing_names) > 1 else ''} {joined_names} missing from borgmatic's configuration"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_restore(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
restore_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "restore" action for the given repository, but only if the repository matches the
|
||||||
|
requested repository in restore arguments.
|
||||||
|
|
||||||
|
Raise ValueError if a configured data source could not be found to restore.
|
||||||
|
'''
|
||||||
|
if restore_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
|
repository, restore_arguments.repository
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Restoring data sources from archive {restore_arguments.archive}'
|
||||||
|
)
|
||||||
|
|
||||||
|
borgmatic.hooks.dispatch.call_hooks_even_if_unconfigured(
|
||||||
|
'remove_data_source_dumps',
|
||||||
|
config,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
|
||||||
|
archive_name = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
restore_arguments.archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
archive_data_source_names = collect_archive_data_source_names(
|
||||||
|
repository['path'],
|
||||||
|
archive_name,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
restore_names = find_data_sources_to_restore(
|
||||||
|
restore_arguments.data_sources, archive_data_source_names
|
||||||
|
)
|
||||||
|
found_names = set()
|
||||||
|
remaining_restore_names = {}
|
||||||
|
connection_params = {
|
||||||
|
'hostname': restore_arguments.hostname,
|
||||||
|
'port': restore_arguments.port,
|
||||||
|
'username': restore_arguments.username,
|
||||||
|
'password': restore_arguments.password,
|
||||||
|
'restore_path': restore_arguments.restore_path,
|
||||||
|
}
|
||||||
|
|
||||||
|
for hook_name, data_source_names in restore_names.items():
|
||||||
|
for data_source_name in data_source_names:
|
||||||
|
found_hook_name, found_data_source = get_configured_data_source(
|
||||||
|
config, archive_data_source_names, hook_name, data_source_name
|
||||||
|
)
|
||||||
|
|
||||||
|
if not found_data_source:
|
||||||
|
remaining_restore_names.setdefault(found_hook_name or hook_name, []).append(
|
||||||
|
data_source_name
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
found_names.add(data_source_name)
|
||||||
|
restore_single_data_source(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
archive_name,
|
||||||
|
found_hook_name or hook_name,
|
||||||
|
dict(found_data_source, **{'schemas': restore_arguments.schemas}),
|
||||||
|
connection_params,
|
||||||
|
)
|
||||||
|
|
||||||
|
# For any data sources that weren't found via exact matches in the configuration, try to
|
||||||
|
# fallback to "all" entries.
|
||||||
|
for hook_name, data_source_names in remaining_restore_names.items():
|
||||||
|
for data_source_name in data_source_names:
|
||||||
|
found_hook_name, found_data_source = get_configured_data_source(
|
||||||
|
config, archive_data_source_names, hook_name, data_source_name, 'all'
|
||||||
|
)
|
||||||
|
|
||||||
|
if not found_data_source:
|
||||||
|
continue
|
||||||
|
|
||||||
|
found_names.add(data_source_name)
|
||||||
|
data_source = copy.copy(found_data_source)
|
||||||
|
data_source['name'] = data_source_name
|
||||||
|
|
||||||
|
restore_single_data_source(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
archive_name,
|
||||||
|
found_hook_name or hook_name,
|
||||||
|
dict(data_source, **{'schemas': restore_arguments.schemas}),
|
||||||
|
connection_params,
|
||||||
|
)
|
||||||
|
|
||||||
|
borgmatic.hooks.dispatch.call_hooks_even_if_unconfigured(
|
||||||
|
'remove_data_source_dumps',
|
||||||
|
config,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
|
||||||
|
ensure_data_sources_found(restore_names, remaining_restore_names, found_names)
|
42
borgmatic/actions/rinfo.py
Normal file
42
borgmatic/actions/rinfo.py
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.actions.json
|
||||||
|
import borgmatic.borg.rinfo
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_rinfo(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
rinfo_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "rinfo" action for the given repository.
|
||||||
|
|
||||||
|
If rinfo_arguments.json is True, yield the JSON output from the info for the repository.
|
||||||
|
'''
|
||||||
|
if rinfo_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, rinfo_arguments.repository
|
||||||
|
):
|
||||||
|
if not rinfo_arguments.json:
|
||||||
|
logger.answer(
|
||||||
|
f'{repository.get("label", repository["path"])}: Displaying repository summary information'
|
||||||
|
)
|
||||||
|
|
||||||
|
json_output = borgmatic.borg.rinfo.display_repository_info(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
rinfo_arguments=rinfo_arguments,
|
||||||
|
global_arguments=global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
if json_output:
|
||||||
|
yield borgmatic.actions.json.parse_json(json_output, repository.get('label'))
|
40
borgmatic/actions/rlist.py
Normal file
40
borgmatic/actions/rlist.py
Normal file
|
@ -0,0 +1,40 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.actions.json
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.config.validate
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_rlist(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "rlist" action for the given repository.
|
||||||
|
|
||||||
|
If rlist_arguments.json is True, yield the JSON output from listing the repository.
|
||||||
|
'''
|
||||||
|
if rlist_arguments.repository is None or borgmatic.config.validate.repositories_match(
|
||||||
|
repository, rlist_arguments.repository
|
||||||
|
):
|
||||||
|
if not rlist_arguments.json:
|
||||||
|
logger.answer(f'{repository.get("label", repository["path"])}: Listing repository')
|
||||||
|
|
||||||
|
json_output = borgmatic.borg.rlist.list_repository(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments=rlist_arguments,
|
||||||
|
global_arguments=global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
if json_output:
|
||||||
|
yield borgmatic.actions.json.parse_json(json_output, repository.get('label'))
|
32
borgmatic/actions/transfer.py
Normal file
32
borgmatic/actions/transfer.py
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import borgmatic.borg.transfer
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def run_transfer(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
transfer_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Run the "transfer" action for the given repository.
|
||||||
|
'''
|
||||||
|
logger.info(
|
||||||
|
f'{repository.get("label", repository["path"])}: Transferring archives to repository'
|
||||||
|
)
|
||||||
|
borgmatic.borg.transfer.transfer_archives(
|
||||||
|
global_arguments.dry_run,
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
transfer_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
|
@ -1,20 +1,20 @@
|
||||||
import logging
|
import logging
|
||||||
|
import shlex
|
||||||
|
|
||||||
|
import borgmatic.commands.arguments
|
||||||
import borgmatic.logger
|
import borgmatic.logger
|
||||||
from borgmatic.borg import environment, flags
|
from borgmatic.borg import environment, flags
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
REPOSITORYLESS_BORG_COMMANDS = {'serve', None}
|
|
||||||
BORG_SUBCOMMANDS_WITH_SUBCOMMANDS = {'key', 'debug'}
|
BORG_SUBCOMMANDS_WITH_SUBCOMMANDS = {'key', 'debug'}
|
||||||
BORG_SUBCOMMANDS_WITHOUT_REPOSITORY = (('debug', 'info'), ('debug', 'convert-profile'), ())
|
|
||||||
|
|
||||||
|
|
||||||
def run_arbitrary_borg(
|
def run_arbitrary_borg(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
options,
|
options,
|
||||||
archive=None,
|
archive=None,
|
||||||
|
@ -22,12 +22,13 @@ def run_arbitrary_borg(
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, the local Borg version, a
|
Given a local or remote repository path, a configuration dict, the local Borg version, a
|
||||||
sequence of arbitrary command-line Borg options, and an optional archive name, run an arbitrary
|
sequence of arbitrary command-line Borg options, and an optional archive name, run an arbitrary
|
||||||
Borg command on the given repository/archive.
|
Borg command, passing in REPOSITORY and ARCHIVE environment variables for optional use in the
|
||||||
|
command.
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
borgmatic.logger.add_custom_log_levels()
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
options = options[1:] if options[0] == '--' else options
|
options = options[1:] if options[0] == '--' else options
|
||||||
|
@ -36,33 +37,36 @@ def run_arbitrary_borg(
|
||||||
command_options_start_index = 2 if options[0] in BORG_SUBCOMMANDS_WITH_SUBCOMMANDS else 1
|
command_options_start_index = 2 if options[0] in BORG_SUBCOMMANDS_WITH_SUBCOMMANDS else 1
|
||||||
borg_command = tuple(options[:command_options_start_index])
|
borg_command = tuple(options[:command_options_start_index])
|
||||||
command_options = tuple(options[command_options_start_index:])
|
command_options = tuple(options[command_options_start_index:])
|
||||||
|
|
||||||
|
if borg_command and borg_command[0] in borgmatic.commands.arguments.ACTION_ALIASES.keys():
|
||||||
|
logger.warning(
|
||||||
|
f"Borg's {borg_command[0]} subcommand is supported natively by borgmatic. Try this instead: borgmatic {borg_command[0]}"
|
||||||
|
)
|
||||||
except IndexError:
|
except IndexError:
|
||||||
borg_command = ()
|
borg_command = ()
|
||||||
command_options = ()
|
command_options = ()
|
||||||
|
|
||||||
if borg_command in BORG_SUBCOMMANDS_WITHOUT_REPOSITORY:
|
|
||||||
repository_archive_flags = ()
|
|
||||||
elif archive:
|
|
||||||
repository_archive_flags = flags.make_repository_archive_flags(
|
|
||||||
repository, archive, local_borg_version
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
repository_archive_flags = flags.make_repository_flags(repository, local_borg_version)
|
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path,)
|
(local_path,)
|
||||||
+ borg_command
|
+ borg_command
|
||||||
+ repository_archive_flags
|
|
||||||
+ command_options
|
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ flags.make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
+ flags.make_flags('lock-wait', lock_wait)
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
|
+ command_options
|
||||||
)
|
)
|
||||||
|
|
||||||
return execute_command(
|
return execute_command(
|
||||||
full_command,
|
tuple(shlex.quote(part) for part in full_command),
|
||||||
output_log_level=logging.ANSWER,
|
output_file=DO_NOT_CAPTURE,
|
||||||
|
shell=True,
|
||||||
|
extra_environment=dict(
|
||||||
|
(environment.make_environment(config) or {}),
|
||||||
|
**{
|
||||||
|
'BORG_REPO': repository_path,
|
||||||
|
'ARCHIVE': archive if archive else '',
|
||||||
|
},
|
||||||
|
),
|
||||||
borg_local_path=local_path,
|
borg_local_path=local_path,
|
||||||
extra_environment=environment.make_environment(storage_config),
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
|
|
|
@ -7,25 +7,36 @@ logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def break_lock(
|
def break_lock(
|
||||||
repository, storage_config, local_borg_version, local_path='borg', remote_path=None,
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage configuration dict, the local Borg version,
|
Given a local or remote repository path, a configuration dict, the local Borg version, an
|
||||||
and optional local and remote Borg paths, break any repository and cache locks leftover from Borg
|
argparse.Namespace of global arguments, and optional local and remote Borg paths, break any
|
||||||
aborting.
|
repository and cache locks leftover from Borg aborting.
|
||||||
'''
|
'''
|
||||||
umask = storage_config.get('umask', None)
|
umask = config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'break-lock')
|
(local_path, 'break-lock')
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
borg_environment = environment.make_environment(storage_config)
|
borg_environment = environment.make_environment(config)
|
||||||
execute_command(full_command, borg_local_path=local_path, extra_environment=borg_environment)
|
execute_command(
|
||||||
|
full_command,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
|
)
|
||||||
|
|
|
@ -1,155 +1,59 @@
|
||||||
import argparse
|
import argparse
|
||||||
import datetime
|
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import os
|
|
||||||
import pathlib
|
|
||||||
|
|
||||||
from borgmatic.borg import environment, extract, feature, flags, rinfo, state
|
from borgmatic.borg import environment, feature, flags, rinfo
|
||||||
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
DEFAULT_CHECKS = (
|
|
||||||
{'name': 'repository', 'frequency': '1 month'},
|
|
||||||
{'name': 'archives', 'frequency': '1 month'},
|
|
||||||
)
|
|
||||||
DEFAULT_PREFIX = '{hostname}-'
|
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def parse_checks(consistency_config, only_checks=None):
|
def make_archive_filter_flags(local_borg_version, config, checks, check_arguments):
|
||||||
'''
|
'''
|
||||||
Given a consistency config with a "checks" sequence of dicts and an optional list of override
|
Given the local Borg version, a configuration dict, a parsed sequence of checks, and check
|
||||||
checks, return a tuple of named checks to run.
|
arguments as an argparse.Namespace instance, transform the checks into tuple of command-line
|
||||||
|
flags for filtering archives in a check command.
|
||||||
|
|
||||||
For example, given a retention config of:
|
If "check_last" is set in the configuration and "archives" is in checks, then include a "--last"
|
||||||
|
flag. And if "prefix" is set in configuration and "archives" is in checks, then include a
|
||||||
{'checks': ({'name': 'repository'}, {'name': 'archives'})}
|
"--match-archives" flag.
|
||||||
|
|
||||||
This will be returned as:
|
|
||||||
|
|
||||||
('repository', 'archives')
|
|
||||||
|
|
||||||
If no "checks" option is present in the config, return the DEFAULT_CHECKS. If a checks value
|
|
||||||
has a name of "disabled", return an empty tuple, meaning that no checks should be run.
|
|
||||||
'''
|
'''
|
||||||
checks = only_checks or tuple(
|
check_last = config.get('check_last', None)
|
||||||
check_config['name']
|
prefix = config.get('prefix')
|
||||||
for check_config in (consistency_config.get('checks', None) or DEFAULT_CHECKS)
|
|
||||||
)
|
if 'archives' in checks or 'data' in checks:
|
||||||
checks = tuple(check.lower() for check in checks)
|
return (('--last', str(check_last)) if check_last else ()) + (
|
||||||
if 'disabled' in checks:
|
(
|
||||||
if len(checks) > 1:
|
('--match-archives', f'sh:{prefix}*')
|
||||||
logger.warning(
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
||||||
'Multiple checks are configured, but one of them is "disabled"; not running any checks'
|
else ('--glob-archives', f'{prefix}*')
|
||||||
|
)
|
||||||
|
if prefix
|
||||||
|
else (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
check_arguments.match_archives or config.get('match_archives'),
|
||||||
|
config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
return ()
|
|
||||||
|
|
||||||
return checks
|
|
||||||
|
|
||||||
|
|
||||||
def parse_frequency(frequency):
|
|
||||||
'''
|
|
||||||
Given a frequency string with a number and a unit of time, return a corresponding
|
|
||||||
datetime.timedelta instance or None if the frequency is None or "always".
|
|
||||||
|
|
||||||
For instance, given "3 weeks", return datetime.timedelta(weeks=3)
|
|
||||||
|
|
||||||
Raise ValueError if the given frequency cannot be parsed.
|
|
||||||
'''
|
|
||||||
if not frequency:
|
|
||||||
return None
|
|
||||||
|
|
||||||
frequency = frequency.strip().lower()
|
|
||||||
|
|
||||||
if frequency == 'always':
|
|
||||||
return None
|
|
||||||
|
|
||||||
try:
|
|
||||||
number, time_unit = frequency.split(' ')
|
|
||||||
number = int(number)
|
|
||||||
except ValueError:
|
|
||||||
raise ValueError(f"Could not parse consistency check frequency '{frequency}'")
|
|
||||||
|
|
||||||
if not time_unit.endswith('s'):
|
|
||||||
time_unit += 's'
|
|
||||||
|
|
||||||
if time_unit == 'months':
|
|
||||||
number *= 30
|
|
||||||
time_unit = 'days'
|
|
||||||
elif time_unit == 'years':
|
|
||||||
number *= 365
|
|
||||||
time_unit = 'days'
|
|
||||||
|
|
||||||
try:
|
|
||||||
return datetime.timedelta(**{time_unit: number})
|
|
||||||
except TypeError:
|
|
||||||
raise ValueError(f"Could not parse consistency check frequency '{frequency}'")
|
|
||||||
|
|
||||||
|
|
||||||
def filter_checks_on_frequency(
|
|
||||||
location_config, consistency_config, borg_repository_id, checks, force
|
|
||||||
):
|
|
||||||
'''
|
|
||||||
Given a location config, a consistency config with a "checks" sequence of dicts, a Borg
|
|
||||||
repository ID, a sequence of checks, and whether to force checks to run, filter down those
|
|
||||||
checks based on the configured "frequency" for each check as compared to its check time file.
|
|
||||||
|
|
||||||
In other words, a check whose check time file's timestamp is too new (based on the configured
|
|
||||||
frequency) will get cut from the returned sequence of checks. Example:
|
|
||||||
|
|
||||||
consistency_config = {
|
|
||||||
'checks': [
|
|
||||||
{
|
|
||||||
'name': 'archives',
|
|
||||||
'frequency': '2 weeks',
|
|
||||||
},
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
When this function is called with that consistency_config and "archives" in checks, "archives"
|
|
||||||
will get filtered out of the returned result if its check time file is newer than 2 weeks old,
|
|
||||||
indicating that it's not yet time to run that check again.
|
|
||||||
|
|
||||||
Raise ValueError if a frequency cannot be parsed.
|
|
||||||
'''
|
|
||||||
filtered_checks = list(checks)
|
|
||||||
|
|
||||||
if force:
|
|
||||||
return tuple(filtered_checks)
|
|
||||||
|
|
||||||
for check_config in consistency_config.get('checks', DEFAULT_CHECKS):
|
|
||||||
check = check_config['name']
|
|
||||||
if checks and check not in checks:
|
|
||||||
continue
|
|
||||||
|
|
||||||
frequency_delta = parse_frequency(check_config.get('frequency'))
|
|
||||||
if not frequency_delta:
|
|
||||||
continue
|
|
||||||
|
|
||||||
check_time = read_check_time(
|
|
||||||
make_check_time_path(location_config, borg_repository_id, check)
|
|
||||||
)
|
)
|
||||||
if not check_time:
|
|
||||||
continue
|
|
||||||
|
|
||||||
# If we've not yet reached the time when the frequency dictates we're ready for another
|
if check_last:
|
||||||
# check, skip this check.
|
logger.warning(
|
||||||
if datetime.datetime.now() < check_time + frequency_delta:
|
'Ignoring check_last option, as "archives" or "data" are not in consistency checks'
|
||||||
remaining = check_time + frequency_delta - datetime.datetime.now()
|
)
|
||||||
logger.info(
|
if prefix:
|
||||||
f"Skipping {check} check due to configured frequency; {remaining} until next check"
|
logger.warning(
|
||||||
)
|
'Ignoring consistency prefix option, as "archives" or "data" are not in consistency checks'
|
||||||
filtered_checks.remove(check)
|
)
|
||||||
|
|
||||||
return tuple(filtered_checks)
|
return ()
|
||||||
|
|
||||||
|
|
||||||
def make_check_flags(local_borg_version, checks, check_last=None, prefix=None):
|
def make_check_flags(checks, archive_filter_flags):
|
||||||
'''
|
'''
|
||||||
Given the local Borg version and a parsed sequence of checks, transform the checks into tuple of
|
Given a parsed checks set and a sequence of flags to filter archives,
|
||||||
command-line flags.
|
transform the checks into tuple of command-line check flags.
|
||||||
|
|
||||||
For example, given parsed checks of:
|
For example, given parsed checks of:
|
||||||
|
|
||||||
|
@ -161,174 +65,105 @@ def make_check_flags(local_borg_version, checks, check_last=None, prefix=None):
|
||||||
|
|
||||||
However, if both "repository" and "archives" are in checks, then omit them from the returned
|
However, if both "repository" and "archives" are in checks, then omit them from the returned
|
||||||
flags because Borg does both checks by default. If "data" is in checks, that implies "archives".
|
flags because Borg does both checks by default. If "data" is in checks, that implies "archives".
|
||||||
|
|
||||||
Additionally, if a check_last value is given and "archives" is in checks, then include a
|
|
||||||
"--last" flag. And if a prefix value is given and "archives" is in checks, then include a
|
|
||||||
"--match-archives" flag.
|
|
||||||
'''
|
'''
|
||||||
if 'data' in checks:
|
if 'data' in checks:
|
||||||
data_flags = ('--verify-data',)
|
data_flags = ('--verify-data',)
|
||||||
checks += ('archives',)
|
checks.update({'archives'})
|
||||||
else:
|
else:
|
||||||
data_flags = ()
|
data_flags = ()
|
||||||
|
|
||||||
if 'archives' in checks:
|
common_flags = (archive_filter_flags if 'archives' in checks else ()) + data_flags
|
||||||
last_flags = ('--last', str(check_last)) if check_last else ()
|
|
||||||
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version):
|
|
||||||
match_archives_flags = ('--match-archives', f'sh:{prefix}*') if prefix else ()
|
|
||||||
else:
|
|
||||||
match_archives_flags = ('--glob-archives', f'{prefix}*') if prefix else ()
|
|
||||||
else:
|
|
||||||
last_flags = ()
|
|
||||||
match_archives_flags = ()
|
|
||||||
if check_last:
|
|
||||||
logger.warning(
|
|
||||||
'Ignoring check_last option, as "archives" or "data" are not in consistency checks'
|
|
||||||
)
|
|
||||||
if prefix:
|
|
||||||
logger.warning(
|
|
||||||
'Ignoring consistency prefix option, as "archives" or "data" are not in consistency checks'
|
|
||||||
)
|
|
||||||
|
|
||||||
common_flags = last_flags + match_archives_flags + data_flags
|
if {'repository', 'archives'}.issubset(checks):
|
||||||
|
|
||||||
if {'repository', 'archives'}.issubset(set(checks)):
|
|
||||||
return common_flags
|
return common_flags
|
||||||
|
|
||||||
return (
|
return (
|
||||||
tuple('--{}-only'.format(check) for check in checks if check in ('repository', 'archives'))
|
tuple(f'--{check}-only' for check in checks if check in ('repository', 'archives'))
|
||||||
+ common_flags
|
+ common_flags
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def make_check_time_path(location_config, borg_repository_id, check_type):
|
def get_repository_id(
|
||||||
'''
|
repository_path, config, local_borg_version, global_arguments, local_path, remote_path
|
||||||
Given a location configuration dict, a Borg repository ID, and the name of a check type
|
|
||||||
("repository", "archives", etc.), return a path for recording that check's time (the time of
|
|
||||||
that check last occurring).
|
|
||||||
'''
|
|
||||||
return os.path.join(
|
|
||||||
os.path.expanduser(
|
|
||||||
location_config.get(
|
|
||||||
'borgmatic_source_directory', state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
|
||||||
)
|
|
||||||
),
|
|
||||||
'checks',
|
|
||||||
borg_repository_id,
|
|
||||||
check_type,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def write_check_time(path): # pragma: no cover
|
|
||||||
'''
|
|
||||||
Record a check time of now as the modification time of the given path.
|
|
||||||
'''
|
|
||||||
logger.debug(f'Writing check time at {path}')
|
|
||||||
|
|
||||||
os.makedirs(os.path.dirname(path), mode=0o700, exist_ok=True)
|
|
||||||
pathlib.Path(path, mode=0o600).touch()
|
|
||||||
|
|
||||||
|
|
||||||
def read_check_time(path):
|
|
||||||
'''
|
|
||||||
Return the check time based on the modification time of the given path. Return None if the path
|
|
||||||
doesn't exist.
|
|
||||||
'''
|
|
||||||
logger.debug(f'Reading check time from {path}')
|
|
||||||
|
|
||||||
try:
|
|
||||||
return datetime.datetime.fromtimestamp(os.stat(path).st_mtime)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def check_archives(
|
|
||||||
repository,
|
|
||||||
location_config,
|
|
||||||
storage_config,
|
|
||||||
consistency_config,
|
|
||||||
local_borg_version,
|
|
||||||
local_path='borg',
|
|
||||||
remote_path=None,
|
|
||||||
progress=None,
|
|
||||||
repair=None,
|
|
||||||
only_checks=None,
|
|
||||||
force=None,
|
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, a consistency config dict,
|
Given a local or remote repository path, a configuration dict, the local Borg version, global
|
||||||
local/remote commands to run, whether to include progress information, whether to attempt a
|
arguments, and local/remote commands to run, return the corresponding Borg repository ID.
|
||||||
repair, and an optional list of checks to use instead of configured checks, check the contained
|
|
||||||
Borg archives for consistency.
|
|
||||||
|
|
||||||
If there are no consistency checks to run, skip running them.
|
Raise ValueError if the Borg repository ID cannot be determined.
|
||||||
|
|
||||||
Raises ValueError if the Borg repository ID cannot be determined.
|
|
||||||
'''
|
'''
|
||||||
try:
|
try:
|
||||||
borg_repository_id = json.loads(
|
return json.loads(
|
||||||
rinfo.display_repository_info(
|
rinfo.display_repository_info(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
argparse.Namespace(json=True),
|
argparse.Namespace(json=True),
|
||||||
|
global_arguments,
|
||||||
local_path,
|
local_path,
|
||||||
remote_path,
|
remote_path,
|
||||||
)
|
)
|
||||||
)['repository']['id']
|
)['repository']['id']
|
||||||
except (json.JSONDecodeError, KeyError):
|
except (json.JSONDecodeError, KeyError):
|
||||||
raise ValueError(f'Cannot determine Borg repository ID for {repository}')
|
raise ValueError(f'Cannot determine Borg repository ID for {repository_path}')
|
||||||
|
|
||||||
checks = filter_checks_on_frequency(
|
|
||||||
location_config,
|
def check_archives(
|
||||||
consistency_config,
|
repository_path,
|
||||||
borg_repository_id,
|
config,
|
||||||
parse_checks(consistency_config, only_checks),
|
local_borg_version,
|
||||||
force,
|
check_arguments,
|
||||||
|
global_arguments,
|
||||||
|
checks,
|
||||||
|
archive_filter_flags,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a configuration dict, the local Borg version, check
|
||||||
|
arguments as an argparse.Namespace instance, global arguments, a set of named Borg checks to run
|
||||||
|
(some combination "repository", "archives", and/or "data"), archive filter flags, and
|
||||||
|
local/remote commands to run, check the contained Borg archives for consistency.
|
||||||
|
'''
|
||||||
|
lock_wait = config.get('lock_wait')
|
||||||
|
extra_borg_options = config.get('extra_borg_options', {}).get('check', '')
|
||||||
|
|
||||||
|
verbosity_flags = ()
|
||||||
|
if logger.isEnabledFor(logging.INFO):
|
||||||
|
verbosity_flags = ('--info',)
|
||||||
|
if logger.isEnabledFor(logging.DEBUG):
|
||||||
|
verbosity_flags = ('--debug', '--show-rc')
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(local_path, 'check')
|
||||||
|
+ (('--repair',) if check_arguments.repair else ())
|
||||||
|
+ make_check_flags(checks, archive_filter_flags)
|
||||||
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
|
+ verbosity_flags
|
||||||
|
+ (('--progress',) if check_arguments.progress else ())
|
||||||
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
check_last = consistency_config.get('check_last', None)
|
|
||||||
lock_wait = None
|
|
||||||
extra_borg_options = storage_config.get('extra_borg_options', {}).get('check', '')
|
|
||||||
|
|
||||||
if set(checks).intersection({'repository', 'archives', 'data'}):
|
borg_environment = environment.make_environment(config)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
borg_exit_codes = config.get('borg_exit_codes')
|
||||||
|
|
||||||
verbosity_flags = ()
|
# The Borg repair option triggers an interactive prompt, which won't work when output is
|
||||||
if logger.isEnabledFor(logging.INFO):
|
# captured. And progress messes with the terminal directly.
|
||||||
verbosity_flags = ('--info',)
|
if check_arguments.repair or check_arguments.progress:
|
||||||
if logger.isEnabledFor(logging.DEBUG):
|
execute_command(
|
||||||
verbosity_flags = ('--debug', '--show-rc')
|
full_command,
|
||||||
|
output_file=DO_NOT_CAPTURE,
|
||||||
prefix = consistency_config.get('prefix', DEFAULT_PREFIX)
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
full_command = (
|
borg_exit_codes=borg_exit_codes,
|
||||||
(local_path, 'check')
|
|
||||||
+ (('--repair',) if repair else ())
|
|
||||||
+ make_check_flags(local_borg_version, checks, check_last, prefix)
|
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
|
||||||
+ verbosity_flags
|
|
||||||
+ (('--progress',) if progress else ())
|
|
||||||
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
|
||||||
)
|
)
|
||||||
|
else:
|
||||||
borg_environment = environment.make_environment(storage_config)
|
execute_command(
|
||||||
|
full_command,
|
||||||
# The Borg repair option triggers an interactive prompt, which won't work when output is
|
extra_environment=borg_environment,
|
||||||
# captured. And progress messes with the terminal directly.
|
borg_local_path=local_path,
|
||||||
if repair or progress:
|
borg_exit_codes=borg_exit_codes,
|
||||||
execute_command(
|
|
||||||
full_command, output_file=DO_NOT_CAPTURE, extra_environment=borg_environment
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
execute_command(full_command, extra_environment=borg_environment)
|
|
||||||
|
|
||||||
for check in checks:
|
|
||||||
write_check_time(make_check_time_path(location_config, borg_repository_id, check))
|
|
||||||
|
|
||||||
if 'extract' in checks:
|
|
||||||
extract.extract_last_archive_dry_run(
|
|
||||||
storage_config, local_borg_version, repository, lock_wait, local_path, remote_path
|
|
||||||
)
|
)
|
||||||
write_check_time(make_check_time_path(location_config, borg_repository_id, 'extract'))
|
|
||||||
|
|
|
@ -8,9 +8,10 @@ logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
def compact_segments(
|
def compact_segments(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
progress=False,
|
progress=False,
|
||||||
|
@ -18,17 +19,18 @@ def compact_segments(
|
||||||
threshold=None,
|
threshold=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given dry-run flag, a local or remote repository path, a storage config dict, and the local
|
Given dry-run flag, a local or remote repository path, a configuration dict, and the local Borg
|
||||||
Borg version, compact the segments in a repository.
|
version, compact the segments in a repository.
|
||||||
'''
|
'''
|
||||||
umask = storage_config.get('umask', None)
|
umask = config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
extra_borg_options = storage_config.get('extra_borg_options', {}).get('compact', '')
|
extra_borg_options = config.get('extra_borg_options', {}).get('compact', '')
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'compact')
|
(local_path, 'compact')
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--progress',) if progress else ())
|
+ (('--progress',) if progress else ())
|
||||||
+ (('--cleanup-commits',) if cleanup_commits else ())
|
+ (('--cleanup-commits',) if cleanup_commits else ())
|
||||||
|
@ -36,16 +38,17 @@ def compact_segments(
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
if dry_run:
|
if dry_run:
|
||||||
logging.info(f'{repository}: Skipping compact (dry run)')
|
logging.info(f'{repository_path}: Skipping compact (dry run)')
|
||||||
return
|
return
|
||||||
|
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command,
|
full_command,
|
||||||
output_log_level=logging.INFO,
|
output_log_level=logging.INFO,
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
borg_local_path=local_path,
|
borg_local_path=local_path,
|
||||||
extra_environment=environment.make_environment(storage_config),
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
|
|
|
@ -146,12 +146,12 @@ def ensure_files_readable(*filename_lists):
|
||||||
open(file_object).close()
|
open(file_object).close()
|
||||||
|
|
||||||
|
|
||||||
def make_pattern_flags(location_config, pattern_filename=None):
|
def make_pattern_flags(config, pattern_filename=None):
|
||||||
'''
|
'''
|
||||||
Given a location config dict with a potential patterns_from option, and a filename containing
|
Given a configuration dict with a potential patterns_from option, and a filename containing any
|
||||||
any additional patterns, return the corresponding Borg flags for those files as a tuple.
|
additional patterns, return the corresponding Borg flags for those files as a tuple.
|
||||||
'''
|
'''
|
||||||
pattern_filenames = tuple(location_config.get('patterns_from') or ()) + (
|
pattern_filenames = tuple(config.get('patterns_from') or ()) + (
|
||||||
(pattern_filename,) if pattern_filename else ()
|
(pattern_filename,) if pattern_filename else ()
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -162,12 +162,12 @@ def make_pattern_flags(location_config, pattern_filename=None):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def make_exclude_flags(location_config, exclude_filename=None):
|
def make_exclude_flags(config, exclude_filename=None):
|
||||||
'''
|
'''
|
||||||
Given a location config dict with various exclude options, and a filename containing any exclude
|
Given a configuration dict with various exclude options, and a filename containing any exclude
|
||||||
patterns, return the corresponding Borg flags as a tuple.
|
patterns, return the corresponding Borg flags as a tuple.
|
||||||
'''
|
'''
|
||||||
exclude_filenames = tuple(location_config.get('exclude_from') or ()) + (
|
exclude_filenames = tuple(config.get('exclude_from') or ()) + (
|
||||||
(exclude_filename,) if exclude_filename else ()
|
(exclude_filename,) if exclude_filename else ()
|
||||||
)
|
)
|
||||||
exclude_from_flags = tuple(
|
exclude_from_flags = tuple(
|
||||||
|
@ -175,17 +175,15 @@ def make_exclude_flags(location_config, exclude_filename=None):
|
||||||
('--exclude-from', exclude_filename) for exclude_filename in exclude_filenames
|
('--exclude-from', exclude_filename) for exclude_filename in exclude_filenames
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
caches_flag = ('--exclude-caches',) if location_config.get('exclude_caches') else ()
|
caches_flag = ('--exclude-caches',) if config.get('exclude_caches') else ()
|
||||||
if_present_flags = tuple(
|
if_present_flags = tuple(
|
||||||
itertools.chain.from_iterable(
|
itertools.chain.from_iterable(
|
||||||
('--exclude-if-present', if_present)
|
('--exclude-if-present', if_present)
|
||||||
for if_present in location_config.get('exclude_if_present', ())
|
for if_present in config.get('exclude_if_present', ())
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
keep_exclude_tags_flags = (
|
keep_exclude_tags_flags = ('--keep-exclude-tags',) if config.get('keep_exclude_tags') else ()
|
||||||
('--keep-exclude-tags',) if location_config.get('keep_exclude_tags') else ()
|
exclude_nodump_flags = ('--exclude-nodump',) if config.get('exclude_nodump') else ()
|
||||||
)
|
|
||||||
exclude_nodump_flags = ('--exclude-nodump',) if location_config.get('exclude_nodump') else ()
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
exclude_from_flags
|
exclude_from_flags
|
||||||
|
@ -196,7 +194,25 @@ def make_exclude_flags(location_config, exclude_filename=None):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
DEFAULT_ARCHIVE_NAME_FORMAT = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}'
|
def make_list_filter_flags(local_borg_version, dry_run):
|
||||||
|
'''
|
||||||
|
Given the local Borg version and whether this is a dry run, return the corresponding flags for
|
||||||
|
passing to "--list --filter". The general idea is that excludes are shown for a dry run or when
|
||||||
|
the verbosity is debug.
|
||||||
|
'''
|
||||||
|
base_flags = 'AME'
|
||||||
|
show_excludes = logger.isEnabledFor(logging.DEBUG)
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.EXCLUDED_FILES_MINUS, local_borg_version):
|
||||||
|
if show_excludes or dry_run:
|
||||||
|
return f'{base_flags}+-'
|
||||||
|
else:
|
||||||
|
return base_flags
|
||||||
|
|
||||||
|
if show_excludes:
|
||||||
|
return f'{base_flags}x-'
|
||||||
|
else:
|
||||||
|
return f'{base_flags}-'
|
||||||
|
|
||||||
|
|
||||||
def collect_borgmatic_source_directories(borgmatic_source_directory):
|
def collect_borgmatic_source_directories(borgmatic_source_directory):
|
||||||
|
@ -256,26 +272,31 @@ def any_parent_directories(path, candidate_parents):
|
||||||
|
|
||||||
|
|
||||||
def collect_special_file_paths(
|
def collect_special_file_paths(
|
||||||
create_command, local_path, working_directory, borg_environment, skip_directories
|
create_command, config, local_path, working_directory, borg_environment, skip_directories
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a Borg create command as a tuple, a local Borg path, a working directory, and a dict of
|
Given a Borg create command as a tuple, a configuration dict, a local Borg path, a working
|
||||||
environment variables to pass to Borg, and a sequence of parent directories to skip, collect the
|
directory, a dict of environment variables to pass to Borg, and a sequence of parent directories
|
||||||
paths for any special files (character devices, block devices, and named pipes / FIFOs) that
|
to skip, collect the paths for any special files (character devices, block devices, and named
|
||||||
Borg would encounter during a create. These are all paths that could cause Borg to hang if its
|
pipes / FIFOs) that Borg would encounter during a create. These are all paths that could cause
|
||||||
--read-special flag is used.
|
Borg to hang if its --read-special flag is used.
|
||||||
'''
|
'''
|
||||||
|
# Omit "--exclude-nodump" from the Borg dry run command, because that flag causes Borg to open
|
||||||
|
# files including any named pipe we've created.
|
||||||
paths_output = execute_command_and_capture_output(
|
paths_output = execute_command_and_capture_output(
|
||||||
create_command + ('--dry-run', '--list'),
|
tuple(argument for argument in create_command if argument != '--exclude-nodump')
|
||||||
|
+ ('--dry-run', '--list'),
|
||||||
capture_stderr=True,
|
capture_stderr=True,
|
||||||
working_directory=working_directory,
|
working_directory=working_directory,
|
||||||
extra_environment=borg_environment,
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
|
|
||||||
paths = tuple(
|
paths = tuple(
|
||||||
path_line.split(' ', 1)[1]
|
path_line.split(' ', 1)[1]
|
||||||
for path_line in paths_output.split('\n')
|
for path_line in paths_output.split('\n')
|
||||||
if path_line and path_line.startswith('- ')
|
if path_line and path_line.startswith('- ') or path_line.startswith('+ ')
|
||||||
)
|
)
|
||||||
|
|
||||||
return tuple(
|
return tuple(
|
||||||
|
@ -285,81 +306,92 @@ def collect_special_file_paths(
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def create_archive(
|
def check_all_source_directories_exist(source_directories):
|
||||||
|
'''
|
||||||
|
Given a sequence of source directories, check that they all exist. If any do not, raise an
|
||||||
|
exception.
|
||||||
|
'''
|
||||||
|
missing_directories = [
|
||||||
|
source_directory
|
||||||
|
for source_directory in source_directories
|
||||||
|
if not all([os.path.exists(directory) for directory in expand_directory(source_directory)])
|
||||||
|
]
|
||||||
|
if missing_directories:
|
||||||
|
raise ValueError(f"Source directories do not exist: {', '.join(missing_directories)}")
|
||||||
|
|
||||||
|
|
||||||
|
def make_base_create_command(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository_path,
|
||||||
location_config,
|
config,
|
||||||
storage_config,
|
config_paths,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
borgmatic_source_directories,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
progress=False,
|
progress=False,
|
||||||
stats=False,
|
|
||||||
json=False,
|
json=False,
|
||||||
list_files=False,
|
list_files=False,
|
||||||
stream_processes=None,
|
stream_processes=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given vebosity/dry-run flags, a local or remote repository path, a location config dict, and a
|
Given vebosity/dry-run flags, a local or remote repository path, a configuration dict, a
|
||||||
storage config dict, create a Borg archive and return Borg's JSON output (if any).
|
sequence of loaded configuration paths, the local Borg version, global arguments as an
|
||||||
|
argparse.Namespace instance, and a sequence of borgmatic source directories, return a tuple of
|
||||||
If a sequence of stream processes is given (instances of subprocess.Popen), then execute the
|
(base Borg create command flags, Borg create command positional arguments, open pattern file
|
||||||
create command while also triggering the given processes to produce output.
|
handle, open exclude file handle).
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
if config.get('source_directories_must_exist', False):
|
||||||
borgmatic_source_directories = expand_directories(
|
check_all_source_directories_exist(config.get('source_directories'))
|
||||||
collect_borgmatic_source_directories(location_config.get('borgmatic_source_directory'))
|
|
||||||
)
|
|
||||||
sources = deduplicate_directories(
|
sources = deduplicate_directories(
|
||||||
map_directories_to_devices(
|
map_directories_to_devices(
|
||||||
expand_directories(
|
expand_directories(
|
||||||
tuple(location_config.get('source_directories', ())) + borgmatic_source_directories
|
tuple(config.get('source_directories', ()))
|
||||||
|
+ borgmatic_source_directories
|
||||||
|
+ tuple(config_paths if config.get('store_config_files', True) else ())
|
||||||
)
|
)
|
||||||
),
|
),
|
||||||
additional_directory_devices=map_directories_to_devices(
|
additional_directory_devices=map_directories_to_devices(
|
||||||
expand_directories(pattern_root_directories(location_config.get('patterns')))
|
expand_directories(pattern_root_directories(config.get('patterns')))
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
ensure_files_readable(location_config.get('patterns_from'), location_config.get('exclude_from'))
|
ensure_files_readable(config.get('patterns_from'), config.get('exclude_from'))
|
||||||
|
|
||||||
try:
|
|
||||||
working_directory = os.path.expanduser(location_config.get('working_directory'))
|
|
||||||
except TypeError:
|
|
||||||
working_directory = None
|
|
||||||
|
|
||||||
pattern_file = (
|
pattern_file = (
|
||||||
write_pattern_file(location_config.get('patterns'), sources)
|
write_pattern_file(config.get('patterns'), sources)
|
||||||
if location_config.get('patterns') or location_config.get('patterns_from')
|
if config.get('patterns') or config.get('patterns_from')
|
||||||
else None
|
else None
|
||||||
)
|
)
|
||||||
exclude_file = write_pattern_file(
|
exclude_file = write_pattern_file(expand_home_directories(config.get('exclude_patterns')))
|
||||||
expand_home_directories(location_config.get('exclude_patterns'))
|
checkpoint_interval = config.get('checkpoint_interval', None)
|
||||||
)
|
checkpoint_volume = config.get('checkpoint_volume', None)
|
||||||
checkpoint_interval = storage_config.get('checkpoint_interval', None)
|
chunker_params = config.get('chunker_params', None)
|
||||||
chunker_params = storage_config.get('chunker_params', None)
|
compression = config.get('compression', None)
|
||||||
compression = storage_config.get('compression', None)
|
upload_rate_limit = config.get('upload_rate_limit', None)
|
||||||
upload_rate_limit = storage_config.get('upload_rate_limit', None)
|
umask = config.get('umask', None)
|
||||||
umask = storage_config.get('umask', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
list_filter_flags = make_list_filter_flags(local_borg_version, dry_run)
|
||||||
files_cache = location_config.get('files_cache')
|
files_cache = config.get('files_cache')
|
||||||
archive_name_format = storage_config.get('archive_name_format', DEFAULT_ARCHIVE_NAME_FORMAT)
|
archive_name_format = config.get('archive_name_format', flags.DEFAULT_ARCHIVE_NAME_FORMAT)
|
||||||
extra_borg_options = storage_config.get('extra_borg_options', {}).get('create', '')
|
extra_borg_options = config.get('extra_borg_options', {}).get('create', '')
|
||||||
|
|
||||||
if feature.available(feature.Feature.ATIME, local_borg_version):
|
if feature.available(feature.Feature.ATIME, local_borg_version):
|
||||||
atime_flags = ('--atime',) if location_config.get('atime') is True else ()
|
atime_flags = ('--atime',) if config.get('atime') is True else ()
|
||||||
else:
|
else:
|
||||||
atime_flags = ('--noatime',) if location_config.get('atime') is False else ()
|
atime_flags = ('--noatime',) if config.get('atime') is False else ()
|
||||||
|
|
||||||
if feature.available(feature.Feature.NOFLAGS, local_borg_version):
|
if feature.available(feature.Feature.NOFLAGS, local_borg_version):
|
||||||
noflags_flags = ('--noflags',) if location_config.get('flags') is False else ()
|
noflags_flags = ('--noflags',) if config.get('flags') is False else ()
|
||||||
else:
|
else:
|
||||||
noflags_flags = ('--nobsdflags',) if location_config.get('flags') is False else ()
|
noflags_flags = ('--nobsdflags',) if config.get('flags') is False else ()
|
||||||
|
|
||||||
if feature.available(feature.Feature.NUMERIC_IDS, local_borg_version):
|
if feature.available(feature.Feature.NUMERIC_IDS, local_borg_version):
|
||||||
numeric_ids_flags = ('--numeric-ids',) if location_config.get('numeric_ids') else ()
|
numeric_ids_flags = ('--numeric-ids',) if config.get('numeric_ids') else ()
|
||||||
else:
|
else:
|
||||||
numeric_ids_flags = ('--numeric-owner',) if location_config.get('numeric_ids') else ()
|
numeric_ids_flags = ('--numeric-owner',) if config.get('numeric_ids') else ()
|
||||||
|
|
||||||
if feature.available(feature.Feature.UPLOAD_RATELIMIT, local_borg_version):
|
if feature.available(feature.Feature.UPLOAD_RATELIMIT, local_borg_version):
|
||||||
upload_ratelimit_flags = (
|
upload_ratelimit_flags = (
|
||||||
|
@ -370,40 +402,123 @@ def create_archive(
|
||||||
('--remote-ratelimit', str(upload_rate_limit)) if upload_rate_limit else ()
|
('--remote-ratelimit', str(upload_rate_limit)) if upload_rate_limit else ()
|
||||||
)
|
)
|
||||||
|
|
||||||
if stream_processes and location_config.get('read_special') is False:
|
create_flags = (
|
||||||
logger.warning(
|
|
||||||
f'{repository}: Ignoring configured "read_special" value of false, as true is needed for database hooks.'
|
|
||||||
)
|
|
||||||
|
|
||||||
create_command = (
|
|
||||||
tuple(local_path.split(' '))
|
tuple(local_path.split(' '))
|
||||||
+ ('create',)
|
+ ('create',)
|
||||||
+ make_pattern_flags(location_config, pattern_file.name if pattern_file else None)
|
+ make_pattern_flags(config, pattern_file.name if pattern_file else None)
|
||||||
+ make_exclude_flags(location_config, exclude_file.name if exclude_file else None)
|
+ make_exclude_flags(config, exclude_file.name if exclude_file else None)
|
||||||
+ (('--checkpoint-interval', str(checkpoint_interval)) if checkpoint_interval else ())
|
+ (('--checkpoint-interval', str(checkpoint_interval)) if checkpoint_interval else ())
|
||||||
|
+ (('--checkpoint-volume', str(checkpoint_volume)) if checkpoint_volume else ())
|
||||||
+ (('--chunker-params', chunker_params) if chunker_params else ())
|
+ (('--chunker-params', chunker_params) if chunker_params else ())
|
||||||
+ (('--compression', compression) if compression else ())
|
+ (('--compression', compression) if compression else ())
|
||||||
+ upload_ratelimit_flags
|
+ upload_ratelimit_flags
|
||||||
+ (
|
+ (('--one-file-system',) if config.get('one_file_system') or stream_processes else ())
|
||||||
('--one-file-system',)
|
|
||||||
if location_config.get('one_file_system') or stream_processes
|
|
||||||
else ()
|
|
||||||
)
|
|
||||||
+ numeric_ids_flags
|
+ numeric_ids_flags
|
||||||
+ atime_flags
|
+ atime_flags
|
||||||
+ (('--noctime',) if location_config.get('ctime') is False else ())
|
+ (('--noctime',) if config.get('ctime') is False else ())
|
||||||
+ (('--nobirthtime',) if location_config.get('birthtime') is False else ())
|
+ (('--nobirthtime',) if config.get('birthtime') is False else ())
|
||||||
+ (('--read-special',) if location_config.get('read_special') or stream_processes else ())
|
+ (('--read-special',) if config.get('read_special') or stream_processes else ())
|
||||||
+ noflags_flags
|
+ noflags_flags
|
||||||
+ (('--files-cache', files_cache) if files_cache else ())
|
+ (('--files-cache', files_cache) if files_cache else ())
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--list', '--filter', 'AMEx-') if list_files and not json and not progress else ())
|
+ (
|
||||||
|
('--list', '--filter', list_filter_flags)
|
||||||
|
if list_files and not json and not progress
|
||||||
|
else ()
|
||||||
|
)
|
||||||
+ (('--dry-run',) if dry_run else ())
|
+ (('--dry-run',) if dry_run else ())
|
||||||
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
+ flags.make_repository_archive_flags(repository, archive_name_format, local_borg_version)
|
)
|
||||||
+ (sources if not pattern_file else ())
|
|
||||||
|
create_positional_arguments = flags.make_repository_archive_flags(
|
||||||
|
repository_path, archive_name_format, local_borg_version
|
||||||
|
) + (sources if not pattern_file else ())
|
||||||
|
|
||||||
|
# If database hooks are enabled (as indicated by streaming processes), exclude files that might
|
||||||
|
# cause Borg to hang. But skip this if the user has explicitly set the "read_special" to True.
|
||||||
|
if stream_processes and not config.get('read_special'):
|
||||||
|
logger.warning(
|
||||||
|
f'{repository_path}: Ignoring configured "read_special" value of false, as true is needed for database hooks.'
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
working_directory = os.path.expanduser(config.get('working_directory'))
|
||||||
|
except TypeError:
|
||||||
|
working_directory = None
|
||||||
|
|
||||||
|
borg_environment = environment.make_environment(config)
|
||||||
|
|
||||||
|
logger.debug(f'{repository_path}: Collecting special file paths')
|
||||||
|
special_file_paths = collect_special_file_paths(
|
||||||
|
create_flags + create_positional_arguments,
|
||||||
|
config,
|
||||||
|
local_path,
|
||||||
|
working_directory,
|
||||||
|
borg_environment,
|
||||||
|
skip_directories=borgmatic_source_directories,
|
||||||
|
)
|
||||||
|
|
||||||
|
if special_file_paths:
|
||||||
|
logger.warning(
|
||||||
|
f'{repository_path}: Excluding special files to prevent Borg from hanging: {", ".join(special_file_paths)}'
|
||||||
|
)
|
||||||
|
exclude_file = write_pattern_file(
|
||||||
|
expand_home_directories(
|
||||||
|
tuple(config.get('exclude_patterns') or ()) + special_file_paths
|
||||||
|
),
|
||||||
|
pattern_file=exclude_file,
|
||||||
|
)
|
||||||
|
create_flags += make_exclude_flags(config, exclude_file.name)
|
||||||
|
|
||||||
|
return (create_flags, create_positional_arguments, pattern_file, exclude_file)
|
||||||
|
|
||||||
|
|
||||||
|
def create_archive(
|
||||||
|
dry_run,
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
config_paths,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
progress=False,
|
||||||
|
stats=False,
|
||||||
|
json=False,
|
||||||
|
list_files=False,
|
||||||
|
stream_processes=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given vebosity/dry-run flags, a local or remote repository path, a configuration dict, a
|
||||||
|
sequence of loaded configuration paths, the local Borg version, and global arguments as an
|
||||||
|
argparse.Namespace instance, create a Borg archive and return Borg's JSON output (if any).
|
||||||
|
|
||||||
|
If a sequence of stream processes is given (instances of subprocess.Popen), then execute the
|
||||||
|
create command while also triggering the given processes to produce output.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
borgmatic_source_directories = expand_directories(
|
||||||
|
collect_borgmatic_source_directories(config.get('borgmatic_source_directory'))
|
||||||
|
)
|
||||||
|
|
||||||
|
(create_flags, create_positional_arguments, pattern_file, exclude_file) = (
|
||||||
|
make_base_create_command(
|
||||||
|
dry_run,
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
config_paths,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
borgmatic_source_directories,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
progress,
|
||||||
|
json,
|
||||||
|
list_files,
|
||||||
|
stream_processes,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
if json:
|
if json:
|
||||||
|
@ -417,61 +532,48 @@ def create_archive(
|
||||||
# the terminal directly.
|
# the terminal directly.
|
||||||
output_file = DO_NOT_CAPTURE if progress else None
|
output_file = DO_NOT_CAPTURE if progress else None
|
||||||
|
|
||||||
borg_environment = environment.make_environment(storage_config)
|
try:
|
||||||
|
working_directory = os.path.expanduser(config.get('working_directory'))
|
||||||
|
except TypeError:
|
||||||
|
working_directory = None
|
||||||
|
|
||||||
# If database hooks are enabled (as indicated by streaming processes), exclude files that might
|
borg_environment = environment.make_environment(config)
|
||||||
# cause Borg to hang. But skip this if the user has explicitly set the "read_special" to True.
|
|
||||||
if stream_processes and not location_config.get('read_special'):
|
|
||||||
logger.debug(f'{repository}: Collecting special file paths')
|
|
||||||
special_file_paths = collect_special_file_paths(
|
|
||||||
create_command,
|
|
||||||
local_path,
|
|
||||||
working_directory,
|
|
||||||
borg_environment,
|
|
||||||
skip_directories=borgmatic_source_directories,
|
|
||||||
)
|
|
||||||
logger.warning(
|
|
||||||
f'{repository}: Excluding special files to prevent Borg from hanging: {", ".join(special_file_paths)}'
|
|
||||||
)
|
|
||||||
|
|
||||||
exclude_file = write_pattern_file(
|
create_flags += (
|
||||||
expand_home_directories(
|
|
||||||
tuple(location_config.get('exclude_patterns') or ()) + special_file_paths
|
|
||||||
),
|
|
||||||
pattern_file=exclude_file,
|
|
||||||
)
|
|
||||||
|
|
||||||
if exclude_file:
|
|
||||||
create_command += make_exclude_flags(location_config, exclude_file.name)
|
|
||||||
|
|
||||||
create_command += (
|
|
||||||
(('--info',) if logger.getEffectiveLevel() == logging.INFO and not json else ())
|
(('--info',) if logger.getEffectiveLevel() == logging.INFO and not json else ())
|
||||||
+ (('--stats',) if stats and not json and not dry_run else ())
|
+ (('--stats',) if stats and not json and not dry_run else ())
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) and not json else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) and not json else ())
|
||||||
+ (('--progress',) if progress else ())
|
+ (('--progress',) if progress else ())
|
||||||
+ (('--json',) if json else ())
|
+ (('--json',) if json else ())
|
||||||
)
|
)
|
||||||
|
borg_exit_codes = config.get('borg_exit_codes')
|
||||||
|
|
||||||
if stream_processes:
|
if stream_processes:
|
||||||
return execute_command_with_processes(
|
return execute_command_with_processes(
|
||||||
create_command,
|
create_flags + create_positional_arguments,
|
||||||
stream_processes,
|
stream_processes,
|
||||||
output_log_level,
|
output_log_level,
|
||||||
output_file,
|
output_file,
|
||||||
borg_local_path=local_path,
|
|
||||||
working_directory=working_directory,
|
working_directory=working_directory,
|
||||||
extra_environment=borg_environment,
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
elif output_log_level is None:
|
elif output_log_level is None:
|
||||||
return execute_command_and_capture_output(
|
return execute_command_and_capture_output(
|
||||||
create_command, working_directory=working_directory, extra_environment=borg_environment,
|
create_flags + create_positional_arguments,
|
||||||
|
working_directory=working_directory,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
execute_command(
|
execute_command(
|
||||||
create_command,
|
create_flags + create_positional_arguments,
|
||||||
output_log_level,
|
output_log_level,
|
||||||
output_file,
|
output_file,
|
||||||
borg_local_path=local_path,
|
|
||||||
working_directory=working_directory,
|
working_directory=working_directory,
|
||||||
extra_environment=borg_environment,
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
|
@ -2,6 +2,7 @@ OPTION_TO_ENVIRONMENT_VARIABLE = {
|
||||||
'borg_base_directory': 'BORG_BASE_DIR',
|
'borg_base_directory': 'BORG_BASE_DIR',
|
||||||
'borg_config_directory': 'BORG_CONFIG_DIR',
|
'borg_config_directory': 'BORG_CONFIG_DIR',
|
||||||
'borg_cache_directory': 'BORG_CACHE_DIR',
|
'borg_cache_directory': 'BORG_CACHE_DIR',
|
||||||
|
'borg_files_cache_ttl': 'BORG_FILES_CACHE_TTL',
|
||||||
'borg_security_directory': 'BORG_SECURITY_DIR',
|
'borg_security_directory': 'BORG_SECURITY_DIR',
|
||||||
'borg_keys_directory': 'BORG_KEYS_DIR',
|
'borg_keys_directory': 'BORG_KEYS_DIR',
|
||||||
'encryption_passcommand': 'BORG_PASSCOMMAND',
|
'encryption_passcommand': 'BORG_PASSCOMMAND',
|
||||||
|
@ -10,30 +11,47 @@ OPTION_TO_ENVIRONMENT_VARIABLE = {
|
||||||
'temporary_directory': 'TMPDIR',
|
'temporary_directory': 'TMPDIR',
|
||||||
}
|
}
|
||||||
|
|
||||||
DEFAULT_BOOL_OPTION_TO_ENVIRONMENT_VARIABLE = {
|
DEFAULT_BOOL_OPTION_TO_DOWNCASE_ENVIRONMENT_VARIABLE = {
|
||||||
'relocated_repo_access_is_ok': 'BORG_RELOCATED_REPO_ACCESS_IS_OK',
|
'relocated_repo_access_is_ok': 'BORG_RELOCATED_REPO_ACCESS_IS_OK',
|
||||||
'unknown_unencrypted_repo_access_is_ok': 'BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK',
|
'unknown_unencrypted_repo_access_is_ok': 'BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
DEFAULT_BOOL_OPTION_TO_UPPERCASE_ENVIRONMENT_VARIABLE = {
|
||||||
|
'check_i_know_what_i_am_doing': 'BORG_CHECK_I_KNOW_WHAT_I_AM_DOING',
|
||||||
|
}
|
||||||
|
|
||||||
def make_environment(storage_config):
|
|
||||||
|
def make_environment(config):
|
||||||
'''
|
'''
|
||||||
Given a borgmatic storage configuration dict, return its options converted to a Borg environment
|
Given a borgmatic configuration dict, return its options converted to a Borg environment
|
||||||
variable dict.
|
variable dict.
|
||||||
'''
|
'''
|
||||||
environment = {}
|
environment = {}
|
||||||
|
|
||||||
for option_name, environment_variable_name in OPTION_TO_ENVIRONMENT_VARIABLE.items():
|
for option_name, environment_variable_name in OPTION_TO_ENVIRONMENT_VARIABLE.items():
|
||||||
value = storage_config.get(option_name)
|
value = config.get(option_name)
|
||||||
|
|
||||||
if value:
|
if value:
|
||||||
environment[environment_variable_name] = value
|
environment[environment_variable_name] = str(value)
|
||||||
|
|
||||||
for (
|
for (
|
||||||
option_name,
|
option_name,
|
||||||
environment_variable_name,
|
environment_variable_name,
|
||||||
) in DEFAULT_BOOL_OPTION_TO_ENVIRONMENT_VARIABLE.items():
|
) in DEFAULT_BOOL_OPTION_TO_DOWNCASE_ENVIRONMENT_VARIABLE.items():
|
||||||
value = storage_config.get(option_name, False)
|
value = config.get(option_name)
|
||||||
environment[environment_variable_name] = 'yes' if value else 'no'
|
if value is not None:
|
||||||
|
environment[environment_variable_name] = 'yes' if value else 'no'
|
||||||
|
|
||||||
|
for (
|
||||||
|
option_name,
|
||||||
|
environment_variable_name,
|
||||||
|
) in DEFAULT_BOOL_OPTION_TO_UPPERCASE_ENVIRONMENT_VARIABLE.items():
|
||||||
|
value = config.get(option_name)
|
||||||
|
if value is not None:
|
||||||
|
environment[environment_variable_name] = 'YES' if value else 'NO'
|
||||||
|
|
||||||
|
# On Borg 1.4.0a1+, take advantage of more specific exit codes. No effect on
|
||||||
|
# older versions of Borg.
|
||||||
|
environment['BORG_EXIT_CODES'] = 'modern'
|
||||||
|
|
||||||
return environment
|
return environment
|
||||||
|
|
71
borgmatic/borg/export_key.py
Normal file
71
borgmatic/borg/export_key.py
Normal file
|
@ -0,0 +1,71 @@
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
import borgmatic.logger
|
||||||
|
from borgmatic.borg import environment, flags
|
||||||
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def export_key(
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
export_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a configuration dict, the local Borg version, and
|
||||||
|
optional local and remote Borg paths, export the repository key to the destination path
|
||||||
|
indicated in the export arguments.
|
||||||
|
|
||||||
|
If the destination path is empty or "-", then print the key to stdout instead of to a file.
|
||||||
|
|
||||||
|
Raise FileExistsError if a path is given but it already exists on disk.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
umask = config.get('umask', None)
|
||||||
|
lock_wait = config.get('lock_wait', None)
|
||||||
|
|
||||||
|
if export_arguments.path and export_arguments.path != '-':
|
||||||
|
if os.path.exists(export_arguments.path):
|
||||||
|
raise FileExistsError(
|
||||||
|
f'Destination path {export_arguments.path} already exists. Aborting.'
|
||||||
|
)
|
||||||
|
|
||||||
|
output_file = None
|
||||||
|
else:
|
||||||
|
output_file = DO_NOT_CAPTURE
|
||||||
|
|
||||||
|
full_command = (
|
||||||
|
(local_path, 'key', 'export')
|
||||||
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
+ flags.make_flags('paper', export_arguments.paper)
|
||||||
|
+ flags.make_flags('qr-html', export_arguments.qr_html)
|
||||||
|
+ flags.make_repository_flags(
|
||||||
|
repository_path,
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
+ ((export_arguments.path,) if output_file is None else ())
|
||||||
|
)
|
||||||
|
|
||||||
|
if global_arguments.dry_run:
|
||||||
|
logging.info(f'{repository_path}: Skipping key export (dry run)')
|
||||||
|
return
|
||||||
|
|
||||||
|
execute_command(
|
||||||
|
full_command,
|
||||||
|
output_file=output_file,
|
||||||
|
output_log_level=logging.ANSWER,
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
|
)
|
|
@ -1,5 +1,4 @@
|
||||||
import logging
|
import logging
|
||||||
import os
|
|
||||||
|
|
||||||
import borgmatic.logger
|
import borgmatic.logger
|
||||||
from borgmatic.borg import environment, flags
|
from borgmatic.borg import environment, flags
|
||||||
|
@ -10,12 +9,13 @@ logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
def export_tar_archive(
|
def export_tar_archive(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository_path,
|
||||||
archive,
|
archive,
|
||||||
paths,
|
paths,
|
||||||
destination_path,
|
destination_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
tar_filter=None,
|
tar_filter=None,
|
||||||
|
@ -24,21 +24,22 @@ def export_tar_archive(
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a dry-run flag, a local or remote repository path, an archive name, zero or more paths to
|
Given a dry-run flag, a local or remote repository path, an archive name, zero or more paths to
|
||||||
export from the archive, a destination path to export to, a storage configuration dict, the
|
export from the archive, a destination path to export to, a configuration dict, the local Borg
|
||||||
local Borg version, optional local and remote Borg paths, an optional filter program, whether to
|
version, optional local and remote Borg paths, an optional filter program, whether to include
|
||||||
include per-file details, and an optional number of path components to strip, export the archive
|
per-file details, and an optional number of path components to strip, export the archive into
|
||||||
into the given destination path as a tar-formatted file.
|
the given destination path as a tar-formatted file.
|
||||||
|
|
||||||
If the destination path is "-", then stream the output to stdout instead of to a file.
|
If the destination path is "-", then stream the output to stdout instead of to a file.
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
borgmatic.logger.add_custom_log_levels()
|
||||||
umask = storage_config.get('umask', None)
|
umask = config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'export-tar')
|
(local_path, 'export-tar')
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--list',) if list_files else ())
|
+ (('--list',) if list_files else ())
|
||||||
|
@ -47,7 +48,7 @@ def export_tar_archive(
|
||||||
+ (('--tar-filter', tar_filter) if tar_filter else ())
|
+ (('--tar-filter', tar_filter) if tar_filter else ())
|
||||||
+ (('--strip-components', str(strip_components)) if strip_components else ())
|
+ (('--strip-components', str(strip_components)) if strip_components else ())
|
||||||
+ flags.make_repository_archive_flags(
|
+ flags.make_repository_archive_flags(
|
||||||
repository if ':' in repository else os.path.abspath(repository),
|
repository_path,
|
||||||
archive,
|
archive,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
)
|
)
|
||||||
|
@ -61,13 +62,14 @@ def export_tar_archive(
|
||||||
output_log_level = logging.INFO
|
output_log_level = logging.INFO
|
||||||
|
|
||||||
if dry_run:
|
if dry_run:
|
||||||
logging.info('{}: Skipping export to tar file (dry run)'.format(repository))
|
logging.info(f'{repository_path}: Skipping export to tar file (dry run)')
|
||||||
return
|
return
|
||||||
|
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command,
|
full_command,
|
||||||
output_file=DO_NOT_CAPTURE if destination_path == '-' else None,
|
output_file=DO_NOT_CAPTURE if destination_path == '-' else None,
|
||||||
output_log_level=output_log_level,
|
output_log_level=output_log_level,
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
borg_local_path=local_path,
|
borg_local_path=local_path,
|
||||||
extra_environment=environment.make_environment(storage_config),
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
|
|
|
@ -2,6 +2,7 @@ import logging
|
||||||
import os
|
import os
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
|
import borgmatic.config.validate
|
||||||
from borgmatic.borg import environment, feature, flags, rlist
|
from borgmatic.borg import environment, feature, flags, rlist
|
||||||
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
|
@ -9,9 +10,10 @@ logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def extract_last_archive_dry_run(
|
def extract_last_archive_dry_run(
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
repository,
|
global_arguments,
|
||||||
|
repository_path,
|
||||||
lock_wait=None,
|
lock_wait=None,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
|
@ -20,8 +22,6 @@ def extract_last_archive_dry_run(
|
||||||
Perform an extraction dry-run of the most recent archive. If there are no archives, skip the
|
Perform an extraction dry-run of the most recent archive. If there are no archives, skip the
|
||||||
dry-run.
|
dry-run.
|
||||||
'''
|
'''
|
||||||
remote_path_flags = ('--remote-path', remote_path) if remote_path else ()
|
|
||||||
lock_wait_flags = ('--lock-wait', str(lock_wait)) if lock_wait else ()
|
|
||||||
verbosity_flags = ()
|
verbosity_flags = ()
|
||||||
if logger.isEnabledFor(logging.DEBUG):
|
if logger.isEnabledFor(logging.DEBUG):
|
||||||
verbosity_flags = ('--debug', '--show-rc')
|
verbosity_flags = ('--debug', '--show-rc')
|
||||||
|
@ -30,25 +30,38 @@ def extract_last_archive_dry_run(
|
||||||
|
|
||||||
try:
|
try:
|
||||||
last_archive_name = rlist.resolve_archive_name(
|
last_archive_name = rlist.resolve_archive_name(
|
||||||
repository, 'latest', storage_config, local_borg_version, local_path, remote_path
|
repository_path,
|
||||||
|
'latest',
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
)
|
)
|
||||||
except ValueError:
|
except ValueError:
|
||||||
logger.warning('No archives found. Skipping extract consistency check.')
|
logger.warning('No archives found. Skipping extract consistency check.')
|
||||||
return
|
return
|
||||||
|
|
||||||
list_flag = ('--list',) if logger.isEnabledFor(logging.DEBUG) else ()
|
list_flag = ('--list',) if logger.isEnabledFor(logging.DEBUG) else ()
|
||||||
borg_environment = environment.make_environment(storage_config)
|
borg_environment = environment.make_environment(config)
|
||||||
full_extract_command = (
|
full_extract_command = (
|
||||||
(local_path, 'extract', '--dry-run')
|
(local_path, 'extract', '--dry-run')
|
||||||
+ remote_path_flags
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ lock_wait_flags
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ verbosity_flags
|
+ verbosity_flags
|
||||||
+ list_flag
|
+ list_flag
|
||||||
+ flags.make_repository_archive_flags(repository, last_archive_name, local_borg_version)
|
+ flags.make_repository_archive_flags(
|
||||||
|
repository_path, last_archive_name, local_borg_version
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
execute_command(
|
execute_command(
|
||||||
full_extract_command, working_directory=None, extra_environment=borg_environment
|
full_extract_command,
|
||||||
|
working_directory=None,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -57,9 +70,9 @@ def extract_archive(
|
||||||
repository,
|
repository,
|
||||||
archive,
|
archive,
|
||||||
paths,
|
paths,
|
||||||
location_config,
|
config,
|
||||||
storage_config,
|
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
destination_path=None,
|
destination_path=None,
|
||||||
|
@ -69,29 +82,42 @@ def extract_archive(
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a dry-run flag, a local or remote repository path, an archive name, zero or more paths to
|
Given a dry-run flag, a local or remote repository path, an archive name, zero or more paths to
|
||||||
restore from the archive, the local Borg version string, location/storage configuration dicts,
|
restore from the archive, the local Borg version string, an argparse.Namespace of global
|
||||||
optional local and remote Borg paths, and an optional destination path to extract to, extract
|
arguments, a configuration dict, optional local and remote Borg paths, and an optional
|
||||||
the archive into the current directory.
|
destination path to extract to, extract the archive into the current directory.
|
||||||
|
|
||||||
If extract to stdout is True, then start the extraction streaming to stdout, and return that
|
If extract to stdout is True, then start the extraction streaming to stdout, and return that
|
||||||
extract process as an instance of subprocess.Popen.
|
extract process as an instance of subprocess.Popen.
|
||||||
'''
|
'''
|
||||||
umask = storage_config.get('umask', None)
|
umask = config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
|
|
||||||
if progress and extract_to_stdout:
|
if progress and extract_to_stdout:
|
||||||
raise ValueError('progress and extract_to_stdout cannot both be set')
|
raise ValueError('progress and extract_to_stdout cannot both be set')
|
||||||
|
|
||||||
if feature.available(feature.Feature.NUMERIC_IDS, local_borg_version):
|
if feature.available(feature.Feature.NUMERIC_IDS, local_borg_version):
|
||||||
numeric_ids_flags = ('--numeric-ids',) if location_config.get('numeric_ids') else ()
|
numeric_ids_flags = ('--numeric-ids',) if config.get('numeric_ids') else ()
|
||||||
else:
|
else:
|
||||||
numeric_ids_flags = ('--numeric-owner',) if location_config.get('numeric_ids') else ()
|
numeric_ids_flags = ('--numeric-owner',) if config.get('numeric_ids') else ()
|
||||||
|
|
||||||
|
if strip_components == 'all':
|
||||||
|
if not paths:
|
||||||
|
raise ValueError('The --strip-components flag with "all" requires at least one --path')
|
||||||
|
|
||||||
|
# Calculate the maximum number of leading path components of the given paths. "if piece"
|
||||||
|
# ignores empty path components, e.g. those resulting from a leading slash. And the "- 1"
|
||||||
|
# is so this doesn't count the final path component, e.g. the filename itself.
|
||||||
|
strip_components = max(
|
||||||
|
0,
|
||||||
|
*(len(tuple(piece for piece in path.split(os.path.sep) if piece)) - 1 for path in paths)
|
||||||
|
)
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'extract')
|
(local_path, 'extract')
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ numeric_ids_flags
|
+ numeric_ids_flags
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug', '--list', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--list', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
@ -100,14 +126,17 @@ def extract_archive(
|
||||||
+ (('--progress',) if progress else ())
|
+ (('--progress',) if progress else ())
|
||||||
+ (('--stdout',) if extract_to_stdout else ())
|
+ (('--stdout',) if extract_to_stdout else ())
|
||||||
+ flags.make_repository_archive_flags(
|
+ flags.make_repository_archive_flags(
|
||||||
repository if ':' in repository else os.path.abspath(repository),
|
# Make the repository path absolute so the working directory changes below don't
|
||||||
|
# prevent Borg from finding the repo.
|
||||||
|
borgmatic.config.validate.normalize_repository_path(repository),
|
||||||
archive,
|
archive,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
)
|
)
|
||||||
+ (tuple(paths) if paths else ())
|
+ (tuple(paths) if paths else ())
|
||||||
)
|
)
|
||||||
|
|
||||||
borg_environment = environment.make_environment(storage_config)
|
borg_environment = environment.make_environment(config)
|
||||||
|
borg_exit_codes = config.get('borg_exit_codes')
|
||||||
|
|
||||||
# The progress output isn't compatible with captured and logged output, as progress messes with
|
# The progress output isn't compatible with captured and logged output, as progress messes with
|
||||||
# the terminal directly.
|
# the terminal directly.
|
||||||
|
@ -117,6 +146,8 @@ def extract_archive(
|
||||||
output_file=DO_NOT_CAPTURE,
|
output_file=DO_NOT_CAPTURE,
|
||||||
working_directory=destination_path,
|
working_directory=destination_path,
|
||||||
extra_environment=borg_environment,
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
@ -127,10 +158,16 @@ def extract_archive(
|
||||||
working_directory=destination_path,
|
working_directory=destination_path,
|
||||||
run_to_completion=False,
|
run_to_completion=False,
|
||||||
extra_environment=borg_environment,
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
||||||
# if the restore paths don't exist in the archive.
|
# if the restore paths don't exist in the archive.
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command, working_directory=destination_path, extra_environment=borg_environment
|
full_command,
|
||||||
|
working_directory=destination_path,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
from enum import Enum
|
from enum import Enum
|
||||||
|
|
||||||
from pkg_resources import parse_version
|
from packaging.version import parse
|
||||||
|
|
||||||
|
|
||||||
class Feature(Enum):
|
class Feature(Enum):
|
||||||
|
@ -14,19 +14,21 @@ class Feature(Enum):
|
||||||
RLIST = 8
|
RLIST = 8
|
||||||
RINFO = 9
|
RINFO = 9
|
||||||
MATCH_ARCHIVES = 10
|
MATCH_ARCHIVES = 10
|
||||||
|
EXCLUDED_FILES_MINUS = 11
|
||||||
|
|
||||||
|
|
||||||
FEATURE_TO_MINIMUM_BORG_VERSION = {
|
FEATURE_TO_MINIMUM_BORG_VERSION = {
|
||||||
Feature.COMPACT: parse_version('1.2.0a2'), # borg compact
|
Feature.COMPACT: parse('1.2.0a2'), # borg compact
|
||||||
Feature.ATIME: parse_version('1.2.0a7'), # borg create --atime
|
Feature.ATIME: parse('1.2.0a7'), # borg create --atime
|
||||||
Feature.NOFLAGS: parse_version('1.2.0a8'), # borg create --noflags
|
Feature.NOFLAGS: parse('1.2.0a8'), # borg create --noflags
|
||||||
Feature.NUMERIC_IDS: parse_version('1.2.0b3'), # borg create/extract/mount --numeric-ids
|
Feature.NUMERIC_IDS: parse('1.2.0b3'), # borg create/extract/mount --numeric-ids
|
||||||
Feature.UPLOAD_RATELIMIT: parse_version('1.2.0b3'), # borg create --upload-ratelimit
|
Feature.UPLOAD_RATELIMIT: parse('1.2.0b3'), # borg create --upload-ratelimit
|
||||||
Feature.SEPARATE_REPOSITORY_ARCHIVE: parse_version('2.0.0a2'), # --repo with separate archive
|
Feature.SEPARATE_REPOSITORY_ARCHIVE: parse('2.0.0a2'), # --repo with separate archive
|
||||||
Feature.RCREATE: parse_version('2.0.0a2'), # borg rcreate
|
Feature.RCREATE: parse('2.0.0a2'), # borg rcreate
|
||||||
Feature.RLIST: parse_version('2.0.0a2'), # borg rlist
|
Feature.RLIST: parse('2.0.0a2'), # borg rlist
|
||||||
Feature.RINFO: parse_version('2.0.0a2'), # borg rinfo
|
Feature.RINFO: parse('2.0.0a2'), # borg rinfo
|
||||||
Feature.MATCH_ARCHIVES: parse_version('2.0.0b3'), # borg --match-archives
|
Feature.MATCH_ARCHIVES: parse('2.0.0b3'), # borg --match-archives
|
||||||
|
Feature.EXCLUDED_FILES_MINUS: parse('2.0.0b5'), # --list --filter uses "-" for excludes
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -35,4 +37,4 @@ def available(feature, borg_version):
|
||||||
Given a Borg Feature constant and a Borg version string, return whether that feature is
|
Given a Borg Feature constant and a Borg version string, return whether that feature is
|
||||||
available in that version of Borg.
|
available in that version of Borg.
|
||||||
'''
|
'''
|
||||||
return FEATURE_TO_MINIMUM_BORG_VERSION[feature] <= parse_version(borg_version)
|
return FEATURE_TO_MINIMUM_BORG_VERSION[feature] <= parse(borg_version)
|
||||||
|
|
|
@ -1,7 +1,12 @@
|
||||||
import itertools
|
import itertools
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import re
|
||||||
|
|
||||||
from borgmatic.borg import feature
|
from borgmatic.borg import feature
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def make_flags(name, value):
|
def make_flags(name, value):
|
||||||
'''
|
'''
|
||||||
|
@ -10,7 +15,7 @@ def make_flags(name, value):
|
||||||
if not value:
|
if not value:
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
flag = '--{}'.format(name.replace('_', '-'))
|
flag = f"--{name.replace('_', '-')}"
|
||||||
|
|
||||||
if value is True:
|
if value is True:
|
||||||
return (flag,)
|
return (flag,)
|
||||||
|
@ -33,7 +38,7 @@ def make_flags_from_arguments(arguments, excludes=()):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def make_repository_flags(repository, local_borg_version):
|
def make_repository_flags(repository_path, local_borg_version):
|
||||||
'''
|
'''
|
||||||
Given the path of a Borg repository and the local Borg version, return Borg-version-appropriate
|
Given the path of a Borg repository and the local Borg version, return Borg-version-appropriate
|
||||||
command-line flags (as a tuple) for selecting that repository.
|
command-line flags (as a tuple) for selecting that repository.
|
||||||
|
@ -42,17 +47,72 @@ def make_repository_flags(repository, local_borg_version):
|
||||||
('--repo',)
|
('--repo',)
|
||||||
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
||||||
else ()
|
else ()
|
||||||
) + (repository,)
|
) + (repository_path,)
|
||||||
|
|
||||||
|
|
||||||
def make_repository_archive_flags(repository, archive, local_borg_version):
|
def make_repository_archive_flags(repository_path, archive, local_borg_version):
|
||||||
'''
|
'''
|
||||||
Given the path of a Borg repository, an archive name or pattern, and the local Borg version,
|
Given the path of a Borg repository, an archive name or pattern, and the local Borg version,
|
||||||
return Borg-version-appropriate command-line flags (as a tuple) for selecting that repository
|
return Borg-version-appropriate command-line flags (as a tuple) for selecting that repository
|
||||||
and archive.
|
and archive.
|
||||||
'''
|
'''
|
||||||
return (
|
return (
|
||||||
('--repo', repository, archive)
|
('--repo', repository_path, archive)
|
||||||
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
||||||
else (f'{repository}::{archive}',)
|
else (f'{repository_path}::{archive}',)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_ARCHIVE_NAME_FORMAT = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}' # noqa: FS003
|
||||||
|
|
||||||
|
|
||||||
|
def make_match_archives_flags(match_archives, archive_name_format, local_borg_version):
|
||||||
|
'''
|
||||||
|
Return match archives flags based on the given match archives value, if any. If it isn't set,
|
||||||
|
return match archives flags to match archives created with the given (or default) archive name
|
||||||
|
format. This is done by replacing certain archive name format placeholders for ephemeral data
|
||||||
|
(like "{now}") with globs.
|
||||||
|
'''
|
||||||
|
if match_archives:
|
||||||
|
if match_archives in {'*', 're:.*', 'sh:*'}:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version):
|
||||||
|
return ('--match-archives', match_archives)
|
||||||
|
else:
|
||||||
|
return ('--glob-archives', re.sub(r'^sh:', '', match_archives))
|
||||||
|
|
||||||
|
derived_match_archives = re.sub(
|
||||||
|
r'\{(now|utcnow|pid)([:%\w\.-]*)\}', '*', archive_name_format or DEFAULT_ARCHIVE_NAME_FORMAT
|
||||||
|
)
|
||||||
|
|
||||||
|
if derived_match_archives == '*':
|
||||||
|
return ()
|
||||||
|
|
||||||
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version):
|
||||||
|
return ('--match-archives', f'sh:{derived_match_archives}')
|
||||||
|
else:
|
||||||
|
return ('--glob-archives', f'{derived_match_archives}')
|
||||||
|
|
||||||
|
|
||||||
|
def warn_for_aggressive_archive_flags(json_command, json_output):
|
||||||
|
'''
|
||||||
|
Given a JSON archives command and the resulting JSON string output from running it, parse the
|
||||||
|
JSON and warn if the command used an archive flag but the output indicates zero archives were
|
||||||
|
found.
|
||||||
|
'''
|
||||||
|
archive_flags_used = {'--glob-archives', '--match-archives'}.intersection(set(json_command))
|
||||||
|
|
||||||
|
if not archive_flags_used:
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
if len(json.loads(json_output)['archives']) == 0:
|
||||||
|
logger.warning('An archive filter was applied, but no matching archives were found.')
|
||||||
|
logger.warning(
|
||||||
|
'Try adding --match-archives "*" or adjusting archive_name_format/match_archives in configuration.'
|
||||||
|
)
|
||||||
|
except json.JSONDecodeError as error:
|
||||||
|
logger.debug(f'Cannot parse JSON output from archive command: {error}')
|
||||||
|
except (TypeError, KeyError):
|
||||||
|
logger.debug('Cannot parse JSON output from archive command: No "archives" key found')
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
import argparse
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
import borgmatic.logger
|
import borgmatic.logger
|
||||||
|
@ -7,23 +8,21 @@ from borgmatic.execute import execute_command, execute_command_and_capture_outpu
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def display_archives_info(
|
def make_info_command(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
info_arguments,
|
info_arguments,
|
||||||
local_path='borg',
|
global_arguments,
|
||||||
remote_path=None,
|
local_path,
|
||||||
|
remote_path,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, the local Borg version, and the
|
Given a local or remote repository path, a configuration dict, the local Borg version, the
|
||||||
arguments to the info action, display summary information for Borg archives in the repository or
|
arguments to the info action as an argparse.Namespace, and global arguments, return a command
|
||||||
return JSON summary information.
|
as a tuple to display summary information for archives in the repository.
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
return (
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
|
||||||
|
|
||||||
full_command = (
|
|
||||||
(local_path, 'info')
|
(local_path, 'info')
|
||||||
+ (
|
+ (
|
||||||
('--info',)
|
('--info',)
|
||||||
|
@ -36,7 +35,8 @@ def display_archives_info(
|
||||||
else ()
|
else ()
|
||||||
)
|
)
|
||||||
+ flags.make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
+ flags.make_flags('lock-wait', lock_wait)
|
+ flags.make_flags('log-json', global_arguments.log_json)
|
||||||
|
+ flags.make_flags('lock-wait', config.get('lock_wait'))
|
||||||
+ (
|
+ (
|
||||||
(
|
(
|
||||||
flags.make_flags('match-archives', f'sh:{info_arguments.prefix}*')
|
flags.make_flags('match-archives', f'sh:{info_arguments.prefix}*')
|
||||||
|
@ -44,27 +44,75 @@ def display_archives_info(
|
||||||
else flags.make_flags('glob-archives', f'{info_arguments.prefix}*')
|
else flags.make_flags('glob-archives', f'{info_arguments.prefix}*')
|
||||||
)
|
)
|
||||||
if info_arguments.prefix
|
if info_arguments.prefix
|
||||||
else ()
|
else (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
info_arguments.match_archives
|
||||||
|
or info_arguments.archive
|
||||||
|
or config.get('match_archives'),
|
||||||
|
config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
)
|
)
|
||||||
+ flags.make_flags_from_arguments(
|
+ flags.make_flags_from_arguments(
|
||||||
info_arguments, excludes=('repository', 'archive', 'prefix')
|
info_arguments, excludes=('repository', 'archive', 'prefix', 'match_archives')
|
||||||
)
|
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
|
||||||
+ (
|
|
||||||
flags.make_flags('match-archives', info_arguments.archive)
|
|
||||||
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
|
||||||
else flags.make_flags('glob-archives', info_arguments.archive)
|
|
||||||
)
|
)
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def display_archives_info(
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
info_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a configuration dict, the local Borg version, the
|
||||||
|
arguments to the info action as an argparse.Namespace, and global arguments, display summary
|
||||||
|
information for Borg archives in the repository or return JSON summary information.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
|
||||||
|
main_command = make_info_command(
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
info_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
json_command = make_info_command(
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
argparse.Namespace(**dict(info_arguments.__dict__, json=True)),
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
borg_exit_codes = config.get('borg_exit_codes')
|
||||||
|
|
||||||
|
json_info = execute_command_and_capture_output(
|
||||||
|
json_command,
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
||||||
if info_arguments.json:
|
if info_arguments.json:
|
||||||
return execute_command_and_capture_output(
|
return json_info
|
||||||
full_command, extra_environment=environment.make_environment(storage_config),
|
|
||||||
)
|
flags.warn_for_aggressive_archive_flags(json_command, json_info)
|
||||||
else:
|
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command,
|
main_command,
|
||||||
output_log_level=logging.ANSWER,
|
output_log_level=logging.ANSWER,
|
||||||
borg_local_path=local_path,
|
extra_environment=environment.make_environment(config),
|
||||||
extra_environment=environment.make_environment(storage_config),
|
borg_local_path=local_path,
|
||||||
)
|
borg_exit_codes=borg_exit_codes,
|
||||||
|
)
|
||||||
|
|
|
@ -14,26 +14,26 @@ ARCHIVE_FILTER_FLAGS_MOVED_TO_RLIST = ('prefix', 'match_archives', 'sort_by', 'f
|
||||||
MAKE_FLAGS_EXCLUDES = (
|
MAKE_FLAGS_EXCLUDES = (
|
||||||
'repository',
|
'repository',
|
||||||
'archive',
|
'archive',
|
||||||
'successful',
|
|
||||||
'paths',
|
'paths',
|
||||||
'find_paths',
|
'find_paths',
|
||||||
) + ARCHIVE_FILTER_FLAGS_MOVED_TO_RLIST
|
) + ARCHIVE_FILTER_FLAGS_MOVED_TO_RLIST
|
||||||
|
|
||||||
|
|
||||||
def make_list_command(
|
def make_list_command(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
list_arguments,
|
list_arguments,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, the arguments to the list
|
Given a local or remote repository path, a configuration dict, the arguments to the list action,
|
||||||
action, and local and remote Borg paths, return a command as a tuple to list archives or paths
|
and local and remote Borg paths, return a command as a tuple to list archives or paths within an
|
||||||
within an archive.
|
archive.
|
||||||
'''
|
'''
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
|
|
||||||
return (
|
return (
|
||||||
(local_path, 'list')
|
(local_path, 'list')
|
||||||
|
@ -48,14 +48,15 @@ def make_list_command(
|
||||||
else ()
|
else ()
|
||||||
)
|
)
|
||||||
+ flags.make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
|
+ flags.make_flags('log-json', global_arguments.log_json)
|
||||||
+ flags.make_flags('lock-wait', lock_wait)
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
+ flags.make_flags_from_arguments(list_arguments, excludes=MAKE_FLAGS_EXCLUDES)
|
+ flags.make_flags_from_arguments(list_arguments, excludes=MAKE_FLAGS_EXCLUDES)
|
||||||
+ (
|
+ (
|
||||||
flags.make_repository_archive_flags(
|
flags.make_repository_archive_flags(
|
||||||
repository, list_arguments.archive, local_borg_version
|
repository_path, list_arguments.archive, local_borg_version
|
||||||
)
|
)
|
||||||
if list_arguments.archive
|
if list_arguments.archive
|
||||||
else flags.make_repository_flags(repository, local_borg_version)
|
else flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
+ (tuple(list_arguments.paths) if list_arguments.paths else ())
|
+ (tuple(list_arguments.paths) if list_arguments.paths else ())
|
||||||
)
|
)
|
||||||
|
@ -78,27 +79,77 @@ def make_find_paths(find_paths):
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
return tuple(
|
return tuple(
|
||||||
find_path
|
(
|
||||||
if re.compile(r'([-!+RrPp] )|(\w\w:)').match(find_path)
|
find_path
|
||||||
else f'sh:**/*{find_path}*/**'
|
if re.compile(r'([-!+RrPp] )|(\w\w:)').match(find_path)
|
||||||
|
else f'sh:**/*{find_path}*/**'
|
||||||
|
)
|
||||||
for find_path in find_paths
|
for find_path in find_paths
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def list_archive(
|
def capture_archive_listing(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
archive,
|
||||||
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
list_arguments,
|
global_arguments,
|
||||||
|
list_paths=None,
|
||||||
|
path_format=None,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, the local Borg version, the
|
Given a local or remote repository path, an archive name, a configuration dict, the local Borg
|
||||||
arguments to the list action, and local and remote Borg paths, display the output of listing
|
version, global arguments as an argparse.Namespace, the archive paths in which to list files,
|
||||||
the files of a Borg archive (or return JSON output). If list_arguments.find_paths are given,
|
the Borg path format to use for the output, and local and remote Borg paths, capture the output
|
||||||
list the files by searching across multiple archives. If neither find_paths nor archive name
|
of listing that archive and return it as a list of file paths.
|
||||||
are given, instead list the archives in the given repository.
|
'''
|
||||||
|
borg_environment = environment.make_environment(config)
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
execute_command_and_capture_output(
|
||||||
|
make_list_command(
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
argparse.Namespace(
|
||||||
|
repository=repository_path,
|
||||||
|
archive=archive,
|
||||||
|
paths=[f'sh:{path}' for path in list_paths] if list_paths else None,
|
||||||
|
find_paths=None,
|
||||||
|
json=None,
|
||||||
|
format=path_format or '{path}{NL}', # noqa: FS003
|
||||||
|
),
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
),
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
|
)
|
||||||
|
.strip('\n')
|
||||||
|
.split('\n')
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def list_archive(
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
list_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a configuration dict, the local Borg version, global
|
||||||
|
arguments as an argparse.Namespace, the arguments to the list action as an argparse.Namespace,
|
||||||
|
and local and remote Borg paths, display the output of listing the files of a Borg archive (or
|
||||||
|
return JSON output). If list_arguments.find_paths are given, list the files by searching across
|
||||||
|
multiple archives. If neither find_paths nor archive name are given, instead list the archives
|
||||||
|
in the given repository.
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
|
||||||
|
@ -109,7 +160,7 @@ def list_archive(
|
||||||
)
|
)
|
||||||
|
|
||||||
rlist_arguments = argparse.Namespace(
|
rlist_arguments = argparse.Namespace(
|
||||||
repository=repository,
|
repository=repository_path,
|
||||||
short=list_arguments.short,
|
short=list_arguments.short,
|
||||||
format=list_arguments.format,
|
format=list_arguments.format,
|
||||||
json=list_arguments.json,
|
json=list_arguments.json,
|
||||||
|
@ -120,7 +171,13 @@ def list_archive(
|
||||||
last=list_arguments.last,
|
last=list_arguments.last,
|
||||||
)
|
)
|
||||||
return rlist.list_repository(
|
return rlist.list_repository(
|
||||||
repository, storage_config, local_borg_version, rlist_arguments, local_path, remote_path
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
)
|
)
|
||||||
|
|
||||||
if list_arguments.archive:
|
if list_arguments.archive:
|
||||||
|
@ -135,13 +192,14 @@ def list_archive(
|
||||||
'The --json flag on the list action is not supported when using the --archive/--find flags.'
|
'The --json flag on the list action is not supported when using the --archive/--find flags.'
|
||||||
)
|
)
|
||||||
|
|
||||||
borg_environment = environment.make_environment(storage_config)
|
borg_environment = environment.make_environment(config)
|
||||||
|
borg_exit_codes = config.get('borg_exit_codes')
|
||||||
|
|
||||||
# If there are any paths to find (and there's not a single archive already selected), start by
|
# If there are any paths to find (and there's not a single archive already selected), start by
|
||||||
# getting a list of archives to search.
|
# getting a list of archives to search.
|
||||||
if list_arguments.find_paths and not list_arguments.archive:
|
if list_arguments.find_paths and not list_arguments.archive:
|
||||||
rlist_arguments = argparse.Namespace(
|
rlist_arguments = argparse.Namespace(
|
||||||
repository=repository,
|
repository=repository_path,
|
||||||
short=True,
|
short=True,
|
||||||
format=None,
|
format=None,
|
||||||
json=None,
|
json=None,
|
||||||
|
@ -156,14 +214,17 @@ def list_archive(
|
||||||
archive_lines = tuple(
|
archive_lines = tuple(
|
||||||
execute_command_and_capture_output(
|
execute_command_and_capture_output(
|
||||||
rlist.make_rlist_command(
|
rlist.make_rlist_command(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
rlist_arguments,
|
rlist_arguments,
|
||||||
|
global_arguments,
|
||||||
local_path,
|
local_path,
|
||||||
remote_path,
|
remote_path,
|
||||||
),
|
),
|
||||||
extra_environment=borg_environment,
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
.strip('\n')
|
.strip('\n')
|
||||||
.split('\n')
|
.split('\n')
|
||||||
|
@ -173,7 +234,7 @@ def list_archive(
|
||||||
|
|
||||||
# For each archive listed by Borg, run list on the contents of that archive.
|
# For each archive listed by Borg, run list on the contents of that archive.
|
||||||
for archive in archive_lines:
|
for archive in archive_lines:
|
||||||
logger.answer(f'{repository}: Listing archive {archive}')
|
logger.answer(f'{repository_path}: Listing archive {archive}')
|
||||||
|
|
||||||
archive_arguments = copy.copy(list_arguments)
|
archive_arguments = copy.copy(list_arguments)
|
||||||
archive_arguments.archive = archive
|
archive_arguments.archive = archive
|
||||||
|
@ -184,10 +245,11 @@ def list_archive(
|
||||||
setattr(archive_arguments, name, None)
|
setattr(archive_arguments, name, None)
|
||||||
|
|
||||||
main_command = make_list_command(
|
main_command = make_list_command(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
archive_arguments,
|
archive_arguments,
|
||||||
|
global_arguments,
|
||||||
local_path,
|
local_path,
|
||||||
remote_path,
|
remote_path,
|
||||||
) + make_find_paths(list_arguments.find_paths)
|
) + make_find_paths(list_arguments.find_paths)
|
||||||
|
@ -195,6 +257,7 @@ def list_archive(
|
||||||
execute_command(
|
execute_command(
|
||||||
main_command,
|
main_command,
|
||||||
output_log_level=logging.ANSWER,
|
output_log_level=logging.ANSWER,
|
||||||
borg_local_path=local_path,
|
|
||||||
extra_environment=borg_environment,
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
|
@ -7,38 +7,40 @@ logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def mount_archive(
|
def mount_archive(
|
||||||
repository,
|
repository_path,
|
||||||
archive,
|
archive,
|
||||||
mount_point,
|
mount_arguments,
|
||||||
paths,
|
config,
|
||||||
foreground,
|
|
||||||
options,
|
|
||||||
storage_config,
|
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, an optional archive name, a filesystem mount point,
|
Given a local or remote repository path, an optional archive name, a filesystem mount point,
|
||||||
zero or more paths to mount from the archive, extra Borg mount options, a storage configuration
|
zero or more paths to mount from the archive, extra Borg mount options, a storage configuration
|
||||||
dict, the local Borg version, and optional local and remote Borg paths, mount the archive onto
|
dict, the local Borg version, global arguments as an argparse.Namespace instance, and optional
|
||||||
the mount point.
|
local and remote Borg paths, mount the archive onto the mount point.
|
||||||
'''
|
'''
|
||||||
umask = storage_config.get('umask', None)
|
umask = config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'mount')
|
(local_path, 'mount')
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ (('--foreground',) if foreground else ())
|
+ flags.make_flags_from_arguments(
|
||||||
+ (('-o', options) if options else ())
|
mount_arguments,
|
||||||
|
excludes=('repository', 'archive', 'mount_point', 'paths', 'options'),
|
||||||
|
)
|
||||||
|
+ (('-o', mount_arguments.options) if mount_arguments.options else ())
|
||||||
+ (
|
+ (
|
||||||
(
|
(
|
||||||
flags.make_repository_flags(repository, local_borg_version)
|
flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
+ (
|
+ (
|
||||||
('--match-archives', archive)
|
('--match-archives', archive)
|
||||||
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
||||||
|
@ -47,25 +49,31 @@ def mount_archive(
|
||||||
)
|
)
|
||||||
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
if feature.available(feature.Feature.SEPARATE_REPOSITORY_ARCHIVE, local_borg_version)
|
||||||
else (
|
else (
|
||||||
flags.make_repository_archive_flags(repository, archive, local_borg_version)
|
flags.make_repository_archive_flags(repository_path, archive, local_borg_version)
|
||||||
if archive
|
if archive
|
||||||
else flags.make_repository_flags(repository, local_borg_version)
|
else flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
+ (mount_point,)
|
+ (mount_arguments.mount_point,)
|
||||||
+ (tuple(paths) if paths else ())
|
+ (tuple(mount_arguments.paths) if mount_arguments.paths else ())
|
||||||
)
|
)
|
||||||
|
|
||||||
borg_environment = environment.make_environment(storage_config)
|
borg_environment = environment.make_environment(config)
|
||||||
|
|
||||||
# Don't capture the output when foreground mode is used so that ctrl-C can work properly.
|
# Don't capture the output when foreground mode is used so that ctrl-C can work properly.
|
||||||
if foreground:
|
if mount_arguments.foreground:
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command,
|
full_command,
|
||||||
output_file=DO_NOT_CAPTURE,
|
output_file=DO_NOT_CAPTURE,
|
||||||
borg_local_path=local_path,
|
|
||||||
extra_environment=borg_environment,
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
execute_command(full_command, borg_local_path=local_path, extra_environment=borg_environment)
|
execute_command(
|
||||||
|
full_command,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
|
)
|
||||||
|
|
|
@ -7,10 +7,10 @@ from borgmatic.execute import execute_command
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def make_prune_flags(retention_config, local_borg_version):
|
def make_prune_flags(config, local_borg_version):
|
||||||
'''
|
'''
|
||||||
Given a retention config dict mapping from option name to value, tranform it into an iterable of
|
Given a configuration dict mapping from option name to value, transform it into an sequence of
|
||||||
command-line name-value flag pairs.
|
command-line flags.
|
||||||
|
|
||||||
For example, given a retention config of:
|
For example, given a retention config of:
|
||||||
|
|
||||||
|
@ -23,61 +23,70 @@ def make_prune_flags(retention_config, local_borg_version):
|
||||||
('--keep-monthly', '6'),
|
('--keep-monthly', '6'),
|
||||||
)
|
)
|
||||||
'''
|
'''
|
||||||
config = retention_config.copy()
|
flag_pairs = (
|
||||||
prefix = config.pop('prefix', '{hostname}-')
|
('--' + option_name.replace('_', '-'), str(value))
|
||||||
|
for option_name, value in config.items()
|
||||||
|
if option_name.startswith('keep_') and option_name != 'keep_exclude_tags'
|
||||||
|
)
|
||||||
|
prefix = config.get('prefix')
|
||||||
|
|
||||||
if prefix:
|
return tuple(element for pair in flag_pairs for element in pair) + (
|
||||||
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version):
|
(
|
||||||
config['match_archives'] = f'sh:{prefix}*'
|
('--match-archives', f'sh:{prefix}*')
|
||||||
else:
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version)
|
||||||
config['glob_archives'] = f'{prefix}*'
|
else ('--glob-archives', f'{prefix}*')
|
||||||
|
)
|
||||||
return (
|
if prefix
|
||||||
('--' + option_name.replace('_', '-'), str(value)) for option_name, value in config.items()
|
else (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
config.get('match_archives'),
|
||||||
|
config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def prune_archives(
|
def prune_archives(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
retention_config,
|
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
|
prune_arguments,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
stats=False,
|
|
||||||
list_archives=False,
|
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given dry-run flag, a local or remote repository path, a storage config dict, and a
|
Given dry-run flag, a local or remote repository path, and a configuration dict, prune Borg
|
||||||
retention config dict, prune Borg archives according to the retention policy specified in that
|
archives according to the retention policy specified in that configuration.
|
||||||
configuration.
|
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
borgmatic.logger.add_custom_log_levels()
|
||||||
umask = storage_config.get('umask', None)
|
umask = config.get('umask', None)
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
extra_borg_options = storage_config.get('extra_borg_options', {}).get('prune', '')
|
extra_borg_options = config.get('extra_borg_options', {}).get('prune', '')
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'prune')
|
(local_path, 'prune')
|
||||||
+ tuple(
|
+ make_prune_flags(config, local_borg_version)
|
||||||
element
|
|
||||||
for pair in make_prune_flags(retention_config, local_borg_version)
|
|
||||||
for element in pair
|
|
||||||
)
|
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--umask', str(umask)) if umask else ())
|
+ (('--umask', str(umask)) if umask else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--stats',) if stats and not dry_run else ())
|
+ (('--stats',) if prune_arguments.stats and not dry_run else ())
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--list',) if list_archives else ())
|
+ flags.make_flags_from_arguments(
|
||||||
|
prune_arguments,
|
||||||
|
excludes=('repository', 'stats', 'list_archives'),
|
||||||
|
)
|
||||||
|
+ (('--list',) if prune_arguments.list_archives else ())
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ (('--dry-run',) if dry_run else ())
|
+ (('--dry-run',) if dry_run else ())
|
||||||
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
if stats or list_archives:
|
if prune_arguments.stats or prune_arguments.list_archives:
|
||||||
output_log_level = logging.ANSWER
|
output_log_level = logging.ANSWER
|
||||||
else:
|
else:
|
||||||
output_log_level = logging.INFO
|
output_log_level = logging.INFO
|
||||||
|
@ -85,6 +94,7 @@ def prune_archives(
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command,
|
full_command,
|
||||||
output_log_level=output_log_level,
|
output_log_level=output_log_level,
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
borg_local_path=local_path,
|
borg_local_path=local_path,
|
||||||
extra_environment=environment.make_environment(storage_config),
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
import argparse
|
import argparse
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
|
@ -8,14 +9,15 @@ from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
RINFO_REPOSITORY_NOT_FOUND_EXIT_CODE = 2
|
RINFO_REPOSITORY_NOT_FOUND_EXIT_CODES = {2, 13}
|
||||||
|
|
||||||
|
|
||||||
def create_repository(
|
def create_repository(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
encryption_mode,
|
encryption_mode,
|
||||||
source_repository=None,
|
source_repository=None,
|
||||||
copy_crypt_key=False,
|
copy_crypt_key=False,
|
||||||
|
@ -26,27 +28,42 @@ def create_repository(
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a dry-run flag, a local or remote repository path, a storage configuration dict, the local
|
Given a dry-run flag, a local or remote repository path, a configuration dict, the local Borg
|
||||||
Borg version, a Borg encryption mode, the path to another repo whose key material should be
|
version, a Borg encryption mode, the path to another repo whose key material should be reused,
|
||||||
reused, whether the repository should be append-only, and the storage quota to use, create the
|
whether the repository should be append-only, and the storage quota to use, create the
|
||||||
repository. If the repository already exists, then log and skip creation.
|
repository. If the repository already exists, then log and skip creation.
|
||||||
|
|
||||||
|
Raise ValueError if the requested encryption mode does not match that of the repository.
|
||||||
|
Raise json.decoder.JSONDecodeError if the "borg info" JSON outputcannot be decoded.
|
||||||
|
Raise subprocess.CalledProcessError if "borg info" returns an error exit code.
|
||||||
'''
|
'''
|
||||||
try:
|
try:
|
||||||
rinfo.display_repository_info(
|
info_data = json.loads(
|
||||||
repository,
|
rinfo.display_repository_info(
|
||||||
storage_config,
|
repository_path,
|
||||||
local_borg_version,
|
config,
|
||||||
argparse.Namespace(json=True),
|
local_borg_version,
|
||||||
local_path,
|
argparse.Namespace(json=True),
|
||||||
remote_path,
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
logger.info(f'{repository}: Repository already exists. Skipping creation.')
|
repository_encryption_mode = info_data.get('encryption', {}).get('mode')
|
||||||
|
|
||||||
|
if repository_encryption_mode != encryption_mode:
|
||||||
|
raise ValueError(
|
||||||
|
f'Requested encryption mode "{encryption_mode}" does not match existing repository encryption mode "{repository_encryption_mode}"'
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(f'{repository_path}: Repository already exists. Skipping creation.')
|
||||||
return
|
return
|
||||||
except subprocess.CalledProcessError as error:
|
except subprocess.CalledProcessError as error:
|
||||||
if error.returncode != RINFO_REPOSITORY_NOT_FOUND_EXIT_CODE:
|
if error.returncode not in RINFO_REPOSITORY_NOT_FOUND_EXIT_CODES:
|
||||||
raise
|
raise
|
||||||
|
|
||||||
extra_borg_options = storage_config.get('extra_borg_options', {}).get('rcreate', '')
|
lock_wait = config.get('lock_wait')
|
||||||
|
extra_borg_options = config.get('extra_borg_options', {}).get('rcreate', '')
|
||||||
|
|
||||||
rcreate_command = (
|
rcreate_command = (
|
||||||
(local_path,)
|
(local_path,)
|
||||||
|
@ -63,19 +80,22 @@ def create_repository(
|
||||||
+ (('--make-parent-dirs',) if make_parent_dirs else ())
|
+ (('--make-parent-dirs',) if make_parent_dirs else ())
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug',) if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug',) if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
if dry_run:
|
if dry_run:
|
||||||
logging.info(f'{repository}: Skipping repository creation (dry run)')
|
logging.info(f'{repository_path}: Skipping repository creation (dry run)')
|
||||||
return
|
return
|
||||||
|
|
||||||
# Do not capture output here, so as to support interactive prompts.
|
# Do not capture output here, so as to support interactive prompts.
|
||||||
execute_command(
|
execute_command(
|
||||||
rcreate_command,
|
rcreate_command,
|
||||||
output_file=DO_NOT_CAPTURE,
|
output_file=DO_NOT_CAPTURE,
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
borg_local_path=local_path,
|
borg_local_path=local_path,
|
||||||
extra_environment=environment.make_environment(storage_config),
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
|
|
|
@ -8,20 +8,21 @@ logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def display_repository_info(
|
def display_repository_info(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
rinfo_arguments,
|
rinfo_arguments,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, the local Borg version, and the
|
Given a local or remote repository path, a configuration dict, the local Borg version, the
|
||||||
arguments to the rinfo action, display summary information for the Borg repository or return
|
arguments to the rinfo action, and global arguments as an argparse.Namespace, display summary
|
||||||
JSON summary information.
|
information for the Borg repository or return JSON summary information.
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
borgmatic.logger.add_custom_log_levels()
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = config.get('lock_wait', None)
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path,)
|
(local_path,)
|
||||||
|
@ -41,21 +42,27 @@ def display_repository_info(
|
||||||
else ()
|
else ()
|
||||||
)
|
)
|
||||||
+ flags.make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
|
+ flags.make_flags('log-json', global_arguments.log_json)
|
||||||
+ flags.make_flags('lock-wait', lock_wait)
|
+ flags.make_flags('lock-wait', lock_wait)
|
||||||
+ (('--json',) if rinfo_arguments.json else ())
|
+ (('--json',) if rinfo_arguments.json else ())
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
extra_environment = environment.make_environment(storage_config)
|
extra_environment = environment.make_environment(config)
|
||||||
|
borg_exit_codes = config.get('borg_exit_codes')
|
||||||
|
|
||||||
if rinfo_arguments.json:
|
if rinfo_arguments.json:
|
||||||
return execute_command_and_capture_output(
|
return execute_command_and_capture_output(
|
||||||
full_command, extra_environment=extra_environment,
|
full_command,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
execute_command(
|
execute_command(
|
||||||
full_command,
|
full_command,
|
||||||
output_log_level=logging.ANSWER,
|
output_log_level=logging.ANSWER,
|
||||||
borg_local_path=local_path,
|
|
||||||
extra_environment=extra_environment,
|
extra_environment=extra_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
import argparse
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
import borgmatic.logger
|
import borgmatic.logger
|
||||||
|
@ -8,63 +9,71 @@ logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def resolve_archive_name(
|
def resolve_archive_name(
|
||||||
repository, archive, storage_config, local_borg_version, local_path='borg', remote_path=None
|
repository_path,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, an archive name, a storage config dict, a local Borg
|
Given a local or remote repository path, an archive name, a configuration dict, the local Borg
|
||||||
path, and a remote Borg path, simply return the archive name. But if the archive name is
|
version, global arguments as an argparse.Namespace, a local Borg path, and a remote Borg path,
|
||||||
"latest", then instead introspect the repository for the latest archive and return its name.
|
return the archive name. But if the archive name is "latest", then instead introspect the
|
||||||
|
repository for the latest archive and return its name.
|
||||||
|
|
||||||
Raise ValueError if "latest" is given but there are no archives in the repository.
|
Raise ValueError if "latest" is given but there are no archives in the repository.
|
||||||
'''
|
'''
|
||||||
if archive != "latest":
|
if archive != 'latest':
|
||||||
return archive
|
return archive
|
||||||
|
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(
|
(
|
||||||
local_path,
|
local_path,
|
||||||
'rlist' if feature.available(feature.Feature.RLIST, local_borg_version) else 'list',
|
'rlist' if feature.available(feature.Feature.RLIST, local_borg_version) else 'list',
|
||||||
)
|
)
|
||||||
+ flags.make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
+ flags.make_flags('lock-wait', lock_wait)
|
+ flags.make_flags('log-json', global_arguments.log_json)
|
||||||
|
+ flags.make_flags('lock-wait', config.get('lock_wait'))
|
||||||
+ flags.make_flags('last', 1)
|
+ flags.make_flags('last', 1)
|
||||||
+ ('--short',)
|
+ ('--short',)
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
output = execute_command_and_capture_output(
|
output = execute_command_and_capture_output(
|
||||||
full_command, extra_environment=environment.make_environment(storage_config),
|
full_command,
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
latest_archive = output.strip().splitlines()[-1]
|
latest_archive = output.strip().splitlines()[-1]
|
||||||
except IndexError:
|
except IndexError:
|
||||||
raise ValueError('No archives found in the repository')
|
raise ValueError('No archives found in the repository')
|
||||||
|
|
||||||
logger.debug('{}: Latest archive is {}'.format(repository, latest_archive))
|
logger.debug(f'{repository_path}: Latest archive is {latest_archive}')
|
||||||
|
|
||||||
return latest_archive
|
return latest_archive
|
||||||
|
|
||||||
|
|
||||||
MAKE_FLAGS_EXCLUDES = ('repository', 'prefix')
|
MAKE_FLAGS_EXCLUDES = ('repository', 'prefix', 'match_archives')
|
||||||
|
|
||||||
|
|
||||||
def make_rlist_command(
|
def make_rlist_command(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
rlist_arguments,
|
rlist_arguments,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, the local Borg version, the
|
Given a local or remote repository path, a configuration dict, the local Borg version, the
|
||||||
arguments to the rlist action, and local and remote Borg paths, return a command as a tuple to
|
arguments to the rlist action, global arguments as an argparse.Namespace instance, and local and
|
||||||
list archives with a repository.
|
remote Borg paths, return a command as a tuple to list archives with a repository.
|
||||||
'''
|
'''
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
(
|
(
|
||||||
local_path,
|
local_path,
|
||||||
|
@ -81,7 +90,8 @@ def make_rlist_command(
|
||||||
else ()
|
else ()
|
||||||
)
|
)
|
||||||
+ flags.make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
+ flags.make_flags('lock-wait', lock_wait)
|
+ flags.make_flags('log-json', global_arguments.log_json)
|
||||||
|
+ flags.make_flags('lock-wait', config.get('lock_wait'))
|
||||||
+ (
|
+ (
|
||||||
(
|
(
|
||||||
flags.make_flags('match-archives', f'sh:{rlist_arguments.prefix}*')
|
flags.make_flags('match-archives', f'sh:{rlist_arguments.prefix}*')
|
||||||
|
@ -89,39 +99,73 @@ def make_rlist_command(
|
||||||
else flags.make_flags('glob-archives', f'{rlist_arguments.prefix}*')
|
else flags.make_flags('glob-archives', f'{rlist_arguments.prefix}*')
|
||||||
)
|
)
|
||||||
if rlist_arguments.prefix
|
if rlist_arguments.prefix
|
||||||
else ()
|
else (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
rlist_arguments.match_archives or config.get('match_archives'),
|
||||||
|
config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
)
|
)
|
||||||
+ flags.make_flags_from_arguments(rlist_arguments, excludes=MAKE_FLAGS_EXCLUDES)
|
+ flags.make_flags_from_arguments(rlist_arguments, excludes=MAKE_FLAGS_EXCLUDES)
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def list_repository(
|
def list_repository(
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
rlist_arguments,
|
rlist_arguments,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, the local Borg version, the
|
Given a local or remote repository path, a configuration dict, the local Borg version, the
|
||||||
arguments to the list action, and local and remote Borg paths, display the output of listing
|
arguments to the list action, global arguments as an argparse.Namespace instance, and local and
|
||||||
Borg archives in the given repository (or return JSON output).
|
remote Borg paths, display the output of listing Borg archives in the given repository (or
|
||||||
|
return JSON output).
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
borgmatic.logger.add_custom_log_levels()
|
||||||
borg_environment = environment.make_environment(storage_config)
|
borg_environment = environment.make_environment(config)
|
||||||
|
|
||||||
main_command = make_rlist_command(
|
main_command = make_rlist_command(
|
||||||
repository, storage_config, local_borg_version, rlist_arguments, local_path, remote_path
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
rlist_arguments,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
json_command = make_rlist_command(
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
argparse.Namespace(**dict(rlist_arguments.__dict__, json=True)),
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
borg_exit_codes = config.get('borg_exit_codes')
|
||||||
|
|
||||||
|
json_listing = execute_command_and_capture_output(
|
||||||
|
json_command,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
||||||
if rlist_arguments.json:
|
if rlist_arguments.json:
|
||||||
return execute_command_and_capture_output(main_command, extra_environment=borg_environment,)
|
return json_listing
|
||||||
else:
|
|
||||||
execute_command(
|
flags.warn_for_aggressive_archive_flags(json_command, json_listing)
|
||||||
main_command,
|
|
||||||
output_log_level=logging.ANSWER,
|
execute_command(
|
||||||
borg_local_path=local_path,
|
main_command,
|
||||||
extra_environment=borg_environment,
|
output_log_level=logging.ANSWER,
|
||||||
)
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=borg_exit_codes,
|
||||||
|
)
|
||||||
|
|
|
@ -2,23 +2,25 @@ import logging
|
||||||
|
|
||||||
import borgmatic.logger
|
import borgmatic.logger
|
||||||
from borgmatic.borg import environment, flags
|
from borgmatic.borg import environment, flags
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def transfer_archives(
|
def transfer_archives(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository_path,
|
||||||
storage_config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
transfer_arguments,
|
transfer_arguments,
|
||||||
|
global_arguments,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a dry-run flag, a local or remote repository path, a storage config dict, the local Borg
|
Given a dry-run flag, a local or remote repository path, a configuration dict, the local Borg
|
||||||
version, and the arguments to the transfer action, transfer archives to the given repository.
|
version, the arguments to the transfer action, and global arguments as an argparse.Namespace
|
||||||
|
instance, transfer archives to the given repository.
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
|
||||||
|
@ -27,17 +29,24 @@ def transfer_archives(
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ flags.make_flags('remote-path', remote_path)
|
+ flags.make_flags('remote-path', remote_path)
|
||||||
+ flags.make_flags('lock-wait', storage_config.get('lock_wait', None))
|
+ flags.make_flags('log-json', global_arguments.log_json)
|
||||||
|
+ flags.make_flags('lock-wait', config.get('lock_wait', None))
|
||||||
+ (
|
+ (
|
||||||
flags.make_flags(
|
flags.make_flags_from_arguments(
|
||||||
'match-archives', transfer_arguments.match_archives or transfer_arguments.archive
|
transfer_arguments,
|
||||||
|
excludes=('repository', 'source_repository', 'archive', 'match_archives'),
|
||||||
|
)
|
||||||
|
or (
|
||||||
|
flags.make_match_archives_flags(
|
||||||
|
transfer_arguments.match_archives
|
||||||
|
or transfer_arguments.archive
|
||||||
|
or config.get('match_archives'),
|
||||||
|
config.get('archive_name_format'),
|
||||||
|
local_borg_version,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
+ flags.make_flags_from_arguments(
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
transfer_arguments,
|
|
||||||
excludes=('repository', 'source_repository', 'archive', 'match_archives'),
|
|
||||||
)
|
|
||||||
+ flags.make_repository_flags(repository, local_borg_version)
|
|
||||||
+ flags.make_flags('other-repo', transfer_arguments.source_repository)
|
+ flags.make_flags('other-repo', transfer_arguments.source_repository)
|
||||||
+ flags.make_flags('dry-run', dry_run)
|
+ flags.make_flags('dry-run', dry_run)
|
||||||
)
|
)
|
||||||
|
@ -45,6 +54,8 @@ def transfer_archives(
|
||||||
return execute_command(
|
return execute_command(
|
||||||
full_command,
|
full_command,
|
||||||
output_log_level=logging.ANSWER,
|
output_log_level=logging.ANSWER,
|
||||||
|
output_file=DO_NOT_CAPTURE if transfer_arguments.progress else None,
|
||||||
borg_local_path=local_path,
|
borg_local_path=local_path,
|
||||||
extra_environment=environment.make_environment(storage_config),
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
)
|
)
|
||||||
|
|
|
@ -5,7 +5,7 @@ from borgmatic.execute import execute_command
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def unmount_archive(mount_point, local_path='borg'):
|
def unmount_archive(config, mount_point, local_path='borg'):
|
||||||
'''
|
'''
|
||||||
Given a mounted filesystem mount point, and an optional local Borg paths, umount the filesystem
|
Given a mounted filesystem mount point, and an optional local Borg paths, umount the filesystem
|
||||||
from the mount point.
|
from the mount point.
|
||||||
|
@ -17,4 +17,6 @@ def unmount_archive(mount_point, local_path='borg'):
|
||||||
+ (mount_point,)
|
+ (mount_point,)
|
||||||
)
|
)
|
||||||
|
|
||||||
execute_command(full_command)
|
execute_command(
|
||||||
|
full_command, borg_local_path=local_path, borg_exit_codes=config.get('borg_exit_codes')
|
||||||
|
)
|
||||||
|
|
|
@ -6,9 +6,9 @@ from borgmatic.execute import execute_command_and_capture_output
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def local_borg_version(storage_config, local_path='borg'):
|
def local_borg_version(config, local_path='borg'):
|
||||||
'''
|
'''
|
||||||
Given a storage configuration dict and a local Borg binary path, return a version string for it.
|
Given a configuration dict and a local Borg binary path, return a version string for it.
|
||||||
|
|
||||||
Raise OSError or CalledProcessError if there is a problem running Borg.
|
Raise OSError or CalledProcessError if there is a problem running Borg.
|
||||||
Raise ValueError if the version cannot be parsed.
|
Raise ValueError if the version cannot be parsed.
|
||||||
|
@ -19,7 +19,10 @@ def local_borg_version(storage_config, local_path='borg'):
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
)
|
)
|
||||||
output = execute_command_and_capture_output(
|
output = execute_command_and_capture_output(
|
||||||
full_command, extra_environment=environment.make_environment(storage_config),
|
full_command,
|
||||||
|
extra_environment=environment.make_environment(config),
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
)
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
0
borgmatic/commands/completion/__init__.py
Normal file
0
borgmatic/commands/completion/__init__.py
Normal file
36
borgmatic/commands/completion/actions.py
Normal file
36
borgmatic/commands/completion/actions.py
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
import borgmatic.commands.arguments
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade_message(language: str, upgrade_command: str, completion_file: str):
|
||||||
|
return f'''
|
||||||
|
Your {language} completions script is from a different version of borgmatic than is
|
||||||
|
currently installed. Please upgrade your script so your completions match the
|
||||||
|
command-line flags in your installed borgmatic! Try this to upgrade:
|
||||||
|
|
||||||
|
{upgrade_command}
|
||||||
|
source {completion_file}
|
||||||
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
def available_actions(subparsers, current_action=None):
|
||||||
|
'''
|
||||||
|
Given subparsers as an argparse._SubParsersAction instance and a current action name (if
|
||||||
|
any), return the actions names that can follow the current action on a command-line.
|
||||||
|
|
||||||
|
This takes into account which sub-actions that the current action supports. For instance, if
|
||||||
|
"bootstrap" is a sub-action for "config", then "bootstrap" should be able to follow a current
|
||||||
|
action of "config" but not "list".
|
||||||
|
'''
|
||||||
|
action_to_subactions = borgmatic.commands.arguments.get_subactions_for_actions(
|
||||||
|
subparsers.choices
|
||||||
|
)
|
||||||
|
current_subactions = action_to_subactions.get(current_action)
|
||||||
|
|
||||||
|
if current_subactions:
|
||||||
|
return current_subactions
|
||||||
|
|
||||||
|
all_subactions = set(
|
||||||
|
subaction for subactions in action_to_subactions.values() for subaction in subactions
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(action for action in subparsers.choices.keys() if action not in all_subactions)
|
|
@ -1,13 +1,5 @@
|
||||||
from borgmatic.commands import arguments
|
import borgmatic.commands.arguments
|
||||||
|
import borgmatic.commands.completion.actions
|
||||||
UPGRADE_MESSAGE = '''
|
|
||||||
Your bash completions script is from a different version of borgmatic than is
|
|
||||||
currently installed. Please upgrade your script so your completions match the
|
|
||||||
command-line flags in your installed borgmatic! Try this to upgrade:
|
|
||||||
|
|
||||||
sudo sh -c "borgmatic --bash-completion > $BASH_SOURCE"
|
|
||||||
source $BASH_SOURCE
|
|
||||||
'''
|
|
||||||
|
|
||||||
|
|
||||||
def parser_flags(parser):
|
def parser_flags(parser):
|
||||||
|
@ -23,9 +15,12 @@ def bash_completion():
|
||||||
Return a bash completion script for the borgmatic command. Produce this by introspecting
|
Return a bash completion script for the borgmatic command. Produce this by introspecting
|
||||||
borgmatic's command-line argument parsers.
|
borgmatic's command-line argument parsers.
|
||||||
'''
|
'''
|
||||||
top_level_parser, subparsers = arguments.make_parsers()
|
(
|
||||||
global_flags = parser_flags(top_level_parser)
|
unused_global_parser,
|
||||||
actions = ' '.join(subparsers.choices.keys())
|
action_parsers,
|
||||||
|
global_plus_action_parser,
|
||||||
|
) = borgmatic.commands.arguments.make_parsers()
|
||||||
|
global_flags = parser_flags(global_plus_action_parser)
|
||||||
|
|
||||||
# Avert your eyes.
|
# Avert your eyes.
|
||||||
return '\n'.join(
|
return '\n'.join(
|
||||||
|
@ -34,7 +29,11 @@ def bash_completion():
|
||||||
' local this_script="$(cat "$BASH_SOURCE" 2> /dev/null)"',
|
' local this_script="$(cat "$BASH_SOURCE" 2> /dev/null)"',
|
||||||
' local installed_script="$(borgmatic --bash-completion 2> /dev/null)"',
|
' local installed_script="$(borgmatic --bash-completion 2> /dev/null)"',
|
||||||
' if [ "$this_script" != "$installed_script" ] && [ "$installed_script" != "" ];'
|
' if [ "$this_script" != "$installed_script" ] && [ "$installed_script" != "" ];'
|
||||||
' then cat << EOF\n%s\nEOF' % UPGRADE_MESSAGE,
|
f''' then cat << EOF\n{borgmatic.commands.completion.actions.upgrade_message(
|
||||||
|
'bash',
|
||||||
|
'sudo sh -c "borgmatic --bash-completion > $BASH_SOURCE"',
|
||||||
|
'$BASH_SOURCE',
|
||||||
|
)}\nEOF''',
|
||||||
' fi',
|
' fi',
|
||||||
'}',
|
'}',
|
||||||
'complete_borgmatic() {',
|
'complete_borgmatic() {',
|
||||||
|
@ -44,12 +43,22 @@ def bash_completion():
|
||||||
COMPREPLY=($(compgen -W "%s %s %s" -- "${COMP_WORDS[COMP_CWORD]}"))
|
COMPREPLY=($(compgen -W "%s %s %s" -- "${COMP_WORDS[COMP_CWORD]}"))
|
||||||
return 0
|
return 0
|
||||||
fi'''
|
fi'''
|
||||||
% (action, parser_flags(subparser), actions, global_flags)
|
% (
|
||||||
for action, subparser in subparsers.choices.items()
|
action,
|
||||||
|
parser_flags(action_parser),
|
||||||
|
' '.join(
|
||||||
|
borgmatic.commands.completion.actions.available_actions(action_parsers, action)
|
||||||
|
),
|
||||||
|
global_flags,
|
||||||
|
)
|
||||||
|
for action, action_parser in reversed(action_parsers.choices.items())
|
||||||
)
|
)
|
||||||
+ (
|
+ (
|
||||||
' COMPREPLY=($(compgen -W "%s %s" -- "${COMP_WORDS[COMP_CWORD]}"))'
|
' COMPREPLY=($(compgen -W "%s %s" -- "${COMP_WORDS[COMP_CWORD]}"))' # noqa: FS003
|
||||||
% (actions, global_flags),
|
% (
|
||||||
|
' '.join(borgmatic.commands.completion.actions.available_actions(action_parsers)),
|
||||||
|
global_flags,
|
||||||
|
),
|
||||||
' (check_version &)',
|
' (check_version &)',
|
||||||
'}',
|
'}',
|
||||||
'\ncomplete -o bashdefault -o default -F complete_borgmatic borgmatic',
|
'\ncomplete -o bashdefault -o default -F complete_borgmatic borgmatic',
|
176
borgmatic/commands/completion/fish.py
Normal file
176
borgmatic/commands/completion/fish.py
Normal file
|
@ -0,0 +1,176 @@
|
||||||
|
import shlex
|
||||||
|
from argparse import Action
|
||||||
|
from textwrap import dedent
|
||||||
|
|
||||||
|
import borgmatic.commands.arguments
|
||||||
|
import borgmatic.commands.completion.actions
|
||||||
|
|
||||||
|
|
||||||
|
def has_file_options(action: Action):
|
||||||
|
'''
|
||||||
|
Given an argparse.Action instance, return True if it takes a file argument.
|
||||||
|
'''
|
||||||
|
return action.metavar in (
|
||||||
|
'FILENAME',
|
||||||
|
'PATH',
|
||||||
|
) or action.dest in ('config_paths',)
|
||||||
|
|
||||||
|
|
||||||
|
def has_choice_options(action: Action):
|
||||||
|
'''
|
||||||
|
Given an argparse.Action instance, return True if it takes one of a predefined set of arguments.
|
||||||
|
'''
|
||||||
|
return action.choices is not None
|
||||||
|
|
||||||
|
|
||||||
|
def has_unknown_required_param_options(action: Action):
|
||||||
|
'''
|
||||||
|
A catch-all for options that take a required parameter, but we don't know what the parameter is.
|
||||||
|
This should be used last. These are actions that take something like a glob, a list of numbers, or a string.
|
||||||
|
|
||||||
|
Actions that match this pattern should not show the normal arguments, because those are unlikely to be valid.
|
||||||
|
'''
|
||||||
|
return (
|
||||||
|
action.required is True
|
||||||
|
or action.nargs
|
||||||
|
in (
|
||||||
|
'+',
|
||||||
|
'*',
|
||||||
|
)
|
||||||
|
or action.metavar in ('PATTERN', 'KEYS', 'N')
|
||||||
|
or (action.type is not None and action.default is None)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def has_exact_options(action: Action):
|
||||||
|
return (
|
||||||
|
has_file_options(action)
|
||||||
|
or has_choice_options(action)
|
||||||
|
or has_unknown_required_param_options(action)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def exact_options_completion(action: Action):
|
||||||
|
'''
|
||||||
|
Given an argparse.Action instance, return a completion invocation that forces file completions, options completion,
|
||||||
|
or just that some value follow the action, if the action takes such an argument and was the last action on the
|
||||||
|
command line prior to the cursor.
|
||||||
|
|
||||||
|
Otherwise, return an empty string.
|
||||||
|
'''
|
||||||
|
|
||||||
|
if not has_exact_options(action):
|
||||||
|
return ''
|
||||||
|
|
||||||
|
args = ' '.join(action.option_strings)
|
||||||
|
|
||||||
|
if has_file_options(action):
|
||||||
|
return f'''\ncomplete -c borgmatic -Fr -n "__borgmatic_current_arg {args}"'''
|
||||||
|
|
||||||
|
if has_choice_options(action):
|
||||||
|
return f'''\ncomplete -c borgmatic -f -a '{' '.join(map(str, action.choices))}' -n "__borgmatic_current_arg {args}"'''
|
||||||
|
|
||||||
|
if has_unknown_required_param_options(action):
|
||||||
|
return f'''\ncomplete -c borgmatic -x -n "__borgmatic_current_arg {args}"'''
|
||||||
|
|
||||||
|
raise ValueError(
|
||||||
|
f'Unexpected action: {action} passes has_exact_options but has no choices produced'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def dedent_strip_as_tuple(string: str):
|
||||||
|
'''
|
||||||
|
Dedent a string, then strip it to avoid requiring your first line to have content, then return a tuple of the string.
|
||||||
|
Makes it easier to write multiline strings for completions when you join them with a tuple.
|
||||||
|
'''
|
||||||
|
return (dedent(string).strip('\n'),)
|
||||||
|
|
||||||
|
|
||||||
|
def fish_completion():
|
||||||
|
'''
|
||||||
|
Return a fish completion script for the borgmatic command. Produce this by introspecting
|
||||||
|
borgmatic's command-line argument parsers.
|
||||||
|
'''
|
||||||
|
(
|
||||||
|
unused_global_parser,
|
||||||
|
action_parsers,
|
||||||
|
global_plus_action_parser,
|
||||||
|
) = borgmatic.commands.arguments.make_parsers()
|
||||||
|
|
||||||
|
all_action_parsers = ' '.join(action for action in action_parsers.choices.keys())
|
||||||
|
|
||||||
|
exact_option_args = tuple(
|
||||||
|
' '.join(action.option_strings)
|
||||||
|
for action_parser in action_parsers.choices.values()
|
||||||
|
for action in action_parser._actions
|
||||||
|
if has_exact_options(action)
|
||||||
|
) + tuple(
|
||||||
|
' '.join(action.option_strings)
|
||||||
|
for action in global_plus_action_parser._actions
|
||||||
|
if len(action.option_strings) > 0
|
||||||
|
if has_exact_options(action)
|
||||||
|
)
|
||||||
|
|
||||||
|
# Avert your eyes.
|
||||||
|
return '\n'.join(
|
||||||
|
dedent_strip_as_tuple(
|
||||||
|
f'''
|
||||||
|
function __borgmatic_check_version
|
||||||
|
set -fx this_filename (status current-filename)
|
||||||
|
fish -c '
|
||||||
|
if test -f "$this_filename"
|
||||||
|
set this_script (cat $this_filename 2> /dev/null)
|
||||||
|
set installed_script (borgmatic --fish-completion 2> /dev/null)
|
||||||
|
if [ "$this_script" != "$installed_script" ] && [ "$installed_script" != "" ]
|
||||||
|
echo "{borgmatic.commands.completion.actions.upgrade_message(
|
||||||
|
'fish',
|
||||||
|
'borgmatic --fish-completion | sudo tee $this_filename',
|
||||||
|
'$this_filename',
|
||||||
|
)}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
' &
|
||||||
|
end
|
||||||
|
__borgmatic_check_version
|
||||||
|
|
||||||
|
function __borgmatic_current_arg --description 'Check if any of the given arguments are the last on the command line before the cursor'
|
||||||
|
set -l all_args (commandline -poc)
|
||||||
|
# premature optimization to avoid iterating all args if there aren't enough
|
||||||
|
# to have a last arg beyond borgmatic
|
||||||
|
if [ (count $all_args) -lt 2 ]
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
for arg in $argv
|
||||||
|
if [ "$arg" = "$all_args[-1]" ]
|
||||||
|
return 0
|
||||||
|
end
|
||||||
|
end
|
||||||
|
return 1
|
||||||
|
end
|
||||||
|
|
||||||
|
set --local action_parser_condition "not __fish_seen_subcommand_from {all_action_parsers}"
|
||||||
|
set --local exact_option_condition "not __borgmatic_current_arg {' '.join(exact_option_args)}"
|
||||||
|
'''
|
||||||
|
)
|
||||||
|
+ ('\n# action_parser completions',)
|
||||||
|
+ tuple(
|
||||||
|
f'''complete -c borgmatic -f -n "$action_parser_condition" -n "$exact_option_condition" -a '{action_name}' -d {shlex.quote(action_parser.description)}'''
|
||||||
|
for action_name, action_parser in action_parsers.choices.items()
|
||||||
|
)
|
||||||
|
+ ('\n# global flags',)
|
||||||
|
+ tuple(
|
||||||
|
# -n is checked in order, so put faster / more likely to be true checks first
|
||||||
|
f'''complete -c borgmatic -f -n "$exact_option_condition" -a '{' '.join(action.option_strings)}' -d {shlex.quote(action.help)}{exact_options_completion(action)}'''
|
||||||
|
for action in global_plus_action_parser._actions
|
||||||
|
# ignore the noargs action, as this is an impossible completion for fish
|
||||||
|
if len(action.option_strings) > 0
|
||||||
|
if 'Deprecated' not in action.help
|
||||||
|
)
|
||||||
|
+ ('\n# action_parser flags',)
|
||||||
|
+ tuple(
|
||||||
|
f'''complete -c borgmatic -f -n "$exact_option_condition" -a '{' '.join(action.option_strings)}' -d {shlex.quote(action.help)} -n "__fish_seen_subcommand_from {action_name}"{exact_options_completion(action)}'''
|
||||||
|
for action_name, action_parser in action_parsers.choices.items()
|
||||||
|
for action in action_parser._actions
|
||||||
|
if 'Deprecated' not in (action.help or ())
|
||||||
|
)
|
||||||
|
)
|
|
@ -1,110 +0,0 @@
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
import textwrap
|
|
||||||
from argparse import ArgumentParser
|
|
||||||
|
|
||||||
from ruamel import yaml
|
|
||||||
|
|
||||||
from borgmatic.config import convert, generate, legacy, validate
|
|
||||||
|
|
||||||
DEFAULT_SOURCE_CONFIG_FILENAME = '/etc/borgmatic/config'
|
|
||||||
DEFAULT_SOURCE_EXCLUDES_FILENAME = '/etc/borgmatic/excludes'
|
|
||||||
DEFAULT_DESTINATION_CONFIG_FILENAME = '/etc/borgmatic/config.yaml'
|
|
||||||
|
|
||||||
|
|
||||||
def parse_arguments(*arguments):
|
|
||||||
'''
|
|
||||||
Given command-line arguments with which this script was invoked, parse the arguments and return
|
|
||||||
them as an ArgumentParser instance.
|
|
||||||
'''
|
|
||||||
parser = ArgumentParser(
|
|
||||||
description='''
|
|
||||||
Convert legacy INI-style borgmatic configuration and excludes files to a single YAML
|
|
||||||
configuration file. Note that this replaces any comments from the source files.
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
'-s',
|
|
||||||
'--source-config',
|
|
||||||
dest='source_config_filename',
|
|
||||||
default=DEFAULT_SOURCE_CONFIG_FILENAME,
|
|
||||||
help='Source INI-style configuration filename. Default: {}'.format(
|
|
||||||
DEFAULT_SOURCE_CONFIG_FILENAME
|
|
||||||
),
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
'-e',
|
|
||||||
'--source-excludes',
|
|
||||||
dest='source_excludes_filename',
|
|
||||||
default=DEFAULT_SOURCE_EXCLUDES_FILENAME
|
|
||||||
if os.path.exists(DEFAULT_SOURCE_EXCLUDES_FILENAME)
|
|
||||||
else None,
|
|
||||||
help='Excludes filename',
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
'-d',
|
|
||||||
'--destination-config',
|
|
||||||
dest='destination_config_filename',
|
|
||||||
default=DEFAULT_DESTINATION_CONFIG_FILENAME,
|
|
||||||
help='Destination YAML configuration filename. Default: {}'.format(
|
|
||||||
DEFAULT_DESTINATION_CONFIG_FILENAME
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
return parser.parse_args(arguments)
|
|
||||||
|
|
||||||
|
|
||||||
TEXT_WRAP_CHARACTERS = 80
|
|
||||||
|
|
||||||
|
|
||||||
def display_result(args): # pragma: no cover
|
|
||||||
result_lines = textwrap.wrap(
|
|
||||||
'Your borgmatic configuration has been upgraded. Please review the result in {}.'.format(
|
|
||||||
args.destination_config_filename
|
|
||||||
),
|
|
||||||
TEXT_WRAP_CHARACTERS,
|
|
||||||
)
|
|
||||||
|
|
||||||
delete_lines = textwrap.wrap(
|
|
||||||
'Once you are satisfied, you can safely delete {}{}.'.format(
|
|
||||||
args.source_config_filename,
|
|
||||||
' and {}'.format(args.source_excludes_filename)
|
|
||||||
if args.source_excludes_filename
|
|
||||||
else '',
|
|
||||||
),
|
|
||||||
TEXT_WRAP_CHARACTERS,
|
|
||||||
)
|
|
||||||
|
|
||||||
print('\n'.join(result_lines))
|
|
||||||
print()
|
|
||||||
print('\n'.join(delete_lines))
|
|
||||||
|
|
||||||
|
|
||||||
def main(): # pragma: no cover
|
|
||||||
try:
|
|
||||||
args = parse_arguments(*sys.argv[1:])
|
|
||||||
schema = yaml.round_trip_load(open(validate.schema_filename()).read())
|
|
||||||
source_config = legacy.parse_configuration(
|
|
||||||
args.source_config_filename, legacy.CONFIG_FORMAT
|
|
||||||
)
|
|
||||||
source_config_file_mode = os.stat(args.source_config_filename).st_mode
|
|
||||||
source_excludes = (
|
|
||||||
open(args.source_excludes_filename).read().splitlines()
|
|
||||||
if args.source_excludes_filename
|
|
||||||
else []
|
|
||||||
)
|
|
||||||
|
|
||||||
destination_config = convert.convert_legacy_parsed_config(
|
|
||||||
source_config, source_excludes, schema
|
|
||||||
)
|
|
||||||
|
|
||||||
generate.write_configuration(
|
|
||||||
args.destination_config_filename,
|
|
||||||
generate.render_configuration(destination_config),
|
|
||||||
mode=source_config_file_mode,
|
|
||||||
)
|
|
||||||
|
|
||||||
display_result(args)
|
|
||||||
except (ValueError, OSError) as error:
|
|
||||||
print(error, file=sys.stderr)
|
|
||||||
sys.exit(1)
|
|
|
@ -1,69 +1,17 @@
|
||||||
|
import logging
|
||||||
import sys
|
import sys
|
||||||
from argparse import ArgumentParser
|
|
||||||
|
|
||||||
from borgmatic.config import generate, validate
|
import borgmatic.commands.borgmatic
|
||||||
|
|
||||||
DEFAULT_DESTINATION_CONFIG_FILENAME = '/etc/borgmatic/config.yaml'
|
|
||||||
|
|
||||||
|
|
||||||
def parse_arguments(*arguments):
|
def main():
|
||||||
'''
|
warning_log = logging.makeLogRecord(
|
||||||
Given command-line arguments with which this script was invoked, parse the arguments and return
|
dict(
|
||||||
them as an ArgumentParser instance.
|
levelno=logging.WARNING,
|
||||||
'''
|
levelname='WARNING',
|
||||||
parser = ArgumentParser(description='Generate a sample borgmatic YAML configuration file.')
|
msg='generate-borgmatic-config is deprecated and will be removed from a future release. Please use "borgmatic config generate" instead.',
|
||||||
parser.add_argument(
|
|
||||||
'-s',
|
|
||||||
'--source',
|
|
||||||
dest='source_filename',
|
|
||||||
help='Optional YAML configuration file to merge into the generated configuration, useful for upgrading your configuration',
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
'-d',
|
|
||||||
'--destination',
|
|
||||||
dest='destination_filename',
|
|
||||||
default=DEFAULT_DESTINATION_CONFIG_FILENAME,
|
|
||||||
help='Destination YAML configuration file, default: {}'.format(
|
|
||||||
DEFAULT_DESTINATION_CONFIG_FILENAME
|
|
||||||
),
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
'--overwrite',
|
|
||||||
default=False,
|
|
||||||
action='store_true',
|
|
||||||
help='Whether to overwrite any existing destination file, defaults to false',
|
|
||||||
)
|
|
||||||
|
|
||||||
return parser.parse_args(arguments)
|
|
||||||
|
|
||||||
|
|
||||||
def main(): # pragma: no cover
|
|
||||||
try:
|
|
||||||
args = parse_arguments(*sys.argv[1:])
|
|
||||||
|
|
||||||
generate.generate_sample_configuration(
|
|
||||||
args.source_filename,
|
|
||||||
args.destination_filename,
|
|
||||||
validate.schema_filename(),
|
|
||||||
overwrite=args.overwrite,
|
|
||||||
)
|
)
|
||||||
|
)
|
||||||
|
|
||||||
print('Generated a sample configuration file at {}.'.format(args.destination_filename))
|
sys.argv = ['borgmatic', 'config', 'generate'] + sys.argv[1:]
|
||||||
print()
|
borgmatic.commands.borgmatic.main([warning_log])
|
||||||
if args.source_filename:
|
|
||||||
print(
|
|
||||||
'Merged in the contents of configuration file at {}.'.format(args.source_filename)
|
|
||||||
)
|
|
||||||
print('To review the changes made, run:')
|
|
||||||
print()
|
|
||||||
print(
|
|
||||||
' diff --unified {} {}'.format(args.source_filename, args.destination_filename)
|
|
||||||
)
|
|
||||||
print()
|
|
||||||
print('This includes all available configuration options with example values. The few')
|
|
||||||
print('required options are indicated. Please edit the file to suit your needs.')
|
|
||||||
print()
|
|
||||||
print('If you ever need help: https://torsion.org/borgmatic/#issues')
|
|
||||||
except (ValueError, OSError) as error:
|
|
||||||
print(error, file=sys.stderr)
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
|
@ -1,56 +1,17 @@
|
||||||
import logging
|
import logging
|
||||||
import sys
|
import sys
|
||||||
from argparse import ArgumentParser
|
|
||||||
|
|
||||||
from borgmatic.config import collect, validate
|
import borgmatic.commands.borgmatic
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
def parse_arguments(*arguments):
|
def main():
|
||||||
'''
|
warning_log = logging.makeLogRecord(
|
||||||
Given command-line arguments with which this script was invoked, parse the arguments and return
|
dict(
|
||||||
them as an ArgumentParser instance.
|
levelno=logging.WARNING,
|
||||||
'''
|
levelname='WARNING',
|
||||||
config_paths = collect.get_default_config_paths()
|
msg='validate-borgmatic-config is deprecated and will be removed from a future release. Please use "borgmatic config validate" instead.',
|
||||||
|
)
|
||||||
parser = ArgumentParser(description='Validate borgmatic configuration file(s).')
|
|
||||||
parser.add_argument(
|
|
||||||
'-c',
|
|
||||||
'--config',
|
|
||||||
nargs='+',
|
|
||||||
dest='config_paths',
|
|
||||||
default=config_paths,
|
|
||||||
help='Configuration filenames or directories, defaults to: {}'.format(
|
|
||||||
' '.join(config_paths)
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
return parser.parse_args(arguments)
|
sys.argv = ['borgmatic', 'config', 'validate'] + sys.argv[1:]
|
||||||
|
borgmatic.commands.borgmatic.main([warning_log])
|
||||||
|
|
||||||
def main(): # pragma: no cover
|
|
||||||
args = parse_arguments(*sys.argv[1:])
|
|
||||||
|
|
||||||
logging.basicConfig(level=logging.INFO, format='%(message)s')
|
|
||||||
|
|
||||||
config_filenames = tuple(collect.collect_config_filenames(args.config_paths))
|
|
||||||
if len(config_filenames) == 0:
|
|
||||||
logger.critical('No files to validate found')
|
|
||||||
sys.exit(1)
|
|
||||||
|
|
||||||
found_issues = False
|
|
||||||
for config_filename in config_filenames:
|
|
||||||
try:
|
|
||||||
validate.parse_configuration(config_filename, validate.schema_filename())
|
|
||||||
except (ValueError, OSError, validate.Validation_error) as error:
|
|
||||||
logging.critical('{}: Error parsing configuration file'.format(config_filename))
|
|
||||||
logging.critical(error)
|
|
||||||
found_issues = True
|
|
||||||
|
|
||||||
if found_issues:
|
|
||||||
sys.exit(1)
|
|
||||||
else:
|
|
||||||
logger.info(
|
|
||||||
'All given configuration files are valid: {}'.format(', '.join(config_filenames))
|
|
||||||
)
|
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
def repository_enabled_for_checks(repository, consistency):
|
def repository_enabled_for_checks(repository, config):
|
||||||
'''
|
'''
|
||||||
Given a repository name and a consistency configuration dict, return whether the repository
|
Given a repository name and a configuration dict, return whether the
|
||||||
is enabled to have consistency checks run.
|
repository is enabled to have consistency checks run.
|
||||||
'''
|
'''
|
||||||
if not consistency.get('check_repositories'):
|
if not config.get('check_repositories'):
|
||||||
return True
|
return True
|
||||||
|
|
||||||
return repository in consistency['check_repositories']
|
return repository in config['check_repositories']
|
||||||
|
|
|
@ -16,17 +16,17 @@ def get_default_config_paths(expand_home=True):
|
||||||
return [
|
return [
|
||||||
'/etc/borgmatic/config.yaml',
|
'/etc/borgmatic/config.yaml',
|
||||||
'/etc/borgmatic.d',
|
'/etc/borgmatic.d',
|
||||||
'%s/borgmatic/config.yaml' % user_config_directory,
|
os.path.join(user_config_directory, 'borgmatic/config.yaml'),
|
||||||
'%s/borgmatic.d' % user_config_directory,
|
os.path.join(user_config_directory, 'borgmatic.d'),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
def collect_config_filenames(config_paths):
|
def collect_config_filenames(config_paths):
|
||||||
'''
|
'''
|
||||||
Given a sequence of config paths, both filenames and directories, resolve that to an iterable
|
Given a sequence of config paths, both filenames and directories, resolve that to an iterable
|
||||||
of files. Accomplish this by listing any given directories looking for contained config files
|
of absolute files. Accomplish this by listing any given directories looking for contained config
|
||||||
(ending with the ".yaml" or ".yml" extension). This is non-recursive, so any directories within the given
|
files (ending with the ".yaml" or ".yml" extension). This is non-recursive, so any directories
|
||||||
directories are ignored.
|
within the given directories are ignored.
|
||||||
|
|
||||||
Return paths even if they don't exist on disk, so the user can find out about missing
|
Return paths even if they don't exist on disk, so the user can find out about missing
|
||||||
configuration paths. However, skip a default config path if it's missing, so the user doesn't
|
configuration paths. However, skip a default config path if it's missing, so the user doesn't
|
||||||
|
@ -41,7 +41,7 @@ def collect_config_filenames(config_paths):
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if not os.path.isdir(path) or not exists:
|
if not os.path.isdir(path) or not exists:
|
||||||
yield path
|
yield os.path.abspath(path)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if not os.access(path, os.R_OK):
|
if not os.access(path, os.R_OK):
|
||||||
|
@ -51,4 +51,4 @@ def collect_config_filenames(config_paths):
|
||||||
full_filename = os.path.join(path, filename)
|
full_filename = os.path.join(path, filename)
|
||||||
matching_filetype = full_filename.endswith('.yaml') or full_filename.endswith('.yml')
|
matching_filetype = full_filename.endswith('.yaml') or full_filename.endswith('.yml')
|
||||||
if matching_filetype and not os.path.isdir(full_filename):
|
if matching_filetype and not os.path.isdir(full_filename):
|
||||||
yield full_filename
|
yield os.path.abspath(full_filename)
|
||||||
|
|
64
borgmatic/config/constants.py
Normal file
64
borgmatic/config/constants.py
Normal file
|
@ -0,0 +1,64 @@
|
||||||
|
import shlex
|
||||||
|
|
||||||
|
|
||||||
|
def coerce_scalar(value):
|
||||||
|
'''
|
||||||
|
Given a configuration value, coerce it to an integer or a boolean as appropriate and return the
|
||||||
|
result.
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
return int(value)
|
||||||
|
except (TypeError, ValueError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
if value == 'true' or value == 'True':
|
||||||
|
return True
|
||||||
|
if value == 'false' or value == 'False':
|
||||||
|
return False
|
||||||
|
|
||||||
|
return value
|
||||||
|
|
||||||
|
|
||||||
|
def apply_constants(value, constants, shell_escape=False):
|
||||||
|
'''
|
||||||
|
Given a configuration value (bool, dict, int, list, or string) and a dict of named constants,
|
||||||
|
replace any configuration string values of the form "{constant}" (or containing it) with the
|
||||||
|
value of the correspondingly named key from the constants. Recurse as necessary into nested
|
||||||
|
configuration to find values to replace.
|
||||||
|
|
||||||
|
For instance, if a configuration value contains "{foo}", replace it with the value of the "foo"
|
||||||
|
key found within the configuration's "constants".
|
||||||
|
|
||||||
|
If shell escape is True, then escape the constant's value before applying it.
|
||||||
|
|
||||||
|
Return the configuration value and modify the original.
|
||||||
|
'''
|
||||||
|
if not value or not constants:
|
||||||
|
return value
|
||||||
|
|
||||||
|
if isinstance(value, str):
|
||||||
|
for constant_name, constant_value in constants.items():
|
||||||
|
value = value.replace(
|
||||||
|
'{' + constant_name + '}',
|
||||||
|
shlex.quote(str(constant_value)) if shell_escape else str(constant_value),
|
||||||
|
)
|
||||||
|
|
||||||
|
# Support constants within non-string scalars by coercing the value to its appropriate type.
|
||||||
|
value = coerce_scalar(value)
|
||||||
|
elif isinstance(value, list):
|
||||||
|
for index, list_value in enumerate(value):
|
||||||
|
value[index] = apply_constants(list_value, constants, shell_escape)
|
||||||
|
elif isinstance(value, dict):
|
||||||
|
for option_name, option_value in value.items():
|
||||||
|
value[option_name] = apply_constants(
|
||||||
|
option_value,
|
||||||
|
constants,
|
||||||
|
shell_escape=(
|
||||||
|
shell_escape
|
||||||
|
or option_name.startswith('before_')
|
||||||
|
or option_name.startswith('after_')
|
||||||
|
or option_name == 'on_error'
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
return value
|
|
@ -1,95 +0,0 @@
|
||||||
import os
|
|
||||||
|
|
||||||
from ruamel import yaml
|
|
||||||
|
|
||||||
from borgmatic.config import generate
|
|
||||||
|
|
||||||
|
|
||||||
def _convert_section(source_section_config, section_schema):
|
|
||||||
'''
|
|
||||||
Given a legacy Parsed_config instance for a single section, convert it to its corresponding
|
|
||||||
yaml.comments.CommentedMap representation in preparation for actual serialization to YAML.
|
|
||||||
|
|
||||||
Where integer types exist in the given section schema, convert their values to integers.
|
|
||||||
'''
|
|
||||||
destination_section_config = yaml.comments.CommentedMap(
|
|
||||||
[
|
|
||||||
(
|
|
||||||
option_name,
|
|
||||||
int(option_value)
|
|
||||||
if section_schema['properties'].get(option_name, {}).get('type') == 'integer'
|
|
||||||
else option_value,
|
|
||||||
)
|
|
||||||
for option_name, option_value in source_section_config.items()
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
return destination_section_config
|
|
||||||
|
|
||||||
|
|
||||||
def convert_legacy_parsed_config(source_config, source_excludes, schema):
|
|
||||||
'''
|
|
||||||
Given a legacy Parsed_config instance loaded from an INI-style config file and a list of exclude
|
|
||||||
patterns, convert them to a corresponding yaml.comments.CommentedMap representation in
|
|
||||||
preparation for serialization to a single YAML config file.
|
|
||||||
|
|
||||||
Additionally, use the given schema as a source of helpful comments to include within the
|
|
||||||
returned CommentedMap.
|
|
||||||
'''
|
|
||||||
destination_config = yaml.comments.CommentedMap(
|
|
||||||
[
|
|
||||||
(section_name, _convert_section(section_config, schema['properties'][section_name]))
|
|
||||||
for section_name, section_config in source_config._asdict().items()
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
# Split space-seperated values into actual lists, make "repository" into a list, and merge in
|
|
||||||
# excludes.
|
|
||||||
location = destination_config['location']
|
|
||||||
location['source_directories'] = source_config.location['source_directories'].split(' ')
|
|
||||||
location['repositories'] = [location.pop('repository')]
|
|
||||||
location['exclude_patterns'] = source_excludes
|
|
||||||
|
|
||||||
if source_config.consistency.get('checks'):
|
|
||||||
destination_config['consistency']['checks'] = source_config.consistency['checks'].split(' ')
|
|
||||||
|
|
||||||
# Add comments to each section, and then add comments to the fields in each section.
|
|
||||||
generate.add_comments_to_configuration_object(destination_config, schema)
|
|
||||||
|
|
||||||
for section_name, section_config in destination_config.items():
|
|
||||||
generate.add_comments_to_configuration_object(
|
|
||||||
section_config, schema['properties'][section_name], indent=generate.INDENT
|
|
||||||
)
|
|
||||||
|
|
||||||
return destination_config
|
|
||||||
|
|
||||||
|
|
||||||
class Legacy_configuration_not_upgraded(FileNotFoundError):
|
|
||||||
def __init__(self):
|
|
||||||
super(Legacy_configuration_not_upgraded, self).__init__(
|
|
||||||
'''borgmatic changed its configuration file format in version 1.1.0 from INI-style
|
|
||||||
to YAML. This better supports validation, and has a more natural way to express
|
|
||||||
lists of values. To upgrade your existing configuration, run:
|
|
||||||
|
|
||||||
sudo upgrade-borgmatic-config
|
|
||||||
|
|
||||||
That will generate a new YAML configuration file at /etc/borgmatic/config.yaml
|
|
||||||
(by default) using the values from both your existing configuration and excludes
|
|
||||||
files. The new version of borgmatic will consume the YAML configuration file
|
|
||||||
instead of the old one.'''
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def guard_configuration_upgraded(source_config_filename, destination_config_filenames):
|
|
||||||
'''
|
|
||||||
If legacy source configuration exists but no destination upgraded configs do, raise
|
|
||||||
Legacy_configuration_not_upgraded.
|
|
||||||
|
|
||||||
The idea is that we want to alert the user about upgrading their config if they haven't already.
|
|
||||||
'''
|
|
||||||
destination_config_exists = any(
|
|
||||||
os.path.exists(filename) for filename in destination_config_filenames
|
|
||||||
)
|
|
||||||
|
|
||||||
if os.path.exists(source_config_filename) and not destination_config_exists:
|
|
||||||
raise Legacy_configuration_not_upgraded()
|
|
|
@ -1,42 +1,51 @@
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
|
|
||||||
_VARIABLE_PATTERN = re.compile(
|
VARIABLE_PATTERN = re.compile(
|
||||||
r'(?P<escape>\\)?(?P<variable>\$\{(?P<name>[A-Za-z0-9_]+)((:?-)(?P<default>[^}]+))?\})'
|
r'(?P<escape>\\)?(?P<variable>\$\{(?P<name>[A-Za-z0-9_]+)((:?-)(?P<default>[^}]+))?\})'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _resolve_string(matcher):
|
def resolve_string(matcher):
|
||||||
'''
|
'''
|
||||||
Get the value from environment given a matcher containing a name and an optional default value.
|
Given a matcher containing a name and an optional default value, get the value from environment.
|
||||||
If the variable is not defined in environment and no default value is provided, an Error is raised.
|
|
||||||
|
Raise ValueError if the variable is not defined in environment and no default value is provided.
|
||||||
'''
|
'''
|
||||||
if matcher.group('escape') is not None:
|
if matcher.group('escape') is not None:
|
||||||
# in case of escaped envvar, unescape it
|
# In the case of an escaped environment variable, unescape it.
|
||||||
return matcher.group('variable')
|
return matcher.group('variable')
|
||||||
# resolve the env var
|
|
||||||
|
# Resolve the environment variable.
|
||||||
name, default = matcher.group('name'), matcher.group('default')
|
name, default = matcher.group('name'), matcher.group('default')
|
||||||
out = os.getenv(name, default=default)
|
out = os.getenv(name, default=default)
|
||||||
|
|
||||||
if out is None:
|
if out is None:
|
||||||
raise ValueError('Cannot find variable ${name} in environment'.format(name=name))
|
raise ValueError(f'Cannot find variable {name} in environment')
|
||||||
|
|
||||||
return out
|
return out
|
||||||
|
|
||||||
|
|
||||||
def resolve_env_variables(item):
|
def resolve_env_variables(item):
|
||||||
'''
|
'''
|
||||||
Resolves variables like or ${FOO} from given configuration with values from process environment
|
Resolves variables like or ${FOO} from given configuration with values from process environment.
|
||||||
Supported formats:
|
|
||||||
- ${FOO} will return FOO env variable
|
|
||||||
- ${FOO-bar} or ${FOO:-bar} will return FOO env variable if it exists, else "bar"
|
|
||||||
|
|
||||||
If any variable is missing in environment and no default value is provided, an Error is raised.
|
Supported formats:
|
||||||
|
|
||||||
|
* ${FOO} will return FOO env variable
|
||||||
|
* ${FOO-bar} or ${FOO:-bar} will return FOO env variable if it exists, else "bar"
|
||||||
|
|
||||||
|
Raise if any variable is missing in environment and no default value is provided.
|
||||||
'''
|
'''
|
||||||
if isinstance(item, str):
|
if isinstance(item, str):
|
||||||
return _VARIABLE_PATTERN.sub(_resolve_string, item)
|
return VARIABLE_PATTERN.sub(resolve_string, item)
|
||||||
|
|
||||||
if isinstance(item, list):
|
if isinstance(item, list):
|
||||||
for i, subitem in enumerate(item):
|
for index, subitem in enumerate(item):
|
||||||
item[i] = resolve_env_variables(subitem)
|
item[index] = resolve_env_variables(subitem)
|
||||||
|
|
||||||
if isinstance(item, dict):
|
if isinstance(item, dict):
|
||||||
for key, value in item.items():
|
for key, value in item.items():
|
||||||
item[key] = resolve_env_variables(value)
|
item[key] = resolve_env_variables(value)
|
||||||
|
|
||||||
return item
|
return item
|
||||||
|
|
|
@ -3,7 +3,7 @@ import io
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
|
|
||||||
from ruamel import yaml
|
import ruamel.yaml
|
||||||
|
|
||||||
from borgmatic.config import load, normalize
|
from borgmatic.config import load, normalize
|
||||||
|
|
||||||
|
@ -11,20 +11,33 @@ INDENT = 4
|
||||||
SEQUENCE_INDENT = 2
|
SEQUENCE_INDENT = 2
|
||||||
|
|
||||||
|
|
||||||
def _insert_newline_before_comment(config, field_name):
|
def insert_newline_before_comment(config, field_name):
|
||||||
'''
|
'''
|
||||||
Using some ruamel.yaml black magic, insert a blank line in the config right before the given
|
Using some ruamel.yaml black magic, insert a blank line in the config right before the given
|
||||||
field and its comments.
|
field and its comments.
|
||||||
'''
|
'''
|
||||||
config.ca.items[field_name][1].insert(
|
config.ca.items[field_name][1].insert(
|
||||||
0, yaml.tokens.CommentToken('\n', yaml.error.CommentMark(0), None)
|
0, ruamel.yaml.tokens.CommentToken('\n', ruamel.yaml.error.CommentMark(0), None)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def _schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
def get_properties(schema):
|
||||||
|
'''
|
||||||
|
Given a schema dict, return its properties. But if it's got sub-schemas with multiple different
|
||||||
|
potential properties, returned their merged properties instead.
|
||||||
|
'''
|
||||||
|
if 'oneOf' in schema:
|
||||||
|
return dict(
|
||||||
|
collections.ChainMap(*[sub_schema['properties'] for sub_schema in schema['oneOf']])
|
||||||
|
)
|
||||||
|
|
||||||
|
return schema['properties']
|
||||||
|
|
||||||
|
|
||||||
|
def schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
||||||
'''
|
'''
|
||||||
Given a loaded configuration schema, generate and return sample config for it. Include comments
|
Given a loaded configuration schema, generate and return sample config for it. Include comments
|
||||||
for each section based on the schema "description".
|
for each option based on the schema "description".
|
||||||
'''
|
'''
|
||||||
schema_type = schema.get('type')
|
schema_type = schema.get('type')
|
||||||
example = schema.get('example')
|
example = schema.get('example')
|
||||||
|
@ -32,15 +45,15 @@ def _schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
||||||
return example
|
return example
|
||||||
|
|
||||||
if schema_type == 'array':
|
if schema_type == 'array':
|
||||||
config = yaml.comments.CommentedSeq(
|
config = ruamel.yaml.comments.CommentedSeq(
|
||||||
[_schema_to_sample_configuration(schema['items'], level, parent_is_sequence=True)]
|
[schema_to_sample_configuration(schema['items'], level, parent_is_sequence=True)]
|
||||||
)
|
)
|
||||||
add_comments_to_configuration_sequence(config, schema, indent=(level * INDENT))
|
add_comments_to_configuration_sequence(config, schema, indent=(level * INDENT))
|
||||||
elif schema_type == 'object':
|
elif schema_type == 'object':
|
||||||
config = yaml.comments.CommentedMap(
|
config = ruamel.yaml.comments.CommentedMap(
|
||||||
[
|
[
|
||||||
(field_name, _schema_to_sample_configuration(sub_schema, level + 1))
|
(field_name, schema_to_sample_configuration(sub_schema, level + 1))
|
||||||
for field_name, sub_schema in schema['properties'].items()
|
for field_name, sub_schema in get_properties(schema).items()
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
indent = (level * INDENT) + (SEQUENCE_INDENT if parent_is_sequence else 0)
|
indent = (level * INDENT) + (SEQUENCE_INDENT if parent_is_sequence else 0)
|
||||||
|
@ -48,18 +61,18 @@ def _schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
||||||
config, schema, indent=indent, skip_first=parent_is_sequence
|
config, schema, indent=indent, skip_first=parent_is_sequence
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
raise ValueError('Schema at level {} is unsupported: {}'.format(level, schema))
|
raise ValueError(f'Schema at level {level} is unsupported: {schema}')
|
||||||
|
|
||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
def _comment_out_line(line):
|
def comment_out_line(line):
|
||||||
# If it's already is commented out (or empty), there's nothing further to do!
|
# If it's already is commented out (or empty), there's nothing further to do!
|
||||||
stripped_line = line.lstrip()
|
stripped_line = line.lstrip()
|
||||||
if not stripped_line or stripped_line.startswith('#'):
|
if not stripped_line or stripped_line.startswith('#'):
|
||||||
return line
|
return line
|
||||||
|
|
||||||
# Comment out the names of optional sections, inserting the '#' after any indent for aesthetics.
|
# Comment out the names of optional options, inserting the '#' after any indent for aesthetics.
|
||||||
matches = re.match(r'(\s*)', line)
|
matches = re.match(r'(\s*)', line)
|
||||||
indent_spaces = matches.group(0) if matches else ''
|
indent_spaces = matches.group(0) if matches else ''
|
||||||
count_indent_spaces = len(indent_spaces)
|
count_indent_spaces = len(indent_spaces)
|
||||||
|
@ -67,7 +80,7 @@ def _comment_out_line(line):
|
||||||
return '# '.join((indent_spaces, line[count_indent_spaces:]))
|
return '# '.join((indent_spaces, line[count_indent_spaces:]))
|
||||||
|
|
||||||
|
|
||||||
def _comment_out_optional_configuration(rendered_config):
|
def comment_out_optional_configuration(rendered_config):
|
||||||
'''
|
'''
|
||||||
Post-process a rendered configuration string to comment out optional key/values, as determined
|
Post-process a rendered configuration string to comment out optional key/values, as determined
|
||||||
by a sentinel in the comment before each key.
|
by a sentinel in the comment before each key.
|
||||||
|
@ -84,7 +97,7 @@ def _comment_out_optional_configuration(rendered_config):
|
||||||
for line in rendered_config.split('\n'):
|
for line in rendered_config.split('\n'):
|
||||||
# Upon encountering an optional configuration option, comment out lines until the next blank
|
# Upon encountering an optional configuration option, comment out lines until the next blank
|
||||||
# line.
|
# line.
|
||||||
if line.strip().startswith('# {}'.format(COMMENTED_OUT_SENTINEL)):
|
if line.strip().startswith(f'# {COMMENTED_OUT_SENTINEL}'):
|
||||||
optional = True
|
optional = True
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
@ -92,7 +105,7 @@ def _comment_out_optional_configuration(rendered_config):
|
||||||
if not line.strip():
|
if not line.strip():
|
||||||
optional = False
|
optional = False
|
||||||
|
|
||||||
lines.append(_comment_out_line(line) if optional else line)
|
lines.append(comment_out_line(line) if optional else line)
|
||||||
|
|
||||||
return '\n'.join(lines)
|
return '\n'.join(lines)
|
||||||
|
|
||||||
|
@ -101,7 +114,7 @@ def render_configuration(config):
|
||||||
'''
|
'''
|
||||||
Given a config data structure of nested OrderedDicts, render the config as YAML and return it.
|
Given a config data structure of nested OrderedDicts, render the config as YAML and return it.
|
||||||
'''
|
'''
|
||||||
dumper = yaml.YAML()
|
dumper = ruamel.yaml.YAML(typ='rt')
|
||||||
dumper.indent(mapping=INDENT, sequence=INDENT + SEQUENCE_INDENT, offset=INDENT)
|
dumper.indent(mapping=INDENT, sequence=INDENT + SEQUENCE_INDENT, offset=INDENT)
|
||||||
rendered = io.StringIO()
|
rendered = io.StringIO()
|
||||||
dumper.dump(config, rendered)
|
dumper.dump(config, rendered)
|
||||||
|
@ -117,9 +130,7 @@ def write_configuration(config_filename, rendered_config, mode=0o600, overwrite=
|
||||||
'''
|
'''
|
||||||
if not overwrite and os.path.exists(config_filename):
|
if not overwrite and os.path.exists(config_filename):
|
||||||
raise FileExistsError(
|
raise FileExistsError(
|
||||||
'{} already exists. Aborting. Use --overwrite to replace the file.'.format(
|
f'{config_filename} already exists. Aborting. Use --overwrite to replace the file.'
|
||||||
config_filename
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
@ -153,7 +164,7 @@ def add_comments_to_configuration_sequence(config, schema, indent=0):
|
||||||
return
|
return
|
||||||
|
|
||||||
for field_name in config[0].keys():
|
for field_name in config[0].keys():
|
||||||
field_schema = schema['items']['properties'].get(field_name, {})
|
field_schema = get_properties(schema['items']).get(field_name, {})
|
||||||
description = field_schema.get('description')
|
description = field_schema.get('description')
|
||||||
|
|
||||||
# No description to use? Skip it.
|
# No description to use? Skip it.
|
||||||
|
@ -167,7 +178,6 @@ def add_comments_to_configuration_sequence(config, schema, indent=0):
|
||||||
return
|
return
|
||||||
|
|
||||||
|
|
||||||
REQUIRED_SECTION_NAMES = {'location', 'retention'}
|
|
||||||
REQUIRED_KEYS = {'source_directories', 'repositories', 'keep_daily'}
|
REQUIRED_KEYS = {'source_directories', 'repositories', 'keep_daily'}
|
||||||
COMMENTED_OUT_SENTINEL = 'COMMENT_OUT'
|
COMMENTED_OUT_SENTINEL = 'COMMENT_OUT'
|
||||||
|
|
||||||
|
@ -181,13 +191,13 @@ def add_comments_to_configuration_object(config, schema, indent=0, skip_first=Fa
|
||||||
if skip_first and index == 0:
|
if skip_first and index == 0:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
field_schema = schema['properties'].get(field_name, {})
|
field_schema = get_properties(schema).get(field_name, {})
|
||||||
description = field_schema.get('description', '').strip()
|
description = field_schema.get('description', '').strip()
|
||||||
|
|
||||||
# If this is an optional key, add an indicator to the comment flagging it to be commented
|
# If this is an optional key, add an indicator to the comment flagging it to be commented
|
||||||
# out from the sample configuration. This sentinel is consumed by downstream processing that
|
# out from the sample configuration. This sentinel is consumed by downstream processing that
|
||||||
# does the actual commenting out.
|
# does the actual commenting out.
|
||||||
if field_name not in REQUIRED_SECTION_NAMES and field_name not in REQUIRED_KEYS:
|
if field_name not in REQUIRED_KEYS:
|
||||||
description = (
|
description = (
|
||||||
'\n'.join((description, COMMENTED_OUT_SENTINEL))
|
'\n'.join((description, COMMENTED_OUT_SENTINEL))
|
||||||
if description
|
if description
|
||||||
|
@ -201,7 +211,7 @@ def add_comments_to_configuration_object(config, schema, indent=0, skip_first=Fa
|
||||||
config.yaml_set_comment_before_after_key(key=field_name, before=description, indent=indent)
|
config.yaml_set_comment_before_after_key(key=field_name, before=description, indent=indent)
|
||||||
|
|
||||||
if index > 0:
|
if index > 0:
|
||||||
_insert_newline_before_comment(config, field_name)
|
insert_newline_before_comment(config, field_name)
|
||||||
|
|
||||||
|
|
||||||
RUAMEL_YAML_COMMENTS_INDEX = 1
|
RUAMEL_YAML_COMMENTS_INDEX = 1
|
||||||
|
@ -218,7 +228,7 @@ def remove_commented_out_sentinel(config, field_name):
|
||||||
except KeyError:
|
except KeyError:
|
||||||
return
|
return
|
||||||
|
|
||||||
if last_comment_value == '# {}\n'.format(COMMENTED_OUT_SENTINEL):
|
if last_comment_value == f'# {COMMENTED_OUT_SENTINEL}\n':
|
||||||
config.ca.items[field_name][RUAMEL_YAML_COMMENTS_INDEX].pop()
|
config.ca.items[field_name][RUAMEL_YAML_COMMENTS_INDEX].pop()
|
||||||
|
|
||||||
|
|
||||||
|
@ -228,8 +238,7 @@ def merge_source_configuration_into_destination(destination_config, source_confi
|
||||||
favoring values from the source when there are collisions.
|
favoring values from the source when there are collisions.
|
||||||
|
|
||||||
The purpose of this is to upgrade configuration files from old versions of borgmatic by adding
|
The purpose of this is to upgrade configuration files from old versions of borgmatic by adding
|
||||||
new
|
new configuration keys and comments.
|
||||||
configuration keys and comments.
|
|
||||||
'''
|
'''
|
||||||
if not source_config:
|
if not source_config:
|
||||||
return destination_config
|
return destination_config
|
||||||
|
@ -239,7 +248,9 @@ def merge_source_configuration_into_destination(destination_config, source_confi
|
||||||
for field_name, source_value in source_config.items():
|
for field_name, source_value in source_config.items():
|
||||||
# Since this key/value is from the source configuration, leave it uncommented and remove any
|
# Since this key/value is from the source configuration, leave it uncommented and remove any
|
||||||
# sentinel that would cause it to get commented out.
|
# sentinel that would cause it to get commented out.
|
||||||
remove_commented_out_sentinel(destination_config, field_name)
|
remove_commented_out_sentinel(
|
||||||
|
ruamel.yaml.comments.CommentedMap(destination_config), field_name
|
||||||
|
)
|
||||||
|
|
||||||
# This is a mapping. Recurse for this key/value.
|
# This is a mapping. Recurse for this key/value.
|
||||||
if isinstance(source_value, collections.abc.Mapping):
|
if isinstance(source_value, collections.abc.Mapping):
|
||||||
|
@ -251,7 +262,7 @@ def merge_source_configuration_into_destination(destination_config, source_confi
|
||||||
# This is a sequence. Recurse for each item in it.
|
# This is a sequence. Recurse for each item in it.
|
||||||
if isinstance(source_value, collections.abc.Sequence) and not isinstance(source_value, str):
|
if isinstance(source_value, collections.abc.Sequence) and not isinstance(source_value, str):
|
||||||
destination_value = destination_config[field_name]
|
destination_value = destination_config[field_name]
|
||||||
destination_config[field_name] = yaml.comments.CommentedSeq(
|
destination_config[field_name] = ruamel.yaml.comments.CommentedSeq(
|
||||||
[
|
[
|
||||||
merge_source_configuration_into_destination(
|
merge_source_configuration_into_destination(
|
||||||
destination_value[index] if index < len(destination_value) else None,
|
destination_value[index] if index < len(destination_value) else None,
|
||||||
|
@ -262,14 +273,14 @@ def merge_source_configuration_into_destination(destination_config, source_confi
|
||||||
)
|
)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
# This is some sort of scalar. Simply set it into the destination.
|
# This is some sort of scalar. Set it into the destination.
|
||||||
destination_config[field_name] = source_config[field_name]
|
destination_config[field_name] = source_config[field_name]
|
||||||
|
|
||||||
return destination_config
|
return destination_config
|
||||||
|
|
||||||
|
|
||||||
def generate_sample_configuration(
|
def generate_sample_configuration(
|
||||||
source_filename, destination_filename, schema_filename, overwrite=False
|
dry_run, source_filename, destination_filename, schema_filename, overwrite=False
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given an optional source configuration filename, and a required destination configuration
|
Given an optional source configuration filename, and a required destination configuration
|
||||||
|
@ -278,7 +289,7 @@ def generate_sample_configuration(
|
||||||
schema. If a source filename is provided, merge the parsed contents of that configuration into
|
schema. If a source filename is provided, merge the parsed contents of that configuration into
|
||||||
the generated configuration.
|
the generated configuration.
|
||||||
'''
|
'''
|
||||||
schema = yaml.round_trip_load(open(schema_filename))
|
schema = ruamel.yaml.YAML(typ='safe').load(open(schema_filename))
|
||||||
source_config = None
|
source_config = None
|
||||||
|
|
||||||
if source_filename:
|
if source_filename:
|
||||||
|
@ -286,11 +297,14 @@ def generate_sample_configuration(
|
||||||
normalize.normalize(source_filename, source_config)
|
normalize.normalize(source_filename, source_config)
|
||||||
|
|
||||||
destination_config = merge_source_configuration_into_destination(
|
destination_config = merge_source_configuration_into_destination(
|
||||||
_schema_to_sample_configuration(schema), source_config
|
schema_to_sample_configuration(schema), source_config
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
write_configuration(
|
write_configuration(
|
||||||
destination_filename,
|
destination_filename,
|
||||||
_comment_out_optional_configuration(render_configuration(destination_config)),
|
comment_out_optional_configuration(render_configuration(destination_config)),
|
||||||
overwrite=overwrite,
|
overwrite=overwrite,
|
||||||
)
|
)
|
||||||
|
|
|
@ -1,152 +0,0 @@
|
||||||
from collections import OrderedDict, namedtuple
|
|
||||||
from configparser import RawConfigParser
|
|
||||||
|
|
||||||
Section_format = namedtuple('Section_format', ('name', 'options'))
|
|
||||||
Config_option = namedtuple('Config_option', ('name', 'value_type', 'required'))
|
|
||||||
|
|
||||||
|
|
||||||
def option(name, value_type=str, required=True):
|
|
||||||
'''
|
|
||||||
Given a config file option name, an expected type for its value, and whether it's required,
|
|
||||||
return a Config_option capturing that information.
|
|
||||||
'''
|
|
||||||
return Config_option(name, value_type, required)
|
|
||||||
|
|
||||||
|
|
||||||
CONFIG_FORMAT = (
|
|
||||||
Section_format(
|
|
||||||
'location',
|
|
||||||
(
|
|
||||||
option('source_directories'),
|
|
||||||
option('one_file_system', value_type=bool, required=False),
|
|
||||||
option('remote_path', required=False),
|
|
||||||
option('repository'),
|
|
||||||
),
|
|
||||||
),
|
|
||||||
Section_format(
|
|
||||||
'storage',
|
|
||||||
(
|
|
||||||
option('encryption_passphrase', required=False),
|
|
||||||
option('compression', required=False),
|
|
||||||
option('umask', required=False),
|
|
||||||
),
|
|
||||||
),
|
|
||||||
Section_format(
|
|
||||||
'retention',
|
|
||||||
(
|
|
||||||
option('keep_within', required=False),
|
|
||||||
option('keep_hourly', int, required=False),
|
|
||||||
option('keep_daily', int, required=False),
|
|
||||||
option('keep_weekly', int, required=False),
|
|
||||||
option('keep_monthly', int, required=False),
|
|
||||||
option('keep_yearly', int, required=False),
|
|
||||||
option('prefix', required=False),
|
|
||||||
),
|
|
||||||
),
|
|
||||||
Section_format(
|
|
||||||
'consistency', (option('checks', required=False), option('check_last', required=False))
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def validate_configuration_format(parser, config_format):
|
|
||||||
'''
|
|
||||||
Given an open RawConfigParser and an expected config file format, validate that the parsed
|
|
||||||
configuration file has the expected sections, that any required options are present in those
|
|
||||||
sections, and that there aren't any unexpected options.
|
|
||||||
|
|
||||||
A section is required if any of its contained options are required.
|
|
||||||
|
|
||||||
Raise ValueError if anything is awry.
|
|
||||||
'''
|
|
||||||
section_names = set(parser.sections())
|
|
||||||
required_section_names = tuple(
|
|
||||||
section.name
|
|
||||||
for section in config_format
|
|
||||||
if any(option.required for option in section.options)
|
|
||||||
)
|
|
||||||
|
|
||||||
unknown_section_names = section_names - set(
|
|
||||||
section_format.name for section_format in config_format
|
|
||||||
)
|
|
||||||
if unknown_section_names:
|
|
||||||
raise ValueError(
|
|
||||||
'Unknown config sections found: {}'.format(', '.join(unknown_section_names))
|
|
||||||
)
|
|
||||||
|
|
||||||
missing_section_names = set(required_section_names) - section_names
|
|
||||||
if missing_section_names:
|
|
||||||
raise ValueError('Missing config sections: {}'.format(', '.join(missing_section_names)))
|
|
||||||
|
|
||||||
for section_format in config_format:
|
|
||||||
if section_format.name not in section_names:
|
|
||||||
continue
|
|
||||||
|
|
||||||
option_names = parser.options(section_format.name)
|
|
||||||
expected_options = section_format.options
|
|
||||||
|
|
||||||
unexpected_option_names = set(option_names) - set(
|
|
||||||
option.name for option in expected_options
|
|
||||||
)
|
|
||||||
|
|
||||||
if unexpected_option_names:
|
|
||||||
raise ValueError(
|
|
||||||
'Unexpected options found in config section {}: {}'.format(
|
|
||||||
section_format.name, ', '.join(sorted(unexpected_option_names))
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
missing_option_names = tuple(
|
|
||||||
option.name
|
|
||||||
for option in expected_options
|
|
||||||
if option.required
|
|
||||||
if option.name not in option_names
|
|
||||||
)
|
|
||||||
|
|
||||||
if missing_option_names:
|
|
||||||
raise ValueError(
|
|
||||||
'Required options missing from config section {}: {}'.format(
|
|
||||||
section_format.name, ', '.join(missing_option_names)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def parse_section_options(parser, section_format):
|
|
||||||
'''
|
|
||||||
Given an open RawConfigParser and an expected section format, return the option values from that
|
|
||||||
section as a dict mapping from option name to value. Omit those options that are not present in
|
|
||||||
the parsed options.
|
|
||||||
|
|
||||||
Raise ValueError if any option values cannot be coerced to the expected Python data type.
|
|
||||||
'''
|
|
||||||
type_getter = {str: parser.get, int: parser.getint, bool: parser.getboolean}
|
|
||||||
|
|
||||||
return OrderedDict(
|
|
||||||
(option.name, type_getter[option.value_type](section_format.name, option.name))
|
|
||||||
for option in section_format.options
|
|
||||||
if parser.has_option(section_format.name, option.name)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def parse_configuration(config_filename, config_format):
|
|
||||||
'''
|
|
||||||
Given a config filename and an expected config file format, return the parsed configuration
|
|
||||||
as a namedtuple with one attribute for each parsed section.
|
|
||||||
|
|
||||||
Raise IOError if the file cannot be read, or ValueError if the format is not as expected.
|
|
||||||
'''
|
|
||||||
parser = RawConfigParser()
|
|
||||||
if not parser.read(config_filename):
|
|
||||||
raise ValueError('Configuration file cannot be opened: {}'.format(config_filename))
|
|
||||||
|
|
||||||
validate_configuration_format(parser, config_format)
|
|
||||||
|
|
||||||
# Describes a parsed configuration, where each attribute is the name of a configuration file
|
|
||||||
# section and each value is a dict of that section's parsed options.
|
|
||||||
Parsed_config = namedtuple(
|
|
||||||
'Parsed_config', (section_format.name for section_format in config_format)
|
|
||||||
)
|
|
||||||
|
|
||||||
return Parsed_config(
|
|
||||||
*(parse_section_options(parser, section_format) for section_format in config_format)
|
|
||||||
)
|
|
|
@ -1,4 +1,7 @@
|
||||||
|
import functools
|
||||||
|
import itertools
|
||||||
import logging
|
import logging
|
||||||
|
import operator
|
||||||
import os
|
import os
|
||||||
|
|
||||||
import ruamel.yaml
|
import ruamel.yaml
|
||||||
|
@ -6,99 +9,277 @@ import ruamel.yaml
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
class Yaml_with_loader_stream(ruamel.yaml.YAML):
|
def probe_and_include_file(filename, include_directories, config_paths):
|
||||||
'''
|
'''
|
||||||
A derived class of ruamel.yaml.YAML that simply tacks the loaded stream (file object) onto the
|
Given a filename to include, a list of include directories to search for matching files, and a
|
||||||
loader class so that it's available anywhere that's passed a loader (in this case,
|
set of configuration paths, probe for the file, load it, and return the loaded configuration as
|
||||||
include_configuration() below).
|
a data structure of nested dicts, lists, etc. Add the filename to the given configuration paths.
|
||||||
|
|
||||||
|
Raise FileNotFoundError if the included file was not found.
|
||||||
|
'''
|
||||||
|
expanded_filename = os.path.expanduser(filename)
|
||||||
|
|
||||||
|
if os.path.isabs(expanded_filename):
|
||||||
|
return load_configuration(expanded_filename, config_paths)
|
||||||
|
|
||||||
|
candidate_filenames = {
|
||||||
|
os.path.join(directory, expanded_filename) for directory in include_directories
|
||||||
|
}
|
||||||
|
|
||||||
|
for candidate_filename in candidate_filenames:
|
||||||
|
if os.path.exists(candidate_filename):
|
||||||
|
return load_configuration(candidate_filename, config_paths)
|
||||||
|
|
||||||
|
raise FileNotFoundError(
|
||||||
|
f'Could not find include {filename} at {" or ".join(candidate_filenames)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def include_configuration(loader, filename_node, include_directory, config_paths):
|
||||||
|
'''
|
||||||
|
Given a ruamel.yaml.loader.Loader, a ruamel.yaml.nodes.ScalarNode containing the included
|
||||||
|
filename (or a list containing multiple such filenames), an include directory path to search for
|
||||||
|
matching files, and a set of configuration paths, load the given YAML filenames (ignoring the
|
||||||
|
given loader so we can use our own) and return their contents as data structure of nested dicts,
|
||||||
|
lists, etc. Add the names of included files to the given configuration paths. If the given
|
||||||
|
filename node's value is a scalar string, then the return value will be a single value. But if
|
||||||
|
the given node value is a list, then the return value will be a list of values, one per loaded
|
||||||
|
configuration file.
|
||||||
|
|
||||||
|
If a filename is relative, probe for it within: 1. the current working directory and 2. the
|
||||||
|
given include directory.
|
||||||
|
|
||||||
|
Raise FileNotFoundError if an included file was not found.
|
||||||
|
'''
|
||||||
|
include_directories = [os.getcwd(), os.path.abspath(include_directory)]
|
||||||
|
|
||||||
|
if isinstance(filename_node.value, str):
|
||||||
|
return probe_and_include_file(filename_node.value, include_directories, config_paths)
|
||||||
|
|
||||||
|
if (
|
||||||
|
isinstance(filename_node.value, list)
|
||||||
|
and len(filename_node.value)
|
||||||
|
and isinstance(filename_node.value[0], ruamel.yaml.nodes.ScalarNode)
|
||||||
|
):
|
||||||
|
# Reversing the values ensures the correct ordering if these includes are subsequently
|
||||||
|
# merged together.
|
||||||
|
return [
|
||||||
|
probe_and_include_file(node.value, include_directories, config_paths)
|
||||||
|
for node in reversed(filename_node.value)
|
||||||
|
]
|
||||||
|
|
||||||
|
raise ValueError(
|
||||||
|
'!include value is not supported; use a single filename or a list of filenames'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def raise_retain_node_error(loader, node):
|
||||||
|
'''
|
||||||
|
Given a ruamel.yaml.loader.Loader and a YAML node, raise an error about "!retain" usage.
|
||||||
|
|
||||||
|
Raise ValueError if a mapping or sequence node is given, as that indicates that "!retain" was
|
||||||
|
used in a configuration file without a merge. In configuration files with a merge, mapping and
|
||||||
|
sequence nodes with "!retain" tags are handled by deep_merge_nodes() below.
|
||||||
|
|
||||||
|
Also raise ValueError if a scalar node is given, as "!retain" is not supported on scalar nodes.
|
||||||
|
'''
|
||||||
|
if isinstance(node, (ruamel.yaml.nodes.MappingNode, ruamel.yaml.nodes.SequenceNode)):
|
||||||
|
raise ValueError(
|
||||||
|
'The !retain tag may only be used within a configuration file containing a merged !include tag.'
|
||||||
|
)
|
||||||
|
|
||||||
|
raise ValueError('The !retain tag may only be used on a mapping or list.')
|
||||||
|
|
||||||
|
|
||||||
|
def raise_omit_node_error(loader, node):
|
||||||
|
'''
|
||||||
|
Given a ruamel.yaml.loader.Loader and a YAML node, raise an error about "!omit" usage.
|
||||||
|
|
||||||
|
Raise ValueError unconditionally, as an "!omit" node here indicates it was used in a
|
||||||
|
configuration file without a merge. In configuration files with a merge, nodes with "!omit"
|
||||||
|
tags are handled by deep_merge_nodes() below.
|
||||||
|
'''
|
||||||
|
raise ValueError(
|
||||||
|
'The !omit tag may only be used on a scalar (e.g., string) or list element within a configuration file containing a merged !include tag.'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class Include_constructor(ruamel.yaml.SafeConstructor):
|
||||||
|
'''
|
||||||
|
A YAML "constructor" (a ruamel.yaml concept) that supports a custom "!include" tag for including
|
||||||
|
separate YAML configuration files. Example syntax: `option: !include common.yaml`
|
||||||
'''
|
'''
|
||||||
|
|
||||||
def get_constructor_parser(self, stream):
|
def __init__(
|
||||||
constructor, parser = super(Yaml_with_loader_stream, self).get_constructor_parser(stream)
|
self, preserve_quotes=None, loader=None, include_directory=None, config_paths=None
|
||||||
constructor.loader.stream = stream
|
):
|
||||||
return constructor, parser
|
super(Include_constructor, self).__init__(preserve_quotes, loader)
|
||||||
|
self.add_constructor(
|
||||||
|
'!include',
|
||||||
|
functools.partial(
|
||||||
|
include_configuration,
|
||||||
|
include_directory=include_directory,
|
||||||
|
config_paths=config_paths,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
# These are catch-all error handlers for tags that don't get applied and removed by
|
||||||
|
# deep_merge_nodes() below.
|
||||||
|
self.add_constructor('!retain', raise_retain_node_error)
|
||||||
|
self.add_constructor('!omit', raise_omit_node_error)
|
||||||
|
|
||||||
|
def flatten_mapping(self, node):
|
||||||
|
'''
|
||||||
|
Support the special case of deep merging included configuration into an existing mapping
|
||||||
|
using the YAML '<<' merge key. Example syntax:
|
||||||
|
|
||||||
|
```
|
||||||
|
option:
|
||||||
|
sub_option: 1
|
||||||
|
|
||||||
|
<<: !include common.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
These includes are deep merged into the current configuration file. For instance, in this
|
||||||
|
example, any "option" with sub-options in common.yaml will get merged into the corresponding
|
||||||
|
"option" with sub-options in the example configuration file.
|
||||||
|
'''
|
||||||
|
representer = ruamel.yaml.representer.SafeRepresenter()
|
||||||
|
|
||||||
|
for index, (key_node, value_node) in enumerate(node.value):
|
||||||
|
if key_node.tag == u'tag:yaml.org,2002:merge' and value_node.tag == '!include':
|
||||||
|
# Replace the merge include with a sequence of included configuration nodes ready
|
||||||
|
# for merging. The construct_object() call here triggers include_configuration()
|
||||||
|
# among other constructors.
|
||||||
|
node.value[index] = (
|
||||||
|
key_node,
|
||||||
|
representer.represent_data(self.construct_object(value_node)),
|
||||||
|
)
|
||||||
|
|
||||||
|
# This super().flatten_mapping() call actually performs "<<" merges.
|
||||||
|
super(Include_constructor, self).flatten_mapping(node)
|
||||||
|
|
||||||
|
node.value = deep_merge_nodes(node.value)
|
||||||
|
|
||||||
|
|
||||||
def load_configuration(filename):
|
def load_configuration(filename, config_paths=None):
|
||||||
'''
|
'''
|
||||||
Load the given configuration file and return its contents as a data structure of nested dicts
|
Load the given configuration file and return its contents as a data structure of nested dicts
|
||||||
and lists.
|
and lists. Add the filename to the given configuration paths set, and also add any included
|
||||||
|
configuration filenames.
|
||||||
|
|
||||||
Raise ruamel.yaml.error.YAMLError if something goes wrong parsing the YAML, or RecursionError
|
Raise ruamel.yaml.error.YAMLError if something goes wrong parsing the YAML, or RecursionError
|
||||||
if there are too many recursive includes.
|
if there are too many recursive includes.
|
||||||
'''
|
'''
|
||||||
yaml = Yaml_with_loader_stream(typ='safe')
|
if config_paths is None:
|
||||||
yaml.Constructor = Include_constructor
|
config_paths = set()
|
||||||
|
|
||||||
return yaml.load(open(filename))
|
# Use an embedded derived class for the include constructor so as to capture the include
|
||||||
|
# directory and configuration paths values. (functools.partial doesn't work for this use case
|
||||||
|
# because yaml.Constructor has to be an actual class.)
|
||||||
def include_configuration(loader, filename_node):
|
class Include_constructor_with_extras(Include_constructor):
|
||||||
'''
|
def __init__(self, preserve_quotes=None, loader=None):
|
||||||
Load the given YAML filename (ignoring the given loader so we can use our own) and return its
|
super(Include_constructor_with_extras, self).__init__(
|
||||||
contents as a data structure of nested dicts and lists. If the filename is relative, probe for
|
preserve_quotes,
|
||||||
it within 1. the current working directory and 2. the directory containing the YAML file doing
|
loader,
|
||||||
the including.
|
include_directory=os.path.dirname(filename),
|
||||||
|
config_paths=config_paths,
|
||||||
Raise FileNotFoundError if an included file was not found.
|
|
||||||
'''
|
|
||||||
include_directories = [os.getcwd(), os.path.abspath(os.path.dirname(loader.stream.name))]
|
|
||||||
include_filename = os.path.expanduser(filename_node.value)
|
|
||||||
|
|
||||||
if not os.path.isabs(include_filename):
|
|
||||||
candidate_filenames = [
|
|
||||||
os.path.join(directory, include_filename) for directory in include_directories
|
|
||||||
]
|
|
||||||
|
|
||||||
for candidate_filename in candidate_filenames:
|
|
||||||
if os.path.exists(candidate_filename):
|
|
||||||
include_filename = candidate_filename
|
|
||||||
break
|
|
||||||
else:
|
|
||||||
raise FileNotFoundError(
|
|
||||||
f'Could not find include {filename_node.value} at {" or ".join(candidate_filenames)}'
|
|
||||||
)
|
)
|
||||||
|
|
||||||
return load_configuration(include_filename)
|
yaml = ruamel.yaml.YAML(typ='safe')
|
||||||
|
yaml.Constructor = Include_constructor_with_extras
|
||||||
|
config_paths.add(filename)
|
||||||
|
|
||||||
|
with open(filename) as file:
|
||||||
|
return yaml.load(file.read())
|
||||||
|
|
||||||
|
|
||||||
DELETED_NODE = object()
|
def filter_omitted_nodes(nodes, values):
|
||||||
|
'''
|
||||||
|
Given a nested borgmatic configuration data structure as a list of tuples in the form of:
|
||||||
|
|
||||||
|
[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode as a key,
|
||||||
|
ruamel.yaml.nodes.MappingNode or other Node as a value,
|
||||||
|
),
|
||||||
|
...
|
||||||
|
]
|
||||||
|
|
||||||
|
... and a combined list of all values for those nodes, return a filtered list of the values,
|
||||||
|
omitting any that have an "!omit" tag (or with a value matching such nodes).
|
||||||
|
|
||||||
|
But if only a single node is given, bail and return the given values unfiltered, as "!omit" only
|
||||||
|
applies when there are merge includes (and therefore multiple nodes).
|
||||||
|
'''
|
||||||
|
if len(nodes) <= 1:
|
||||||
|
return values
|
||||||
|
|
||||||
|
omitted_values = tuple(node.value for node in values if node.tag == '!omit')
|
||||||
|
|
||||||
|
return [node for node in values if node.value not in omitted_values]
|
||||||
|
|
||||||
|
|
||||||
|
def merge_values(nodes):
|
||||||
|
'''
|
||||||
|
Given a nested borgmatic configuration data structure as a list of tuples in the form of:
|
||||||
|
|
||||||
|
[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode as a key,
|
||||||
|
ruamel.yaml.nodes.MappingNode or other Node as a value,
|
||||||
|
),
|
||||||
|
...
|
||||||
|
]
|
||||||
|
|
||||||
|
... merge its sequence or mapping node values and return the result. For sequence nodes, this
|
||||||
|
means appending together its contained lists. For mapping nodes, it means merging its contained
|
||||||
|
dicts.
|
||||||
|
'''
|
||||||
|
return functools.reduce(operator.add, (value.value for key, value in nodes))
|
||||||
|
|
||||||
|
|
||||||
def deep_merge_nodes(nodes):
|
def deep_merge_nodes(nodes):
|
||||||
'''
|
'''
|
||||||
Given a nested borgmatic configuration data structure as a list of tuples in the form of:
|
Given a nested borgmatic configuration data structure as a list of tuples in the form of:
|
||||||
|
|
||||||
|
[
|
||||||
(
|
(
|
||||||
ruamel.yaml.nodes.ScalarNode as a key,
|
ruamel.yaml.nodes.ScalarNode as a key,
|
||||||
ruamel.yaml.nodes.MappingNode or other Node as a value,
|
ruamel.yaml.nodes.MappingNode or other Node as a value,
|
||||||
),
|
),
|
||||||
|
...
|
||||||
|
]
|
||||||
|
|
||||||
... deep merge any node values corresponding to duplicate keys and return the result. If
|
... deep merge any node values corresponding to duplicate keys and return the result. The
|
||||||
there are colliding keys with non-MappingNode values (e.g., integers or strings), the last
|
purpose of merging like this is to support, for instance, merging one borgmatic configuration
|
||||||
of the values wins.
|
file into another for reuse, such that a configuration option with sub-options does not
|
||||||
|
completely replace the corresponding option in a merged file.
|
||||||
|
|
||||||
|
If there are colliding keys with scalar values (e.g., integers or strings), the last of the
|
||||||
|
values wins.
|
||||||
|
|
||||||
For instance, given node values of:
|
For instance, given node values of:
|
||||||
|
|
||||||
[
|
[
|
||||||
(
|
(
|
||||||
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
ScalarNode(tag='tag:yaml.org,2002:str', value='option'),
|
||||||
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
(
|
(
|
||||||
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_hourly'),
|
ScalarNode(tag='tag:yaml.org,2002:str', value='sub_option1'),
|
||||||
ScalarNode(tag='tag:yaml.org,2002:int', value='24')
|
ScalarNode(tag='tag:yaml.org,2002:int', value='1')
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
ScalarNode(tag='tag:yaml.org,2002:str', value='sub_option2'),
|
||||||
ScalarNode(tag='tag:yaml.org,2002:int', value='7')
|
ScalarNode(tag='tag:yaml.org,2002:int', value='2')
|
||||||
),
|
),
|
||||||
]),
|
]),
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
ScalarNode(tag='tag:yaml.org,2002:str', value='option'),
|
||||||
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
(
|
(
|
||||||
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
ScalarNode(tag='tag:yaml.org,2002:str', value='sub_option2'),
|
||||||
ScalarNode(tag='tag:yaml.org,2002:int', value='5')
|
ScalarNode(tag='tag:yaml.org,2002:int', value='5')
|
||||||
),
|
),
|
||||||
]),
|
]),
|
||||||
|
@ -109,107 +290,95 @@ def deep_merge_nodes(nodes):
|
||||||
|
|
||||||
[
|
[
|
||||||
(
|
(
|
||||||
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
ScalarNode(tag='tag:yaml.org,2002:str', value='option'),
|
||||||
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
(
|
(
|
||||||
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_hourly'),
|
ScalarNode(tag='tag:yaml.org,2002:str', value='sub_option1'),
|
||||||
ScalarNode(tag='tag:yaml.org,2002:int', value='24')
|
ScalarNode(tag='tag:yaml.org,2002:int', value='1')
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
ScalarNode(tag='tag:yaml.org,2002:str', value='sub_option2'),
|
||||||
ScalarNode(tag='tag:yaml.org,2002:int', value='5')
|
ScalarNode(tag='tag:yaml.org,2002:int', value='5')
|
||||||
),
|
),
|
||||||
]),
|
]),
|
||||||
),
|
),
|
||||||
]
|
]
|
||||||
|
|
||||||
The purpose of deep merging like this is to support, for instance, merging one borgmatic
|
This function supports multi-way merging, meaning that if the same option name exists three or
|
||||||
configuration file into another for reuse, such that a configuration section ("retention",
|
more times (at the same scope level), all of those instances get merged together.
|
||||||
etc.) does not completely replace the corresponding section in a merged file.
|
|
||||||
|
If a mapping or sequence node has a YAML "!retain" tag, then that node is not merged.
|
||||||
|
|
||||||
|
Raise ValueError if a merge is implied using multiple incompatible types.
|
||||||
'''
|
'''
|
||||||
# Map from original node key/value to the replacement merged node. DELETED_NODE as a replacement
|
merged_nodes = []
|
||||||
# node indications deletion.
|
|
||||||
replaced_nodes = {}
|
|
||||||
|
|
||||||
# To find nodes that require merging, compare each node with each other node.
|
def get_node_key_name(node):
|
||||||
for a_key, a_value in nodes:
|
return node[0].value
|
||||||
for b_key, b_value in nodes:
|
|
||||||
# If we've already considered one of the nodes for merging, skip it.
|
|
||||||
if (a_key, a_value) in replaced_nodes or (b_key, b_value) in replaced_nodes:
|
|
||||||
continue
|
|
||||||
|
|
||||||
# If the keys match and the values are different, we need to merge these two A and B nodes.
|
# Bucket the nodes by their keys. Then merge all of the values sharing the same key.
|
||||||
if a_key.tag == b_key.tag and a_key.value == b_key.value and a_value != b_value:
|
for key_name, grouped_nodes in itertools.groupby(
|
||||||
# Since we're merging into the B node, consider the A node a duplicate and remove it.
|
sorted(nodes, key=get_node_key_name), get_node_key_name
|
||||||
replaced_nodes[(a_key, a_value)] = DELETED_NODE
|
):
|
||||||
|
grouped_nodes = list(grouped_nodes)
|
||||||
|
|
||||||
# If we're dealing with MappingNodes, recurse and merge its values as well.
|
# The merged node inherits its attributes from the final node in the group.
|
||||||
if isinstance(b_value, ruamel.yaml.nodes.MappingNode):
|
(last_node_key, last_node_value) = grouped_nodes[-1]
|
||||||
replaced_nodes[(b_key, b_value)] = (
|
value_types = set(type(value) for (_, value) in grouped_nodes)
|
||||||
b_key,
|
|
||||||
|
if len(value_types) > 1:
|
||||||
|
raise ValueError(
|
||||||
|
f'Incompatible types found when trying to merge "{key_name}:" values across configuration files: {", ".join(value_type.id for value_type in value_types)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
# If we're dealing with MappingNodes, recurse and merge its values as well.
|
||||||
|
if ruamel.yaml.nodes.MappingNode in value_types:
|
||||||
|
# A "!retain" tag says to skip deep merging for this node. Replace the tag so
|
||||||
|
# downstream schema validation doesn't break on our application-specific tag.
|
||||||
|
if last_node_value.tag == '!retain' and len(grouped_nodes) > 1:
|
||||||
|
last_node_value.tag = 'tag:yaml.org,2002:map'
|
||||||
|
merged_nodes.append((last_node_key, last_node_value))
|
||||||
|
else:
|
||||||
|
merged_nodes.append(
|
||||||
|
(
|
||||||
|
last_node_key,
|
||||||
ruamel.yaml.nodes.MappingNode(
|
ruamel.yaml.nodes.MappingNode(
|
||||||
tag=b_value.tag,
|
tag=last_node_value.tag,
|
||||||
value=deep_merge_nodes(a_value.value + b_value.value),
|
value=deep_merge_nodes(merge_values(grouped_nodes)),
|
||||||
start_mark=b_value.start_mark,
|
start_mark=last_node_value.start_mark,
|
||||||
end_mark=b_value.end_mark,
|
end_mark=last_node_value.end_mark,
|
||||||
flow_style=b_value.flow_style,
|
flow_style=last_node_value.flow_style,
|
||||||
comment=b_value.comment,
|
comment=last_node_value.comment,
|
||||||
anchor=b_value.anchor,
|
anchor=last_node_value.anchor,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
# If we're dealing with SequenceNodes, merge by appending one sequence to the other.
|
)
|
||||||
elif isinstance(b_value, ruamel.yaml.nodes.SequenceNode):
|
|
||||||
replaced_nodes[(b_key, b_value)] = (
|
continue
|
||||||
b_key,
|
|
||||||
|
# If we're dealing with SequenceNodes, merge by appending sequences together.
|
||||||
|
if ruamel.yaml.nodes.SequenceNode in value_types:
|
||||||
|
if last_node_value.tag == '!retain' and len(grouped_nodes) > 1:
|
||||||
|
last_node_value.tag = 'tag:yaml.org,2002:seq'
|
||||||
|
merged_nodes.append((last_node_key, last_node_value))
|
||||||
|
else:
|
||||||
|
merged_nodes.append(
|
||||||
|
(
|
||||||
|
last_node_key,
|
||||||
ruamel.yaml.nodes.SequenceNode(
|
ruamel.yaml.nodes.SequenceNode(
|
||||||
tag=b_value.tag,
|
tag=last_node_value.tag,
|
||||||
value=a_value.value + b_value.value,
|
value=filter_omitted_nodes(grouped_nodes, merge_values(grouped_nodes)),
|
||||||
start_mark=b_value.start_mark,
|
start_mark=last_node_value.start_mark,
|
||||||
end_mark=b_value.end_mark,
|
end_mark=last_node_value.end_mark,
|
||||||
flow_style=b_value.flow_style,
|
flow_style=last_node_value.flow_style,
|
||||||
comment=b_value.comment,
|
comment=last_node_value.comment,
|
||||||
anchor=b_value.anchor,
|
anchor=last_node_value.anchor,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
)
|
||||||
|
|
||||||
return [
|
continue
|
||||||
replaced_nodes.get(node, node) for node in nodes if replaced_nodes.get(node) != DELETED_NODE
|
|
||||||
]
|
|
||||||
|
|
||||||
|
merged_nodes.append((last_node_key, last_node_value))
|
||||||
|
|
||||||
class Include_constructor(ruamel.yaml.SafeConstructor):
|
return merged_nodes
|
||||||
'''
|
|
||||||
A YAML "constructor" (a ruamel.yaml concept) that supports a custom "!include" tag for including
|
|
||||||
separate YAML configuration files. Example syntax: `retention: !include common.yaml`
|
|
||||||
'''
|
|
||||||
|
|
||||||
def __init__(self, preserve_quotes=None, loader=None):
|
|
||||||
super(Include_constructor, self).__init__(preserve_quotes, loader)
|
|
||||||
self.add_constructor('!include', include_configuration)
|
|
||||||
|
|
||||||
def flatten_mapping(self, node):
|
|
||||||
'''
|
|
||||||
Support the special case of deep merging included configuration into an existing mapping
|
|
||||||
using the YAML '<<' merge key. Example syntax:
|
|
||||||
|
|
||||||
```
|
|
||||||
retention:
|
|
||||||
keep_daily: 1
|
|
||||||
|
|
||||||
<<: !include common.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
These includes are deep merged into the current configuration file. For instance, in this
|
|
||||||
example, any "retention" options in common.yaml will get merged into the "retention" section
|
|
||||||
in the example configuration file.
|
|
||||||
'''
|
|
||||||
representer = ruamel.yaml.representer.SafeRepresenter()
|
|
||||||
|
|
||||||
for index, (key_node, value_node) in enumerate(node.value):
|
|
||||||
if key_node.tag == u'tag:yaml.org,2002:merge' and value_node.tag == '!include':
|
|
||||||
included_value = representer.represent_data(self.construct_object(value_node))
|
|
||||||
node.value[index] = (key_node, included_value)
|
|
||||||
|
|
||||||
super(Include_constructor, self).flatten_mapping(node)
|
|
||||||
|
|
||||||
node.value = deep_merge_nodes(node.value)
|
|
||||||
|
|
|
@ -1,4 +1,61 @@
|
||||||
import logging
|
import logging
|
||||||
|
import os
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_sections(config_filename, config):
|
||||||
|
'''
|
||||||
|
Given a configuration filename and a configuration dict of its loaded contents, airlift any
|
||||||
|
options out of sections ("location:", etc.) to the global scope and delete those sections.
|
||||||
|
Return any log message warnings produced based on the normalization performed.
|
||||||
|
|
||||||
|
Raise ValueError if the "prefix" option is set in both "location" and "consistency" sections.
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
location = config.get('location') or {}
|
||||||
|
except AttributeError:
|
||||||
|
raise ValueError('Configuration does not contain any options')
|
||||||
|
|
||||||
|
storage = config.get('storage') or {}
|
||||||
|
consistency = config.get('consistency') or {}
|
||||||
|
hooks = config.get('hooks') or {}
|
||||||
|
|
||||||
|
if (
|
||||||
|
location.get('prefix')
|
||||||
|
and consistency.get('prefix')
|
||||||
|
and location.get('prefix') != consistency.get('prefix')
|
||||||
|
):
|
||||||
|
raise ValueError(
|
||||||
|
'The retention prefix and the consistency prefix cannot have different values (unless one is not set).'
|
||||||
|
)
|
||||||
|
|
||||||
|
if storage.get('umask') and hooks.get('umask') and storage.get('umask') != hooks.get('umask'):
|
||||||
|
raise ValueError(
|
||||||
|
'The storage umask and the hooks umask cannot have different values (unless one is not set).'
|
||||||
|
)
|
||||||
|
|
||||||
|
any_section_upgraded = False
|
||||||
|
|
||||||
|
# Move any options from deprecated sections into the global scope.
|
||||||
|
for section_name in ('location', 'storage', 'retention', 'consistency', 'output', 'hooks'):
|
||||||
|
section_config = config.get(section_name)
|
||||||
|
|
||||||
|
if section_config is not None:
|
||||||
|
any_section_upgraded = True
|
||||||
|
del config[section_name]
|
||||||
|
config.update(section_config)
|
||||||
|
|
||||||
|
if any_section_upgraded:
|
||||||
|
return [
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: Configuration sections (like location:, storage:, retention:, consistency:, and hooks:) are deprecated and support will be removed from a future release. To prepare for this, move your options out of sections to the global scope.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
]
|
||||||
|
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
def normalize(config_filename, config):
|
def normalize(config_filename, config):
|
||||||
|
@ -6,83 +63,207 @@ def normalize(config_filename, config):
|
||||||
Given a configuration filename and a configuration dict of its loaded contents, apply particular
|
Given a configuration filename and a configuration dict of its loaded contents, apply particular
|
||||||
hard-coded rules to normalize the configuration to adhere to the current schema. Return any log
|
hard-coded rules to normalize the configuration to adhere to the current schema. Return any log
|
||||||
message warnings produced based on the normalization performed.
|
message warnings produced based on the normalization performed.
|
||||||
|
|
||||||
|
Raise ValueError the configuration cannot be normalized.
|
||||||
'''
|
'''
|
||||||
logs = []
|
logs = normalize_sections(config_filename, config)
|
||||||
location = config.get('location') or {}
|
|
||||||
storage = config.get('storage') or {}
|
|
||||||
consistency = config.get('consistency') or {}
|
|
||||||
hooks = config.get('hooks') or {}
|
|
||||||
|
|
||||||
# Upgrade exclude_if_present from a string to a list.
|
# Upgrade exclude_if_present from a string to a list.
|
||||||
exclude_if_present = location.get('exclude_if_present')
|
exclude_if_present = config.get('exclude_if_present')
|
||||||
if isinstance(exclude_if_present, str):
|
if isinstance(exclude_if_present, str):
|
||||||
config['location']['exclude_if_present'] = [exclude_if_present]
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The exclude_if_present option now expects a list value. String values for this option are deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['exclude_if_present'] = [exclude_if_present]
|
||||||
|
|
||||||
# Upgrade various monitoring hooks from a string to a dict.
|
# Upgrade various monitoring hooks from a string to a dict.
|
||||||
healthchecks = hooks.get('healthchecks')
|
healthchecks = config.get('healthchecks')
|
||||||
if isinstance(healthchecks, str):
|
if isinstance(healthchecks, str):
|
||||||
config['hooks']['healthchecks'] = {'ping_url': healthchecks}
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The healthchecks hook now expects a key/value pair with "ping_url" as a key. String values for this option are deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['healthchecks'] = {'ping_url': healthchecks}
|
||||||
|
|
||||||
cronitor = hooks.get('cronitor')
|
cronitor = config.get('cronitor')
|
||||||
if isinstance(cronitor, str):
|
if isinstance(cronitor, str):
|
||||||
config['hooks']['cronitor'] = {'ping_url': cronitor}
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The healthchecks hook now expects key/value pairs. String values for this option are deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['cronitor'] = {'ping_url': cronitor}
|
||||||
|
|
||||||
pagerduty = hooks.get('pagerduty')
|
pagerduty = config.get('pagerduty')
|
||||||
if isinstance(pagerduty, str):
|
if isinstance(pagerduty, str):
|
||||||
config['hooks']['pagerduty'] = {'integration_key': pagerduty}
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The healthchecks hook now expects key/value pairs. String values for this option are deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['pagerduty'] = {'integration_key': pagerduty}
|
||||||
|
|
||||||
cronhub = hooks.get('cronhub')
|
cronhub = config.get('cronhub')
|
||||||
if isinstance(cronhub, str):
|
if isinstance(cronhub, str):
|
||||||
config['hooks']['cronhub'] = {'ping_url': cronhub}
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The healthchecks hook now expects key/value pairs. String values for this option are deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['cronhub'] = {'ping_url': cronhub}
|
||||||
|
|
||||||
# Upgrade consistency checks from a list of strings to a list of dicts.
|
# Upgrade consistency checks from a list of strings to a list of dicts.
|
||||||
checks = consistency.get('checks')
|
checks = config.get('checks')
|
||||||
if isinstance(checks, list) and len(checks) and isinstance(checks[0], str):
|
if isinstance(checks, list) and len(checks) and isinstance(checks[0], str):
|
||||||
config['consistency']['checks'] = [{'name': check_type} for check_type in checks]
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The checks option now expects a list of key/value pairs. Lists of strings for this option are deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['checks'] = [{'name': check_type} for check_type in checks]
|
||||||
|
|
||||||
# Rename various configuration options.
|
# Rename various configuration options.
|
||||||
numeric_owner = location.pop('numeric_owner', None)
|
numeric_owner = config.pop('numeric_owner', None)
|
||||||
if numeric_owner is not None:
|
if numeric_owner is not None:
|
||||||
config['location']['numeric_ids'] = numeric_owner
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The numeric_owner option has been renamed to numeric_ids. numeric_owner is deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['numeric_ids'] = numeric_owner
|
||||||
|
|
||||||
bsd_flags = location.pop('bsd_flags', None)
|
bsd_flags = config.pop('bsd_flags', None)
|
||||||
if bsd_flags is not None:
|
if bsd_flags is not None:
|
||||||
config['location']['flags'] = bsd_flags
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The bsd_flags option has been renamed to flags. bsd_flags is deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['flags'] = bsd_flags
|
||||||
|
|
||||||
remote_rate_limit = storage.pop('remote_rate_limit', None)
|
remote_rate_limit = config.pop('remote_rate_limit', None)
|
||||||
if remote_rate_limit is not None:
|
if remote_rate_limit is not None:
|
||||||
config['storage']['upload_rate_limit'] = remote_rate_limit
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The remote_rate_limit option has been renamed to upload_rate_limit. remote_rate_limit is deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['upload_rate_limit'] = remote_rate_limit
|
||||||
|
|
||||||
# Upgrade remote repositories to ssh:// syntax, required in Borg 2.
|
# Upgrade remote repositories to ssh:// syntax, required in Borg 2.
|
||||||
repositories = location.get('repositories')
|
repositories = config.get('repositories')
|
||||||
if repositories:
|
if repositories:
|
||||||
config['location']['repositories'] = []
|
if any(isinstance(repository, str) for repository in repositories):
|
||||||
for repository in repositories:
|
logs.append(
|
||||||
if '~' in repository:
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The repositories option now expects a list of key/value pairs. Lists of strings for this option are deprecated and support will be removed from a future release.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['repositories'] = [
|
||||||
|
{'path': repository} if isinstance(repository, str) else repository
|
||||||
|
for repository in repositories
|
||||||
|
]
|
||||||
|
repositories = config['repositories']
|
||||||
|
|
||||||
|
config['repositories'] = []
|
||||||
|
|
||||||
|
for repository_dict in repositories:
|
||||||
|
repository_path = repository_dict['path']
|
||||||
|
if '~' in repository_path:
|
||||||
logs.append(
|
logs.append(
|
||||||
logging.makeLogRecord(
|
logging.makeLogRecord(
|
||||||
dict(
|
dict(
|
||||||
levelno=logging.WARNING,
|
levelno=logging.WARNING,
|
||||||
levelname='WARNING',
|
levelname='WARNING',
|
||||||
msg=f'{config_filename}: Repository paths containing "~" are deprecated in borgmatic and no longer work in Borg 2.x+.',
|
msg=f'{config_filename}: Repository paths containing "~" are deprecated in borgmatic and support will be removed from a future release.',
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
if ':' in repository and not repository.startswith('ssh://'):
|
if ':' in repository_path:
|
||||||
rewritten_repository = (
|
if repository_path.startswith('file://'):
|
||||||
f"ssh://{repository.replace(':~', '/~').replace(':/', '/').replace(':', '/./')}"
|
updated_repository_path = os.path.abspath(
|
||||||
)
|
repository_path.partition('file://')[-1]
|
||||||
logs.append(
|
)
|
||||||
logging.makeLogRecord(
|
config['repositories'].append(
|
||||||
dict(
|
dict(
|
||||||
levelno=logging.WARNING,
|
repository_dict,
|
||||||
levelname='WARNING',
|
path=updated_repository_path,
|
||||||
msg=f'{config_filename}: Remote repository paths without ssh:// syntax are deprecated. Interpreting "{repository}" as "{rewritten_repository}"',
|
)
|
||||||
|
)
|
||||||
|
elif repository_path.startswith('ssh://'):
|
||||||
|
config['repositories'].append(repository_dict)
|
||||||
|
else:
|
||||||
|
rewritten_repository_path = f"ssh://{repository_path.replace(':~', '/~').replace(':/', '/').replace(':', '/./')}"
|
||||||
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: Remote repository paths without ssh:// syntax are deprecated and support will be removed from a future release. Interpreting "{repository_path}" as "{rewritten_repository_path}"',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
config['repositories'].append(
|
||||||
|
dict(
|
||||||
|
repository_dict,
|
||||||
|
path=rewritten_repository_path,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
)
|
|
||||||
config['location']['repositories'].append(rewritten_repository)
|
|
||||||
else:
|
else:
|
||||||
config['location']['repositories'].append(repository)
|
config['repositories'].append(repository_dict)
|
||||||
|
|
||||||
|
if config.get('prefix'):
|
||||||
|
logs.append(
|
||||||
|
logging.makeLogRecord(
|
||||||
|
dict(
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
levelname='WARNING',
|
||||||
|
msg=f'{config_filename}: The prefix option is deprecated and support will be removed from a future release. Use archive_name_format or match_archives instead.',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
return logs
|
return logs
|
||||||
|
|
|
@ -13,6 +13,11 @@ def set_values(config, keys, value):
|
||||||
|
|
||||||
first_key = keys[0]
|
first_key = keys[0]
|
||||||
if len(keys) == 1:
|
if len(keys) == 1:
|
||||||
|
if isinstance(config, list):
|
||||||
|
raise ValueError(
|
||||||
|
'When overriding a list option, the value must use list syntax (e.g., "[foo, bar]" or "[{key: value}]" as appropriate)'
|
||||||
|
)
|
||||||
|
|
||||||
config[first_key] = value
|
config[first_key] = value
|
||||||
return
|
return
|
||||||
|
|
||||||
|
@ -22,29 +27,70 @@ def set_values(config, keys, value):
|
||||||
set_values(config[first_key], keys[1:], value)
|
set_values(config[first_key], keys[1:], value)
|
||||||
|
|
||||||
|
|
||||||
def convert_value_type(value):
|
def convert_value_type(value, option_type):
|
||||||
'''
|
'''
|
||||||
Given a string value, determine its logical type (string, boolean, integer, etc.), and return it
|
Given a string value and its schema type as a string, determine its logical type (string,
|
||||||
converted to that type.
|
boolean, integer, etc.), and return it converted to that type.
|
||||||
|
|
||||||
|
If the option type is a string, leave the value as a string so that special characters in it
|
||||||
|
don't get interpreted as YAML during conversion.
|
||||||
|
|
||||||
Raise ruamel.yaml.error.YAMLError if there's a parse issue with the YAML.
|
Raise ruamel.yaml.error.YAMLError if there's a parse issue with the YAML.
|
||||||
'''
|
'''
|
||||||
|
if option_type == 'string':
|
||||||
|
return value
|
||||||
|
|
||||||
return ruamel.yaml.YAML(typ='safe').load(io.StringIO(value))
|
return ruamel.yaml.YAML(typ='safe').load(io.StringIO(value))
|
||||||
|
|
||||||
|
|
||||||
def parse_overrides(raw_overrides):
|
LEGACY_SECTION_NAMES = {'location', 'storage', 'retention', 'consistency', 'output', 'hooks'}
|
||||||
'''
|
|
||||||
Given a sequence of configuration file override strings in the form of "section.option=value",
|
|
||||||
parse and return a sequence of tuples (keys, values), where keys is a sequence of strings. For
|
|
||||||
instance, given the following raw overrides:
|
|
||||||
|
|
||||||
['section.my_option=value1', 'section.other_option=value2']
|
|
||||||
|
def strip_section_names(parsed_override_key):
|
||||||
|
'''
|
||||||
|
Given a parsed override key as a tuple of option and suboption names, strip out any initial
|
||||||
|
legacy section names, since configuration file normalization also strips them out.
|
||||||
|
'''
|
||||||
|
if parsed_override_key[0] in LEGACY_SECTION_NAMES:
|
||||||
|
return parsed_override_key[1:]
|
||||||
|
|
||||||
|
return parsed_override_key
|
||||||
|
|
||||||
|
|
||||||
|
def type_for_option(schema, option_keys):
|
||||||
|
'''
|
||||||
|
Given a configuration schema and a sequence of keys identifying an option, e.g.
|
||||||
|
('extra_borg_options', 'init'), return the schema type of that option as a string.
|
||||||
|
|
||||||
|
Return None if the option or its type cannot be found in the schema.
|
||||||
|
'''
|
||||||
|
option_schema = schema
|
||||||
|
|
||||||
|
for key in option_keys:
|
||||||
|
try:
|
||||||
|
option_schema = option_schema['properties'][key]
|
||||||
|
except KeyError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
try:
|
||||||
|
return option_schema['type']
|
||||||
|
except KeyError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def parse_overrides(raw_overrides, schema):
|
||||||
|
'''
|
||||||
|
Given a sequence of configuration file override strings in the form of "option.suboption=value"
|
||||||
|
and a configuration schema dict, parse and return a sequence of tuples (keys, values), where
|
||||||
|
keys is a sequence of strings. For instance, given the following raw overrides:
|
||||||
|
|
||||||
|
['my_option.suboption=value1', 'other_option=value2']
|
||||||
|
|
||||||
... return this:
|
... return this:
|
||||||
|
|
||||||
(
|
(
|
||||||
(('section', 'my_option'), 'value1'),
|
(('my_option', 'suboption'), 'value1'),
|
||||||
(('section', 'other_option'), 'value2'),
|
(('other_option'), 'value2'),
|
||||||
)
|
)
|
||||||
|
|
||||||
Raise ValueError if an override can't be parsed.
|
Raise ValueError if an override can't be parsed.
|
||||||
|
@ -57,10 +103,18 @@ def parse_overrides(raw_overrides):
|
||||||
for raw_override in raw_overrides:
|
for raw_override in raw_overrides:
|
||||||
try:
|
try:
|
||||||
raw_keys, value = raw_override.split('=', 1)
|
raw_keys, value = raw_override.split('=', 1)
|
||||||
parsed_overrides.append((tuple(raw_keys.split('.')), convert_value_type(value),))
|
keys = tuple(raw_keys.split('.'))
|
||||||
|
option_type = type_for_option(schema, keys)
|
||||||
|
|
||||||
|
parsed_overrides.append(
|
||||||
|
(
|
||||||
|
keys,
|
||||||
|
convert_value_type(value, option_type),
|
||||||
|
)
|
||||||
|
)
|
||||||
except ValueError:
|
except ValueError:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
f"Invalid override '{raw_override}'. Make sure you use the form: SECTION.OPTION=VALUE"
|
f"Invalid override '{raw_override}'. Make sure you use the form: OPTION=VALUE or OPTION.SUBOPTION=VALUE"
|
||||||
)
|
)
|
||||||
except ruamel.yaml.error.YAMLError as error:
|
except ruamel.yaml.error.YAMLError as error:
|
||||||
raise ValueError(f"Invalid override '{raw_override}': {error.problem}")
|
raise ValueError(f"Invalid override '{raw_override}': {error.problem}")
|
||||||
|
@ -68,12 +122,18 @@ def parse_overrides(raw_overrides):
|
||||||
return tuple(parsed_overrides)
|
return tuple(parsed_overrides)
|
||||||
|
|
||||||
|
|
||||||
def apply_overrides(config, raw_overrides):
|
def apply_overrides(config, schema, raw_overrides):
|
||||||
'''
|
'''
|
||||||
Given a configuration dict and a sequence of configuration file override strings in the form of
|
Given a configuration dict, a corresponding configuration schema dict, and a sequence of
|
||||||
"section.option=value", parse each override and set it the configuration dict.
|
configuration file override strings in the form of "option.suboption=value", parse each override
|
||||||
'''
|
and set it into the configuration dict.
|
||||||
overrides = parse_overrides(raw_overrides)
|
|
||||||
|
|
||||||
for (keys, value) in overrides:
|
Set the overrides into the configuration both with and without deprecated section names (if
|
||||||
|
used), so that the overrides work regardless of whether the configuration is also using
|
||||||
|
deprecated section names.
|
||||||
|
'''
|
||||||
|
overrides = parse_overrides(raw_overrides, schema)
|
||||||
|
|
||||||
|
for keys, value in overrides:
|
||||||
set_values(config, keys, value)
|
set_values(config, keys, value)
|
||||||
|
set_values(config, strip_section_names(keys), value)
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -1,18 +1,23 @@
|
||||||
import os
|
import os
|
||||||
|
|
||||||
import jsonschema
|
import jsonschema
|
||||||
import pkg_resources
|
|
||||||
import ruamel.yaml
|
import ruamel.yaml
|
||||||
|
|
||||||
from borgmatic.config import environment, load, normalize, override
|
import borgmatic.config
|
||||||
|
from borgmatic.config import constants, environment, load, normalize, override
|
||||||
|
|
||||||
|
|
||||||
def schema_filename():
|
def schema_filename():
|
||||||
'''
|
'''
|
||||||
Path to the installed YAML configuration schema file, used to validate and parse the
|
Path to the installed YAML configuration schema file, used to validate and parse the
|
||||||
configuration.
|
configuration.
|
||||||
|
|
||||||
|
Raise FileNotFoundError when the schema path does not exist.
|
||||||
'''
|
'''
|
||||||
return pkg_resources.resource_filename('borgmatic', 'config/schema.yaml')
|
schema_path = os.path.join(os.path.dirname(borgmatic.config.__file__), 'schema.yaml')
|
||||||
|
|
||||||
|
with open(schema_path):
|
||||||
|
return schema_path
|
||||||
|
|
||||||
|
|
||||||
def format_json_error_path_element(path_element):
|
def format_json_error_path_element(path_element):
|
||||||
|
@ -20,9 +25,9 @@ def format_json_error_path_element(path_element):
|
||||||
Given a path element into a JSON data structure, format it for display as a string.
|
Given a path element into a JSON data structure, format it for display as a string.
|
||||||
'''
|
'''
|
||||||
if isinstance(path_element, int):
|
if isinstance(path_element, int):
|
||||||
return str('[{}]'.format(path_element))
|
return str(f'[{path_element}]')
|
||||||
|
|
||||||
return str('.{}'.format(path_element))
|
return str(f'.{path_element}')
|
||||||
|
|
||||||
|
|
||||||
def format_json_error(error):
|
def format_json_error(error):
|
||||||
|
@ -30,10 +35,10 @@ def format_json_error(error):
|
||||||
Given an instance of jsonschema.exceptions.ValidationError, format it for display as a string.
|
Given an instance of jsonschema.exceptions.ValidationError, format it for display as a string.
|
||||||
'''
|
'''
|
||||||
if not error.path:
|
if not error.path:
|
||||||
return 'At the top level: {}'.format(error.message)
|
return f'At the top level: {error.message}'
|
||||||
|
|
||||||
formatted_path = ''.join(format_json_error_path_element(element) for element in error.path)
|
formatted_path = ''.join(format_json_error_path_element(element) for element in error.path)
|
||||||
return "At '{}': {}".format(formatted_path.lstrip('.'), error.message)
|
return f"At '{formatted_path.lstrip('.')}': {error.message}"
|
||||||
|
|
||||||
|
|
||||||
class Validation_error(ValueError):
|
class Validation_error(ValueError):
|
||||||
|
@ -54,9 +59,10 @@ class Validation_error(ValueError):
|
||||||
'''
|
'''
|
||||||
Render a validation error as a user-facing string.
|
Render a validation error as a user-facing string.
|
||||||
'''
|
'''
|
||||||
return 'An error occurred while parsing a configuration file at {}:\n'.format(
|
return (
|
||||||
self.config_filename
|
f'An error occurred while parsing a configuration file at {self.config_filename}:\n'
|
||||||
) + '\n'.join(error for error in self.errors)
|
+ '\n'.join(error for error in self.errors)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def apply_logical_validation(config_filename, parsed_configuration):
|
def apply_logical_validation(config_filename, parsed_configuration):
|
||||||
|
@ -65,17 +71,15 @@ def apply_logical_validation(config_filename, parsed_configuration):
|
||||||
below), run through any additional logical validation checks. If there are any such validation
|
below), run through any additional logical validation checks. If there are any such validation
|
||||||
problems, raise a Validation_error.
|
problems, raise a Validation_error.
|
||||||
'''
|
'''
|
||||||
location_repositories = parsed_configuration.get('location', {}).get('repositories')
|
repositories = parsed_configuration.get('repositories')
|
||||||
check_repositories = parsed_configuration.get('consistency', {}).get('check_repositories', [])
|
check_repositories = parsed_configuration.get('check_repositories', [])
|
||||||
for repository in check_repositories:
|
for repository in check_repositories:
|
||||||
if repository not in location_repositories:
|
if not any(
|
||||||
|
repositories_match(repository, config_repository) for config_repository in repositories
|
||||||
|
):
|
||||||
raise Validation_error(
|
raise Validation_error(
|
||||||
config_filename,
|
config_filename,
|
||||||
(
|
(f'Unknown repository in "check_repositories": {repository}',),
|
||||||
'Unknown repository in the "consistency" section\'s "check_repositories": {}'.format(
|
|
||||||
repository
|
|
||||||
),
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -83,29 +87,38 @@ def parse_configuration(config_filename, schema_filename, overrides=None, resolv
|
||||||
'''
|
'''
|
||||||
Given the path to a config filename in YAML format, the path to a schema filename in a YAML
|
Given the path to a config filename in YAML format, the path to a schema filename in a YAML
|
||||||
rendition of JSON Schema format, a sequence of configuration file override strings in the form
|
rendition of JSON Schema format, a sequence of configuration file override strings in the form
|
||||||
of "section.option=value", return the parsed configuration as a data structure of nested dicts
|
of "option.suboption=value", return the parsed configuration as a data structure of nested dicts
|
||||||
and lists corresponding to the schema. Example return value:
|
and lists corresponding to the schema. Example return value:
|
||||||
|
|
||||||
{'location': {'source_directories': ['/home', '/etc'], 'repository': 'hostname.borg'},
|
{
|
||||||
'retention': {'keep_daily': 7}, 'consistency': {'checks': ['repository', 'archives']}}
|
'source_directories': ['/home', '/etc'],
|
||||||
|
'repository': 'hostname.borg',
|
||||||
|
'keep_daily': 7,
|
||||||
|
'checks': ['repository', 'archives'],
|
||||||
|
}
|
||||||
|
|
||||||
Also return a sequence of logging.LogRecord instances containing any warnings about the
|
Also return a set of loaded configuration paths and a sequence of logging.LogRecord instances
|
||||||
configuration.
|
containing any warnings about the configuration.
|
||||||
|
|
||||||
Raise FileNotFoundError if the file does not exist, PermissionError if the user does not
|
Raise FileNotFoundError if the file does not exist, PermissionError if the user does not
|
||||||
have permissions to read the file, or Validation_error if the config does not match the schema.
|
have permissions to read the file, or Validation_error if the config does not match the schema.
|
||||||
'''
|
'''
|
||||||
|
config_paths = set()
|
||||||
|
|
||||||
try:
|
try:
|
||||||
config = load.load_configuration(config_filename)
|
config = load.load_configuration(config_filename, config_paths)
|
||||||
schema = load.load_configuration(schema_filename)
|
schema = load.load_configuration(schema_filename)
|
||||||
except (ruamel.yaml.error.YAMLError, RecursionError) as error:
|
except (ruamel.yaml.error.YAMLError, RecursionError) as error:
|
||||||
raise Validation_error(config_filename, (str(error),))
|
raise Validation_error(config_filename, (str(error),))
|
||||||
|
|
||||||
override.apply_overrides(config, overrides)
|
override.apply_overrides(config, schema, overrides)
|
||||||
logs = normalize.normalize(config_filename, config)
|
constants.apply_constants(config, config.get('constants') if config else {})
|
||||||
|
|
||||||
if resolve_env:
|
if resolve_env:
|
||||||
environment.resolve_env_variables(config)
|
environment.resolve_env_variables(config)
|
||||||
|
|
||||||
|
logs = normalize.normalize(config_filename, config)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
validator = jsonschema.Draft7Validator(schema)
|
validator = jsonschema.Draft7Validator(schema)
|
||||||
except AttributeError: # pragma: no cover
|
except AttributeError: # pragma: no cover
|
||||||
|
@ -119,35 +132,45 @@ def parse_configuration(config_filename, schema_filename, overrides=None, resolv
|
||||||
|
|
||||||
apply_logical_validation(config_filename, config)
|
apply_logical_validation(config_filename, config)
|
||||||
|
|
||||||
return config, logs
|
return config, config_paths, logs
|
||||||
|
|
||||||
|
|
||||||
def normalize_repository_path(repository):
|
def normalize_repository_path(repository):
|
||||||
'''
|
'''
|
||||||
Given a repository path, return the absolute path of it (for local repositories).
|
Given a repository path, return the absolute path of it (for local repositories).
|
||||||
'''
|
'''
|
||||||
# A colon in the repository indicates it's a remote repository. Bail.
|
# A colon in the repository could mean that it's either a file:// URL or a remote repository.
|
||||||
if ':' in repository:
|
# If it's a remote repository, we don't want to normalize it. If it's a file:// URL, we do.
|
||||||
|
if ':' not in repository:
|
||||||
|
return os.path.abspath(repository)
|
||||||
|
elif repository.startswith('file://'):
|
||||||
|
return os.path.abspath(repository.partition('file://')[-1])
|
||||||
|
else:
|
||||||
return repository
|
return repository
|
||||||
|
|
||||||
return os.path.abspath(repository)
|
|
||||||
|
|
||||||
|
|
||||||
def repositories_match(first, second):
|
def repositories_match(first, second):
|
||||||
'''
|
'''
|
||||||
Given two repository paths (relative and/or absolute), return whether they match.
|
Given two repository dicts with keys 'path' (relative and/or absolute),
|
||||||
|
and 'label', or two repository paths, return whether they match.
|
||||||
'''
|
'''
|
||||||
return normalize_repository_path(first) == normalize_repository_path(second)
|
if isinstance(first, str):
|
||||||
|
first = {'path': first, 'label': first}
|
||||||
|
if isinstance(second, str):
|
||||||
|
second = {'path': second, 'label': second}
|
||||||
|
return (first.get('label') == second.get('label')) or (
|
||||||
|
normalize_repository_path(first.get('path'))
|
||||||
|
== normalize_repository_path(second.get('path'))
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def guard_configuration_contains_repository(repository, configurations):
|
def guard_configuration_contains_repository(repository, configurations):
|
||||||
'''
|
'''
|
||||||
Given a repository path and a dict mapping from config filename to corresponding parsed config
|
Given a repository path and a dict mapping from config filename to corresponding parsed config
|
||||||
dict, ensure that the repository is declared exactly once in all of the configurations. If no
|
dict, ensure that the repository is declared at least once in all of the configurations. If no
|
||||||
repository is given, skip this check.
|
repository is given, skip this check.
|
||||||
|
|
||||||
Raise ValueError if the repository is not found in a configuration, or is declared multiple
|
Raise ValueError if the repository is not found in any configurations.
|
||||||
times.
|
|
||||||
'''
|
'''
|
||||||
if not repository:
|
if not repository:
|
||||||
return
|
return
|
||||||
|
@ -156,15 +179,13 @@ def guard_configuration_contains_repository(repository, configurations):
|
||||||
tuple(
|
tuple(
|
||||||
config_repository
|
config_repository
|
||||||
for config in configurations.values()
|
for config in configurations.values()
|
||||||
for config_repository in config['location']['repositories']
|
for config_repository in config['repositories']
|
||||||
if repositories_match(repository, config_repository)
|
if repositories_match(config_repository, repository)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
if count == 0:
|
if count == 0:
|
||||||
raise ValueError('Repository {} not found in configuration files'.format(repository))
|
raise ValueError(f'Repository "{repository}" not found in configuration files')
|
||||||
if count > 1:
|
|
||||||
raise ValueError('Repository {} found in multiple configuration files'.format(repository))
|
|
||||||
|
|
||||||
|
|
||||||
def guard_single_repository_selected(repository, configurations):
|
def guard_single_repository_selected(repository, configurations):
|
||||||
|
@ -180,11 +201,11 @@ def guard_single_repository_selected(repository, configurations):
|
||||||
tuple(
|
tuple(
|
||||||
config_repository
|
config_repository
|
||||||
for config in configurations.values()
|
for config in configurations.values()
|
||||||
for config_repository in config['location']['repositories']
|
for config_repository in config['repositories']
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
if count != 1:
|
if count != 1:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
'Can\'t determine which repository to use. Use --repository to disambiguate'
|
"Can't determine which repository to use. Use --repository to disambiguate"
|
||||||
)
|
)
|
||||||
|
|
|
@ -1,31 +1,70 @@
|
||||||
import collections
|
import collections
|
||||||
|
import enum
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import select
|
import select
|
||||||
import subprocess
|
import subprocess
|
||||||
|
import textwrap
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
ERROR_OUTPUT_MAX_LINE_COUNT = 25
|
ERROR_OUTPUT_MAX_LINE_COUNT = 25
|
||||||
BORG_ERROR_EXIT_CODE = 2
|
BORG_ERROR_EXIT_CODE_START = 2
|
||||||
|
BORG_ERROR_EXIT_CODE_END = 99
|
||||||
|
|
||||||
|
|
||||||
def exit_code_indicates_error(process, exit_code, borg_local_path=None):
|
class Exit_status(enum.Enum):
|
||||||
|
STILL_RUNNING = 1
|
||||||
|
SUCCESS = 2
|
||||||
|
WARNING = 3
|
||||||
|
ERROR = 4
|
||||||
|
|
||||||
|
|
||||||
|
def interpret_exit_code(command, exit_code, borg_local_path=None, borg_exit_codes=None):
|
||||||
'''
|
'''
|
||||||
Return True if the given exit code from running a command corresponds to an error. If a Borg
|
Return an Exit_status value (e.g. SUCCESS, ERROR, or WARNING) based on interpreting the given
|
||||||
local path is given and matches the process' command, then treat exit code 1 as a warning
|
exit code. If a Borg local path is given and matches the process' command, then interpret the
|
||||||
instead of an error.
|
exit code based on Borg's documented exit code semantics. And if Borg exit codes are given as a
|
||||||
|
sequence of exit code configuration dicts, then take those configured preferences into account.
|
||||||
'''
|
'''
|
||||||
if exit_code is None:
|
if exit_code is None:
|
||||||
return False
|
return Exit_status.STILL_RUNNING
|
||||||
|
if exit_code == 0:
|
||||||
command = process.args.split(' ') if isinstance(process.args, str) else process.args
|
return Exit_status.SUCCESS
|
||||||
|
|
||||||
if borg_local_path and command[0] == borg_local_path:
|
if borg_local_path and command[0] == borg_local_path:
|
||||||
return bool(exit_code < 0 or exit_code >= BORG_ERROR_EXIT_CODE)
|
# First try looking for the exit code in the borg_exit_codes configuration.
|
||||||
|
for entry in borg_exit_codes or ():
|
||||||
|
if entry.get('code') == exit_code:
|
||||||
|
treat_as = entry.get('treat_as')
|
||||||
|
|
||||||
return bool(exit_code != 0)
|
if treat_as == 'error':
|
||||||
|
logger.error(
|
||||||
|
f'Treating exit code {exit_code} as an error, as per configuration'
|
||||||
|
)
|
||||||
|
return Exit_status.ERROR
|
||||||
|
elif treat_as == 'warning':
|
||||||
|
logger.warning(
|
||||||
|
f'Treating exit code {exit_code} as a warning, as per configuration'
|
||||||
|
)
|
||||||
|
return Exit_status.WARNING
|
||||||
|
|
||||||
|
# If the exit code doesn't have explicit configuration, then fall back to the default Borg
|
||||||
|
# behavior.
|
||||||
|
return (
|
||||||
|
Exit_status.ERROR
|
||||||
|
if (
|
||||||
|
exit_code < 0
|
||||||
|
or (
|
||||||
|
exit_code >= BORG_ERROR_EXIT_CODE_START
|
||||||
|
and exit_code <= BORG_ERROR_EXIT_CODE_END
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else Exit_status.WARNING
|
||||||
|
)
|
||||||
|
|
||||||
|
return Exit_status.ERROR
|
||||||
|
|
||||||
|
|
||||||
def command_for_process(process):
|
def command_for_process(process):
|
||||||
|
@ -45,14 +84,33 @@ def output_buffer_for_process(process, exclude_stdouts):
|
||||||
return process.stderr if process.stdout in exclude_stdouts else process.stdout
|
return process.stderr if process.stdout in exclude_stdouts else process.stdout
|
||||||
|
|
||||||
|
|
||||||
def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
|
def append_last_lines(last_lines, captured_output, line, output_log_level):
|
||||||
|
'''
|
||||||
|
Given a rolling list of last lines, a list of captured output, a line to append, and an output
|
||||||
|
log level, append the line to the last lines and (if necessary) the captured output. Then log
|
||||||
|
the line at the requested output log level.
|
||||||
|
'''
|
||||||
|
last_lines.append(line)
|
||||||
|
|
||||||
|
if len(last_lines) > ERROR_OUTPUT_MAX_LINE_COUNT:
|
||||||
|
last_lines.pop(0)
|
||||||
|
|
||||||
|
if output_log_level is None:
|
||||||
|
captured_output.append(line)
|
||||||
|
else:
|
||||||
|
logger.log(output_log_level, line)
|
||||||
|
|
||||||
|
|
||||||
|
def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path, borg_exit_codes):
|
||||||
'''
|
'''
|
||||||
Given a sequence of subprocess.Popen() instances for multiple processes, log the output for each
|
Given a sequence of subprocess.Popen() instances for multiple processes, log the output for each
|
||||||
process with the requested log level. Additionally, raise a CalledProcessError if a process
|
process with the requested log level. Additionally, raise a CalledProcessError if a process
|
||||||
exits with an error (or a warning for exit code 1, if that process matches the Borg local path).
|
exits with an error (or a warning for exit code 1, if that process does not match the Borg local
|
||||||
|
path).
|
||||||
|
|
||||||
If output log level is None, then instead of logging, capture output for each process and return
|
If output log level is None, then instead of logging, capture output for each process and return
|
||||||
it as a dict from the process to its output.
|
it as a dict from the process to its output. Use the given Borg local path and exit code
|
||||||
|
configuration to decide what's an error and what's a warning.
|
||||||
|
|
||||||
For simplicity, it's assumed that the output buffer for each process is its stdout. But if any
|
For simplicity, it's assumed that the output buffer for each process is its stdout. But if any
|
||||||
stdouts are given to exclude, then for any matching processes, log from their stderr instead.
|
stdouts are given to exclude, then for any matching processes, log from their stderr instead.
|
||||||
|
@ -99,15 +157,12 @@ def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
|
||||||
|
|
||||||
# Keep the last few lines of output in case the process errors, and we need the output for
|
# Keep the last few lines of output in case the process errors, and we need the output for
|
||||||
# the exception below.
|
# the exception below.
|
||||||
last_lines = buffer_last_lines[ready_buffer]
|
append_last_lines(
|
||||||
last_lines.append(line)
|
buffer_last_lines[ready_buffer],
|
||||||
if len(last_lines) > ERROR_OUTPUT_MAX_LINE_COUNT:
|
captured_outputs[ready_process],
|
||||||
last_lines.pop(0)
|
line,
|
||||||
|
output_log_level,
|
||||||
if output_log_level is None:
|
)
|
||||||
captured_outputs[ready_process].append(line)
|
|
||||||
else:
|
|
||||||
logger.log(output_log_level, line)
|
|
||||||
|
|
||||||
if not still_running:
|
if not still_running:
|
||||||
break
|
break
|
||||||
|
@ -119,14 +174,28 @@ def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
|
||||||
|
|
||||||
if exit_code is None:
|
if exit_code is None:
|
||||||
still_running = True
|
still_running = True
|
||||||
|
command = process.args.split(' ') if isinstance(process.args, str) else process.args
|
||||||
|
continue
|
||||||
|
|
||||||
# If any process errors, then raise accordingly.
|
command = process.args.split(' ') if isinstance(process.args, str) else process.args
|
||||||
if exit_code_indicates_error(process, exit_code, borg_local_path):
|
exit_status = interpret_exit_code(command, exit_code, borg_local_path, borg_exit_codes)
|
||||||
|
|
||||||
|
if exit_status in (Exit_status.ERROR, Exit_status.WARNING):
|
||||||
# If an error occurs, include its output in the raised exception so that we don't
|
# If an error occurs, include its output in the raised exception so that we don't
|
||||||
# inadvertently hide error output.
|
# inadvertently hide error output.
|
||||||
output_buffer = output_buffer_for_process(process, exclude_stdouts)
|
output_buffer = output_buffer_for_process(process, exclude_stdouts)
|
||||||
|
|
||||||
last_lines = buffer_last_lines[output_buffer] if output_buffer else []
|
last_lines = buffer_last_lines[output_buffer] if output_buffer else []
|
||||||
|
|
||||||
|
# Collect any straggling output lines that came in since we last gathered output.
|
||||||
|
while output_buffer: # pragma: no cover
|
||||||
|
line = output_buffer.readline().rstrip().decode()
|
||||||
|
if not line:
|
||||||
|
break
|
||||||
|
|
||||||
|
append_last_lines(
|
||||||
|
last_lines, captured_outputs[process], line, output_log_level=logging.ERROR
|
||||||
|
)
|
||||||
|
|
||||||
if len(last_lines) == ERROR_OUTPUT_MAX_LINE_COUNT:
|
if len(last_lines) == ERROR_OUTPUT_MAX_LINE_COUNT:
|
||||||
last_lines.insert(0, '...')
|
last_lines.insert(0, '...')
|
||||||
|
|
||||||
|
@ -137,9 +206,13 @@ def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
|
||||||
other_process.stdout.read(0)
|
other_process.stdout.read(0)
|
||||||
other_process.kill()
|
other_process.kill()
|
||||||
|
|
||||||
raise subprocess.CalledProcessError(
|
if exit_status == Exit_status.ERROR:
|
||||||
exit_code, command_for_process(process), '\n'.join(last_lines)
|
raise subprocess.CalledProcessError(
|
||||||
)
|
exit_code, command_for_process(process), '\n'.join(last_lines)
|
||||||
|
)
|
||||||
|
|
||||||
|
still_running = False
|
||||||
|
break
|
||||||
|
|
||||||
if captured_outputs:
|
if captured_outputs:
|
||||||
return {
|
return {
|
||||||
|
@ -147,19 +220,47 @@ def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path):
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def log_command(full_command, input_file=None, output_file=None):
|
SECRET_COMMAND_FLAG_NAMES = {'--password'}
|
||||||
|
|
||||||
|
|
||||||
|
def mask_command_secrets(full_command):
|
||||||
|
'''
|
||||||
|
Given a command as a sequence, mask secret values for flags like "--password" in preparation for
|
||||||
|
logging.
|
||||||
|
'''
|
||||||
|
masked_command = []
|
||||||
|
previous_piece = None
|
||||||
|
|
||||||
|
for piece in full_command:
|
||||||
|
masked_command.append('***' if previous_piece in SECRET_COMMAND_FLAG_NAMES else piece)
|
||||||
|
previous_piece = piece
|
||||||
|
|
||||||
|
return tuple(masked_command)
|
||||||
|
|
||||||
|
|
||||||
|
MAX_LOGGED_COMMAND_LENGTH = 1000
|
||||||
|
|
||||||
|
|
||||||
|
def log_command(full_command, input_file=None, output_file=None, environment=None):
|
||||||
'''
|
'''
|
||||||
Log the given command (a sequence of command/argument strings), along with its input/output file
|
Log the given command (a sequence of command/argument strings), along with its input/output file
|
||||||
paths.
|
paths and extra environment variables (with omitted values in case they contain passwords).
|
||||||
'''
|
'''
|
||||||
logger.debug(
|
logger.debug(
|
||||||
' '.join(full_command)
|
textwrap.shorten(
|
||||||
+ (' < {}'.format(getattr(input_file, 'name', '')) if input_file else '')
|
' '.join(
|
||||||
+ (' > {}'.format(getattr(output_file, 'name', '')) if output_file else '')
|
tuple(f'{key}=***' for key in (environment or {}).keys())
|
||||||
|
+ mask_command_secrets(full_command)
|
||||||
|
),
|
||||||
|
width=MAX_LOGGED_COMMAND_LENGTH,
|
||||||
|
placeholder=' ...',
|
||||||
|
)
|
||||||
|
+ (f" < {getattr(input_file, 'name', '')}" if input_file else '')
|
||||||
|
+ (f" > {getattr(output_file, 'name', '')}" if output_file else '')
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
# An sentinel passed as an output file to execute_command() to indicate that the command's output
|
# A sentinel passed as an output file to execute_command() to indicate that the command's output
|
||||||
# should be allowed to flow through to stdout without being captured for logging. Useful for
|
# should be allowed to flow through to stdout without being captured for logging. Useful for
|
||||||
# commands with interactive prompts or those that mess directly with the console.
|
# commands with interactive prompts or those that mess directly with the console.
|
||||||
DO_NOT_CAPTURE = object()
|
DO_NOT_CAPTURE = object()
|
||||||
|
@ -174,6 +275,7 @@ def execute_command(
|
||||||
extra_environment=None,
|
extra_environment=None,
|
||||||
working_directory=None,
|
working_directory=None,
|
||||||
borg_local_path=None,
|
borg_local_path=None,
|
||||||
|
borg_exit_codes=None,
|
||||||
run_to_completion=True,
|
run_to_completion=True,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
|
@ -184,12 +286,13 @@ def execute_command(
|
||||||
augment the current environment, and pass the result into the command. If a working directory is
|
augment the current environment, and pass the result into the command. If a working directory is
|
||||||
given, use that as the present working directory when running the command. If a Borg local path
|
given, use that as the present working directory when running the command. If a Borg local path
|
||||||
is given, and the command matches it (regardless of arguments), treat exit code 1 as a warning
|
is given, and the command matches it (regardless of arguments), treat exit code 1 as a warning
|
||||||
instead of an error. If run to completion is False, then return the process for the command
|
instead of an error. But if Borg exit codes are given as a sequence of exit code configuration
|
||||||
without executing it to completion.
|
dicts, then use that configuration to decide what's an error and what's a warning. If run to
|
||||||
|
completion is False, then return the process for the command without executing it to completion.
|
||||||
|
|
||||||
Raise subprocesses.CalledProcessError if an error occurs while running the command.
|
Raise subprocesses.CalledProcessError if an error occurs while running the command.
|
||||||
'''
|
'''
|
||||||
log_command(full_command, input_file, output_file)
|
log_command(full_command, input_file, output_file, extra_environment)
|
||||||
environment = {**os.environ, **extra_environment} if extra_environment else None
|
environment = {**os.environ, **extra_environment} if extra_environment else None
|
||||||
do_not_capture = bool(output_file is DO_NOT_CAPTURE)
|
do_not_capture = bool(output_file is DO_NOT_CAPTURE)
|
||||||
command = ' '.join(full_command) if shell else full_command
|
command = ' '.join(full_command) if shell else full_command
|
||||||
|
@ -207,33 +310,55 @@ def execute_command(
|
||||||
return process
|
return process
|
||||||
|
|
||||||
log_outputs(
|
log_outputs(
|
||||||
(process,), (input_file, output_file), output_log_level, borg_local_path=borg_local_path
|
(process,),
|
||||||
|
(input_file, output_file),
|
||||||
|
output_log_level,
|
||||||
|
borg_local_path,
|
||||||
|
borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def execute_command_and_capture_output(
|
def execute_command_and_capture_output(
|
||||||
full_command, capture_stderr=False, shell=False, extra_environment=None, working_directory=None,
|
full_command,
|
||||||
|
capture_stderr=False,
|
||||||
|
shell=False,
|
||||||
|
extra_environment=None,
|
||||||
|
working_directory=None,
|
||||||
|
borg_local_path=None,
|
||||||
|
borg_exit_codes=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Execute the given command (a sequence of command/argument strings), capturing and returning its
|
Execute the given command (a sequence of command/argument strings), capturing and returning its
|
||||||
output (stdout). If capture stderr is True, then capture and return stderr in addition to
|
output (stdout). If capture stderr is True, then capture and return stderr in addition to
|
||||||
stdout. If shell is True, execute the command within a shell. If an extra environment dict is
|
stdout. If shell is True, execute the command within a shell. If an extra environment dict is
|
||||||
given, then use it to augment the current environment, and pass the result into the command. If
|
given, then use it to augment the current environment, and pass the result into the command. If
|
||||||
a working directory is given, use that as the present working directory when running the command.
|
a working directory is given, use that as the present working directory when running the
|
||||||
|
command. If a Borg local path is given, and the command matches it (regardless of arguments),
|
||||||
|
treat exit code 1 as a warning instead of an error. But if Borg exit codes are given as a
|
||||||
|
sequence of exit code configuration dicts, then use that configuration to decide what's an error
|
||||||
|
and what's a warning.
|
||||||
|
|
||||||
Raise subprocesses.CalledProcessError if an error occurs while running the command.
|
Raise subprocesses.CalledProcessError if an error occurs while running the command.
|
||||||
'''
|
'''
|
||||||
log_command(full_command)
|
log_command(full_command, environment=extra_environment)
|
||||||
environment = {**os.environ, **extra_environment} if extra_environment else None
|
environment = {**os.environ, **extra_environment} if extra_environment else None
|
||||||
command = ' '.join(full_command) if shell else full_command
|
command = ' '.join(full_command) if shell else full_command
|
||||||
|
|
||||||
output = subprocess.check_output(
|
try:
|
||||||
command,
|
output = subprocess.check_output(
|
||||||
stderr=subprocess.STDOUT if capture_stderr else None,
|
command,
|
||||||
shell=shell,
|
stderr=subprocess.STDOUT if capture_stderr else None,
|
||||||
env=environment,
|
shell=shell,
|
||||||
cwd=working_directory,
|
env=environment,
|
||||||
)
|
cwd=working_directory,
|
||||||
|
)
|
||||||
|
except subprocess.CalledProcessError as error:
|
||||||
|
if (
|
||||||
|
interpret_exit_code(command, error.returncode, borg_local_path, borg_exit_codes)
|
||||||
|
== Exit_status.ERROR
|
||||||
|
):
|
||||||
|
raise
|
||||||
|
output = error.output
|
||||||
|
|
||||||
return output.decode() if output is not None else None
|
return output.decode() if output is not None else None
|
||||||
|
|
||||||
|
@ -248,6 +373,7 @@ def execute_command_with_processes(
|
||||||
extra_environment=None,
|
extra_environment=None,
|
||||||
working_directory=None,
|
working_directory=None,
|
||||||
borg_local_path=None,
|
borg_local_path=None,
|
||||||
|
borg_exit_codes=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Execute the given command (a sequence of command/argument strings) and log its output at the
|
Execute the given command (a sequence of command/argument strings) and log its output at the
|
||||||
|
@ -262,12 +388,14 @@ def execute_command_with_processes(
|
||||||
use it to augment the current environment, and pass the result into the command. If a working
|
use it to augment the current environment, and pass the result into the command. If a working
|
||||||
directory is given, use that as the present working directory when running the command. If a
|
directory is given, use that as the present working directory when running the command. If a
|
||||||
Borg local path is given, then for any matching command or process (regardless of arguments),
|
Borg local path is given, then for any matching command or process (regardless of arguments),
|
||||||
treat exit code 1 as a warning instead of an error.
|
treat exit code 1 as a warning instead of an error. But if Borg exit codes are given as a
|
||||||
|
sequence of exit code configuration dicts, then use that configuration to decide what's an error
|
||||||
|
and what's a warning.
|
||||||
|
|
||||||
Raise subprocesses.CalledProcessError if an error occurs while running the command or in the
|
Raise subprocesses.CalledProcessError if an error occurs while running the command or in the
|
||||||
upstream process.
|
upstream process.
|
||||||
'''
|
'''
|
||||||
log_command(full_command, input_file, output_file)
|
log_command(full_command, input_file, output_file, extra_environment)
|
||||||
environment = {**os.environ, **extra_environment} if extra_environment else None
|
environment = {**os.environ, **extra_environment} if extra_environment else None
|
||||||
do_not_capture = bool(output_file is DO_NOT_CAPTURE)
|
do_not_capture = bool(output_file is DO_NOT_CAPTURE)
|
||||||
command = ' '.join(full_command) if shell else full_command
|
command = ' '.join(full_command) if shell else full_command
|
||||||
|
@ -277,9 +405,9 @@ def execute_command_with_processes(
|
||||||
command,
|
command,
|
||||||
stdin=input_file,
|
stdin=input_file,
|
||||||
stdout=None if do_not_capture else (output_file or subprocess.PIPE),
|
stdout=None if do_not_capture else (output_file or subprocess.PIPE),
|
||||||
stderr=None
|
stderr=(
|
||||||
if do_not_capture
|
None if do_not_capture else (subprocess.PIPE if output_file else subprocess.STDOUT)
|
||||||
else (subprocess.PIPE if output_file else subprocess.STDOUT),
|
),
|
||||||
shell=shell,
|
shell=shell,
|
||||||
env=environment,
|
env=environment,
|
||||||
cwd=working_directory,
|
cwd=working_directory,
|
||||||
|
@ -297,7 +425,8 @@ def execute_command_with_processes(
|
||||||
tuple(processes) + (command_process,),
|
tuple(processes) + (command_process,),
|
||||||
(input_file, output_file),
|
(input_file, output_file),
|
||||||
output_log_level,
|
output_log_level,
|
||||||
borg_local_path=borg_local_path,
|
borg_local_path,
|
||||||
|
borg_exit_codes,
|
||||||
)
|
)
|
||||||
|
|
||||||
if output_log_level is None:
|
if output_log_level is None:
|
||||||
|
|
109
borgmatic/hooks/apprise.py
Normal file
109
borgmatic/hooks/apprise.py
Normal file
|
@ -0,0 +1,109 @@
|
||||||
|
import logging
|
||||||
|
import operator
|
||||||
|
|
||||||
|
import borgmatic.hooks.logs
|
||||||
|
import borgmatic.hooks.monitor
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
DEFAULT_LOGS_SIZE_LIMIT_BYTES = 100000
|
||||||
|
HANDLER_IDENTIFIER = 'apprise'
|
||||||
|
|
||||||
|
|
||||||
|
def initialize_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Add a handler to the root logger that stores in memory the most recent logs emitted. That way,
|
||||||
|
we can send them all to an Apprise notification service upon a finish or failure state. But skip
|
||||||
|
this if the "send_logs" option is false.
|
||||||
|
'''
|
||||||
|
if hook_config.get('send_logs') is False:
|
||||||
|
return
|
||||||
|
|
||||||
|
logs_size_limit = max(
|
||||||
|
hook_config.get('logs_size_limit', DEFAULT_LOGS_SIZE_LIMIT_BYTES)
|
||||||
|
- len(borgmatic.hooks.logs.PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
|
0,
|
||||||
|
)
|
||||||
|
|
||||||
|
borgmatic.hooks.logs.add_handler(
|
||||||
|
borgmatic.hooks.logs.Forgetful_buffering_handler(
|
||||||
|
HANDLER_IDENTIFIER, logs_size_limit, monitoring_log_level
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Ping the configured Apprise service URLs. Use the given configuration filename in any log
|
||||||
|
entries. If this is a dry run, then don't actually ping anything.
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
import apprise
|
||||||
|
from apprise import NotifyFormat, NotifyType
|
||||||
|
except ImportError: # pragma: no cover
|
||||||
|
logger.warning('Unable to import Apprise in monitoring hook')
|
||||||
|
return
|
||||||
|
|
||||||
|
state_to_notify_type = {
|
||||||
|
'start': NotifyType.INFO,
|
||||||
|
'finish': NotifyType.SUCCESS,
|
||||||
|
'fail': NotifyType.FAILURE,
|
||||||
|
'log': NotifyType.INFO,
|
||||||
|
}
|
||||||
|
|
||||||
|
run_states = hook_config.get('states', ['fail'])
|
||||||
|
|
||||||
|
if state.name.lower() not in run_states:
|
||||||
|
return
|
||||||
|
|
||||||
|
state_config = hook_config.get(
|
||||||
|
state.name.lower(),
|
||||||
|
{
|
||||||
|
'title': f'A borgmatic {state.name} event happened',
|
||||||
|
'body': f'A borgmatic {state.name} event happened',
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
if not hook_config.get('services'):
|
||||||
|
logger.info(f'{config_filename}: No Apprise services to ping')
|
||||||
|
return
|
||||||
|
|
||||||
|
dry_run_string = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
|
labels_string = ', '.join(map(operator.itemgetter('label'), hook_config.get('services')))
|
||||||
|
logger.info(f'{config_filename}: Pinging Apprise services: {labels_string}{dry_run_string}')
|
||||||
|
|
||||||
|
apprise_object = apprise.Apprise()
|
||||||
|
apprise_object.add(list(map(operator.itemgetter('url'), hook_config.get('services'))))
|
||||||
|
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
body = state_config.get('body')
|
||||||
|
|
||||||
|
if state in (
|
||||||
|
borgmatic.hooks.monitor.State.FINISH,
|
||||||
|
borgmatic.hooks.monitor.State.FAIL,
|
||||||
|
borgmatic.hooks.monitor.State.LOG,
|
||||||
|
):
|
||||||
|
formatted_logs = borgmatic.hooks.logs.format_buffered_logs_for_payload(HANDLER_IDENTIFIER)
|
||||||
|
if formatted_logs:
|
||||||
|
body += f'\n\n{formatted_logs}'
|
||||||
|
|
||||||
|
result = apprise_object.notify(
|
||||||
|
title=state_config.get('title', ''),
|
||||||
|
body=body,
|
||||||
|
body_format=NotifyFormat.TEXT,
|
||||||
|
notify_type=state_to_notify_type[state.name.lower()],
|
||||||
|
)
|
||||||
|
|
||||||
|
if result is False:
|
||||||
|
logger.warning(f'{config_filename}: Error sending some Apprise notifications')
|
||||||
|
|
||||||
|
|
||||||
|
def destroy_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Remove the monitor handler that was added to the root logger. This prevents the handler from
|
||||||
|
getting reused by other instances of this monitor.
|
||||||
|
'''
|
||||||
|
borgmatic.hooks.logs.remove_handler(HANDLER_IDENTIFIER)
|
|
@ -1,6 +1,7 @@
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
|
import shlex
|
||||||
|
|
||||||
from borgmatic import execute
|
from borgmatic import execute
|
||||||
|
|
||||||
|
@ -16,7 +17,7 @@ def interpolate_context(config_filename, hook_description, command, context):
|
||||||
names/values, interpolate the values by "{name}" into the command and return the result.
|
names/values, interpolate the values by "{name}" into the command and return the result.
|
||||||
'''
|
'''
|
||||||
for name, value in context.items():
|
for name, value in context.items():
|
||||||
command = command.replace('{%s}' % name, str(value))
|
command = command.replace(f'{{{name}}}', shlex.quote(str(value)))
|
||||||
|
|
||||||
for unsupported_variable in re.findall(r'{\w+}', command):
|
for unsupported_variable in re.findall(r'{\w+}', command):
|
||||||
logger.warning(
|
logger.warning(
|
||||||
|
@ -38,7 +39,7 @@ def execute_hook(commands, umask, config_filename, description, dry_run, **conte
|
||||||
Raise subprocesses.CalledProcessError if an error occurs in a hook.
|
Raise subprocesses.CalledProcessError if an error occurs in a hook.
|
||||||
'''
|
'''
|
||||||
if not commands:
|
if not commands:
|
||||||
logger.debug('{}: No commands to run for {} hook'.format(config_filename, description))
|
logger.debug(f'{config_filename}: No commands to run for {description} hook')
|
||||||
return
|
return
|
||||||
|
|
||||||
dry_run_label = ' (dry run; not actually running hooks)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually running hooks)' if dry_run else ''
|
||||||
|
@ -49,19 +50,15 @@ def execute_hook(commands, umask, config_filename, description, dry_run, **conte
|
||||||
]
|
]
|
||||||
|
|
||||||
if len(commands) == 1:
|
if len(commands) == 1:
|
||||||
logger.info(
|
logger.info(f'{config_filename}: Running command for {description} hook{dry_run_label}')
|
||||||
'{}: Running command for {} hook{}'.format(config_filename, description, dry_run_label)
|
|
||||||
)
|
|
||||||
else:
|
else:
|
||||||
logger.info(
|
logger.info(
|
||||||
'{}: Running {} commands for {} hook{}'.format(
|
f'{config_filename}: Running {len(commands)} commands for {description} hook{dry_run_label}',
|
||||||
config_filename, len(commands), description, dry_run_label
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
if umask:
|
if umask:
|
||||||
parsed_umask = int(str(umask), 8)
|
parsed_umask = int(str(umask), 8)
|
||||||
logger.debug('{}: Set hook umask to {}'.format(config_filename, oct(parsed_umask)))
|
logger.debug(f'{config_filename}: Set hook umask to {oct(parsed_umask)}')
|
||||||
original_umask = os.umask(parsed_umask)
|
original_umask = os.umask(parsed_umask)
|
||||||
else:
|
else:
|
||||||
original_umask = None
|
original_umask = None
|
||||||
|
@ -71,9 +68,9 @@ def execute_hook(commands, umask, config_filename, description, dry_run, **conte
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
execute.execute_command(
|
execute.execute_command(
|
||||||
[command],
|
[command],
|
||||||
output_log_level=logging.ERROR
|
output_log_level=(
|
||||||
if description == 'on-error'
|
logging.ERROR if description == 'on-error' else logging.WARNING
|
||||||
else logging.WARNING,
|
),
|
||||||
shell=True,
|
shell=True,
|
||||||
)
|
)
|
||||||
finally:
|
finally:
|
||||||
|
@ -93,9 +90,7 @@ def considered_soft_failure(config_filename, error):
|
||||||
|
|
||||||
if exit_code == SOFT_FAIL_EXIT_CODE:
|
if exit_code == SOFT_FAIL_EXIT_CODE:
|
||||||
logger.info(
|
logger.info(
|
||||||
'{}: Command hook exited with soft failure exit code ({}); skipping remaining actions'.format(
|
f'{config_filename}: Command hook exited with soft failure exit code ({SOFT_FAIL_EXIT_CODE}); skipping remaining actions',
|
||||||
config_filename, SOFT_FAIL_EXIT_CODE
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@ MONITOR_STATE_TO_CRONHUB = {
|
||||||
|
|
||||||
|
|
||||||
def initialize_monitor(
|
def initialize_monitor(
|
||||||
ping_url, config_filename, monitoring_log_level, dry_run
|
ping_url, config, config_filename, monitoring_log_level, dry_run
|
||||||
): # pragma: no cover
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
No initialization is necessary for this monitor.
|
No initialization is necessary for this monitor.
|
||||||
|
@ -22,23 +22,27 @@ def initialize_monitor(
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Ping the configured Cronhub URL, modified with the monitor.State. Use the given configuration
|
Ping the configured Cronhub URL, modified with the monitor.State. Use the given configuration
|
||||||
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
||||||
'''
|
'''
|
||||||
|
if state not in MONITOR_STATE_TO_CRONHUB:
|
||||||
|
logger.debug(
|
||||||
|
f'{config_filename}: Ignoring unsupported monitoring {state.name.lower()} in Cronhub hook'
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
formatted_state = '/{}/'.format(MONITOR_STATE_TO_CRONHUB[state])
|
formatted_state = f'/{MONITOR_STATE_TO_CRONHUB[state]}/'
|
||||||
ping_url = (
|
ping_url = (
|
||||||
hook_config['ping_url']
|
hook_config['ping_url']
|
||||||
.replace('/start/', formatted_state)
|
.replace('/start/', formatted_state)
|
||||||
.replace('/ping/', formatted_state)
|
.replace('/ping/', formatted_state)
|
||||||
)
|
)
|
||||||
|
|
||||||
logger.info(
|
logger.info(f'{config_filename}: Pinging Cronhub {state.name.lower()}{dry_run_label}')
|
||||||
'{}: Pinging Cronhub {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
logger.debug(f'{config_filename}: Using Cronhub ping URL {ping_url}')
|
||||||
)
|
|
||||||
logger.debug('{}: Using Cronhub ping URL {}'.format(config_filename, ping_url))
|
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
|
@ -51,7 +55,7 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(
|
def destroy_monitor(
|
||||||
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
ping_url_or_uuid, config, config_filename, monitoring_log_level, dry_run
|
||||||
): # pragma: no cover
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
No destruction is necessary for this monitor.
|
No destruction is necessary for this monitor.
|
||||||
|
|
|
@ -14,7 +14,7 @@ MONITOR_STATE_TO_CRONITOR = {
|
||||||
|
|
||||||
|
|
||||||
def initialize_monitor(
|
def initialize_monitor(
|
||||||
ping_url, config_filename, monitoring_log_level, dry_run
|
ping_url, config, config_filename, monitoring_log_level, dry_run
|
||||||
): # pragma: no cover
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
No initialization is necessary for this monitor.
|
No initialization is necessary for this monitor.
|
||||||
|
@ -22,18 +22,22 @@ def initialize_monitor(
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Ping the configured Cronitor URL, modified with the monitor.State. Use the given configuration
|
Ping the configured Cronitor URL, modified with the monitor.State. Use the given configuration
|
||||||
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
if state not in MONITOR_STATE_TO_CRONITOR:
|
||||||
ping_url = '{}/{}'.format(hook_config['ping_url'], MONITOR_STATE_TO_CRONITOR[state])
|
logger.debug(
|
||||||
|
f'{config_filename}: Ignoring unsupported monitoring {state.name.lower()} in Cronitor hook'
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
logger.info(
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
'{}: Pinging Cronitor {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
ping_url = f"{hook_config['ping_url']}/{MONITOR_STATE_TO_CRONITOR[state]}"
|
||||||
)
|
|
||||||
logger.debug('{}: Using Cronitor ping URL {}'.format(config_filename, ping_url))
|
logger.info(f'{config_filename}: Pinging Cronitor {state.name.lower()}{dry_run_label}')
|
||||||
|
logger.debug(f'{config_filename}: Using Cronitor ping URL {ping_url}')
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
|
@ -46,7 +50,7 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(
|
def destroy_monitor(
|
||||||
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
ping_url_or_uuid, config, config_filename, monitoring_log_level, dry_run
|
||||||
): # pragma: no cover
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
No destruction is necessary for this monitor.
|
No destruction is necessary for this monitor.
|
||||||
|
|
|
@ -1,58 +1,65 @@
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from borgmatic.hooks import (
|
from borgmatic.hooks import (
|
||||||
|
apprise,
|
||||||
cronhub,
|
cronhub,
|
||||||
cronitor,
|
cronitor,
|
||||||
healthchecks,
|
healthchecks,
|
||||||
|
loki,
|
||||||
|
mariadb,
|
||||||
mongodb,
|
mongodb,
|
||||||
mysql,
|
mysql,
|
||||||
ntfy,
|
ntfy,
|
||||||
pagerduty,
|
pagerduty,
|
||||||
postgresql,
|
postgresql,
|
||||||
|
sqlite,
|
||||||
)
|
)
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
HOOK_NAME_TO_MODULE = {
|
HOOK_NAME_TO_MODULE = {
|
||||||
|
'apprise': apprise,
|
||||||
'cronhub': cronhub,
|
'cronhub': cronhub,
|
||||||
'cronitor': cronitor,
|
'cronitor': cronitor,
|
||||||
'healthchecks': healthchecks,
|
'healthchecks': healthchecks,
|
||||||
|
'mariadb_databases': mariadb,
|
||||||
'mongodb_databases': mongodb,
|
'mongodb_databases': mongodb,
|
||||||
'mysql_databases': mysql,
|
'mysql_databases': mysql,
|
||||||
'ntfy': ntfy,
|
'ntfy': ntfy,
|
||||||
'pagerduty': pagerduty,
|
'pagerduty': pagerduty,
|
||||||
'postgresql_databases': postgresql,
|
'postgresql_databases': postgresql,
|
||||||
|
'sqlite_databases': sqlite,
|
||||||
|
'loki': loki,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs):
|
def call_hook(function_name, config, log_prefix, hook_name, *args, **kwargs):
|
||||||
'''
|
'''
|
||||||
Given the hooks configuration dict and a prefix to use in log entries, call the requested
|
Given a configuration dict and a prefix to use in log entries, call the requested function of
|
||||||
function of the Python module corresponding to the given hook name. Supply that call with the
|
the Python module corresponding to the given hook name. Supply that call with the configuration
|
||||||
configuration for this hook (if any), the log prefix, and any given args and kwargs. Return any
|
for this hook (if any), the log prefix, and any given args and kwargs. Return any return value.
|
||||||
return value.
|
|
||||||
|
|
||||||
Raise ValueError if the hook name is unknown.
|
Raise ValueError if the hook name is unknown.
|
||||||
Raise AttributeError if the function name is not found in the module.
|
Raise AttributeError if the function name is not found in the module.
|
||||||
Raise anything else that the called function raises.
|
Raise anything else that the called function raises.
|
||||||
'''
|
'''
|
||||||
config = hooks.get(hook_name, {})
|
hook_config = config.get(hook_name, {})
|
||||||
|
|
||||||
try:
|
try:
|
||||||
module = HOOK_NAME_TO_MODULE[hook_name]
|
module = HOOK_NAME_TO_MODULE[hook_name]
|
||||||
except KeyError:
|
except KeyError:
|
||||||
raise ValueError('Unknown hook name: {}'.format(hook_name))
|
raise ValueError(f'Unknown hook name: {hook_name}')
|
||||||
|
|
||||||
logger.debug('{}: Calling {} hook function {}'.format(log_prefix, hook_name, function_name))
|
logger.debug(f'{log_prefix}: Calling {hook_name} hook function {function_name}')
|
||||||
return getattr(module, function_name)(config, log_prefix, *args, **kwargs)
|
return getattr(module, function_name)(hook_config, config, log_prefix, *args, **kwargs)
|
||||||
|
|
||||||
|
|
||||||
def call_hooks(function_name, hooks, log_prefix, hook_names, *args, **kwargs):
|
def call_hooks(function_name, config, log_prefix, hook_names, *args, **kwargs):
|
||||||
'''
|
'''
|
||||||
Given the hooks configuration dict and a prefix to use in log entries, call the requested
|
Given a configuration dict and a prefix to use in log entries, call the requested function of
|
||||||
function of the Python module corresponding to each given hook name. Supply each call with the
|
the Python module corresponding to each given hook name. Supply each call with the configuration
|
||||||
configuration for that hook, the log prefix, and any given args and kwargs. Collect any return
|
for that hook, the log prefix, and any given args and kwargs. Collect any return values into a
|
||||||
values into a dict from hook name to return value.
|
dict from hook name to return value.
|
||||||
|
|
||||||
If the hook name is not present in the hooks configuration, then don't call the function for it
|
If the hook name is not present in the hooks configuration, then don't call the function for it
|
||||||
and omit it from the return values.
|
and omit it from the return values.
|
||||||
|
@ -62,23 +69,23 @@ def call_hooks(function_name, hooks, log_prefix, hook_names, *args, **kwargs):
|
||||||
Raise anything else that a called function raises. An error stops calls to subsequent functions.
|
Raise anything else that a called function raises. An error stops calls to subsequent functions.
|
||||||
'''
|
'''
|
||||||
return {
|
return {
|
||||||
hook_name: call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs)
|
hook_name: call_hook(function_name, config, log_prefix, hook_name, *args, **kwargs)
|
||||||
for hook_name in hook_names
|
for hook_name in hook_names
|
||||||
if hooks.get(hook_name)
|
if config.get(hook_name)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def call_hooks_even_if_unconfigured(function_name, hooks, log_prefix, hook_names, *args, **kwargs):
|
def call_hooks_even_if_unconfigured(function_name, config, log_prefix, hook_names, *args, **kwargs):
|
||||||
'''
|
'''
|
||||||
Given the hooks configuration dict and a prefix to use in log entries, call the requested
|
Given a configuration dict and a prefix to use in log entries, call the requested function of
|
||||||
function of the Python module corresponding to each given hook name. Supply each call with the
|
the Python module corresponding to each given hook name. Supply each call with the configuration
|
||||||
configuration for that hook, the log prefix, and any given args and kwargs. Collect any return
|
for that hook, the log prefix, and any given args and kwargs. Collect any return values into a
|
||||||
values into a dict from hook name to return value.
|
dict from hook name to return value.
|
||||||
|
|
||||||
Raise AttributeError if the function name is not found in the module.
|
Raise AttributeError if the function name is not found in the module.
|
||||||
Raise anything else that a called function raises. An error stops calls to subsequent functions.
|
Raise anything else that a called function raises. An error stops calls to subsequent functions.
|
||||||
'''
|
'''
|
||||||
return {
|
return {
|
||||||
hook_name: call_hook(function_name, hooks, log_prefix, hook_name, *args, **kwargs)
|
hook_name: call_hook(function_name, config, log_prefix, hook_name, *args, **kwargs)
|
||||||
for hook_name in hook_names
|
for hook_name in hook_names
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,29 +6,35 @@ from borgmatic.borg.state import DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
DATABASE_HOOK_NAMES = ('postgresql_databases', 'mysql_databases', 'mongodb_databases')
|
DATA_SOURCE_HOOK_NAMES = (
|
||||||
|
'mariadb_databases',
|
||||||
|
'mysql_databases',
|
||||||
|
'mongodb_databases',
|
||||||
|
'postgresql_databases',
|
||||||
|
'sqlite_databases',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def make_database_dump_path(borgmatic_source_directory, database_hook_name):
|
def make_data_source_dump_path(borgmatic_source_directory, data_source_hook_name):
|
||||||
'''
|
'''
|
||||||
Given a borgmatic source directory (or None) and a database hook name, construct a database dump
|
Given a borgmatic source directory (or None) and a data source hook name, construct a data
|
||||||
path.
|
source dump path.
|
||||||
'''
|
'''
|
||||||
if not borgmatic_source_directory:
|
if not borgmatic_source_directory:
|
||||||
borgmatic_source_directory = DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
borgmatic_source_directory = DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
|
||||||
return os.path.join(borgmatic_source_directory, database_hook_name)
|
return os.path.join(borgmatic_source_directory, data_source_hook_name)
|
||||||
|
|
||||||
|
|
||||||
def make_database_dump_filename(dump_path, name, hostname=None):
|
def make_data_source_dump_filename(dump_path, name, hostname=None):
|
||||||
'''
|
'''
|
||||||
Based on the given dump directory path, database name, and hostname, return a filename to use
|
Based on the given dump directory path, data source name, and hostname, return a filename to use
|
||||||
for the database dump. The hostname defaults to localhost.
|
for the data source dump. The hostname defaults to localhost.
|
||||||
|
|
||||||
Raise ValueError if the database name is invalid.
|
Raise ValueError if the data source name is invalid.
|
||||||
'''
|
'''
|
||||||
if os.path.sep in name:
|
if os.path.sep in name:
|
||||||
raise ValueError('Invalid database name {}'.format(name))
|
raise ValueError(f'Invalid data source name {name}')
|
||||||
|
|
||||||
return os.path.join(os.path.expanduser(dump_path), hostname or 'localhost', name)
|
return os.path.join(os.path.expanduser(dump_path), hostname or 'localhost', name)
|
||||||
|
|
||||||
|
@ -48,16 +54,14 @@ def create_named_pipe_for_dump(dump_path):
|
||||||
os.mkfifo(dump_path, mode=0o600)
|
os.mkfifo(dump_path, mode=0o600)
|
||||||
|
|
||||||
|
|
||||||
def remove_database_dumps(dump_path, database_type_name, log_prefix, dry_run):
|
def remove_data_source_dumps(dump_path, data_source_type_name, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Remove all database dumps in the given dump directory path (including the directory itself). If
|
Remove all data source dumps in the given dump directory path (including the directory itself).
|
||||||
this is a dry run, then don't actually remove anything.
|
If this is a dry run, then don't actually remove anything.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually removing anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually removing anything)' if dry_run else ''
|
||||||
|
|
||||||
logger.debug(
|
logger.debug(f'{log_prefix}: Removing {data_source_type_name} data source dumps{dry_run_label}')
|
||||||
'{}: Removing {} database dumps{}'.format(log_prefix, database_type_name, dry_run_label)
|
|
||||||
)
|
|
||||||
|
|
||||||
expanded_path = os.path.expanduser(dump_path)
|
expanded_path = os.path.expanduser(dump_path)
|
||||||
|
|
||||||
|
@ -73,4 +77,4 @@ def convert_glob_patterns_to_borg_patterns(patterns):
|
||||||
Convert a sequence of shell glob patterns like "/etc/*" to the corresponding Borg archive
|
Convert a sequence of shell glob patterns like "/etc/*" to the corresponding Borg archive
|
||||||
patterns like "sh:etc/*".
|
patterns like "sh:etc/*".
|
||||||
'''
|
'''
|
||||||
return ['sh:{}'.format(pattern.lstrip(os.path.sep)) for pattern in patterns]
|
return [f'sh:{pattern.lstrip(os.path.sep)}' for pattern in patterns]
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
import logging
|
import logging
|
||||||
|
import re
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
|
import borgmatic.hooks.logs
|
||||||
from borgmatic.hooks import monitor
|
from borgmatic.hooks import monitor
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
@ -10,66 +12,14 @@ MONITOR_STATE_TO_HEALTHCHECKS = {
|
||||||
monitor.State.START: 'start',
|
monitor.State.START: 'start',
|
||||||
monitor.State.FINISH: None, # Healthchecks doesn't append to the URL for the finished state.
|
monitor.State.FINISH: None, # Healthchecks doesn't append to the URL for the finished state.
|
||||||
monitor.State.FAIL: 'fail',
|
monitor.State.FAIL: 'fail',
|
||||||
|
monitor.State.LOG: 'log',
|
||||||
}
|
}
|
||||||
|
|
||||||
PAYLOAD_TRUNCATION_INDICATOR = '...\n'
|
DEFAULT_PING_BODY_LIMIT_BYTES = 1500
|
||||||
DEFAULT_PING_BODY_LIMIT_BYTES = 100000
|
HANDLER_IDENTIFIER = 'healthchecks'
|
||||||
|
|
||||||
|
|
||||||
class Forgetful_buffering_handler(logging.Handler):
|
def initialize_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
'''
|
|
||||||
A buffering log handler that stores log messages in memory, and throws away messages (oldest
|
|
||||||
first) once a particular capacity in bytes is reached. But if the given byte capacity is zero,
|
|
||||||
don't throw away any messages.
|
|
||||||
'''
|
|
||||||
|
|
||||||
def __init__(self, byte_capacity, log_level):
|
|
||||||
super().__init__()
|
|
||||||
|
|
||||||
self.byte_capacity = byte_capacity
|
|
||||||
self.byte_count = 0
|
|
||||||
self.buffer = []
|
|
||||||
self.forgot = False
|
|
||||||
self.setLevel(log_level)
|
|
||||||
|
|
||||||
def emit(self, record):
|
|
||||||
message = record.getMessage() + '\n'
|
|
||||||
self.byte_count += len(message)
|
|
||||||
self.buffer.append(message)
|
|
||||||
|
|
||||||
if not self.byte_capacity:
|
|
||||||
return
|
|
||||||
|
|
||||||
while self.byte_count > self.byte_capacity and self.buffer:
|
|
||||||
self.byte_count -= len(self.buffer[0])
|
|
||||||
self.buffer.pop(0)
|
|
||||||
self.forgot = True
|
|
||||||
|
|
||||||
|
|
||||||
def format_buffered_logs_for_payload():
|
|
||||||
'''
|
|
||||||
Get the handler previously added to the root logger, and slurp buffered logs out of it to
|
|
||||||
send to Healthchecks.
|
|
||||||
'''
|
|
||||||
try:
|
|
||||||
buffering_handler = next(
|
|
||||||
handler
|
|
||||||
for handler in logging.getLogger().handlers
|
|
||||||
if isinstance(handler, Forgetful_buffering_handler)
|
|
||||||
)
|
|
||||||
except StopIteration:
|
|
||||||
# No handler means no payload.
|
|
||||||
return ''
|
|
||||||
|
|
||||||
payload = ''.join(message for message in buffering_handler.buffer)
|
|
||||||
|
|
||||||
if buffering_handler.forgot:
|
|
||||||
return PAYLOAD_TRUNCATION_INDICATOR + payload
|
|
||||||
|
|
||||||
return payload
|
|
||||||
|
|
||||||
|
|
||||||
def initialize_monitor(hook_config, config_filename, monitoring_log_level, dry_run):
|
|
||||||
'''
|
'''
|
||||||
Add a handler to the root logger that stores in memory the most recent logs emitted. That way,
|
Add a handler to the root logger that stores in memory the most recent logs emitted. That way,
|
||||||
we can send them all to Healthchecks upon a finish or failure state. But skip this if the
|
we can send them all to Healthchecks upon a finish or failure state. But skip this if the
|
||||||
|
@ -80,16 +30,18 @@ def initialize_monitor(hook_config, config_filename, monitoring_log_level, dry_r
|
||||||
|
|
||||||
ping_body_limit = max(
|
ping_body_limit = max(
|
||||||
hook_config.get('ping_body_limit', DEFAULT_PING_BODY_LIMIT_BYTES)
|
hook_config.get('ping_body_limit', DEFAULT_PING_BODY_LIMIT_BYTES)
|
||||||
- len(PAYLOAD_TRUNCATION_INDICATOR),
|
- len(borgmatic.hooks.logs.PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
0,
|
0,
|
||||||
)
|
)
|
||||||
|
|
||||||
logging.getLogger().addHandler(
|
borgmatic.hooks.logs.add_handler(
|
||||||
Forgetful_buffering_handler(ping_body_limit, monitoring_log_level)
|
borgmatic.hooks.logs.Forgetful_buffering_handler(
|
||||||
|
HANDLER_IDENTIFIER, ping_body_limit, monitoring_log_level
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Ping the configured Healthchecks URL or UUID, modified with the monitor.State. Use the given
|
Ping the configured Healthchecks URL or UUID, modified with the monitor.State. Use the given
|
||||||
configuration filename in any log entries, and log to Healthchecks with the giving log level.
|
configuration filename in any log entries, and log to Healthchecks with the giving log level.
|
||||||
|
@ -98,7 +50,7 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
ping_url = (
|
ping_url = (
|
||||||
hook_config['ping_url']
|
hook_config['ping_url']
|
||||||
if hook_config['ping_url'].startswith('http')
|
if hook_config['ping_url'].startswith('http')
|
||||||
else 'https://hc-ping.com/{}'.format(hook_config['ping_url'])
|
else f"https://hc-ping.com/{hook_config['ping_url']}"
|
||||||
)
|
)
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
|
|
||||||
|
@ -108,17 +60,25 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
ping_url_is_uuid = re.search(r'\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$', ping_url)
|
||||||
|
|
||||||
healthchecks_state = MONITOR_STATE_TO_HEALTHCHECKS.get(state)
|
healthchecks_state = MONITOR_STATE_TO_HEALTHCHECKS.get(state)
|
||||||
if healthchecks_state:
|
if healthchecks_state:
|
||||||
ping_url = '{}/{}'.format(ping_url, healthchecks_state)
|
ping_url = f'{ping_url}/{healthchecks_state}'
|
||||||
|
|
||||||
logger.info(
|
if hook_config.get('create_slug'):
|
||||||
'{}: Pinging Healthchecks {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
if ping_url_is_uuid:
|
||||||
)
|
logger.warning(
|
||||||
logger.debug('{}: Using Healthchecks ping URL {}'.format(config_filename, ping_url))
|
f'{config_filename}: Healthchecks UUIDs do not support auto provisionning; ignoring'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
ping_url = f'{ping_url}?create=1'
|
||||||
|
|
||||||
if state in (monitor.State.FINISH, monitor.State.FAIL):
|
logger.info(f'{config_filename}: Pinging Healthchecks {state.name.lower()}{dry_run_label}')
|
||||||
payload = format_buffered_logs_for_payload()
|
logger.debug(f'{config_filename}: Using Healthchecks ping URL {ping_url}')
|
||||||
|
|
||||||
|
if state in (monitor.State.FINISH, monitor.State.FAIL, monitor.State.LOG):
|
||||||
|
payload = borgmatic.hooks.logs.format_buffered_logs_for_payload(HANDLER_IDENTIFIER)
|
||||||
else:
|
else:
|
||||||
payload = ''
|
payload = ''
|
||||||
|
|
||||||
|
@ -134,13 +94,9 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
logger.warning(f'{config_filename}: Healthchecks error: {error}')
|
logger.warning(f'{config_filename}: Healthchecks error: {error}')
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(hook_config, config_filename, monitoring_log_level, dry_run):
|
def destroy_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Remove the monitor handler that was added to the root logger. This prevents the handler from
|
Remove the monitor handler that was added to the root logger. This prevents the handler from
|
||||||
getting reused by other instances of this monitor.
|
getting reused by other instances of this monitor.
|
||||||
'''
|
'''
|
||||||
logger = logging.getLogger()
|
borgmatic.hooks.logs.remove_handler(HANDLER_IDENTIFIER)
|
||||||
|
|
||||||
for handler in tuple(logger.handlers):
|
|
||||||
if isinstance(handler, Forgetful_buffering_handler):
|
|
||||||
logger.removeHandler(handler)
|
|
||||||
|
|
91
borgmatic/hooks/logs.py
Normal file
91
borgmatic/hooks/logs.py
Normal file
|
@ -0,0 +1,91 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
PAYLOAD_TRUNCATION_INDICATOR = '...\n'
|
||||||
|
|
||||||
|
|
||||||
|
class Forgetful_buffering_handler(logging.Handler):
|
||||||
|
'''
|
||||||
|
A buffering log handler that stores log messages in memory, and throws away messages (oldest
|
||||||
|
first) once a particular capacity in bytes is reached. But if the given byte capacity is zero,
|
||||||
|
don't throw away any messages.
|
||||||
|
|
||||||
|
The given identifier is used to distinguish the instance of this handler used for one monitoring
|
||||||
|
hook from those instances used for other monitoring hooks.
|
||||||
|
'''
|
||||||
|
|
||||||
|
def __init__(self, identifier, byte_capacity, log_level):
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
self.identifier = identifier
|
||||||
|
self.byte_capacity = byte_capacity
|
||||||
|
self.byte_count = 0
|
||||||
|
self.buffer = []
|
||||||
|
self.forgot = False
|
||||||
|
self.setLevel(log_level)
|
||||||
|
|
||||||
|
def emit(self, record):
|
||||||
|
message = record.getMessage() + '\n'
|
||||||
|
self.byte_count += len(message)
|
||||||
|
self.buffer.append(message)
|
||||||
|
|
||||||
|
if not self.byte_capacity:
|
||||||
|
return
|
||||||
|
|
||||||
|
while self.byte_count > self.byte_capacity and self.buffer:
|
||||||
|
self.byte_count -= len(self.buffer[0])
|
||||||
|
self.buffer.pop(0)
|
||||||
|
self.forgot = True
|
||||||
|
|
||||||
|
|
||||||
|
def add_handler(handler): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Add the given handler to the global logger.
|
||||||
|
'''
|
||||||
|
logging.getLogger().addHandler(handler)
|
||||||
|
|
||||||
|
|
||||||
|
def get_handler(identifier):
|
||||||
|
'''
|
||||||
|
Given the identifier for an existing Forgetful_buffering_handler instance, return the handler.
|
||||||
|
|
||||||
|
Raise ValueError if the handler isn't found.
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
return next(
|
||||||
|
handler
|
||||||
|
for handler in logging.getLogger().handlers
|
||||||
|
if isinstance(handler, Forgetful_buffering_handler) and handler.identifier == identifier
|
||||||
|
)
|
||||||
|
except StopIteration:
|
||||||
|
raise ValueError(f'A buffering handler for {identifier} was not found')
|
||||||
|
|
||||||
|
|
||||||
|
def format_buffered_logs_for_payload(identifier):
|
||||||
|
'''
|
||||||
|
Get the handler previously added to the root logger, and slurp buffered logs out of it to
|
||||||
|
send to Healthchecks.
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
buffering_handler = get_handler(identifier)
|
||||||
|
except ValueError:
|
||||||
|
# No handler means no payload.
|
||||||
|
return ''
|
||||||
|
|
||||||
|
payload = ''.join(message for message in buffering_handler.buffer)
|
||||||
|
|
||||||
|
if buffering_handler.forgot:
|
||||||
|
return PAYLOAD_TRUNCATION_INDICATOR + payload
|
||||||
|
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def remove_handler(identifier):
|
||||||
|
'''
|
||||||
|
Given the identifier for an existing Forgetful_buffering_handler instance, remove it.
|
||||||
|
'''
|
||||||
|
logger = logging.getLogger()
|
||||||
|
|
||||||
|
try:
|
||||||
|
logger.removeHandler(get_handler(identifier))
|
||||||
|
except ValueError:
|
||||||
|
pass
|
154
borgmatic/hooks/loki.py
Normal file
154
borgmatic/hooks/loki.py
Normal file
|
@ -0,0 +1,154 @@
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import platform
|
||||||
|
import time
|
||||||
|
|
||||||
|
import requests
|
||||||
|
|
||||||
|
from borgmatic.hooks import monitor
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
MONITOR_STATE_TO_LOKI = {
|
||||||
|
monitor.State.START: 'Started',
|
||||||
|
monitor.State.FINISH: 'Finished',
|
||||||
|
monitor.State.FAIL: 'Failed',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Threshold at which logs get flushed to loki
|
||||||
|
MAX_BUFFER_LINES = 100
|
||||||
|
|
||||||
|
|
||||||
|
class Loki_log_buffer:
|
||||||
|
'''
|
||||||
|
A log buffer that allows to output the logs as loki requests in json. Allows
|
||||||
|
adding labels to the log stream and takes care of communication with loki.
|
||||||
|
'''
|
||||||
|
|
||||||
|
def __init__(self, url, dry_run):
|
||||||
|
self.url = url
|
||||||
|
self.dry_run = dry_run
|
||||||
|
self.root = {'streams': [{'stream': {}, 'values': []}]}
|
||||||
|
|
||||||
|
def add_value(self, value):
|
||||||
|
'''
|
||||||
|
Add a log entry to the stream.
|
||||||
|
'''
|
||||||
|
timestamp = str(time.time_ns())
|
||||||
|
self.root['streams'][0]['values'].append((timestamp, value))
|
||||||
|
|
||||||
|
def add_label(self, label, value):
|
||||||
|
'''
|
||||||
|
Add a label to the logging stream.
|
||||||
|
'''
|
||||||
|
self.root['streams'][0]['stream'][label] = value
|
||||||
|
|
||||||
|
def to_request(self):
|
||||||
|
return json.dumps(self.root)
|
||||||
|
|
||||||
|
def __len__(self):
|
||||||
|
'''
|
||||||
|
Gets the number of lines currently in the buffer.
|
||||||
|
'''
|
||||||
|
return len(self.root['streams'][0]['values'])
|
||||||
|
|
||||||
|
def flush(self):
|
||||||
|
if self.dry_run:
|
||||||
|
# Just empty the buffer and skip
|
||||||
|
self.root['streams'][0]['values'] = []
|
||||||
|
logger.info('Skipped uploading logs to loki due to dry run')
|
||||||
|
return
|
||||||
|
|
||||||
|
if len(self) == 0:
|
||||||
|
# Skip as there are not logs to send yet
|
||||||
|
return
|
||||||
|
|
||||||
|
request_body = self.to_request()
|
||||||
|
self.root['streams'][0]['values'] = []
|
||||||
|
request_header = {'Content-Type': 'application/json'}
|
||||||
|
|
||||||
|
try:
|
||||||
|
result = requests.post(self.url, headers=request_header, data=request_body, timeout=5)
|
||||||
|
result.raise_for_status()
|
||||||
|
except requests.RequestException:
|
||||||
|
logger.warning('Failed to upload logs to loki')
|
||||||
|
|
||||||
|
|
||||||
|
class Loki_log_handler(logging.Handler):
|
||||||
|
'''
|
||||||
|
A log handler that sends logs to loki.
|
||||||
|
'''
|
||||||
|
|
||||||
|
def __init__(self, url, dry_run):
|
||||||
|
super().__init__()
|
||||||
|
self.buffer = Loki_log_buffer(url, dry_run)
|
||||||
|
|
||||||
|
def emit(self, record):
|
||||||
|
'''
|
||||||
|
Add a log record from the logging module to the stream.
|
||||||
|
'''
|
||||||
|
self.raw(record.getMessage())
|
||||||
|
|
||||||
|
def add_label(self, key, value):
|
||||||
|
'''
|
||||||
|
Add a label to the logging stream.
|
||||||
|
'''
|
||||||
|
self.buffer.add_label(key, value)
|
||||||
|
|
||||||
|
def raw(self, msg):
|
||||||
|
'''
|
||||||
|
Add an arbitrary string as a log entry to the stream.
|
||||||
|
'''
|
||||||
|
self.buffer.add_value(msg)
|
||||||
|
|
||||||
|
if len(self.buffer) > MAX_BUFFER_LINES:
|
||||||
|
self.buffer.flush()
|
||||||
|
|
||||||
|
def flush(self):
|
||||||
|
'''
|
||||||
|
Send the logs to loki and empty the buffer.
|
||||||
|
'''
|
||||||
|
self.buffer.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def initialize_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Add a handler to the root logger to regularly send the logs to loki.
|
||||||
|
'''
|
||||||
|
url = hook_config.get('url')
|
||||||
|
loki = Loki_log_handler(url, dry_run)
|
||||||
|
|
||||||
|
for key, value in hook_config.get('labels').items():
|
||||||
|
if value == '__hostname':
|
||||||
|
loki.add_label(key, platform.node())
|
||||||
|
elif value == '__config':
|
||||||
|
loki.add_label(key, os.path.basename(config_filename))
|
||||||
|
elif value == '__config_path':
|
||||||
|
loki.add_label(key, config_filename)
|
||||||
|
else:
|
||||||
|
loki.add_label(key, value)
|
||||||
|
|
||||||
|
logging.getLogger().addHandler(loki)
|
||||||
|
|
||||||
|
|
||||||
|
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Add an entry to the loki logger with the current state.
|
||||||
|
'''
|
||||||
|
for handler in tuple(logging.getLogger().handlers):
|
||||||
|
if isinstance(handler, Loki_log_handler):
|
||||||
|
if state in MONITOR_STATE_TO_LOKI.keys():
|
||||||
|
handler.raw(f'{config_filename}: {MONITOR_STATE_TO_LOKI[state]} backup')
|
||||||
|
|
||||||
|
|
||||||
|
def destroy_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
|
'''
|
||||||
|
Remove the monitor handler that was added to the root logger.
|
||||||
|
'''
|
||||||
|
logger = logging.getLogger()
|
||||||
|
|
||||||
|
for handler in tuple(logger.handlers):
|
||||||
|
if isinstance(handler, Loki_log_handler):
|
||||||
|
handler.flush()
|
||||||
|
logger.removeHandler(handler)
|
257
borgmatic/hooks/mariadb.py
Normal file
257
borgmatic/hooks/mariadb.py
Normal file
|
@ -0,0 +1,257 @@
|
||||||
|
import copy
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
|
||||||
|
from borgmatic.execute import (
|
||||||
|
execute_command,
|
||||||
|
execute_command_and_capture_output,
|
||||||
|
execute_command_with_processes,
|
||||||
|
)
|
||||||
|
from borgmatic.hooks import dump
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def make_dump_path(config): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Make the dump path from the given configuration dict and the name of this hook.
|
||||||
|
'''
|
||||||
|
return dump.make_data_source_dump_path(
|
||||||
|
config.get('borgmatic_source_directory'), 'mariadb_databases'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
SYSTEM_DATABASE_NAMES = ('information_schema', 'mysql', 'performance_schema', 'sys')
|
||||||
|
|
||||||
|
|
||||||
|
def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
|
'''
|
||||||
|
Given a requested database config, return the corresponding sequence of database names to dump.
|
||||||
|
In the case of "all", query for the names of databases on the configured host and return them,
|
||||||
|
excluding any system databases that will cause problems during restore.
|
||||||
|
'''
|
||||||
|
if database['name'] != 'all':
|
||||||
|
return (database['name'],)
|
||||||
|
if dry_run:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
mariadb_show_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(database.get('mariadb_command') or 'mariadb')
|
||||||
|
)
|
||||||
|
show_command = (
|
||||||
|
mariadb_show_command
|
||||||
|
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
||||||
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
||||||
|
+ (('--user', database['username']) if 'username' in database else ())
|
||||||
|
+ ('--skip-column-names', '--batch')
|
||||||
|
+ ('--execute', 'show schemas')
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_prefix}: Querying for "all" MariaDB databases to dump')
|
||||||
|
show_output = execute_command_and_capture_output(
|
||||||
|
show_command, extra_environment=extra_environment
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
show_name
|
||||||
|
for show_name in show_output.strip().splitlines()
|
||||||
|
if show_name not in SYSTEM_DATABASE_NAMES
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def execute_dump_command(
|
||||||
|
database, log_prefix, dump_path, database_names, extra_environment, dry_run, dry_run_label
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Kick off a dump for the given MariaDB database (provided as a configuration dict) to a named
|
||||||
|
pipe constructed from the given dump path and database name. Use the given log prefix in any
|
||||||
|
log entries.
|
||||||
|
|
||||||
|
Return a subprocess.Popen instance for the dump process ready to spew to a named pipe. But if
|
||||||
|
this is a dry run, then don't actually dump anything and return None.
|
||||||
|
'''
|
||||||
|
database_name = database['name']
|
||||||
|
dump_filename = dump.make_data_source_dump_filename(
|
||||||
|
dump_path, database['name'], database.get('hostname')
|
||||||
|
)
|
||||||
|
|
||||||
|
if os.path.exists(dump_filename):
|
||||||
|
logger.warning(
|
||||||
|
f'{log_prefix}: Skipping duplicate dump of MariaDB database "{database_name}" to {dump_filename}'
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
mariadb_dump_command = tuple(
|
||||||
|
shlex.quote(part)
|
||||||
|
for part in shlex.split(database.get('mariadb_dump_command') or 'mariadb-dump')
|
||||||
|
)
|
||||||
|
dump_command = (
|
||||||
|
mariadb_dump_command
|
||||||
|
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
||||||
|
+ (('--add-drop-database',) if database.get('add_drop_database', True) else ())
|
||||||
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
||||||
|
+ (('--user', database['username']) if 'username' in database else ())
|
||||||
|
+ ('--databases',)
|
||||||
|
+ database_names
|
||||||
|
+ ('--result-file', dump_filename)
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.debug(
|
||||||
|
f'{log_prefix}: Dumping MariaDB database "{database_name}" to {dump_filename}{dry_run_label}'
|
||||||
|
)
|
||||||
|
if dry_run:
|
||||||
|
return None
|
||||||
|
|
||||||
|
dump.create_named_pipe_for_dump(dump_filename)
|
||||||
|
|
||||||
|
return execute_command(
|
||||||
|
dump_command,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
run_to_completion=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of MariaDB database configuration dicts, a configuration dict (ignored), and a
|
||||||
|
log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(databases)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
|
'''
|
||||||
|
Dump the given MariaDB databases to a named pipe. The databases are supplied as a sequence of
|
||||||
|
dicts, one dict describing each database as per the configuration schema. Use the given
|
||||||
|
configuration dict to construct the destination path and the given log prefix in any log
|
||||||
|
entries.
|
||||||
|
|
||||||
|
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
||||||
|
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
||||||
|
'''
|
||||||
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
|
processes = []
|
||||||
|
|
||||||
|
logger.info(f'{log_prefix}: Dumping MariaDB databases{dry_run_label}')
|
||||||
|
|
||||||
|
for database in databases:
|
||||||
|
dump_path = make_dump_path(config)
|
||||||
|
extra_environment = {'MYSQL_PWD': database['password']} if 'password' in database else None
|
||||||
|
dump_database_names = database_names_to_dump(
|
||||||
|
database, extra_environment, log_prefix, dry_run
|
||||||
|
)
|
||||||
|
|
||||||
|
if not dump_database_names:
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
|
||||||
|
raise ValueError('Cannot find any MariaDB databases to dump.')
|
||||||
|
|
||||||
|
if database['name'] == 'all' and database.get('format'):
|
||||||
|
for dump_name in dump_database_names:
|
||||||
|
renamed_database = copy.copy(database)
|
||||||
|
renamed_database['name'] = dump_name
|
||||||
|
processes.append(
|
||||||
|
execute_dump_command(
|
||||||
|
renamed_database,
|
||||||
|
log_prefix,
|
||||||
|
dump_path,
|
||||||
|
(dump_name,),
|
||||||
|
extra_environment,
|
||||||
|
dry_run,
|
||||||
|
dry_run_label,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
processes.append(
|
||||||
|
execute_dump_command(
|
||||||
|
database,
|
||||||
|
log_prefix,
|
||||||
|
dump_path,
|
||||||
|
dump_database_names,
|
||||||
|
extra_environment,
|
||||||
|
dry_run,
|
||||||
|
dry_run_label,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
return [process for process in processes if process]
|
||||||
|
|
||||||
|
|
||||||
|
def remove_data_source_dumps(databases, config, log_prefix, dry_run): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Remove all database dump files for this hook regardless of the given databases. Use the given
|
||||||
|
configuration dict to construct the destination path and the log prefix in any log entries. If
|
||||||
|
this is a dry run, then don't actually remove anything.
|
||||||
|
'''
|
||||||
|
dump.remove_data_source_dumps(make_dump_path(config), 'MariaDB', log_prefix, dry_run)
|
||||||
|
|
||||||
|
|
||||||
|
def make_data_source_dump_pattern(databases, config, log_prefix, name=None): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Given a sequence of configurations dicts, a configuration dict, a prefix to log with, and a
|
||||||
|
database name to match, return the corresponding glob patterns to match the database dump in an
|
||||||
|
archive.
|
||||||
|
'''
|
||||||
|
return dump.make_data_source_dump_filename(make_dump_path(config), name, hostname='*')
|
||||||
|
|
||||||
|
|
||||||
|
def restore_data_source_dump(
|
||||||
|
hook_config, config, log_prefix, data_source, dry_run, extract_process, connection_params
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Restore a database from the given extract stream. The database is supplied as a data source
|
||||||
|
configuration dict, but the given hook configuration is ignored. The given configuration dict is
|
||||||
|
used to construct the destination path, and the given log prefix is used for any log entries. If
|
||||||
|
this is a dry run, then don't actually restore anything. Trigger the given active extract
|
||||||
|
process (an instance of subprocess.Popen) to produce output to consume.
|
||||||
|
'''
|
||||||
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
hostname = connection_params['hostname'] or data_source.get(
|
||||||
|
'restore_hostname', data_source.get('hostname')
|
||||||
|
)
|
||||||
|
port = str(
|
||||||
|
connection_params['port'] or data_source.get('restore_port', data_source.get('port', ''))
|
||||||
|
)
|
||||||
|
username = connection_params['username'] or data_source.get(
|
||||||
|
'restore_username', data_source.get('username')
|
||||||
|
)
|
||||||
|
password = connection_params['password'] or data_source.get(
|
||||||
|
'restore_password', data_source.get('password')
|
||||||
|
)
|
||||||
|
|
||||||
|
mariadb_restore_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(data_source.get('mariadb_command') or 'mariadb')
|
||||||
|
)
|
||||||
|
restore_command = (
|
||||||
|
mariadb_restore_command
|
||||||
|
+ ('--batch',)
|
||||||
|
+ (
|
||||||
|
tuple(data_source['restore_options'].split(' '))
|
||||||
|
if 'restore_options' in data_source
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ (('--host', hostname) if hostname else ())
|
||||||
|
+ (('--port', str(port)) if port else ())
|
||||||
|
+ (('--protocol', 'tcp') if hostname or port else ())
|
||||||
|
+ (('--user', username) if username else ())
|
||||||
|
)
|
||||||
|
extra_environment = {'MYSQL_PWD': password} if password else None
|
||||||
|
|
||||||
|
logger.debug(f"{log_prefix}: Restoring MariaDB database {data_source['name']}{dry_run_label}")
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
||||||
|
# if the restore paths don't exist in the archive.
|
||||||
|
execute_command_with_processes(
|
||||||
|
restore_command,
|
||||||
|
[extract_process],
|
||||||
|
output_log_level=logging.DEBUG,
|
||||||
|
input_file=extract_process.stdout,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
)
|
|
@ -1,4 +1,5 @@
|
||||||
import logging
|
import logging
|
||||||
|
import shlex
|
||||||
|
|
||||||
from borgmatic.execute import execute_command, execute_command_with_processes
|
from borgmatic.execute import execute_command, execute_command_with_processes
|
||||||
from borgmatic.hooks import dump
|
from borgmatic.hooks import dump
|
||||||
|
@ -6,52 +7,58 @@ from borgmatic.hooks import dump
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def make_dump_path(location_config): # pragma: no cover
|
def make_dump_path(config): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Make the dump path from the given location configuration and the name of this hook.
|
Make the dump path from the given configuration dict and the name of this hook.
|
||||||
'''
|
'''
|
||||||
return dump.make_database_dump_path(
|
return dump.make_data_source_dump_path(
|
||||||
location_config.get('borgmatic_source_directory'), 'mongodb_databases'
|
config.get('borgmatic_source_directory'), 'mongodb_databases'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def dump_databases(databases, log_prefix, location_config, dry_run):
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of MongoDB database configuration dicts, a configuration dict (ignored), and a
|
||||||
|
log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(database.get('format') != 'directory' for database in databases)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Dump the given MongoDB databases to a named pipe. The databases are supplied as a sequence of
|
Dump the given MongoDB databases to a named pipe. The databases are supplied as a sequence of
|
||||||
dicts, one dict describing each database as per the configuration schema. Use the given log
|
dicts, one dict describing each database as per the configuration schema. Use the configuration
|
||||||
prefix in any log entries. Use the given location configuration dict to construct the
|
dict to construct the destination path and the given log prefix in any log entries.
|
||||||
destination path.
|
|
||||||
|
|
||||||
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
||||||
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
|
|
||||||
logger.info('{}: Dumping MongoDB databases{}'.format(log_prefix, dry_run_label))
|
logger.info(f'{log_prefix}: Dumping MongoDB databases{dry_run_label}')
|
||||||
|
|
||||||
processes = []
|
processes = []
|
||||||
for database in databases:
|
for database in databases:
|
||||||
name = database['name']
|
name = database['name']
|
||||||
dump_filename = dump.make_database_dump_filename(
|
dump_filename = dump.make_data_source_dump_filename(
|
||||||
make_dump_path(location_config), name, database.get('hostname')
|
make_dump_path(config), name, database.get('hostname')
|
||||||
)
|
)
|
||||||
dump_format = database.get('format', 'archive')
|
dump_format = database.get('format', 'archive')
|
||||||
|
|
||||||
logger.debug(
|
logger.debug(
|
||||||
'{}: Dumping MongoDB database {} to {}{}'.format(
|
f'{log_prefix}: Dumping MongoDB database {name} to {dump_filename}{dry_run_label}',
|
||||||
log_prefix, name, dump_filename, dry_run_label
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
if dry_run:
|
if dry_run:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
command = build_dump_command(database, dump_filename, dump_format)
|
||||||
|
|
||||||
if dump_format == 'directory':
|
if dump_format == 'directory':
|
||||||
dump.create_parent_directory_for_dump(dump_filename)
|
dump.create_parent_directory_for_dump(dump_filename)
|
||||||
|
execute_command(command, shell=True)
|
||||||
else:
|
else:
|
||||||
dump.create_named_pipe_for_dump(dump_filename)
|
dump.create_named_pipe_for_dump(dump_filename)
|
||||||
|
processes.append(execute_command(command, shell=True, run_to_completion=False))
|
||||||
command = build_dump_command(database, dump_filename, dump_format)
|
|
||||||
processes.append(execute_command(command, shell=True, run_to_completion=False))
|
|
||||||
|
|
||||||
return processes
|
return processes
|
||||||
|
|
||||||
|
@ -61,73 +68,69 @@ def build_dump_command(database, dump_filename, dump_format):
|
||||||
Return the mongodump command from a single database configuration.
|
Return the mongodump command from a single database configuration.
|
||||||
'''
|
'''
|
||||||
all_databases = database['name'] == 'all'
|
all_databases = database['name'] == 'all'
|
||||||
command = ['mongodump', '--archive']
|
|
||||||
if dump_format == 'directory':
|
return (
|
||||||
command.append(dump_filename)
|
('mongodump',)
|
||||||
if 'hostname' in database:
|
+ (('--out', shlex.quote(dump_filename)) if dump_format == 'directory' else ())
|
||||||
command.extend(('--host', database['hostname']))
|
+ (('--host', shlex.quote(database['hostname'])) if 'hostname' in database else ())
|
||||||
if 'port' in database:
|
+ (('--port', shlex.quote(str(database['port']))) if 'port' in database else ())
|
||||||
command.extend(('--port', str(database['port'])))
|
+ (('--username', shlex.quote(database['username'])) if 'username' in database else ())
|
||||||
if 'username' in database:
|
+ (('--password', shlex.quote(database['password'])) if 'password' in database else ())
|
||||||
command.extend(('--username', database['username']))
|
+ (
|
||||||
if 'password' in database:
|
('--authenticationDatabase', shlex.quote(database['authentication_database']))
|
||||||
command.extend(('--password', database['password']))
|
if 'authentication_database' in database
|
||||||
if 'authentication_database' in database:
|
else ()
|
||||||
command.extend(('--authenticationDatabase', database['authentication_database']))
|
)
|
||||||
if not all_databases:
|
+ (('--db', shlex.quote(database['name'])) if not all_databases else ())
|
||||||
command.extend(('--db', database['name']))
|
+ (
|
||||||
if 'options' in database:
|
tuple(shlex.quote(option) for option in database['options'].split(' '))
|
||||||
command.extend(database['options'].split(' '))
|
if 'options' in database
|
||||||
if dump_format != 'directory':
|
else ()
|
||||||
command.extend(('>', dump_filename))
|
)
|
||||||
return command
|
+ (('--archive', '>', shlex.quote(dump_filename)) if dump_format != 'directory' else ())
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def remove_database_dumps(databases, log_prefix, location_config, dry_run): # pragma: no cover
|
def remove_data_source_dumps(databases, config, log_prefix, dry_run): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Remove all database dump files for this hook regardless of the given databases. Use the log
|
Remove all database dump files for this hook regardless of the given databases. Use the log
|
||||||
prefix in any log entries. Use the given location configuration dict to construct the
|
prefix in any log entries. Use the given configuration dict to construct the destination path.
|
||||||
destination path. If this is a dry run, then don't actually remove anything.
|
If this is a dry run, then don't actually remove anything.
|
||||||
'''
|
'''
|
||||||
dump.remove_database_dumps(make_dump_path(location_config), 'MongoDB', log_prefix, dry_run)
|
dump.remove_data_source_dumps(make_dump_path(config), 'MongoDB', log_prefix, dry_run)
|
||||||
|
|
||||||
|
|
||||||
def make_database_dump_pattern(
|
def make_data_source_dump_pattern(databases, config, log_prefix, name=None): # pragma: no cover
|
||||||
databases, log_prefix, location_config, name=None
|
|
||||||
): # pragma: no cover
|
|
||||||
'''
|
'''
|
||||||
Given a sequence of configurations dicts, a prefix to log with, a location configuration dict,
|
Given a sequence of database configurations dicts, a configuration dict, a prefix to log with,
|
||||||
and a database name to match, return the corresponding glob patterns to match the database dump
|
and a database name to match, return the corresponding glob patterns to match the database dump
|
||||||
in an archive.
|
in an archive.
|
||||||
'''
|
'''
|
||||||
return dump.make_database_dump_filename(make_dump_path(location_config), name, hostname='*')
|
return dump.make_data_source_dump_filename(make_dump_path(config), name, hostname='*')
|
||||||
|
|
||||||
|
|
||||||
def restore_database_dump(database_config, log_prefix, location_config, dry_run, extract_process):
|
def restore_data_source_dump(
|
||||||
|
hook_config, config, log_prefix, data_source, dry_run, extract_process, connection_params
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Restore the given MongoDB database from an extract stream. The database is supplied as a
|
Restore a database from the given extract stream. The database is supplied as a data source
|
||||||
one-element sequence containing a dict describing the database, as per the configuration schema.
|
configuration dict, but the given hook configuration is ignored. The given configuration dict is
|
||||||
Use the given log prefix in any log entries. If this is a dry run, then don't actually restore
|
used to construct the destination path, and the given log prefix is used for any log entries. If
|
||||||
anything. Trigger the given active extract process (an instance of subprocess.Popen) to produce
|
this is a dry run, then don't actually restore anything. Trigger the given active extract
|
||||||
output to consume.
|
process (an instance of subprocess.Popen) to produce output to consume.
|
||||||
|
|
||||||
If the extract process is None, then restore the dump from the filesystem rather than from an
|
If the extract process is None, then restore the dump from the filesystem rather than from an
|
||||||
extract stream.
|
extract stream.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
dump_filename = dump.make_data_source_dump_filename(
|
||||||
if len(database_config) != 1:
|
make_dump_path(config), data_source['name'], data_source.get('hostname')
|
||||||
raise ValueError('The database configuration value is invalid')
|
|
||||||
|
|
||||||
database = database_config[0]
|
|
||||||
dump_filename = dump.make_database_dump_filename(
|
|
||||||
make_dump_path(location_config), database['name'], database.get('hostname')
|
|
||||||
)
|
)
|
||||||
restore_command = build_restore_command(extract_process, database, dump_filename)
|
restore_command = build_restore_command(
|
||||||
|
extract_process, data_source, dump_filename, connection_params
|
||||||
logger.debug(
|
|
||||||
'{}: Restoring MongoDB database {}{}'.format(log_prefix, database['name'], dry_run_label)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
logger.debug(f"{log_prefix}: Restoring MongoDB database {data_source['name']}{dry_run_label}")
|
||||||
if dry_run:
|
if dry_run:
|
||||||
return
|
return
|
||||||
|
|
||||||
|
@ -141,23 +144,42 @@ def restore_database_dump(database_config, log_prefix, location_config, dry_run,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def build_restore_command(extract_process, database, dump_filename):
|
def build_restore_command(extract_process, database, dump_filename, connection_params):
|
||||||
'''
|
'''
|
||||||
Return the mongorestore command from a single database configuration.
|
Return the mongorestore command from a single database configuration.
|
||||||
'''
|
'''
|
||||||
command = ['mongorestore', '--archive']
|
hostname = connection_params['hostname'] or database.get(
|
||||||
if not extract_process:
|
'restore_hostname', database.get('hostname')
|
||||||
command.append(dump_filename)
|
)
|
||||||
|
port = str(connection_params['port'] or database.get('restore_port', database.get('port', '')))
|
||||||
|
username = connection_params['username'] or database.get(
|
||||||
|
'restore_username', database.get('username')
|
||||||
|
)
|
||||||
|
password = connection_params['password'] or database.get(
|
||||||
|
'restore_password', database.get('password')
|
||||||
|
)
|
||||||
|
|
||||||
|
command = ['mongorestore']
|
||||||
|
if extract_process:
|
||||||
|
command.append('--archive')
|
||||||
|
else:
|
||||||
|
command.extend(('--dir', dump_filename))
|
||||||
if database['name'] != 'all':
|
if database['name'] != 'all':
|
||||||
command.extend(('--drop', '--db', database['name']))
|
command.extend(('--drop',))
|
||||||
if 'hostname' in database:
|
if hostname:
|
||||||
command.extend(('--host', database['hostname']))
|
command.extend(('--host', hostname))
|
||||||
if 'port' in database:
|
if port:
|
||||||
command.extend(('--port', str(database['port'])))
|
command.extend(('--port', str(port)))
|
||||||
if 'username' in database:
|
if username:
|
||||||
command.extend(('--username', database['username']))
|
command.extend(('--username', username))
|
||||||
if 'password' in database:
|
if password:
|
||||||
command.extend(('--password', database['password']))
|
command.extend(('--password', password))
|
||||||
if 'authentication_database' in database:
|
if 'authentication_database' in database:
|
||||||
command.extend(('--authenticationDatabase', database['authentication_database']))
|
command.extend(('--authenticationDatabase', database['authentication_database']))
|
||||||
|
if 'restore_options' in database:
|
||||||
|
command.extend(database['restore_options'].split(' '))
|
||||||
|
if database.get('schemas'):
|
||||||
|
for schema in database['schemas']:
|
||||||
|
command.extend(('--nsInclude', schema))
|
||||||
|
|
||||||
return command
|
return command
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
from enum import Enum
|
from enum import Enum
|
||||||
|
|
||||||
MONITOR_HOOK_NAMES = ('healthchecks', 'cronitor', 'cronhub', 'pagerduty', 'ntfy')
|
MONITOR_HOOK_NAMES = ('apprise', 'healthchecks', 'cronitor', 'cronhub', 'pagerduty', 'ntfy', 'loki')
|
||||||
|
|
||||||
|
|
||||||
class State(Enum):
|
class State(Enum):
|
||||||
START = 1
|
START = 1
|
||||||
FINISH = 2
|
FINISH = 2
|
||||||
FAIL = 3
|
FAIL = 3
|
||||||
|
LOG = 4
|
||||||
|
|
|
@ -1,4 +1,7 @@
|
||||||
|
import copy
|
||||||
import logging
|
import logging
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
|
||||||
from borgmatic.execute import (
|
from borgmatic.execute import (
|
||||||
execute_command,
|
execute_command,
|
||||||
|
@ -10,31 +13,34 @@ from borgmatic.hooks import dump
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def make_dump_path(location_config): # pragma: no cover
|
def make_dump_path(config): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Make the dump path from the given location configuration and the name of this hook.
|
Make the dump path from the given configuration dict and the name of this hook.
|
||||||
'''
|
'''
|
||||||
return dump.make_database_dump_path(
|
return dump.make_data_source_dump_path(
|
||||||
location_config.get('borgmatic_source_directory'), 'mysql_databases'
|
config.get('borgmatic_source_directory'), 'mysql_databases'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
SYSTEM_DATABASE_NAMES = ('information_schema', 'mysql', 'performance_schema', 'sys')
|
SYSTEM_DATABASE_NAMES = ('information_schema', 'mysql', 'performance_schema', 'sys')
|
||||||
|
|
||||||
|
|
||||||
def database_names_to_dump(database, extra_environment, log_prefix, dry_run_label):
|
def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Given a requested database config, return the corresponding sequence of database names to dump.
|
Given a requested database config, return the corresponding sequence of database names to dump.
|
||||||
In the case of "all", query for the names of databases on the configured host and return them,
|
In the case of "all", query for the names of databases on the configured host and return them,
|
||||||
excluding any system databases that will cause problems during restore.
|
excluding any system databases that will cause problems during restore.
|
||||||
'''
|
'''
|
||||||
requested_name = database['name']
|
if database['name'] != 'all':
|
||||||
|
return (database['name'],)
|
||||||
if requested_name != 'all':
|
if dry_run:
|
||||||
return (requested_name,)
|
return ()
|
||||||
|
|
||||||
|
mysql_show_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(database.get('mysql_command') or 'mysql')
|
||||||
|
)
|
||||||
show_command = (
|
show_command = (
|
||||||
('mysql',)
|
mysql_show_command
|
||||||
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
@ -43,9 +49,7 @@ def database_names_to_dump(database, extra_environment, log_prefix, dry_run_labe
|
||||||
+ ('--skip-column-names', '--batch')
|
+ ('--skip-column-names', '--batch')
|
||||||
+ ('--execute', 'show schemas')
|
+ ('--execute', 'show schemas')
|
||||||
)
|
)
|
||||||
logger.debug(
|
logger.debug(f'{log_prefix}: Querying for "all" MySQL databases to dump')
|
||||||
'{}: Querying for "all" MySQL databases to dump{}'.format(log_prefix, dry_run_label)
|
|
||||||
)
|
|
||||||
show_output = execute_command_and_capture_output(
|
show_output = execute_command_and_capture_output(
|
||||||
show_command, extra_environment=extra_environment
|
show_command, extra_environment=extra_environment
|
||||||
)
|
)
|
||||||
|
@ -57,12 +61,72 @@ def database_names_to_dump(database, extra_environment, log_prefix, dry_run_labe
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def dump_databases(databases, log_prefix, location_config, dry_run):
|
def execute_dump_command(
|
||||||
|
database, log_prefix, dump_path, database_names, extra_environment, dry_run, dry_run_label
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Kick off a dump for the given MySQL/MariaDB database (provided as a configuration dict) to a
|
||||||
|
named pipe constructed from the given dump path and database name. Use the given log prefix in
|
||||||
|
any log entries.
|
||||||
|
|
||||||
|
Return a subprocess.Popen instance for the dump process ready to spew to a named pipe. But if
|
||||||
|
this is a dry run, then don't actually dump anything and return None.
|
||||||
|
'''
|
||||||
|
database_name = database['name']
|
||||||
|
dump_filename = dump.make_data_source_dump_filename(
|
||||||
|
dump_path, database['name'], database.get('hostname')
|
||||||
|
)
|
||||||
|
|
||||||
|
if os.path.exists(dump_filename):
|
||||||
|
logger.warning(
|
||||||
|
f'{log_prefix}: Skipping duplicate dump of MySQL database "{database_name}" to {dump_filename}'
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
mysql_dump_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(database.get('mysql_dump_command') or 'mysqldump')
|
||||||
|
)
|
||||||
|
dump_command = (
|
||||||
|
mysql_dump_command
|
||||||
|
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
||||||
|
+ (('--add-drop-database',) if database.get('add_drop_database', True) else ())
|
||||||
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
||||||
|
+ (('--user', database['username']) if 'username' in database else ())
|
||||||
|
+ ('--databases',)
|
||||||
|
+ database_names
|
||||||
|
+ ('--result-file', dump_filename)
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.debug(
|
||||||
|
f'{log_prefix}: Dumping MySQL database "{database_name}" to {dump_filename}{dry_run_label}'
|
||||||
|
)
|
||||||
|
if dry_run:
|
||||||
|
return None
|
||||||
|
|
||||||
|
dump.create_named_pipe_for_dump(dump_filename)
|
||||||
|
|
||||||
|
return execute_command(
|
||||||
|
dump_command,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
run_to_completion=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of MySQL database configuration dicts, a configuration dict (ignored), and a
|
||||||
|
log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(databases)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Dump the given MySQL/MariaDB databases to a named pipe. The databases are supplied as a sequence
|
Dump the given MySQL/MariaDB databases to a named pipe. The databases are supplied as a sequence
|
||||||
of dicts, one dict describing each database as per the configuration schema. Use the given log
|
of dicts, one dict describing each database as per the configuration schema. Use the given
|
||||||
prefix in any log entries. Use the given location configuration dict to construct the
|
configuration dict to construct the destination path and the given log prefix in any log entries.
|
||||||
destination path.
|
|
||||||
|
|
||||||
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
||||||
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
||||||
|
@ -70,103 +134,113 @@ def dump_databases(databases, log_prefix, location_config, dry_run):
|
||||||
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
processes = []
|
processes = []
|
||||||
|
|
||||||
logger.info('{}: Dumping MySQL databases{}'.format(log_prefix, dry_run_label))
|
logger.info(f'{log_prefix}: Dumping MySQL databases{dry_run_label}')
|
||||||
|
|
||||||
for database in databases:
|
for database in databases:
|
||||||
requested_name = database['name']
|
dump_path = make_dump_path(config)
|
||||||
dump_filename = dump.make_database_dump_filename(
|
|
||||||
make_dump_path(location_config), requested_name, database.get('hostname')
|
|
||||||
)
|
|
||||||
extra_environment = {'MYSQL_PWD': database['password']} if 'password' in database else None
|
extra_environment = {'MYSQL_PWD': database['password']} if 'password' in database else None
|
||||||
dump_database_names = database_names_to_dump(
|
dump_database_names = database_names_to_dump(
|
||||||
database, extra_environment, log_prefix, dry_run_label
|
database, extra_environment, log_prefix, dry_run
|
||||||
)
|
)
|
||||||
|
|
||||||
if not dump_database_names:
|
if not dump_database_names:
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
|
||||||
raise ValueError('Cannot find any MySQL databases to dump.')
|
raise ValueError('Cannot find any MySQL databases to dump.')
|
||||||
|
|
||||||
dump_command = (
|
if database['name'] == 'all' and database.get('format'):
|
||||||
('mysqldump',)
|
for dump_name in dump_database_names:
|
||||||
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
renamed_database = copy.copy(database)
|
||||||
+ ('--add-drop-database',)
|
renamed_database['name'] = dump_name
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
processes.append(
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
execute_dump_command(
|
||||||
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
renamed_database,
|
||||||
+ (('--user', database['username']) if 'username' in database else ())
|
log_prefix,
|
||||||
+ ('--databases',)
|
dump_path,
|
||||||
+ dump_database_names
|
(dump_name,),
|
||||||
# Use shell redirection rather than execute_command(output_file=open(...)) to prevent
|
extra_environment,
|
||||||
# the open() call on a named pipe from hanging the main borgmatic process.
|
dry_run,
|
||||||
+ ('>', dump_filename)
|
dry_run_label,
|
||||||
)
|
)
|
||||||
|
)
|
||||||
logger.debug(
|
else:
|
||||||
'{}: Dumping MySQL database {} to {}{}'.format(
|
processes.append(
|
||||||
log_prefix, requested_name, dump_filename, dry_run_label
|
execute_dump_command(
|
||||||
|
database,
|
||||||
|
log_prefix,
|
||||||
|
dump_path,
|
||||||
|
dump_database_names,
|
||||||
|
extra_environment,
|
||||||
|
dry_run,
|
||||||
|
dry_run_label,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
)
|
|
||||||
if dry_run:
|
|
||||||
continue
|
|
||||||
|
|
||||||
dump.create_named_pipe_for_dump(dump_filename)
|
return [process for process in processes if process]
|
||||||
|
|
||||||
processes.append(
|
|
||||||
execute_command(
|
|
||||||
dump_command,
|
|
||||||
shell=True,
|
|
||||||
extra_environment=extra_environment,
|
|
||||||
run_to_completion=False,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
return processes
|
|
||||||
|
|
||||||
|
|
||||||
def remove_database_dumps(databases, log_prefix, location_config, dry_run): # pragma: no cover
|
def remove_data_source_dumps(databases, config, log_prefix, dry_run): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Remove all database dump files for this hook regardless of the given databases. Use the log
|
Remove all database dump files for this hook regardless of the given databases. Use the given
|
||||||
prefix in any log entries. Use the given location configuration dict to construct the
|
configuration dict to construct the destination path and the log prefix in any log entries. If
|
||||||
destination path. If this is a dry run, then don't actually remove anything.
|
this is a dry run, then don't actually remove anything.
|
||||||
'''
|
'''
|
||||||
dump.remove_database_dumps(make_dump_path(location_config), 'MySQL', log_prefix, dry_run)
|
dump.remove_data_source_dumps(make_dump_path(config), 'MySQL', log_prefix, dry_run)
|
||||||
|
|
||||||
|
|
||||||
def make_database_dump_pattern(
|
def make_data_source_dump_pattern(databases, config, log_prefix, name=None): # pragma: no cover
|
||||||
databases, log_prefix, location_config, name=None
|
|
||||||
): # pragma: no cover
|
|
||||||
'''
|
'''
|
||||||
Given a sequence of configurations dicts, a prefix to log with, a location configuration dict,
|
Given a sequence of configurations dicts, a configuration dict, a prefix to log with, and a
|
||||||
and a database name to match, return the corresponding glob patterns to match the database dump
|
database name to match, return the corresponding glob patterns to match the database dump in an
|
||||||
in an archive.
|
archive.
|
||||||
'''
|
'''
|
||||||
return dump.make_database_dump_filename(make_dump_path(location_config), name, hostname='*')
|
return dump.make_data_source_dump_filename(make_dump_path(config), name, hostname='*')
|
||||||
|
|
||||||
|
|
||||||
def restore_database_dump(database_config, log_prefix, location_config, dry_run, extract_process):
|
def restore_data_source_dump(
|
||||||
|
hook_config, config, log_prefix, data_source, dry_run, extract_process, connection_params
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Restore the given MySQL/MariaDB database from an extract stream. The database is supplied as a
|
Restore a database from the given extract stream. The database is supplied as a data source
|
||||||
one-element sequence containing a dict describing the database, as per the configuration schema.
|
configuration dict, but the given hook configuration is ignored. The given configuration dict is
|
||||||
Use the given log prefix in any log entries. If this is a dry run, then don't actually restore
|
used to construct the destination path, and the given log prefix is used for any log entries. If
|
||||||
anything. Trigger the given active extract process (an instance of subprocess.Popen) to produce
|
this is a dry run, then don't actually restore anything. Trigger the given active extract
|
||||||
output to consume.
|
process (an instance of subprocess.Popen) to produce output to consume.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
hostname = connection_params['hostname'] or data_source.get(
|
||||||
|
'restore_hostname', data_source.get('hostname')
|
||||||
|
)
|
||||||
|
port = str(
|
||||||
|
connection_params['port'] or data_source.get('restore_port', data_source.get('port', ''))
|
||||||
|
)
|
||||||
|
username = connection_params['username'] or data_source.get(
|
||||||
|
'restore_username', data_source.get('username')
|
||||||
|
)
|
||||||
|
password = connection_params['password'] or data_source.get(
|
||||||
|
'restore_password', data_source.get('password')
|
||||||
|
)
|
||||||
|
|
||||||
if len(database_config) != 1:
|
mysql_restore_command = tuple(
|
||||||
raise ValueError('The database configuration value is invalid')
|
shlex.quote(part) for part in shlex.split(data_source.get('mysql_command') or 'mysql')
|
||||||
|
)
|
||||||
database = database_config[0]
|
|
||||||
restore_command = (
|
restore_command = (
|
||||||
('mysql', '--batch')
|
mysql_restore_command
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ ('--batch',)
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
+ (
|
||||||
+ (('--protocol', 'tcp') if 'hostname' in database or 'port' in database else ())
|
tuple(data_source['restore_options'].split(' '))
|
||||||
+ (('--user', database['username']) if 'username' in database else ())
|
if 'restore_options' in data_source
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ (('--host', hostname) if hostname else ())
|
||||||
|
+ (('--port', str(port)) if port else ())
|
||||||
|
+ (('--protocol', 'tcp') if hostname or port else ())
|
||||||
|
+ (('--user', username) if username else ())
|
||||||
)
|
)
|
||||||
extra_environment = {'MYSQL_PWD': database['password']} if 'password' in database else None
|
extra_environment = {'MYSQL_PWD': password} if password else None
|
||||||
|
|
||||||
logger.debug(
|
logger.debug(f"{log_prefix}: Restoring MySQL database {data_source['name']}{dry_run_label}")
|
||||||
'{}: Restoring MySQL database {}{}'.format(log_prefix, database['name'], dry_run_label)
|
|
||||||
)
|
|
||||||
if dry_run:
|
if dry_run:
|
||||||
return
|
return
|
||||||
|
|
||||||
|
|
|
@ -2,19 +2,11 @@ import logging
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
from borgmatic.hooks import monitor
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
MONITOR_STATE_TO_NTFY = {
|
|
||||||
monitor.State.START: None,
|
|
||||||
monitor.State.FINISH: None,
|
|
||||||
monitor.State.FAIL: None,
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def initialize_monitor(
|
def initialize_monitor(
|
||||||
ping_url, config_filename, monitoring_log_level, dry_run
|
ping_url, config, config_filename, monitoring_log_level, dry_run
|
||||||
): # pragma: no cover
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
No initialization is necessary for this monitor.
|
No initialization is necessary for this monitor.
|
||||||
|
@ -22,7 +14,7 @@ def initialize_monitor(
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Ping the configured Ntfy topic. Use the given configuration filename in any log entries.
|
Ping the configured Ntfy topic. Use the given configuration filename in any log entries.
|
||||||
If this is a dry run, then don't actually ping anything.
|
If this is a dry run, then don't actually ping anything.
|
||||||
|
@ -36,8 +28,8 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
state_config = hook_config.get(
|
state_config = hook_config.get(
|
||||||
state.name.lower(),
|
state.name.lower(),
|
||||||
{
|
{
|
||||||
'title': f'A Borgmatic {state.name} event happened',
|
'title': f'A borgmatic {state.name} event happened',
|
||||||
'message': f'A Borgmatic {state.name} event happened',
|
'message': f'A borgmatic {state.name} event happened',
|
||||||
'priority': 'default',
|
'priority': 'default',
|
||||||
'tags': 'borgmatic',
|
'tags': 'borgmatic',
|
||||||
},
|
},
|
||||||
|
@ -56,18 +48,41 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
'X-Tags': state_config.get('tags'),
|
'X-Tags': state_config.get('tags'),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
username = hook_config.get('username')
|
||||||
|
password = hook_config.get('password')
|
||||||
|
access_token = hook_config.get('access_token')
|
||||||
|
auth = None
|
||||||
|
|
||||||
|
if access_token is not None:
|
||||||
|
if username or password:
|
||||||
|
logger.warning(
|
||||||
|
f'{config_filename}: ntfy access_token is set but so is username/password, only using access_token'
|
||||||
|
)
|
||||||
|
auth = requests.auth.HTTPBasicAuth('', access_token)
|
||||||
|
elif (username and password) is not None:
|
||||||
|
auth = requests.auth.HTTPBasicAuth(username, password)
|
||||||
|
logger.info(f'{config_filename}: Using basic auth with user {username} for ntfy')
|
||||||
|
elif username is not None:
|
||||||
|
logger.warning(
|
||||||
|
f'{config_filename}: Password missing for ntfy authentication, defaulting to no auth'
|
||||||
|
)
|
||||||
|
elif password is not None:
|
||||||
|
logger.warning(
|
||||||
|
f'{config_filename}: Username missing for ntfy authentication, defaulting to no auth'
|
||||||
|
)
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
try:
|
try:
|
||||||
response = requests.post(f'{base_url}/{topic}', headers=headers)
|
response = requests.post(f'{base_url}/{topic}', headers=headers, auth=auth)
|
||||||
if not response.ok:
|
if not response.ok:
|
||||||
response.raise_for_status()
|
response.raise_for_status()
|
||||||
except requests.exceptions.RequestException as error:
|
except requests.exceptions.RequestException as error:
|
||||||
logger.warning(f'{config_filename}: Ntfy error: {error}')
|
logger.warning(f'{config_filename}: ntfy error: {error}')
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(
|
def destroy_monitor(
|
||||||
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
ping_url_or_uuid, config, config_filename, monitoring_log_level, dry_run
|
||||||
): # pragma: no cover
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
No destruction is necessary for this monitor.
|
No destruction is necessary for this monitor.
|
||||||
|
|
|
@ -13,7 +13,7 @@ EVENTS_API_URL = 'https://events.pagerduty.com/v2/enqueue'
|
||||||
|
|
||||||
|
|
||||||
def initialize_monitor(
|
def initialize_monitor(
|
||||||
integration_key, config_filename, monitoring_log_level, dry_run
|
integration_key, config, config_filename, monitoring_log_level, dry_run
|
||||||
): # pragma: no cover
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
No initialization is necessary for this monitor.
|
No initialization is necessary for this monitor.
|
||||||
|
@ -21,7 +21,7 @@ def initialize_monitor(
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
If this is an error state, create a PagerDuty event with the configured integration key. Use
|
If this is an error state, create a PagerDuty event with the configured integration key. Use
|
||||||
the given configuration filename in any log entries. If this is a dry run, then don't actually
|
the given configuration filename in any log entries. If this is a dry run, then don't actually
|
||||||
|
@ -29,14 +29,12 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
'''
|
'''
|
||||||
if state != monitor.State.FAIL:
|
if state != monitor.State.FAIL:
|
||||||
logger.debug(
|
logger.debug(
|
||||||
'{}: Ignoring unsupported monitoring {} in PagerDuty hook'.format(
|
f'{config_filename}: Ignoring unsupported monitoring {state.name.lower()} in PagerDuty hook',
|
||||||
config_filename, state.name.lower()
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
dry_run_label = ' (dry run; not actually sending)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually sending)' if dry_run else ''
|
||||||
logger.info('{}: Sending failure event to PagerDuty {}'.format(config_filename, dry_run_label))
|
logger.info(f'{config_filename}: Sending failure event to PagerDuty {dry_run_label}')
|
||||||
|
|
||||||
if dry_run:
|
if dry_run:
|
||||||
return
|
return
|
||||||
|
@ -50,7 +48,7 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
'routing_key': hook_config['integration_key'],
|
'routing_key': hook_config['integration_key'],
|
||||||
'event_action': 'trigger',
|
'event_action': 'trigger',
|
||||||
'payload': {
|
'payload': {
|
||||||
'summary': 'backup failed on {}'.format(hostname),
|
'summary': f'backup failed on {hostname}',
|
||||||
'severity': 'error',
|
'severity': 'error',
|
||||||
'source': hostname,
|
'source': hostname,
|
||||||
'timestamp': local_timestamp,
|
'timestamp': local_timestamp,
|
||||||
|
@ -65,7 +63,7 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
logger.debug('{}: Using PagerDuty payload: {}'.format(config_filename, payload))
|
logger.debug(f'{config_filename}: Using PagerDuty payload: {payload}')
|
||||||
|
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
try:
|
try:
|
||||||
|
@ -77,7 +75,7 @@ def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(
|
def destroy_monitor(
|
||||||
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
ping_url_or_uuid, config, config_filename, monitoring_log_level, dry_run
|
||||||
): # pragma: no cover
|
): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
No destruction is necessary for this monitor.
|
No destruction is necessary for this monitor.
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
import csv
|
import csv
|
||||||
|
import itertools
|
||||||
import logging
|
import logging
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
|
||||||
from borgmatic.execute import (
|
from borgmatic.execute import (
|
||||||
execute_command,
|
execute_command,
|
||||||
|
@ -11,23 +14,34 @@ from borgmatic.hooks import dump
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def make_dump_path(location_config): # pragma: no cover
|
def make_dump_path(config): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Make the dump path from the given location configuration and the name of this hook.
|
Make the dump path from the given configuration dict and the name of this hook.
|
||||||
'''
|
'''
|
||||||
return dump.make_database_dump_path(
|
return dump.make_data_source_dump_path(
|
||||||
location_config.get('borgmatic_source_directory'), 'postgresql_databases'
|
config.get('borgmatic_source_directory'), 'postgresql_databases'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def make_extra_environment(database):
|
def make_extra_environment(database, restore_connection_params=None):
|
||||||
'''
|
'''
|
||||||
Make the extra_environment dict from the given database configuration.
|
Make the extra_environment dict from the given database configuration. If restore connection
|
||||||
|
params are given, this is for a restore operation.
|
||||||
'''
|
'''
|
||||||
extra = dict()
|
extra = dict()
|
||||||
if 'password' in database:
|
|
||||||
extra['PGPASSWORD'] = database['password']
|
try:
|
||||||
extra['PGSSLMODE'] = database.get('ssl_mode', 'disable')
|
if restore_connection_params:
|
||||||
|
extra['PGPASSWORD'] = restore_connection_params.get('password') or database.get(
|
||||||
|
'restore_password', database['password']
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
extra['PGPASSWORD'] = database['password']
|
||||||
|
except (AttributeError, KeyError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
if 'ssl_mode' in database:
|
||||||
|
extra['PGSSLMODE'] = database['ssl_mode']
|
||||||
if 'ssl_cert' in database:
|
if 'ssl_cert' in database:
|
||||||
extra['PGSSLCERT'] = database['ssl_cert']
|
extra['PGSSLCERT'] = database['ssl_cert']
|
||||||
if 'ssl_key' in database:
|
if 'ssl_key' in database:
|
||||||
|
@ -36,13 +50,14 @@ def make_extra_environment(database):
|
||||||
extra['PGSSLROOTCERT'] = database['ssl_root_cert']
|
extra['PGSSLROOTCERT'] = database['ssl_root_cert']
|
||||||
if 'ssl_crl' in database:
|
if 'ssl_crl' in database:
|
||||||
extra['PGSSLCRL'] = database['ssl_crl']
|
extra['PGSSLCRL'] = database['ssl_crl']
|
||||||
|
|
||||||
return extra
|
return extra
|
||||||
|
|
||||||
|
|
||||||
EXCLUDED_DATABASE_NAMES = ('template0', 'template1')
|
EXCLUDED_DATABASE_NAMES = ('template0', 'template1')
|
||||||
|
|
||||||
|
|
||||||
def database_names_to_dump(database, extra_environment, log_prefix, dry_run_label):
|
def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Given a requested database config, return the corresponding sequence of database names to dump.
|
Given a requested database config, return the corresponding sequence of database names to dump.
|
||||||
In the case of "all" when a database format is given, query for the names of databases on the
|
In the case of "all" when a database format is given, query for the names of databases on the
|
||||||
|
@ -55,17 +70,21 @@ def database_names_to_dump(database, extra_environment, log_prefix, dry_run_labe
|
||||||
return (requested_name,)
|
return (requested_name,)
|
||||||
if not database.get('format'):
|
if not database.get('format'):
|
||||||
return ('all',)
|
return ('all',)
|
||||||
|
if dry_run:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
psql_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(database.get('psql_command') or 'psql')
|
||||||
|
)
|
||||||
list_command = (
|
list_command = (
|
||||||
('psql', '--list', '--no-password', '--csv', '--tuples-only')
|
psql_command
|
||||||
|
+ ('--list', '--no-password', '--no-psqlrc', '--csv', '--tuples-only')
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
+ (('--username', database['username']) if 'username' in database else ())
|
+ (('--username', database['username']) if 'username' in database else ())
|
||||||
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
||||||
)
|
|
||||||
logger.debug(
|
|
||||||
'{}: Querying for "all" PostgreSQL databases to dump{}'.format(log_prefix, dry_run_label)
|
|
||||||
)
|
)
|
||||||
|
logger.debug(f'{log_prefix}: Querying for "all" PostgreSQL databases to dump')
|
||||||
list_output = execute_command_and_capture_output(
|
list_output = execute_command_and_capture_output(
|
||||||
list_command, extra_environment=extra_environment
|
list_command, extra_environment=extra_environment
|
||||||
)
|
)
|
||||||
|
@ -77,12 +96,20 @@ def database_names_to_dump(database, extra_environment, log_prefix, dry_run_labe
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def dump_databases(databases, log_prefix, location_config, dry_run):
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of PostgreSQL database configuration dicts, a configuration dict (ignored), and
|
||||||
|
a log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(database.get('format') != 'directory' for database in databases)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Dump the given PostgreSQL databases to a named pipe. The databases are supplied as a sequence of
|
Dump the given PostgreSQL databases to a named pipe. The databases are supplied as a sequence of
|
||||||
dicts, one dict describing each database as per the configuration schema. Use the given log
|
dicts, one dict describing each database as per the configuration schema. Use the given
|
||||||
prefix in any log entries. Use the given location configuration dict to construct the
|
configuration dict to construct the destination path and the given log prefix in any log
|
||||||
destination path.
|
entries.
|
||||||
|
|
||||||
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
||||||
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
||||||
|
@ -92,133 +119,192 @@ def dump_databases(databases, log_prefix, location_config, dry_run):
|
||||||
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
processes = []
|
processes = []
|
||||||
|
|
||||||
logger.info('{}: Dumping PostgreSQL databases{}'.format(log_prefix, dry_run_label))
|
logger.info(f'{log_prefix}: Dumping PostgreSQL databases{dry_run_label}')
|
||||||
|
|
||||||
for database in databases:
|
for database in databases:
|
||||||
extra_environment = make_extra_environment(database)
|
extra_environment = make_extra_environment(database)
|
||||||
dump_path = make_dump_path(location_config)
|
dump_path = make_dump_path(config)
|
||||||
dump_database_names = database_names_to_dump(
|
dump_database_names = database_names_to_dump(
|
||||||
database, extra_environment, log_prefix, dry_run_label
|
database, extra_environment, log_prefix, dry_run
|
||||||
)
|
)
|
||||||
|
|
||||||
if not dump_database_names:
|
if not dump_database_names:
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
|
||||||
raise ValueError('Cannot find any PostgreSQL databases to dump.')
|
raise ValueError('Cannot find any PostgreSQL databases to dump.')
|
||||||
|
|
||||||
for database_name in dump_database_names:
|
for database_name in dump_database_names:
|
||||||
dump_format = database.get('format', None if database_name == 'all' else 'custom')
|
dump_format = database.get('format', None if database_name == 'all' else 'custom')
|
||||||
default_dump_command = 'pg_dumpall' if database_name == 'all' else 'pg_dump'
|
default_dump_command = 'pg_dumpall' if database_name == 'all' else 'pg_dump'
|
||||||
dump_command = database.get('pg_dump_command') or default_dump_command
|
dump_command = tuple(
|
||||||
dump_filename = dump.make_database_dump_filename(
|
shlex.quote(part)
|
||||||
|
for part in shlex.split(database.get('pg_dump_command') or default_dump_command)
|
||||||
|
)
|
||||||
|
dump_filename = dump.make_data_source_dump_filename(
|
||||||
dump_path, database_name, database.get('hostname')
|
dump_path, database_name, database.get('hostname')
|
||||||
)
|
)
|
||||||
|
if os.path.exists(dump_filename):
|
||||||
|
logger.warning(
|
||||||
|
f'{log_prefix}: Skipping duplicate dump of PostgreSQL database "{database_name}" to {dump_filename}'
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
command = (
|
command = (
|
||||||
(dump_command, '--no-password', '--clean', '--if-exists',)
|
dump_command
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ (
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
'--no-password',
|
||||||
+ (('--username', database['username']) if 'username' in database else ())
|
'--clean',
|
||||||
+ (('--format', dump_format) if dump_format else ())
|
'--if-exists',
|
||||||
+ (('--file', dump_filename) if dump_format == 'directory' else ())
|
)
|
||||||
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
+ (('--host', shlex.quote(database['hostname'])) if 'hostname' in database else ())
|
||||||
+ (() if database_name == 'all' else (database_name,))
|
+ (('--port', shlex.quote(str(database['port']))) if 'port' in database else ())
|
||||||
|
+ (
|
||||||
|
('--username', shlex.quote(database['username']))
|
||||||
|
if 'username' in database
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ (('--no-owner',) if database.get('no_owner', False) else ())
|
||||||
|
+ (('--format', shlex.quote(dump_format)) if dump_format else ())
|
||||||
|
+ (('--file', shlex.quote(dump_filename)) if dump_format == 'directory' else ())
|
||||||
|
+ (
|
||||||
|
tuple(shlex.quote(option) for option in database['options'].split(' '))
|
||||||
|
if 'options' in database
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ (() if database_name == 'all' else (shlex.quote(database_name),))
|
||||||
# Use shell redirection rather than the --file flag to sidestep synchronization issues
|
# Use shell redirection rather than the --file flag to sidestep synchronization issues
|
||||||
# when pg_dump/pg_dumpall tries to write to a named pipe. But for the directory dump
|
# when pg_dump/pg_dumpall tries to write to a named pipe. But for the directory dump
|
||||||
# format in a particular, a named destination is required, and redirection doesn't work.
|
# format in a particular, a named destination is required, and redirection doesn't work.
|
||||||
+ (('>', dump_filename) if dump_format != 'directory' else ())
|
+ (('>', shlex.quote(dump_filename)) if dump_format != 'directory' else ())
|
||||||
)
|
)
|
||||||
|
|
||||||
logger.debug(
|
logger.debug(
|
||||||
'{}: Dumping PostgreSQL database "{}" to {}{}'.format(
|
f'{log_prefix}: Dumping PostgreSQL database "{database_name}" to {dump_filename}{dry_run_label}'
|
||||||
log_prefix, database_name, dump_filename, dry_run_label
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
if dry_run:
|
if dry_run:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if dump_format == 'directory':
|
if dump_format == 'directory':
|
||||||
dump.create_parent_directory_for_dump(dump_filename)
|
dump.create_parent_directory_for_dump(dump_filename)
|
||||||
else:
|
|
||||||
dump.create_named_pipe_for_dump(dump_filename)
|
|
||||||
|
|
||||||
processes.append(
|
|
||||||
execute_command(
|
execute_command(
|
||||||
command,
|
command,
|
||||||
shell=True,
|
shell=True,
|
||||||
extra_environment=extra_environment,
|
extra_environment=extra_environment,
|
||||||
run_to_completion=False,
|
|
||||||
)
|
)
|
||||||
)
|
else:
|
||||||
|
dump.create_named_pipe_for_dump(dump_filename)
|
||||||
|
processes.append(
|
||||||
|
execute_command(
|
||||||
|
command,
|
||||||
|
shell=True,
|
||||||
|
extra_environment=extra_environment,
|
||||||
|
run_to_completion=False,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
return processes
|
return processes
|
||||||
|
|
||||||
|
|
||||||
def remove_database_dumps(databases, log_prefix, location_config, dry_run): # pragma: no cover
|
def remove_data_source_dumps(databases, config, log_prefix, dry_run): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Remove all database dump files for this hook regardless of the given databases. Use the log
|
Remove all database dump files for this hook regardless of the given databases. Use the given
|
||||||
prefix in any log entries. Use the given location configuration dict to construct the
|
configuration dict to construct the destination path and the log prefix in any log entries. If
|
||||||
destination path. If this is a dry run, then don't actually remove anything.
|
this is a dry run, then don't actually remove anything.
|
||||||
'''
|
'''
|
||||||
dump.remove_database_dumps(make_dump_path(location_config), 'PostgreSQL', log_prefix, dry_run)
|
dump.remove_data_source_dumps(make_dump_path(config), 'PostgreSQL', log_prefix, dry_run)
|
||||||
|
|
||||||
|
|
||||||
def make_database_dump_pattern(
|
def make_data_source_dump_pattern(databases, config, log_prefix, name=None): # pragma: no cover
|
||||||
databases, log_prefix, location_config, name=None
|
|
||||||
): # pragma: no cover
|
|
||||||
'''
|
'''
|
||||||
Given a sequence of configurations dicts, a prefix to log with, a location configuration dict,
|
Given a sequence of configurations dicts, a configuration dict, a prefix to log with, and a
|
||||||
and a database name to match, return the corresponding glob patterns to match the database dump
|
database name to match, return the corresponding glob patterns to match the database dump in an
|
||||||
in an archive.
|
archive.
|
||||||
'''
|
'''
|
||||||
return dump.make_database_dump_filename(make_dump_path(location_config), name, hostname='*')
|
return dump.make_data_source_dump_filename(make_dump_path(config), name, hostname='*')
|
||||||
|
|
||||||
|
|
||||||
def restore_database_dump(database_config, log_prefix, location_config, dry_run, extract_process):
|
def restore_data_source_dump(
|
||||||
|
hook_config, config, log_prefix, data_source, dry_run, extract_process, connection_params
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Restore the given PostgreSQL database from an extract stream. The database is supplied as a
|
Restore a database from the given extract stream. The database is supplied as a data source
|
||||||
one-element sequence containing a dict describing the database, as per the configuration schema.
|
configuration dict, but the given hook configuration is ignored. The given configuration dict is
|
||||||
Use the given log prefix in any log entries. If this is a dry run, then don't actually restore
|
used to construct the destination path, and the given log prefix is used for any log entries. If
|
||||||
anything. Trigger the given active extract process (an instance of subprocess.Popen) to produce
|
this is a dry run, then don't actually restore anything. Trigger the given active extract
|
||||||
output to consume.
|
process (an instance of subprocess.Popen) to produce output to consume.
|
||||||
|
|
||||||
If the extract process is None, then restore the dump from the filesystem rather than from an
|
If the extract process is None, then restore the dump from the filesystem rather than from an
|
||||||
extract stream.
|
extract stream.
|
||||||
|
|
||||||
|
Use the given connection parameters to connect to the database. The connection parameters are
|
||||||
|
hostname, port, username, and password.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
hostname = connection_params['hostname'] or data_source.get(
|
||||||
if len(database_config) != 1:
|
'restore_hostname', data_source.get('hostname')
|
||||||
raise ValueError('The database configuration value is invalid')
|
)
|
||||||
|
port = str(
|
||||||
database = database_config[0]
|
connection_params['port'] or data_source.get('restore_port', data_source.get('port', ''))
|
||||||
all_databases = bool(database['name'] == 'all')
|
)
|
||||||
dump_filename = dump.make_database_dump_filename(
|
username = connection_params['username'] or data_source.get(
|
||||||
make_dump_path(location_config), database['name'], database.get('hostname')
|
'restore_username', data_source.get('username')
|
||||||
|
)
|
||||||
|
|
||||||
|
all_databases = bool(data_source['name'] == 'all')
|
||||||
|
dump_filename = dump.make_data_source_dump_filename(
|
||||||
|
make_dump_path(config), data_source['name'], data_source.get('hostname')
|
||||||
|
)
|
||||||
|
psql_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(data_source.get('psql_command') or 'psql')
|
||||||
)
|
)
|
||||||
psql_command = database.get('psql_command') or 'psql'
|
|
||||||
analyze_command = (
|
analyze_command = (
|
||||||
(psql_command, '--no-password', '--quiet')
|
psql_command
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ ('--no-password', '--no-psqlrc', '--quiet')
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
+ (('--host', hostname) if hostname else ())
|
||||||
+ (('--username', database['username']) if 'username' in database else ())
|
+ (('--port', port) if port else ())
|
||||||
+ (('--dbname', database['name']) if not all_databases else ())
|
+ (('--username', username) if username else ())
|
||||||
+ ('--command', 'ANALYZE')
|
+ (('--dbname', data_source['name']) if not all_databases else ())
|
||||||
)
|
|
||||||
pg_restore_command = database.get('pg_restore_command') or 'pg_restore'
|
|
||||||
restore_command = (
|
|
||||||
(psql_command if all_databases else pg_restore_command, '--no-password')
|
|
||||||
+ (
|
+ (
|
||||||
('--if-exists', '--exit-on-error', '--clean', '--dbname', database['name'])
|
tuple(data_source['analyze_options'].split(' '))
|
||||||
if not all_databases
|
if 'analyze_options' in data_source
|
||||||
else ()
|
else ()
|
||||||
)
|
)
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ ('--command', 'ANALYZE')
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
)
|
||||||
+ (('--username', database['username']) if 'username' in database else ())
|
use_psql_command = all_databases or data_source.get('format') == 'plain'
|
||||||
+ (() if extract_process else (dump_filename,))
|
pg_restore_command = tuple(
|
||||||
|
shlex.quote(part)
|
||||||
|
for part in shlex.split(data_source.get('pg_restore_command') or 'pg_restore')
|
||||||
|
)
|
||||||
|
restore_command = (
|
||||||
|
(psql_command if use_psql_command else pg_restore_command)
|
||||||
|
+ ('--no-password',)
|
||||||
|
+ (('--no-psqlrc',) if use_psql_command else ('--if-exists', '--exit-on-error', '--clean'))
|
||||||
|
+ (('--dbname', data_source['name']) if not all_databases else ())
|
||||||
|
+ (('--host', hostname) if hostname else ())
|
||||||
|
+ (('--port', port) if port else ())
|
||||||
|
+ (('--username', username) if username else ())
|
||||||
|
+ (('--no-owner',) if data_source.get('no_owner', False) else ())
|
||||||
|
+ (
|
||||||
|
tuple(data_source['restore_options'].split(' '))
|
||||||
|
if 'restore_options' in data_source
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
+ (() if extract_process else (dump_filename,))
|
||||||
|
+ tuple(
|
||||||
|
itertools.chain.from_iterable(('--schema', schema) for schema in data_source['schemas'])
|
||||||
|
if data_source.get('schemas')
|
||||||
|
else ()
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
extra_environment = make_extra_environment(
|
||||||
|
data_source, restore_connection_params=connection_params
|
||||||
)
|
)
|
||||||
extra_environment = make_extra_environment(database)
|
|
||||||
|
|
||||||
logger.debug(
|
logger.debug(
|
||||||
'{}: Restoring PostgreSQL database {}{}'.format(log_prefix, database['name'], dry_run_label)
|
f"{log_prefix}: Restoring PostgreSQL database {data_source['name']}{dry_run_label}"
|
||||||
)
|
)
|
||||||
if dry_run:
|
if dry_run:
|
||||||
return
|
return
|
||||||
|
|
135
borgmatic/hooks/sqlite.py
Normal file
135
borgmatic/hooks/sqlite.py
Normal file
|
@ -0,0 +1,135 @@
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import shlex
|
||||||
|
|
||||||
|
from borgmatic.execute import execute_command, execute_command_with_processes
|
||||||
|
from borgmatic.hooks import dump
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def make_dump_path(config): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Make the dump path from the given configuration dict and the name of this hook.
|
||||||
|
'''
|
||||||
|
return dump.make_data_source_dump_path(
|
||||||
|
config.get('borgmatic_source_directory'), 'sqlite_databases'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of SQLite database configuration dicts, a configuration dict (ignored), and a
|
||||||
|
log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(databases)
|
||||||
|
|
||||||
|
|
||||||
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
|
'''
|
||||||
|
Dump the given SQLite databases to a named pipe. The databases are supplied as a sequence of
|
||||||
|
configuration dicts, as per the configuration schema. Use the given configuration dict to
|
||||||
|
construct the destination path and the given log prefix in any log entries.
|
||||||
|
|
||||||
|
Return a sequence of subprocess.Popen instances for the dump processes ready to spew to a named
|
||||||
|
pipe. But if this is a dry run, then don't actually dump anything and return an empty sequence.
|
||||||
|
'''
|
||||||
|
dry_run_label = ' (dry run; not actually dumping anything)' if dry_run else ''
|
||||||
|
processes = []
|
||||||
|
|
||||||
|
logger.info(f'{log_prefix}: Dumping SQLite databases{dry_run_label}')
|
||||||
|
|
||||||
|
for database in databases:
|
||||||
|
database_path = database['path']
|
||||||
|
|
||||||
|
if database['name'] == 'all':
|
||||||
|
logger.warning('The "all" database name has no meaning for SQLite databases')
|
||||||
|
if not os.path.exists(database_path):
|
||||||
|
logger.warning(
|
||||||
|
f'{log_prefix}: No SQLite database at {database_path}; an empty database will be created and dumped'
|
||||||
|
)
|
||||||
|
|
||||||
|
dump_path = make_dump_path(config)
|
||||||
|
dump_filename = dump.make_data_source_dump_filename(dump_path, database['name'])
|
||||||
|
|
||||||
|
if os.path.exists(dump_filename):
|
||||||
|
logger.warning(
|
||||||
|
f'{log_prefix}: Skipping duplicate dump of SQLite database at {database_path} to {dump_filename}'
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
command = (
|
||||||
|
'sqlite3',
|
||||||
|
shlex.quote(database_path),
|
||||||
|
'.dump',
|
||||||
|
'>',
|
||||||
|
shlex.quote(dump_filename),
|
||||||
|
)
|
||||||
|
logger.debug(
|
||||||
|
f'{log_prefix}: Dumping SQLite database at {database_path} to {dump_filename}{dry_run_label}'
|
||||||
|
)
|
||||||
|
if dry_run:
|
||||||
|
continue
|
||||||
|
|
||||||
|
dump.create_named_pipe_for_dump(dump_filename)
|
||||||
|
processes.append(execute_command(command, shell=True, run_to_completion=False))
|
||||||
|
|
||||||
|
return processes
|
||||||
|
|
||||||
|
|
||||||
|
def remove_data_source_dumps(databases, config, log_prefix, dry_run): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Remove the given SQLite database dumps from the filesystem. The databases are supplied as a
|
||||||
|
sequence of configuration dicts, as per the configuration schema. Use the given configuration
|
||||||
|
dict to construct the destination path and the given log prefix in any log entries. If this is a
|
||||||
|
dry run, then don't actually remove anything.
|
||||||
|
'''
|
||||||
|
dump.remove_data_source_dumps(make_dump_path(config), 'SQLite', log_prefix, dry_run)
|
||||||
|
|
||||||
|
|
||||||
|
def make_data_source_dump_pattern(databases, config, log_prefix, name=None): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Make a pattern that matches the given SQLite databases. The databases are supplied as a sequence
|
||||||
|
of configuration dicts, as per the configuration schema.
|
||||||
|
'''
|
||||||
|
return dump.make_data_source_dump_filename(make_dump_path(config), name)
|
||||||
|
|
||||||
|
|
||||||
|
def restore_data_source_dump(
|
||||||
|
hook_config, config, log_prefix, data_source, dry_run, extract_process, connection_params
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Restore a database from the given extract stream. The database is supplied as a data source
|
||||||
|
configuration dict, but the given hook configuration is ignored. The given configuration dict is
|
||||||
|
used to construct the destination path, and the given log prefix is used for any log entries. If
|
||||||
|
this is a dry run, then don't actually restore anything. Trigger the given active extract
|
||||||
|
process (an instance of subprocess.Popen) to produce output to consume.
|
||||||
|
'''
|
||||||
|
dry_run_label = ' (dry run; not actually restoring anything)' if dry_run else ''
|
||||||
|
database_path = connection_params['restore_path'] or data_source.get(
|
||||||
|
'restore_path', data_source.get('path')
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.debug(f'{log_prefix}: Restoring SQLite database at {database_path}{dry_run_label}')
|
||||||
|
if dry_run:
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
os.remove(database_path)
|
||||||
|
logger.warning(f'{log_prefix}: Removed existing SQLite database at {database_path}')
|
||||||
|
except FileNotFoundError: # pragma: no cover
|
||||||
|
pass
|
||||||
|
|
||||||
|
restore_command = (
|
||||||
|
'sqlite3',
|
||||||
|
database_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Don't give Borg local path so as to error on warnings, as "borg extract" only gives a warning
|
||||||
|
# if the restore paths don't exist in the archive.
|
||||||
|
execute_command_with_processes(
|
||||||
|
restore_command,
|
||||||
|
[extract_process],
|
||||||
|
output_log_level=logging.DEBUG,
|
||||||
|
input_file=extract_process.stdout,
|
||||||
|
)
|
|
@ -41,6 +41,9 @@ def should_do_markup(no_color, configs):
|
||||||
if any(config.get('output', {}).get('color') is False for config in configs.values()):
|
if any(config.get('output', {}).get('color') is False for config in configs.values()):
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
if os.environ.get('NO_COLOR', None):
|
||||||
|
return False
|
||||||
|
|
||||||
py_colors = os.environ.get('PY_COLORS', None)
|
py_colors = os.environ.get('PY_COLORS', None)
|
||||||
|
|
||||||
if py_colors is not None:
|
if py_colors is not None:
|
||||||
|
@ -68,7 +71,7 @@ class Multi_stream_handler(logging.Handler):
|
||||||
|
|
||||||
def emit(self, record):
|
def emit(self, record):
|
||||||
'''
|
'''
|
||||||
Dispatch the log record to the approriate stream handler for the record's log level.
|
Dispatch the log record to the appropriate stream handler for the record's log level.
|
||||||
'''
|
'''
|
||||||
self.log_level_to_handler[record.levelno].emit(record)
|
self.log_level_to_handler[record.levelno].emit(record)
|
||||||
|
|
||||||
|
@ -85,6 +88,11 @@ class Multi_stream_handler(logging.Handler):
|
||||||
handler.setLevel(level)
|
handler.setLevel(level)
|
||||||
|
|
||||||
|
|
||||||
|
class Console_no_color_formatter(logging.Formatter):
|
||||||
|
def format(self, record):
|
||||||
|
return record.msg
|
||||||
|
|
||||||
|
|
||||||
class Console_color_formatter(logging.Formatter):
|
class Console_color_formatter(logging.Formatter):
|
||||||
def format(self, record):
|
def format(self, record):
|
||||||
add_custom_log_levels()
|
add_custom_log_levels()
|
||||||
|
@ -108,7 +116,7 @@ def color_text(color, message):
|
||||||
if not color:
|
if not color:
|
||||||
return message
|
return message
|
||||||
|
|
||||||
return '{}{}{}'.format(color, message, colorama.Style.RESET_ALL)
|
return f'{color}{message}{colorama.Style.RESET_ALL}'
|
||||||
|
|
||||||
|
|
||||||
def add_logging_level(level_name, level_number):
|
def add_logging_level(level_name, level_number):
|
||||||
|
@ -141,6 +149,7 @@ def add_logging_level(level_name, level_number):
|
||||||
|
|
||||||
|
|
||||||
ANSWER = logging.WARN - 5
|
ANSWER = logging.WARN - 5
|
||||||
|
DISABLED = logging.CRITICAL + 10
|
||||||
|
|
||||||
|
|
||||||
def add_custom_log_levels(): # pragma: no cover
|
def add_custom_log_levels(): # pragma: no cover
|
||||||
|
@ -148,6 +157,7 @@ def add_custom_log_levels(): # pragma: no cover
|
||||||
Add a custom log level between WARN and INFO for user-requested answers.
|
Add a custom log level between WARN and INFO for user-requested answers.
|
||||||
'''
|
'''
|
||||||
add_logging_level('ANSWER', ANSWER)
|
add_logging_level('ANSWER', ANSWER)
|
||||||
|
add_logging_level('DISABLED', DISABLED)
|
||||||
|
|
||||||
|
|
||||||
def configure_logging(
|
def configure_logging(
|
||||||
|
@ -156,28 +166,32 @@ def configure_logging(
|
||||||
log_file_log_level=None,
|
log_file_log_level=None,
|
||||||
monitoring_log_level=None,
|
monitoring_log_level=None,
|
||||||
log_file=None,
|
log_file=None,
|
||||||
|
log_file_format=None,
|
||||||
|
color_enabled=True,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Configure logging to go to both the console and (syslog or log file). Use the given log levels,
|
Configure logging to go to both the console and (syslog or log file). Use the given log levels,
|
||||||
respectively.
|
respectively. If color is enabled, set up log formatting accordingly.
|
||||||
|
|
||||||
Raise FileNotFoundError or PermissionError if the log file could not be opened for writing.
|
Raise FileNotFoundError or PermissionError if the log file could not be opened for writing.
|
||||||
'''
|
'''
|
||||||
|
add_custom_log_levels()
|
||||||
|
|
||||||
if syslog_log_level is None:
|
if syslog_log_level is None:
|
||||||
syslog_log_level = console_log_level
|
syslog_log_level = logging.DISABLED
|
||||||
if log_file_log_level is None:
|
if log_file_log_level is None:
|
||||||
log_file_log_level = console_log_level
|
log_file_log_level = console_log_level
|
||||||
if monitoring_log_level is None:
|
if monitoring_log_level is None:
|
||||||
monitoring_log_level = console_log_level
|
monitoring_log_level = console_log_level
|
||||||
|
|
||||||
add_custom_log_levels()
|
|
||||||
|
|
||||||
# Log certain log levels to console stderr and others to stdout. This supports use cases like
|
# Log certain log levels to console stderr and others to stdout. This supports use cases like
|
||||||
# grepping (non-error) output.
|
# grepping (non-error) output.
|
||||||
|
console_disabled = logging.NullHandler()
|
||||||
console_error_handler = logging.StreamHandler(sys.stderr)
|
console_error_handler = logging.StreamHandler(sys.stderr)
|
||||||
console_standard_handler = logging.StreamHandler(sys.stdout)
|
console_standard_handler = logging.StreamHandler(sys.stdout)
|
||||||
console_handler = Multi_stream_handler(
|
console_handler = Multi_stream_handler(
|
||||||
{
|
{
|
||||||
|
logging.DISABLED: console_disabled,
|
||||||
logging.CRITICAL: console_error_handler,
|
logging.CRITICAL: console_error_handler,
|
||||||
logging.ERROR: console_error_handler,
|
logging.ERROR: console_error_handler,
|
||||||
logging.WARN: console_error_handler,
|
logging.WARN: console_error_handler,
|
||||||
|
@ -186,11 +200,19 @@ def configure_logging(
|
||||||
logging.DEBUG: console_standard_handler,
|
logging.DEBUG: console_standard_handler,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
console_handler.setFormatter(Console_color_formatter())
|
|
||||||
|
if color_enabled:
|
||||||
|
console_handler.setFormatter(Console_color_formatter())
|
||||||
|
else:
|
||||||
|
console_handler.setFormatter(Console_no_color_formatter())
|
||||||
|
|
||||||
console_handler.setLevel(console_log_level)
|
console_handler.setLevel(console_log_level)
|
||||||
|
|
||||||
syslog_path = None
|
handlers = [console_handler]
|
||||||
if log_file is None:
|
|
||||||
|
if syslog_log_level != logging.DISABLED:
|
||||||
|
syslog_path = None
|
||||||
|
|
||||||
if os.path.exists('/dev/log'):
|
if os.path.exists('/dev/log'):
|
||||||
syslog_path = '/dev/log'
|
syslog_path = '/dev/log'
|
||||||
elif os.path.exists('/var/run/syslog'):
|
elif os.path.exists('/var/run/syslog'):
|
||||||
|
@ -198,20 +220,25 @@ def configure_logging(
|
||||||
elif os.path.exists('/var/run/log'):
|
elif os.path.exists('/var/run/log'):
|
||||||
syslog_path = '/var/run/log'
|
syslog_path = '/var/run/log'
|
||||||
|
|
||||||
if syslog_path and not interactive_console():
|
if syslog_path:
|
||||||
syslog_handler = logging.handlers.SysLogHandler(address=syslog_path)
|
syslog_handler = logging.handlers.SysLogHandler(address=syslog_path)
|
||||||
syslog_handler.setFormatter(logging.Formatter('borgmatic: %(levelname)s %(message)s'))
|
syslog_handler.setFormatter(
|
||||||
syslog_handler.setLevel(syslog_log_level)
|
logging.Formatter('borgmatic: {levelname} {message}', style='{') # noqa: FS003
|
||||||
handlers = (console_handler, syslog_handler)
|
)
|
||||||
elif log_file:
|
syslog_handler.setLevel(syslog_log_level)
|
||||||
|
handlers.append(syslog_handler)
|
||||||
|
|
||||||
|
if log_file and log_file_log_level != logging.DISABLED:
|
||||||
file_handler = logging.handlers.WatchedFileHandler(log_file)
|
file_handler = logging.handlers.WatchedFileHandler(log_file)
|
||||||
file_handler.setFormatter(logging.Formatter('[%(asctime)s] %(levelname)s: %(message)s'))
|
file_handler.setFormatter(
|
||||||
|
logging.Formatter(
|
||||||
|
log_file_format or '[{asctime}] {levelname}: {message}', style='{' # noqa: FS003
|
||||||
|
)
|
||||||
|
)
|
||||||
file_handler.setLevel(log_file_log_level)
|
file_handler.setLevel(log_file_log_level)
|
||||||
handlers = (console_handler, file_handler)
|
handlers.append(file_handler)
|
||||||
else:
|
|
||||||
handlers = (console_handler,)
|
|
||||||
|
|
||||||
logging.basicConfig(
|
logging.basicConfig(
|
||||||
level=min(console_log_level, syslog_log_level, log_file_log_level, monitoring_log_level),
|
level=min(handler.level for handler in handlers),
|
||||||
handlers=handlers,
|
handlers=handlers,
|
||||||
)
|
)
|
||||||
|
|
|
@ -23,12 +23,20 @@ def handle_signal(signal_number, frame):
|
||||||
if signal_number == signal.SIGTERM:
|
if signal_number == signal.SIGTERM:
|
||||||
logger.critical('Exiting due to TERM signal')
|
logger.critical('Exiting due to TERM signal')
|
||||||
sys.exit(EXIT_CODE_FROM_SIGNAL + signal.SIGTERM)
|
sys.exit(EXIT_CODE_FROM_SIGNAL + signal.SIGTERM)
|
||||||
|
elif signal_number == signal.SIGINT:
|
||||||
|
raise KeyboardInterrupt()
|
||||||
|
|
||||||
|
|
||||||
def configure_signals():
|
def configure_signals():
|
||||||
'''
|
'''
|
||||||
Configure borgmatic's signal handlers to pass relevant signals through to any child processes
|
Configure borgmatic's signal handlers to pass relevant signals through to any child processes
|
||||||
like Borg. Note that SIGINT gets passed through even without these changes.
|
like Borg.
|
||||||
'''
|
'''
|
||||||
for signal_number in (signal.SIGHUP, signal.SIGTERM, signal.SIGUSR1, signal.SIGUSR2):
|
for signal_number in (
|
||||||
|
signal.SIGHUP,
|
||||||
|
signal.SIGINT,
|
||||||
|
signal.SIGTERM,
|
||||||
|
signal.SIGUSR1,
|
||||||
|
signal.SIGUSR2,
|
||||||
|
):
|
||||||
signal.signal(signal_number, handle_signal)
|
signal.signal(signal_number, handle_signal)
|
||||||
|
|
|
@ -2,6 +2,7 @@ import logging
|
||||||
|
|
||||||
import borgmatic.logger
|
import borgmatic.logger
|
||||||
|
|
||||||
|
VERBOSITY_DISABLED = -2
|
||||||
VERBOSITY_ERROR = -1
|
VERBOSITY_ERROR = -1
|
||||||
VERBOSITY_ANSWER = 0
|
VERBOSITY_ANSWER = 0
|
||||||
VERBOSITY_SOME = 1
|
VERBOSITY_SOME = 1
|
||||||
|
@ -15,6 +16,7 @@ def verbosity_to_log_level(verbosity):
|
||||||
borgmatic.logger.add_custom_log_levels()
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
|
||||||
return {
|
return {
|
||||||
|
VERBOSITY_DISABLED: logging.DISABLED,
|
||||||
VERBOSITY_ERROR: logging.ERROR,
|
VERBOSITY_ERROR: logging.ERROR,
|
||||||
VERBOSITY_ANSWER: logging.ANSWER,
|
VERBOSITY_ANSWER: logging.ANSWER,
|
||||||
VERBOSITY_SOME: logging.INFO,
|
VERBOSITY_SOME: logging.INFO,
|
||||||
|
|
|
@ -1,14 +1,14 @@
|
||||||
FROM alpine:3.16.0 as borgmatic
|
FROM docker.io/alpine:3.17.1 as borgmatic
|
||||||
|
|
||||||
COPY . /app
|
COPY . /app
|
||||||
RUN apk add --no-cache py3-pip py3-ruamel.yaml py3-ruamel.yaml.clib
|
RUN apk add --no-cache py3-pip py3-ruamel.yaml py3-ruamel.yaml.clib
|
||||||
RUN pip install --no-cache /app && generate-borgmatic-config && chmod +r /etc/borgmatic/config.yaml
|
RUN pip install --no-cache /app && generate-borgmatic-config && chmod +r /etc/borgmatic/config.yaml
|
||||||
RUN borgmatic --help > /command-line.txt \
|
RUN borgmatic --help > /command-line.txt \
|
||||||
&& for action in rcreate transfer prune compact create check extract export-tar mount umount restore rlist list rinfo info break-lock borg; do \
|
&& for action in rcreate transfer create prune compact check extract config "config bootstrap" "config generate" "config validate" export-tar mount umount restore rlist list rinfo info break-lock borg; do \
|
||||||
echo -e "\n--------------------------------------------------------------------------------\n" >> /command-line.txt \
|
echo -e "\n--------------------------------------------------------------------------------\n" >> /command-line.txt \
|
||||||
&& borgmatic "$action" --help >> /command-line.txt; done
|
&& borgmatic $action --help >> /command-line.txt; done
|
||||||
|
|
||||||
FROM node:18.4.0-alpine as html
|
FROM docker.io/node:19.5.0-alpine as html
|
||||||
|
|
||||||
ARG ENVIRONMENT=production
|
ARG ENVIRONMENT=production
|
||||||
|
|
||||||
|
@ -18,6 +18,7 @@ RUN npm install @11ty/eleventy \
|
||||||
@11ty/eleventy-plugin-syntaxhighlight \
|
@11ty/eleventy-plugin-syntaxhighlight \
|
||||||
@11ty/eleventy-plugin-inclusive-language \
|
@11ty/eleventy-plugin-inclusive-language \
|
||||||
@11ty/eleventy-navigation \
|
@11ty/eleventy-navigation \
|
||||||
|
eleventy-plugin-code-clipboard \
|
||||||
markdown-it \
|
markdown-it \
|
||||||
markdown-it-anchor \
|
markdown-it-anchor \
|
||||||
markdown-it-replace-link
|
markdown-it-replace-link
|
||||||
|
@ -27,7 +28,7 @@ COPY . /source
|
||||||
RUN NODE_ENV=${ENVIRONMENT} npx eleventy --input=/source/docs --output=/output/docs \
|
RUN NODE_ENV=${ENVIRONMENT} npx eleventy --input=/source/docs --output=/output/docs \
|
||||||
&& mv /output/docs/index.html /output/index.html
|
&& mv /output/docs/index.html /output/index.html
|
||||||
|
|
||||||
FROM nginx:1.22.0-alpine
|
FROM docker.io/nginx:1.22.1-alpine
|
||||||
|
|
||||||
COPY --from=html /output /usr/share/nginx/html
|
COPY --from=html /output /usr/share/nginx/html
|
||||||
COPY --from=borgmatic /etc/borgmatic/config.yaml /usr/share/nginx/html/docs/reference/config.yaml
|
COPY --from=borgmatic /etc/borgmatic/config.yaml /usr/share/nginx/html/docs/reference/config.yaml
|
||||||
|
|
|
@ -16,4 +16,4 @@ each.
|
||||||
If you find a security vulnerability, please [file a
|
If you find a security vulnerability, please [file a
|
||||||
ticket](https://torsion.org/borgmatic/#issues) or [send email
|
ticket](https://torsion.org/borgmatic/#issues) or [send email
|
||||||
directly](mailto:witten@torsion.org) as appropriate. You should expect to hear
|
directly](mailto:witten@torsion.org) as appropriate. You should expect to hear
|
||||||
back within a few days at most, and generally sooner.
|
back within a few days at most and generally sooner.
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user