File: test_cli.py

package info (click to toggle)
python-ring-doorbell 0.9.13-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 972 kB
  • sloc: python: 4,764; makefile: 15
file content (397 lines) | stat: -rw-r--r-- 12,448 bytes parent folder | download
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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
"""Module for cli tests."""

from __future__ import annotations

import json
from pathlib import Path
from typing import Any
from unittest.mock import DEFAULT, MagicMock, call, patch

import aiofiles
import pytest
from asyncclick.testing import CliRunner
from ring_doorbell import AuthenticationError, Requires2FAError, Ring
from ring_doorbell.cli import (
    _event_handler,
    cli,
    devices_command,
    in_home_chime,
    list_command,
    listen,
    motion_detection,
    open_door,
    show,
    videos,
)
from ring_doorbell.const import GCM_TOKEN_FILE

from tests.conftest import (
    load_alert_v1,
    load_fixture,
    load_fixture_as_dict,
)


async def test_cli_default(ring):
    runner = CliRunner()
    with runner.isolated_filesystem():
        res = await runner.invoke(
            cli, ["--username", "foo", "--password", "foo"], obj=ring
        )

        expected = (
            "Name:       Downstairs\nFamily:     chimes\nID:"
            "         999999\nTimezone:   America/New_York\nWifi Name:"
            "  ring_mock_wifi\nWifi RSSI:  -39\n\n"
        )

        assert res.exit_code == 0
        assert expected in res.output


async def test_show(ring):
    runner = CliRunner()
    with runner.isolated_filesystem():
        res = await runner.invoke(show, obj=ring)

        expected = (
            "Name:       Downstairs\nFamily:     chimes\nID:"
            "         999999\nTimezone:   America/New_York\nWifi Name:"
            "  ring_mock_wifi\nWifi RSSI:  -39\n\n"
        )

        assert res.exit_code == 0
        assert expected in res.output


async def test_devices(ring):
    runner = CliRunner()
    with runner.isolated_filesystem():
        res = await runner.invoke(devices_command, obj=ring)

        expected = (
            "(Pretty format coming soon, if you want json "
            "consistently from this command provide the --json flag)\n"
        )
        for device_type in ring.devices_data:
            for device_api_id in ring.devices_data[device_type]:
                expected += (
                    json.dumps(ring.devices_data[device_type][device_api_id], indent=2)
                    + "\n"
                )

        assert res.exit_code == 0
        assert expected == res.output


async def test_list(ring):
    runner = CliRunner()
    with runner.isolated_filesystem():
        res = await runner.invoke(list_command, obj=ring)

        expected = (
            "Front Door (lpd_v1)\nBack Door (lpd_v1)\nDownstairs (chime)\n"
            "Front (hp_cam_v1)\nIngress (intercom_handset_audio)\n"
        )

        assert res.exit_code == 0
        assert expected in res.output


aiofiles.threadpool.wrap.register(MagicMock)(
    lambda *args, **kwargs: aiofiles.threadpool.AsyncBufferedIOBase(*args, **kwargs)
)


async def test_videos(ring, mocker):
    runner = CliRunner()
    mock_file_stream = MagicMock(read=lambda *args, **kwargs: b"")  # noqa: ARG005
    with runner.isolated_filesystem():
        with patch(
            "aiofiles.threadpool.sync_open", return_value=mock_file_stream
        ) as mock_open:
            res = await runner.invoke(videos, ["--count", "--download-all"], obj=ring)
        assert mock_open.call_count == 3
        mock_file_stream.write.assert_has_calls([call(b"123456")] * 3)
        assert "Downloading 3 videos" in res.output


