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
|
import unittest
from unittest.mock import Mock
from PyViCare.PyViCareCachedService import ViCareCachedService
from PyViCare.PyViCareService import ViCareDeviceAccessor
from PyViCare.PyViCareUtils import (PyViCareDeviceCommunicationError,
PyViCareInternalServerError,
PyViCareInvalidDataError,
PyViCareNotSupportedFeatureError)
from tests.helper import now_is
class PyViCareCachedServiceTest(unittest.TestCase):
CACHE_DURATION = 60
def setUp(self):
self.oauth_mock = Mock()
self.oauth_mock.get.return_value = {'data': [{"feature": "someprop"}]}
accessor = ViCareDeviceAccessor("[id]", "[serial]", "[device]")
self.service = ViCareCachedService(
self.oauth_mock, accessor, [], self.CACHE_DURATION)
def test_getProperty_existing(self):
self.service.getProperty("someprop")
self.oauth_mock.get.assert_called_once_with(
'/features/installations/[id]/gateways/[serial]/devices/[device]/features/')
def test_getProperty_nonexisting_raises_exception(self):
def func():
return self.service.getProperty("some-non-prop")
self.assertRaises(PyViCareNotSupportedFeatureError, func)
def test_setProperty_works(self):
self.service.setProperty("someotherprop", "doaction", {'name': 'abc'})
self.oauth_mock.post.assert_called_once_with(
'/features/installations/[id]/gateways/[serial]/devices/[device]/features/someotherprop/commands/doaction', '{"name": "abc"}')
def test_getProperty_existing_cached(self):
# time+0 seconds
with now_is('2000-01-01 00:00:00'):
self.service.getProperty("someprop")
self.service.getProperty("someprop")
# time+30 seconds
with now_is('2000-01-01 00:00:30'):
self.service.getProperty("someprop")
self.assertEqual(self.oauth_mock.get.call_count, 1)
self.oauth_mock.get.assert_called_once_with(
'/features/installations/[id]/gateways/[serial]/devices/[device]/features/')
# time+70 seconds (must be more than CACHE_DURATION)
with now_is('2000-01-01 00:01:10'):
self.service.getProperty("someprop")
self.assertEqual(self.oauth_mock.get.call_count, 2)
def test_setProperty_invalidateCache(self):
# freeze time
with now_is('2000-01-01 00:00:00'):
self.assertEqual(self.service.is_cache_invalid(), True)
self.service.getProperty("someprop")
self.assertEqual(self.service.is_cache_invalid(), False)
self.service.setProperty(
"someotherprop", "doaction", {'name': 'abc'})
self.assertEqual(self.service.is_cache_invalid(), True)
self.service.getProperty("someprop")
self.assertEqual(self.oauth_mock.get.call_count, 2)
def test_device_communication_error_returns_stale_cache(self):
"""When device goes offline after successful fetch, return stale cache."""
with now_is('2000-01-01 00:00:00'):
self.service.getProperty("someprop")
# Device goes offline after cache expires
self.oauth_mock.get.side_effect = PyViCareDeviceCommunicationError(
{"errorType": "DEVICE_COMMUNICATION_ERROR",
"extendedPayload": {"reason": "GATEWAY_OFFLINE"}})
with now_is('2000-01-01 00:01:10'):
result = self.service.getProperty("someprop")
self.assertIsNotNone(result)
def test_server_error_returns_stale_cache(self):
"""When server returns 500 after successful fetch, return stale cache."""
with now_is('2000-01-01 00:00:00'):
self.service.getProperty("someprop")
self.oauth_mock.get.side_effect = PyViCareInternalServerError(
{"statusCode": 500, "message": "Internal server error",
"viErrorId": "test"})
with now_is('2000-01-01 00:01:10'):
result = self.service.getProperty("someprop")
self.assertIsNotNone(result)
def test_device_communication_error_raises_without_cache(self):
"""When device is offline on first fetch (no cache), must raise."""
self.oauth_mock.get.side_effect = PyViCareDeviceCommunicationError(
{"errorType": "DEVICE_COMMUNICATION_ERROR",
"extendedPayload": {"reason": "DEVICE_OFFLINE"}})
with now_is('2000-01-01 00:00:00'):
self.assertRaises(
PyViCareDeviceCommunicationError,
self.service.getProperty, "someprop")
def test_server_error_raises_without_cache(self):
"""When server errors on first fetch (no cache), must raise."""
self.oauth_mock.get.side_effect = PyViCareInternalServerError(
{"statusCode": 500, "message": "Internal server error",
"viErrorId": "test"})
with now_is('2000-01-01 00:00:00'):
self.assertRaises(
PyViCareInternalServerError,
self.service.getProperty, "someprop")
def test_invalid_data_still_raises_with_cache(self):
"""PyViCareInvalidDataError (genuine bad data) must still raise even with cache."""
with now_is('2000-01-01 00:00:00'):
self.service.getProperty("someprop")
self.oauth_mock.get.side_effect = None
self.oauth_mock.get.return_value = {"unexpected": "response"}
with now_is('2000-01-01 00:01:10'):
self.assertRaises(
PyViCareInvalidDataError,
self.service.getProperty, "someprop")
|
