File: item_test.py

package info (click to toggle)
python-mypermobil 0.1.8-1.1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 168 kB
  • sloc: python: 1,172; makefile: 3
file content (279 lines) | stat: -rw-r--r-- 10,841 bytes parent folder | download | duplicates (2)
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
""" test auth control flow """

import aiounittest
import datetime
import unittest
import aiohttp
import asyncio
from unittest.mock import AsyncMock
from mypermobil import (
    MyPermobil,
    MyPermobilClientException,
    MyPermobilAPIException,
    MyPermobilConnectionException,
    BATTERY_AMPERE_HOURS_LEFT,
    RECORDS_DISTANCE,
    RECORDS_SEATING,
    ENDPOINT_VA_USAGE_RECORDS,
    GET,
    POST,
    DELETE,
    PUT,
)


# pylint: disable=missing-docstring
class TestRequest(aiounittest.AsyncTestCase):
    def setUp(self):
        ttl = datetime.datetime.now() + datetime.timedelta(days=1)
        self.api = MyPermobil(
            "test",
            AsyncMock(),
            email="valid@email.com",
            region="http://example.com",
            code="123456",
            token="a" * 256,
            expiration_date=ttl.strftime("%Y-%m-%d"),
        )
        self.api.self_authenticate()

    async def test_request_item(self):
        resp = AsyncMock(status=200)
        resp.json = AsyncMock(return_value={BATTERY_AMPERE_HOURS_LEFT[0]: 123})
        self.api.make_request = AsyncMock(return_value=resp)

        res = await self.api.request_item(BATTERY_AMPERE_HOURS_LEFT)

        assert res == 123
        assert self.api.make_request.call_count == 1

    async def test_request_item_404(self):
        status = 404
        msg = "not found"
        resp = AsyncMock(status=status)
        resp.json = AsyncMock(return_value={"error": msg})
        self.api.make_request = AsyncMock(return_value=resp)

        with self.assertRaises(MyPermobilAPIException):
            await self.api.request_item(BATTERY_AMPERE_HOURS_LEFT)

    async def test_request_non_existent_item(self):
        item = "this item is not an item that exists"
        with self.assertRaises(MyPermobilClientException):
            await self.api.request_item(item)

    async def test_request_empty_item(self):
        item = []
        with self.assertRaises(MyPermobilClientException):
            await self.api.request_item(item)

    async def test_request_invalid_item(self):
        # scenario one, a list that does not have enough items
        items = [100]
        # mock request endpoint result
        resp = [1, 2, 3]
        self.api.request_endpoint = AsyncMock(return_value=resp)
        with self.assertRaises(MyPermobilClientException):
            await self.api.request_item(items, endpoint="test")

        # scenario two, dict that does not have specific item
        item = "i want this item"
        items = [item]
        # mock request endpoint result
        resp = {"i only have this item": 123}
        self.api.request_endpoint = AsyncMock(return_value=resp)
        with self.assertRaises(MyPermobilClientException):
            await self.api.request_item(items, endpoint="test")

    async def test_request_endpoint_ContentTypeError(self):
        # scenario one, a list that does not have enough items
        resp = AsyncMock(status=400)
        mock = AsyncMock()
        resp.json = AsyncMock(
            side_effect=aiohttp.client_exceptions.ContentTypeError(mock, mock)
        )
        self.api.make_request = AsyncMock(return_value=resp)
        with self.assertRaises(MyPermobilAPIException):
            await self.api.request_endpoint("endpoint")

    #    async def test_request_non_existent_endpoint(self):
    #        endpoint = "this endpoint does not exist"
    #        item = "invalid item"
    #        with self.assertRaises(MyPermobilClientException):
    #            await self.api.request_item(item, endpoint=endpoint)

    #    async def test_request_non_invalid_endpoint(self):
    #        endpoint = "this endpoint does not exist"
    #        item = RECORDS_SEATING
    #        with self.assertRaises(MyPermobilClientException):
    #            await self.api.request_item(item, endpoint=endpoint)

    async def test_request_request_endpoint_cache(self):
        """call the same endpoint twice and check that the cache is used"""
        resp = AsyncMock(status=200)
        resp.json = AsyncMock(
            return_value={RECORDS_DISTANCE[0]: 123, RECORDS_SEATING[0]: 456}
        )
        self.api.make_request = AsyncMock(return_value=resp)

        res1 = await self.api.request_item(RECORDS_DISTANCE)
        res2 = await self.api.request_item(RECORDS_SEATING)

        assert res1 == 123
        assert res2 == 456
        assert self.api.make_request.call_count == 1
        assert self.api.make_request.call_args[0][1].endswith(ENDPOINT_VA_USAGE_RECORDS)

    async def test_request_request_endpoint_async(self):
        """call the same endpoint twice and check that the cache is used"""

        async def delay():
            await asyncio.sleep(0.5)
            return {RECORDS_DISTANCE[0]: 123, RECORDS_SEATING[0]: 456}

        resp = AsyncMock(status=200)
        resp.json = AsyncMock(side_effect=delay)
        self.api.make_request = AsyncMock(return_value=resp)
        task1 = asyncio.create_task(self.api.request_item(RECORDS_DISTANCE))
        task2 = asyncio.create_task(self.api.request_item(RECORDS_SEATING))
        res1 = await task1
        res2 = await task2

        assert res1 == 123
        assert res2 == 456
        assert self.api.make_request.call_count == 1
        assert self.api.make_request.call_args[0][1].endswith(ENDPOINT_VA_USAGE_RECORDS)

    async def test_request_request_endpoint_cache_exception(self):
        status = 404
        msg = "not found"
        resp = AsyncMock(status=status)
        resp.json = AsyncMock(return_value={"error": msg})
        self.api.make_request = AsyncMock(return_value=resp)

        with self.assertRaises(MyPermobilAPIException):
            await self.api.request_item(RECORDS_DISTANCE)
        with self.assertRaises(MyPermobilAPIException):
            await self.api.request_item(RECORDS_SEATING)

        assert self.api.make_request.call_count == 1
        assert self.api.make_request.call_args[0][1].endswith(ENDPOINT_VA_USAGE_RECORDS)

    async def test_request_get_request(self):
        session = AsyncMock(status=200)
        session.get = AsyncMock(return_value=AsyncMock(status=200))
        self.api.session = session

        res = await self.api.make_request(GET, "http://example.com")
        assert res.status == 200

    async def test_request_get_request_exceptions(self):
        session = AsyncMock()
        mock = AsyncMock()
        session.get = AsyncMock(side_effect=aiohttp.ClientConnectorError(mock, mock))
        self.api.session = session
        with self.assertRaises(MyPermobilConnectionException):
            await self.api.make_request(GET, "http://example.com")

        session = AsyncMock()
        session.get = AsyncMock(side_effect=asyncio.TimeoutError())
        self.api.session = session
        with self.assertRaises(MyPermobilConnectionException):
            await self.api.make_request(GET, "http://example.com")

        session = AsyncMock()
        session.get = AsyncMock(side_effect=aiohttp.ClientError(None, None))
        self.api.session = session
        with self.assertRaises(MyPermobilConnectionException):
            await self.api.make_request(GET, "http://example.com")

        session = AsyncMock()
        session.get = AsyncMock(side_effect=ValueError())
        self.api.session = session
        with self.assertRaises(MyPermobilAPIException):
            await self.api.make_request(GET, "http://example.com")

    async def test_request_post_request_exceptions(self):
        session = AsyncMock()
        mock = AsyncMock()
        session.post = AsyncMock(side_effect=aiohttp.ClientConnectorError(mock, mock))
        self.api.session = session
        with self.assertRaises(MyPermobilConnectionException):
            await self.api.make_request(POST, "http://example.com")

        session = AsyncMock()
        session.post = AsyncMock(side_effect=asyncio.TimeoutError())
        self.api.session = session
        with self.assertRaises(MyPermobilConnectionException):
            await self.api.make_request(POST, "http://example.com")

        session = AsyncMock()
        session.post = AsyncMock(side_effect=aiohttp.ClientError(None, None))
        self.api.session = session
        with self.assertRaises(MyPermobilConnectionException):
            await self.api.make_request(POST, "http://example.com")

        session = AsyncMock()
        session.post = AsyncMock(side_effect=ValueError())
        self.api.session = session
        with self.assertRaises(MyPermobilAPIException):
            await self.api.make_request(POST, "http://example.com")

    async def test_request_product_id(self):
        ttl = datetime.datetime.now() + datetime.timedelta(days=1)
        self.api = MyPermobil(
            "test",
            AsyncMock(),
            email="valid@email.com",
            region="http://example.com",
            code="123456",
            token="a" * 256,
            expiration_date=ttl.strftime("%Y-%m-%d"),
        )
        self.api.self_authenticate()
        response = [{"_id": "123"}]
        request_endpoint_mock = AsyncMock(return_value=response)
        self.api.request_endpoint = request_endpoint_mock

        await self.api.request_product_id()

        # test for the places it can fail
        # list is not length 1
        response = [{"_id": "123"}, {"_id": "123"}, {"_id": "123"}]
        request_endpoint_mock = AsyncMock(return_value=response)
        self.api.request_endpoint = request_endpoint_mock

        with self.assertRaises(MyPermobilAPIException):
            await self.api.request_product_id()

        # response it not a list
        response = "not a list"
        request_endpoint_mock = AsyncMock(return_value=response)
        self.api.request_endpoint = request_endpoint_mock

        with self.assertRaises(MyPermobilAPIException):
            await self.api.request_product_id()

    async def test_request_invalid_request_type(self):
        with self.assertRaises(MyPermobilClientException):
            await self.api.make_request("invalid request type", "http://example.com")

    async def test_request_put(self):
        # there is no put request in the api so this is the test
        session = AsyncMock()
        session.put = AsyncMock(return_value=AsyncMock(status=200))
        self.api.session = session
        resp = await self.api.make_request(PUT, "http://example.com")
        assert resp.status == 200

    async def test_request_delete(self):
        # there is no put request in the api so this is the test
        session = AsyncMock()
        session.delete = AsyncMock(return_value=AsyncMock(status=200))
        self.api.session = session
        resp = await self.api.make_request(DELETE, "http://example.com")
        assert resp.status == 200


if __name__ == "__main__":
    unittest.main()