1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
# SPDX-FileCopyrightText: 2023-2024 Greenbone AG
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
import asyncio
import unittest
from asyncio.subprocess import Process
from pathlib import Path
from unittest.mock import AsyncMock, patch
from greenbone.feed.sync.errors import RsyncError
from greenbone.feed.sync.rsync import Rsync, exec_rsync
class RsyncTestCase(unittest.IsolatedAsyncioTestCase):
@patch("greenbone.feed.sync.rsync.exec_rsync", autospec=True)
async def test_rsync_with_defaults(self, exec_mock: AsyncMock):
rsync = Rsync()
await rsync.sync("rsync://foo.bar/baz", "/tmp/baz")
exec_mock.assert_awaited_once_with(
"--links",
"--times",
"--omit-dir-times",
"--recursive",
"--partial",
"--progress",
"-q",
"--compress-level=9",
"--delete",
"--perms",
"--chmod=Fugo+r,Fug+w,Dugo-s,Dugo+rx,Dug+w",
"--copy-unsafe-links",
"--hard-links",
"rsync://foo.bar/baz",
"/tmp/baz",
)
@patch("greenbone.feed.sync.rsync.exec_rsync", autospec=True)
async def test_rsync_with_private_subdir(self, exec_mock: AsyncMock):
rsync = Rsync(private_subdir="private")
await rsync.sync("rsync://foo.bar/baz", "/tmp/baz")
exec_mock.assert_awaited_once_with(
"--links",
"--times",
"--omit-dir-times",
"--recursive",
"--partial",
"--progress",
"-q",
"--compress-level=9",
"--delete",
"--exclude",
"private",
"--perms",
"--chmod=Fugo+r,Fug+w,Dugo-s,Dugo+rx,Dug+w",
"--copy-unsafe-links",
"--hard-links",
"rsync://foo.bar/baz",
"/tmp/baz",
)
@patch("greenbone.feed.sync.rsync.exec_rsync", autospec=True)
async def test_rsync_with_verbose(self, exec_mock: AsyncMock):
rsync = Rsync(verbose=True)
await rsync.sync("rsync://foo.bar/baz", "/tmp/baz")
exec_mock.assert_awaited_once_with(
"--links",
"--times",
"--omit-dir-times",
"--recursive",
"--partial",
"--progress",
"-v",
"--compress-level=9",
"--delete",
"--perms",
"--chmod=Fugo+r,Fug+w,Dugo-s,Dugo+rx,Dug+w",
"--copy-unsafe-links",
"--hard-links",
"rsync://foo.bar/baz",
"/tmp/baz",
)
@patch("greenbone.feed.sync.rsync.exec_rsync", autospec=True)
async def test_rsync_with_compression_level(self, exec_mock: AsyncMock):
rsync = Rsync(compression_level=1)
await rsync.sync("rsync://foo.bar/baz", "/tmp/baz")
exec_mock.assert_awaited_once_with(
"--links",
"--times",
"--omit-dir-times",
"--recursive",
"--partial",
"--progress",
"-q",
"--compress-level=1",
"--delete",
"--perms",
"--chmod=Fugo+r,Fug+w,Dugo-s,Dugo+rx,Dug+w",
"--copy-unsafe-links",
"--hard-links",
"rsync://foo.bar/baz",
"/tmp/baz",
)
@patch("greenbone.feed.sync.rsync.exec_rsync", autospec=True)
async def test_rsync_with_exclude(self, exec_mock: AsyncMock):
rsync = Rsync(exclude=["foo", Path("exclude/this")])
await rsync.sync("rsync://foo.bar/baz", "/tmp/baz")
exec_mock.assert_awaited_once_with(
"--links",
"--times",
"--omit-dir-times",
"--recursive",
"--partial",
"--progress",
"-q",
"--compress-level=9",
"--delete",
"--exclude",
"foo",
"--exclude",
"exclude/this",
"--perms",
"--chmod=Fugo+r,Fug+w,Dugo-s,Dugo+rx,Dug+w",
"--copy-unsafe-links",
"--hard-links",
"rsync://foo.bar/baz",
"/tmp/baz",
)
class ExecRsyncTestCase(unittest.IsolatedAsyncioTestCase):
@patch(
"greenbone.feed.sync.rsync.asyncio.create_subprocess_exec",
autospec=True,
)
async def test_failure(self, exec_mock: AsyncMock):
process_mock = AsyncMock(spec=Process)
process_mock.communicate.return_value = (None, b"An error occurred")
process_mock.wait.return_value = 1
exec_mock.return_value = process_mock
with self.assertRaises(RsyncError) as cm:
await exec_rsync("foo", "bar")
exec_mock.assert_awaited_once_with(
"rsync", "foo", "bar", stderr=asyncio.subprocess.PIPE
)
self.assertEqual(cm.exception.returncode, 1)
self.assertEqual(cm.exception.stderr, "An error occurred")
self.assertEqual(cm.exception.cmd, ["rsync", "foo", "bar"])
self.assertIsNone(cm.exception.stout)
self.assertEqual(
str(cm.exception),
"'rsync foo bar' returned non-zero exit status 1.",
)
@patch(
"greenbone.feed.sync.rsync.asyncio.create_subprocess_exec",
autospec=True,
)
async def test_success(self, exec_mock: AsyncMock):
process_mock = AsyncMock(spec=Process)
process_mock.communicate.return_value = (None, None)
process_mock.wait.return_value = 0
exec_mock.return_value = process_mock
await exec_rsync("foo", "bar")
exec_mock.assert_awaited_once_with(
"rsync", "foo", "bar", stderr=asyncio.subprocess.PIPE
)
@patch("greenbone.feed.sync.rsync.exec_rsync", autospec=True)
async def test_rsync_with_timeout(self, exec_mock: AsyncMock):
rsync = Rsync(timeout=120)
await rsync.sync("rsync://foo.bar/baz", "/tmp/baz")
exec_mock.assert_awaited_once_with(
"--links",
"--times",
"--omit-dir-times",
"--recursive",
"--partial",
"--progress",
"--timeout=120",
"-q",
"--compress-level=9",
"--delete",
"--perms",
"--chmod=Fugo+r,Fug+w,Dugo-s,Dugo+rx,Dug+w",
"--copy-unsafe-links",
"--hard-links",
"rsync://foo.bar/baz",
"/tmp/baz",
)
@patch("greenbone.feed.sync.rsync.exec_rsync", autospec=True)
async def test_rsync_with_ssh(self, exec_mock: AsyncMock):
ssh_key = Path("/tmp/ssh.key")
rsync = Rsync(ssh_key=ssh_key)
await rsync.sync("ssh://user@foo.bar/baz", "/tmp/baz")
exec_mock.assert_awaited_once_with(
"--links",
"--times",
"--omit-dir-times",
"--recursive",
"--partial",
"--progress",
"-e",
"ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -p 24 -i '/tmp/ssh.key'", # pylint: disable=line-too-long # noqa: E501
"-q",
"--compress-level=9",
"--delete",
"--perms",
"--chmod=Fugo+r,Fug+w,Dugo-s,Dugo+rx,Dug+w",
"--copy-unsafe-links",
"--hard-links",
"user@foo.bar:/baz",
"/tmp/baz",
)
|