@pytest.mark.parametrize(
    ("affect_method", "exception", "file_exists"),
    [
        (None, None, False),
        ("ring_doorbell.auth.Auth.async_fetch_token", Requires2FAError, False),
        ("ring_doorbell.ring.Ring.async_update_data", AuthenticationError, True),
    ],
    ids=("No 2FA", "Require 2FA", "Invalid Grant"),
)
async def test_auth(mocker, affect_method, exception, file_exists):
    call_count = 0

    def _raise_once(self, *_: dict[str, Any], **__: dict[str, Any]) -> dict[str, Any]:
        nonlocal call_count, exception
        if call_count == 0:
            call_count += 1
            msg = "Simulated exception"
            raise exception(msg)
        call_count += 1

        if hasattr(self, "_update_data"):
            return self._update_data()

        return DEFAULT

    def _add_token(
        uri,
        http_method,
        body,
        headers,
        token_placement=None,
        **kwargs,  # noqa: ANN003
    ) -> tuple[str, dict, bytes]:
        return uri, headers, body

    mocker.patch(
        "oauthlib.oauth2.LegacyApplicationClient.add_token", side_effect=_add_token
    )
    mocker.patch.object(Path, "is_file", return_value=file_exists)
    mocker.patch.object(Path, "read_text", return_value=load_fixture("ring_oauth.json"))
    mocker.patch("builtins.input", return_value="Foo")
    mocker.patch("getpass.getpass", return_value="Foo")
    if affect_method is not None:
        mocker.patch(affect_method, side_effect=_raise_once, autospec=True)

    runner = CliRunner()
    with runner.isolated_filesystem():
        res = await runner.invoke(cli)

        assert res.exit_code == 0


async def test_motion_detection(ring, aioresponses_mock, devices_fixture):
    runner = CliRunner()
    with runner.isolated_filesystem():
        res = await runner.invoke(
            motion_detection,
            ["--device-name", "Front"],
            obj=ring,
        )
        expected = "Front (hp_cam_v1) has motion detection off"
        assert res.exit_code == 0
        assert expected in res.output

        res = await runner.invoke(
            motion_detection,
            ["--device-name", "Front", "--off"],
            obj=ring,
        )
        expected = "Front (hp_cam_v1) already has motion detection off"
        assert res.exit_code == 0
        assert expected in res.output

        # Changes the return to indicate that the siren is now on.
        devices_fixture.updated = True
        aioresponses_mock.get(
            "https://api.ring.com/clients_api/ring_devices",
            payload=load_fixture_as_dict("ring_devices_updated.json"),
        )

        res = await runner.invoke(
            motion_detection,
            ["--device-name", "Front", "--on"],
            obj=ring,
        )
        expected = "Front (hp_cam_v1) motion detection set to on"
        assert res.exit_code == 0
        assert expected in res.output


@pytest.mark.nolistenmock
async def test_listen_store_credentials(mocker, auth):
    runner = CliRunner()
    import firebase_messaging

    credentials = json.loads(load_fixture("ring_listen_credentials.json"))

    with runner.isolated_filesystem():
        mocker.patch(
            "firebase_messaging.fcmregister.FcmRegister.gcm_check_in",
            return_value="foobar",
        )
        mocker.patch(
            "firebase_messaging.fcmregister.FcmRegister.register",
            return_value=credentials,
        )
        mocker.patch("firebase_messaging.FcmPushClient.start")
        mocker.patch("firebase_messaging.FcmPushClient.is_started", return_value=True)

        ring = Ring(auth)
        assert not Path(GCM_TOKEN_FILE).is_file()

        await runner.invoke(
            listen, ["--store-credentials"], obj=ring, catch_exceptions=True
        )
        assert Path(GCM_TOKEN_FILE).is_file()
        assert firebase_messaging.fcmregister.FcmRegister.gcm_check_in.call_count == 0
        assert firebase_messaging.fcmregister.FcmRegister.register.call_count == 1
        assert firebase_messaging.FcmPushClient.start.call_count == 1

        ring = Ring(auth)
        await runner.invoke(listen, ["--store-credentials"], obj=ring)
        assert firebase_messaging.fcmregister.FcmRegister.gcm_check_in.call_count == 1
        assert firebase_messaging.fcmregister.FcmRegister.register.call_count == 1
        assert firebase_messaging.FcmPushClient.start.call_count == 2


