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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
"""
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Tests of the download helper.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/special-thanks.html
Contributors:
https://pyfunceble.github.io/contributors.html
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://docs.pyfunceble.com
Project homepage:
https://pyfunceble.github.io/
License:
::
Copyright 2017, 2018, 2019, 2020, 2021, 2021 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
import tempfile
import unittest
import unittest.mock
import requests
import PyFunceble.helpers.exceptions
from PyFunceble.helpers.download import DownloadHelper
class TestDownloadHelper(unittest.TestCase):
"""
Tests of the download helper.
"""
def test_set_url_return(self) -> None:
"""
Tests the response of the method which let us set the url to work with.
"""
given = "https://example.org"
download_helper = DownloadHelper()
actual = download_helper.set_url(given)
self.assertIsInstance(actual, DownloadHelper)
def test_set_url(self) -> None:
"""
Tests the method which let us set the url to work with.
"""
given = "https://example.org"
expected = "https://example.org"
download_helper = DownloadHelper()
download_helper.set_url(given)
actual = download_helper.url
self.assertEqual(expected, actual)
download_helper = DownloadHelper(given)
actual = download_helper.url
self.assertEqual(expected, actual)
def test_set_url_not_str(self) -> None:
"""
Tests the method which let us set the url to work with for the case that
the given url is not a string.
"""
given = ["Hello", "World"]
download_helper = DownloadHelper()
self.assertRaises(TypeError, lambda: download_helper.set_url(given))
def test_set_certificate_validation_return(self) -> None:
"""
Tests the response of the method which let us authorize the certificate
validation.
"""
given = True
download_helper = DownloadHelper()
actual = download_helper.set_certificate_validation(given)
self.assertIsInstance(actual, DownloadHelper)
def test_set_certificate_validation(self) -> None:
"""
Tests the method which let us authorize the certificate validation.
"""
given = True
expected = True
download_helper = DownloadHelper()
download_helper.set_certificate_validation(given)
actual = download_helper.certificate_validation
self.assertEqual(expected, actual)
download_helper = DownloadHelper(certificate_validation=given)
actual = download_helper.certificate_validation
self.assertEqual(expected, actual)
def test_set_certificate_validation_not_bool(self) -> None:
"""
Tests the method which let us authorize the certificate validation for
the case that the given value is not a boolean.
"""
given = ["Hello", "World"]
download_helper = DownloadHelper()
self.assertRaises(
TypeError, lambda: download_helper.set_certificate_validation(given)
)
def test_set_retries_return(self) -> None:
"""
Tests the response of the method which let us set the number of retry
to perform.
"""
given = 3
download_helper = DownloadHelper()
actual = download_helper.set_retries(given)
self.assertIsInstance(actual, DownloadHelper)
def test_set_retries(self) -> None:
"""
Tests the method which let us set the number of retry to perform.
"""
given = 3
expected = 3
download_helper = DownloadHelper()
download_helper.set_retries(given)
actual = download_helper.retries
self.assertEqual(expected, actual)
download_helper = DownloadHelper(retries=given)
actual = download_helper.retries
self.assertEqual(expected, actual)
def test_set_retries_not_int(self) -> None:
"""
Tests the method which let us set the number of retry to perform for the
case that the given value is not a string.
"""
given = ["Hello", "World"]
download_helper = DownloadHelper()
self.assertRaises(TypeError, lambda: download_helper.set_retries(given))
def test_set_retries_less_than_zero(self) -> None:
"""
Tests the method which let us set the number of retry to perform for the
case that the given value is less than zero
"""
given = -1
download_helper = DownloadHelper()
self.assertRaises(ValueError, lambda: download_helper.set_retries(given))
@unittest.mock.patch.object(requests.Session, "get")
def test_download_text(self, session_patch: unittest.mock.MagicMock) -> None:
"""
Tests the method which let us set download the text of a given
url.
"""
given = "https://exmaple.org"
download_helper = DownloadHelper(given)
session_patch.return_value.text = "Hello, World!"
session_patch.return_value.status_code = 200
expected = "Hello, World!"
actual = download_helper.download_text()
self.assertEqual(expected, actual)
@unittest.mock.patch.object(requests.Session, "get")
def test_download_text_to_file(
self, session_patch: unittest.mock.MagicMock
) -> None:
"""
Tests the method which let us set download the text of a given
url for the case that we want the response into a file.
"""
destination = tempfile.NamedTemporaryFile(delete=False)
given = "https://exmaple.org"
download_helper = DownloadHelper(given)
session_patch.return_value.text = "Hello, World!"
session_patch.return_value.status_code = 200
download_helper.download_text(destination=destination.name)
destination.seek(0)
expected = b"Hello, World!"
actual = destination.read()
self.assertEqual(expected, actual)
@unittest.mock.patch.object(requests.Session, "get")
def test_download_text_response_not_ok(
self, session_patch: unittest.mock.MagicMock
) -> None:
"""
Tests the method which let us set download the text of a given
url for the case that the response is not ok.
"""
destination = tempfile.NamedTemporaryFile(delete=False)
given = "https://exmaple.org"
download_helper = DownloadHelper(given)
session_patch.return_value.status_code = 500
self.assertRaises(
PyFunceble.helpers.exceptions.UnableToDownload,
lambda: download_helper.download_text(destination=destination.name),
)
if __name__ == "__main__":
unittest.main()
|
