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
292
293
294
295
296
297
298
299
300
301
|
from collections.abc import Callable
from datetime import UTC, datetime, timedelta
from pathlib import Path
from typing import Any
import pytest
from pytest_mock import MockerFixture
from autosuspend.checks import Activity, Check, ConfigurationError, TemporaryCheckError
from autosuspend.checks.xpath import (
XPathActivity,
XPathDeltaWakeup,
XPathMixin,
XPathWakeup,
)
from . import CheckTest
from .utils import config_section
class _XPathMixinSub(XPathMixin, Activity):
def __init__(self, name: str, **kwargs: Any) -> None:
Activity.__init__(self, name)
XPathMixin.__init__(self, **kwargs)
def check(self) -> str | None:
pass
class TestXPathMixin:
def test_smoke(self, datadir: Path, serve_file: Callable[[Path], str]) -> None:
result = _XPathMixinSub(
"foo",
xpath="/b",
url=serve_file(datadir / "xml_with_encoding.xml"),
timeout=5,
).evaluate()
assert result is not None
assert len(result) == 0
def test_broken_xml(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = b"//broken"
mocker.patch("requests.Session.get", return_value=mock_reply)
with pytest.raises(TemporaryCheckError):
_XPathMixinSub("foo", xpath="/b", url="nourl", timeout=5).evaluate()
def test_xml_with_encoding(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = (
b'<?xml version="1.0" encoding="ISO-8859-1" ?><root></root>'
)
mocker.patch("requests.Session.get", return_value=mock_reply)
_XPathMixinSub("foo", xpath="/b", url="nourl", timeout=5).evaluate()
def test_xpath_prevalidation(self) -> None:
with pytest.raises(ConfigurationError, match=r"^Invalid xpath.*"):
_XPathMixinSub.create(
"name", config_section({"xpath": "|34/ad", "url": "required"})
)
@pytest.mark.parametrize("entry", ["xpath", "url"])
def test_missing_config_entry(self, entry: str) -> None:
section = config_section({"xpath": "/valid", "url": "required"})
del section[entry]
with pytest.raises(ConfigurationError, match=r"^Lacks '" + entry + "'.*"):
_XPathMixinSub.create("name", section)
def test_invalid_config_entry(self) -> None:
with pytest.raises(ConfigurationError, match=r"^Configuration error .*"):
_XPathMixinSub.create(
"name",
config_section(
{"xpath": "/valid", "url": "required", "timeout": "xxx"}
),
)
class TestXPathActivity(CheckTest):
def create_instance(self, name: str) -> Check:
return XPathActivity(
name=name,
url="url",
timeout=5,
username="userx",
password="pass",
xpath="/b",
)
def test_matching(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = "<a></a>"
mock_method = mocker.patch("requests.Session.get", return_value=mock_reply)
url = "nourl"
assert XPathActivity("foo", xpath="/a", url=url, timeout=5).check() is not None
mock_method.assert_called_once_with(url, timeout=5, headers=None)
content_property.assert_called_once_with()
def test_not_matching(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = "<a></a>"
mocker.patch("requests.Session.get", return_value=mock_reply)
assert XPathActivity("foo", xpath="/b", url="nourl", timeout=5).check() is None
def test_create(self) -> None:
check: XPathActivity = XPathActivity.create(
"name",
config_section(
{
"url": "url",
"xpath": "/xpath",
"username": "user",
"password": "pass",
"timeout": "42",
}
),
)
assert check._xpath == "/xpath"
assert check._url == "url"
assert check._username == "user"
assert check._password == "pass"
assert check._timeout == 42
def test_network_errors_are_passed(
self, datadir: Path, serve_protected: Callable[[Path], tuple[str, str, str]]
) -> None:
with pytest.raises(TemporaryCheckError):
XPathActivity(
name="name",
url=serve_protected(datadir / "data.txt")[0],
timeout=5,
username="wrong",
password="wrong",
xpath="/b",
).request()
class TestXPathWakeup(CheckTest):
def create_instance(self, name: str) -> Check:
return XPathWakeup(name, xpath="/a", url="nourl", timeout=5)
def test_matching(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = '<a value="42.3"></a>'
mock_method = mocker.patch("requests.Session.get", return_value=mock_reply)
url = "nourl"
assert XPathWakeup("foo", xpath="/a/@value", url=url, timeout=5).check(
datetime.now(UTC)
) == datetime.fromtimestamp(42.3, UTC)
mock_method.assert_called_once_with(url, timeout=5, headers=None)
content_property.assert_called_once_with()
def test_not_matching(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = "<a></a>"
mocker.patch("requests.Session.get", return_value=mock_reply)
assert (
XPathWakeup("foo", xpath="/b", url="nourl", timeout=5).check(
datetime.now(UTC)
)
is None
)
def test_not_a_string(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = "<a></a>"
mocker.patch("requests.Session.get", return_value=mock_reply)
with pytest.raises(TemporaryCheckError):
XPathWakeup("foo", xpath="/a", url="nourl", timeout=5).check(
datetime.now(UTC)
)
def test_not_a_number(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = '<a value="narf"></a>'
mocker.patch("requests.Session.get", return_value=mock_reply)
with pytest.raises(TemporaryCheckError):
XPathWakeup("foo", xpath="/a/@value", url="nourl", timeout=5).check(
datetime.now(UTC)
)
def test_multiple_min(self, mocker: MockerFixture) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = """
<root>
<a value="40"></a>
<a value="10"></a>
<a value="20"></a>
</root>
"""
mocker.patch("requests.Session.get", return_value=mock_reply)
assert XPathWakeup("foo", xpath="//a/@value", url="nourl", timeout=5).check(
datetime.now(UTC)
) == datetime.fromtimestamp(10, UTC)
def test_create(self) -> None:
check: XPathWakeup = XPathWakeup.create(
"name",
config_section(
{
"xpath": "/valid",
"url": "nourl",
"timeout": "20",
}
),
)
assert check._xpath == "/valid"
class TestXPathDeltaWakeup(CheckTest):
def create_instance(self, name: str) -> Check:
return XPathDeltaWakeup(name, xpath="/a", url="nourl", timeout=5, unit="days")
@pytest.mark.parametrize(
("unit", "factor"),
[
("microseconds", 0.000001),
("milliseconds", 0.001),
("seconds", 1),
("minutes", 60),
("hours", 60 * 60),
("days", 60 * 60 * 24),
("weeks", 60 * 60 * 24 * 7),
],
)
def test_smoke(self, mocker: MockerFixture, unit: str, factor: float) -> None:
mock_reply = mocker.MagicMock()
content_property = mocker.PropertyMock()
type(mock_reply).content = content_property
content_property.return_value = '<a value="42"></a>'
mocker.patch("requests.Session.get", return_value=mock_reply)
url = "nourl"
now = datetime.now(UTC)
result = XPathDeltaWakeup(
"foo", xpath="/a/@value", url=url, timeout=5, unit=unit
).check(now)
assert result == now + timedelta(seconds=42) * factor
def test_create(self) -> None:
check = XPathDeltaWakeup.create(
"name",
config_section(
{
"xpath": "/valid",
"url": "nourl",
"timeout": "20",
"unit": "weeks",
}
),
)
assert check._unit == "weeks"
def test_create_wrong_unit(self) -> None:
with pytest.raises(ConfigurationError):
XPathDeltaWakeup.create(
"name",
config_section(
{
"xpath": "/valid",
"url": "nourl",
"timeout": "20",
"unit": "unknown",
}
),
)
def test_init_wrong_unit(self) -> None:
with pytest.raises(ValueError, match=r".*unit.*"):
XPathDeltaWakeup(
"name", url="url", xpath="/a", timeout=5, unit="unknownunit"
)
|
