File: test_api.py

package info (click to toggle)
py-canary 0.5.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 204 kB
  • sloc: python: 783; sh: 18; makefile: 8
file content (133 lines) | stat: -rw-r--r-- 4,490 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
"""The tests for the Canary sensor platform."""
import os
import unittest

import pytest
import requests_mock

from canary.api import Api
from canary.const import (
    URL_LOGIN_API,
    URL_MODES_API,
    URL_LOCATIONS_API,
    URL_READINGS_API,
    URL_LOGIN_PAGE,
    COOKIE_XSRF_TOKEN,
    COOKIE_SSESYRANAC,
)
from canary.model import SensorType

COOKIE_XSRF_VAL = "xsrf"
COOKIE_COOKIE_SSESYRANAC_VAL = "ssesyranac"

FIXED_DATE_RANGE = (
    "?end=2022-05-05T23%3A59%3A59.999Z&start=2022-05-05T00%3A00%3A00.000Z"
)
URL_ENTRY_API = f"https://my.canary.is/api/entries/tl2/70001{FIXED_DATE_RANGE}"


def load_fixture(filename):
    """Load a fixture."""
    path = os.path.join(os.path.dirname(__file__), "fixtures", filename)
    with open(path) as fptr:
        return fptr.read()


def _setup_responses(mock):
    mock.register_uri("POST", URL_LOGIN_API, text=load_fixture("api_login.json"))

    mock.register_uri("GET", URL_MODES_API, text=load_fixture("api_modes.json"))

    mock.register_uri("GET", URL_LOCATIONS_API, text=load_fixture("api_locations.json"))

    mock.register_uri(
        "GET", URL_READINGS_API, text=load_fixture("api_readings_80005.json")
    )

    mock.register_uri(
        "GET",
        URL_LOGIN_PAGE,
        cookies={
            COOKIE_XSRF_TOKEN: COOKIE_XSRF_VAL,
            COOKIE_SSESYRANAC: COOKIE_COOKIE_SSESYRANAC_VAL,
        },
    )

    mock.register_uri(
        "GET",
        URL_ENTRY_API,
        text=load_fixture("api_entries_70001.json"),
    )


class TestApi(unittest.TestCase):
    @requests_mock.Mocker()
    def test_locations(self, mock):
        """Test the Canary locations API."""
        _setup_responses(mock)
        api = Api("user", "pass")

        locations = api.get_locations()
        self.assertEqual(2, len(locations))

        for location in locations:
            if location.name == "Vacation Home":
                self.assertTrue(location.is_recording)
                self.assertFalse(location.is_private)
                self.assertTrue(location.is_celsius)
                self.assertEqual(2, len(location.customers))
                self.assertEqual("away", location.mode.name)
                self.assertEqual("armed", location.current_mode.name)
                self.assertEqual(70001, location.location_id)
            elif location.name == "Home":
                self.assertFalse(location.is_recording)
                self.assertFalse(location.is_private)
                self.assertFalse(location.is_celsius)
                self.assertEqual(1, len(location.customers))
                self.assertEqual("home", location.mode.name)
                self.assertEqual("standby", location.current_mode.name)
                self.assertEqual(70002, location.location_id)

    @pytest.mark.freeze_time("2022-05-05")
    @requests_mock.Mocker()
    def test_location_with_motion_entry(self, mock):
        """Test the Canary entries API."""
        _setup_responses(mock)
        api = Api("user", "pass")

        entries = api.get_entries(70001)
        self.assertEqual(2, len(entries))

        entry = entries[0]
        self.assertEqual("00000000-0000-0000-0001-000000000000", entry.entry_id)
        self.assertEqual("2022-05-06 00:08:14+00:00", str(entry.start_time))
        self.assertEqual(False, entry.starred)
        self.assertEqual(False, entry.selected)
        self.assertEqual(1, len(entry.thumbnails))
        self.assertEqual(1, len(entry.device_uuids))

        thumbnail = entry.thumbnails[0]
        self.assertEqual("https://image_url.com", thumbnail.image_url)

        device_uuid = entry.device_uuids[0]
        self.assertEqual("fffffffffeedffffffffffffffffffff", device_uuid)

    @requests_mock.Mocker()
    def test_device_with_readings(self, mock):
        """Test the Canary entries API."""
        _setup_responses(mock)
        api = Api("user", "pass")

        readings = api.get_readings(80001)
        self.assertEqual(6, len(readings))

        readings = api.get_latest_readings(80001)
        self.assertEqual(3, len(readings))

        for reading in readings:
            if reading.sensor_type == SensorType.AIR_QUALITY:
                self.assertEqual("0.8129177689552307", reading.value)
            elif reading.sensor_type == SensorType.HUMIDITY:
                self.assertEqual("41.68813060192352", reading.value)
            elif reading.sensor_type == SensorType.TEMPERATURE:
                self.assertEqual("19.0007521446715", reading.value)