async def test_listen_event_handler(mocker, auth):
    from ring_doorbell.listen import RingEventListener

    ring = Ring(auth)
    listener = RingEventListener(ring)
    await listener.start()
    listener.add_notification_callback(_event_handler(ring).on_event)

    msg = load_alert_v1(
        "camera_motion", 12345678, created_at="2023-10-24T09:42:18.789709Z"
    )
    echomock = mocker.patch("ring_doorbell.cli.echo")
    mocker.patch(
        "ring_doorbell.cli.get_now_str", return_value="2023-10-24 09:42:18.789709"
    )
    listener._on_notification(msg, "1234567")
    exp = (
        "2023-10-24 09:42:18.789709: RingEvent(id=12345678901234, "
        "doorbot_id=12345678, device_name='Front Floodcam'"
        ", device_kind='floodlight_v2', now=1698140538.789709,"
        " expires_in=180, kind='motion', state='human', is_update=False) : "
        "Currently active count = 1"
    )
    echomock.assert_called_with(exp)


async def test_in_home_chime(ring, aioresponses_mock, devices_fixture):
    runner = CliRunner()
    with runner.isolated_filesystem():
        # Gets in-home chime details for a doorbell
        res = await runner.invoke(
            in_home_chime,
            ["--device-name", "Front Door"],
            obj=ring,
        )
        expected_show = (
            "Name:       Front Door\n"
            "ID:         987652\n"
            "Type:       Mechanical\n"
            "Enabled:    True\n"
            "Duration:   None\n"
        )
        expected = expected_show
        assert res.exit_code == 0
        assert expected in res.output

        # Turns off the in-home chime
        res = await runner.invoke(
            in_home_chime,
            ["--device-name", "Front Door", "enabled", "False"],
            obj=ring,
        )
        expected = "Front Door's in-home chime has been disabled"
        assert res.exit_code == 0
        assert expected in res.output

        # Turns on the in-home chime and sets type to Mechanical
        res = await runner.invoke(
            in_home_chime,
            [
                "--device-name",
                "Front Door",
                "type",
                "mechanical",
            ],
            obj=ring,
        )
        expected = "Front Door's in-home chime type has been set to Mechanical\n"
        assert res.exit_code == 0
        assert expected in res.output

        # Sets type to Digital and changes the duration
        res = await runner.invoke(
            in_home_chime,
            ["--device-name", "Front Door", "duration", "5"],
            obj=ring,
        )
        expected = "Front Door's in-home chime duration has been set to 5 seconds\n"
        assert res.exit_code == 0
        assert expected in res.output

        # Runs in-home-chime against a device that doesn't have an in-home chime
        res = await runner.invoke(
            in_home_chime,
            ["--device-name", "Front"],
            obj=ring,
        )
        expected = "Front is not a doorbell"
        assert res.exit_code == 1
        assert expected in res.output

        # Runs in-home-chime with no parameters and error as more than one doorbot.
        res = await runner.invoke(
            in_home_chime,
            [],
            obj=ring,
        )
        expected = "There are 2 doorbells, you need to pass the --device-name option"
        assert res.exit_code == 1
        assert expected in res.output


async def test_open_door(ring, aioresponses_mock, devices_fixture):
    runner = CliRunner()

    res = await runner.invoke(
        open_door,
        ["--device-name", "Ingress"],
        obj=ring,
    )
    assert res.exit_code == 0
    assert res.output == "Ingress opened\n"


async def test_get_device(ring, aioresponses_mock, devices_fixture):
    runner = CliRunner()

    # Get device by name
    res = await runner.invoke(
        open_door,
        ["--device-name", "Ingress"],
        obj=ring,
    )
    assert res.exit_code == 0
    assert res.output == "Ingress opened\n"

    # Get device by single type
    res = await runner.invoke(
        open_door,
        [],
        obj=ring,
    )
    assert res.exit_code == 0
    assert res.output == "Ingress opened\n"

    # Get wrong device type
    res = await runner.invoke(
        open_door,
        ["--device-name", "Front"],
        obj=ring,
    )
    assert res.exit_code == 1
    assert "Front is not a intercom" in res.output

    # Wrong name
    res = await runner.invoke(
        open_door,
        ["--device-name", "Frontx"],
        obj=ring,
    )
    assert res.exit_code == 1
    assert "Cannot find intercom with name Frontx" in res.output