From 17e8e698a559fb308764db97153d1f45d0752176 Mon Sep 17 00:00:00 2001
From: Sebastian Muszynski <basti@linkt.de>
Date: Fri, 16 Mar 2018 13:15:23 +0100
Subject: [PATCH] Tests for reprs of the status classes (#266)

* Test the __repr__ of the status class.

* Import fixed.

* Access the correct object.

* Repr tests for all devices added.

* Yeelight tests refactored.

* Repr test of the vacuum fixed.

* Missing __repr__ method added.

* __str__ methods renamed to __repr__.

* Yeelight refactoring reverted.

* Start state extended by get power output.

* Dict extended properly.

* Reformatted.

* Format updated.
---
 miio/airconditioningcompanion.py            | 20 ++++++++++++++++++++
 miio/airhumidifier.py                       |  2 +-
 miio/plug.py                                |  2 +-
 miio/plug_v1.py                             |  2 +-
 miio/plug_v3.py                             |  2 +-
 miio/tests/test_airconditioningcompanion.py |  6 ++++--
 miio/tests/test_airhumidifier.py            |  5 ++++-
 miio/tests/test_airpurifier.py              |  7 ++++---
 miio/tests/test_airqualitymonitor.py        |  3 +++
 miio/tests/test_ceil.py                     |  4 +++-
 miio/tests/test_philips_bulb.py             |  4 +++-
 miio/tests/test_philips_eyecare.py          |  4 +++-
 miio/tests/test_plug.py                     |  3 +++
 miio/tests/test_plug_v1.py                  |  3 +++
 miio/tests/test_plug_v3.py                  | 12 +++++++++---
 miio/tests/test_powerstrip.py               |  4 +++-
 miio/tests/test_vacuum.py                   |  3 +++
 miio/tests/test_yeelight.py                 |  3 +++
 18 files changed, 72 insertions(+), 17 deletions(-)

diff --git a/miio/airconditioningcompanion.py b/miio/airconditioningcompanion.py
index 0a956f7fa..69c499ab4 100644
--- a/miio/airconditioningcompanion.py
+++ b/miio/airconditioningcompanion.py
@@ -141,6 +141,26 @@ def mode(self) -> Optional[OperationMode]:
         except TypeError:
             return None
 
+    def __repr__(self) -> str:
+        s = "<AirConditioningCompanionStatus " \
+            "power=%s, " \
+            "load_power=%s, " \
+            "air_condition_model=%s, " \
+            "led=%s, " \
+            "temperature=%s, " \
+            "swing_mode=%s, " \
+            "fan_speed=%s, " \
+            "mode=%s>" % \
+            (self.power,
+             self.load_power,
+             self.air_condition_model,
+             self.led,
+             self.temperature,
+             self.swing_mode,
+             self.fan_speed,
+             self.mode)
+        return s
+
 
 class AirConditioningCompanion(Device):
     """Main class representing Xiaomi Air Conditioning Companion."""
diff --git a/miio/airhumidifier.py b/miio/airhumidifier.py
index d9a73cae7..dff93a432 100644
--- a/miio/airhumidifier.py
+++ b/miio/airhumidifier.py
@@ -126,7 +126,7 @@ def button_pressed(self) -> Optional[str]:
         """Last pressed button."""
         return self.data["button_pressed"]
 
-    def __str__(self) -> str:
+    def __repr__(self) -> str:
         s = "<AirHumidiferStatus power=%s, " \
             "mode=%s, " \
             "temperature=%s, " \
diff --git a/miio/plug.py b/miio/plug.py
index df78d4411..a76099d78 100644
--- a/miio/plug.py
+++ b/miio/plug.py
@@ -27,7 +27,7 @@ def temperature(self) -> float:
         """Return temperature."""
         return self.data["temperature"]
 
-    def __str__(self) -> str:
+    def __repr__(self) -> str:
         s = "<PlugStatus power=%s, temperature=%s>" % \
             (self.power,
              self.temperature)
diff --git a/miio/plug_v1.py b/miio/plug_v1.py
index c14de09ba..19b06546a 100644
--- a/miio/plug_v1.py
+++ b/miio/plug_v1.py
@@ -31,7 +31,7 @@ def usb_power(self) -> bool:
     def temperature(self) -> float:
         return self.data["temperature"]
 
-    def __str__(self) -> str:
+    def __repr__(self) -> str:
         s = "<PlugV1Status power=%s, usb_power=%s, temperature=%s>" % \
             (self.power,
              self.usb_power,
diff --git a/miio/plug_v3.py b/miio/plug_v3.py
index f220ce64b..247604cd5 100644
--- a/miio/plug_v3.py
+++ b/miio/plug_v3.py
@@ -49,7 +49,7 @@ def wifi_led(self) -> bool:
         """True if the wifi led is turned on."""
         return self.data["wifi_led"] == "on"
 
-    def __str__(self) -> str:
+    def __repr__(self) -> str:
         s = "<PlugV3Status " \
             "power=%s, " \
             "usb_power=%s, " \
diff --git a/miio/tests/test_airconditioningcompanion.py b/miio/tests/test_airconditioningcompanion.py
index 5426984e8..e56311dd9 100644
--- a/miio/tests/test_airconditioningcompanion.py
+++ b/miio/tests/test_airconditioningcompanion.py
@@ -1,8 +1,8 @@
 import string
 from unittest import TestCase
 from miio import AirConditioningCompanion
-from miio.airconditioningcompanion import OperationMode, FanSpeed, Power, \
-    SwingMode, Led, STORAGE_SLOT_ID
+from miio.airconditioningcompanion import (OperationMode, FanSpeed, Power, SwingMode, Led,
+                                           AirConditioningCompanionStatus, STORAGE_SLOT_ID, )
 import pytest
 
 STATE_ON = ['on']
@@ -78,6 +78,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(AirConditioningCompanionStatus(self.device.start_state))
+
         assert self.is_on() is False
         assert self.state().load_power == 2
         assert self.state().air_condition_model == '010500978022222102'
diff --git a/miio/tests/test_airhumidifier.py b/miio/tests/test_airhumidifier.py
index 3e6fe6491..5e74ff369 100644
--- a/miio/tests/test_airhumidifier.py
+++ b/miio/tests/test_airhumidifier.py
@@ -1,6 +1,7 @@
 from unittest import TestCase
 from miio import AirHumidifier
-from miio.airhumidifier import OperationMode, LedBrightness, AirHumidifierException
+from miio.airhumidifier import (OperationMode, LedBrightness,
+                                AirHumidifierStatus, AirHumidifierException)
 from .dummies import DummyDevice
 import pytest
 
@@ -69,6 +70,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(AirHumidifierStatus(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().temperature == self.device.start_state["temp_dec"] / 10.0
         assert self.state().humidity == self.device.start_state["humidity"]
diff --git a/miio/tests/test_airpurifier.py b/miio/tests/test_airpurifier.py
index a10550597..13fb879ba 100644
--- a/miio/tests/test_airpurifier.py
+++ b/miio/tests/test_airpurifier.py
@@ -1,8 +1,7 @@
 from unittest import TestCase
 from miio import AirPurifier
-from miio.airpurifier import (
-    OperationMode, LedBrightness, FilterType, SleepMode, AirPurifierException
-)
+from miio.airpurifier import (OperationMode, LedBrightness, FilterType,
+                              SleepMode, AirPurifierStatus, AirPurifierException)
 from .dummies import DummyDevice
 import pytest
 
@@ -93,6 +92,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(AirPurifierStatus(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().aqi == self.device.start_state["aqi"]
         assert self.state().average_aqi == self.device.start_state["average_aqi"]
diff --git a/miio/tests/test_airqualitymonitor.py b/miio/tests/test_airqualitymonitor.py
index 1016e3622..20c41f9c3 100644
--- a/miio/tests/test_airqualitymonitor.py
+++ b/miio/tests/test_airqualitymonitor.py
@@ -1,5 +1,6 @@
 from unittest import TestCase
 from miio import AirQualityMonitor
+from miio.airqualitymonitor import AirQualityMonitorStatus
 from .dummies import DummyDevice
 import pytest
 
@@ -51,6 +52,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(AirQualityMonitorStatus(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().aqi == self.device.start_state["aqi"]
         assert self.state().battery == self.device.start_state["battery"]
diff --git a/miio/tests/test_ceil.py b/miio/tests/test_ceil.py
index 9eabcc7d4..e8b66dea4 100644
--- a/miio/tests/test_ceil.py
+++ b/miio/tests/test_ceil.py
@@ -1,6 +1,6 @@
 from unittest import TestCase
 from miio import Ceil
-from miio.ceil import CeilException
+from miio.ceil import CeilStatus, CeilException
 from .dummies import DummyDevice
 import pytest
 
@@ -66,6 +66,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(CeilStatus(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().brightness == self.device.start_state["bright"]
         assert self.state().color_temperature == self.device.start_state["cct"]
diff --git a/miio/tests/test_philips_bulb.py b/miio/tests/test_philips_bulb.py
index 2c3ea0089..6d6dc5adf 100644
--- a/miio/tests/test_philips_bulb.py
+++ b/miio/tests/test_philips_bulb.py
@@ -1,6 +1,6 @@
 from unittest import TestCase
 from miio import PhilipsBulb
-from miio.philips_bulb import PhilipsBulbException
+from miio.philips_bulb import PhilipsBulbStatus, PhilipsBulbException
 from .dummies import DummyDevice
 import pytest
 
@@ -60,6 +60,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(PhilipsBulbStatus(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().brightness == self.device.start_state["bright"]
         assert self.state().color_temperature == self.device.start_state["cct"]
diff --git a/miio/tests/test_philips_eyecare.py b/miio/tests/test_philips_eyecare.py
index c25478120..b986e15c9 100644
--- a/miio/tests/test_philips_eyecare.py
+++ b/miio/tests/test_philips_eyecare.py
@@ -1,6 +1,6 @@
 from unittest import TestCase
 from miio import PhilipsEyecare
-from miio.philips_eyecare import PhilipsEyecareException
+from miio.philips_eyecare import PhilipsEyecareStatus, PhilipsEyecareException
 from .dummies import DummyDevice
 import pytest
 
@@ -64,6 +64,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(PhilipsEyecareStatus(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().brightness == self.device.start_state["bright"]
         assert self.state().reminder is (self.device.start_state["notifystatus"] == 'on')
diff --git a/miio/tests/test_plug.py b/miio/tests/test_plug.py
index 0ec85fd66..0487e65a4 100644
--- a/miio/tests/test_plug.py
+++ b/miio/tests/test_plug.py
@@ -1,5 +1,6 @@
 from unittest import TestCase
 from miio import Plug
+from miio.plug import PlugStatus
 from .dummies import DummyDevice
 import pytest
 
@@ -48,5 +49,7 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(PlugStatus(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().temperature == self.device.start_state["temperature"]
diff --git a/miio/tests/test_plug_v1.py b/miio/tests/test_plug_v1.py
index a7f53c8a6..4f162ffa9 100644
--- a/miio/tests/test_plug_v1.py
+++ b/miio/tests/test_plug_v1.py
@@ -1,5 +1,6 @@
 from unittest import TestCase
 from miio import PlugV1
+from miio.plug_v1 import PlugV1Status
 import pytest
 
 
@@ -67,6 +68,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(PlugV1Status(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().usb_power is True
         assert self.state().temperature == self.device.start_state[
diff --git a/miio/tests/test_plug_v3.py b/miio/tests/test_plug_v3.py
index b4811a8de..18913da79 100644
--- a/miio/tests/test_plug_v3.py
+++ b/miio/tests/test_plug_v3.py
@@ -1,5 +1,6 @@
 from unittest import TestCase
 from miio import PlugV3
+from miio.plug_v3 import PlugV3Status
 from .dummies import DummyDevice
 import pytest
 
@@ -62,11 +63,16 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        load_power = self.device._get_load_power().pop(0)
+
+        start_state_extended = self.device.start_state.copy()
+        start_state_extended['load_power'] = load_power
+        assert repr(self.state()) == repr(PlugV3Status(start_state_extended))
+
         assert self.is_on() is True
         assert self.state().usb_power is True
-        assert self.state().temperature == self.device.start_state[
-            "temperature"]
-        assert self.state().load_power == self.device._get_load_power().pop(0)
+        assert self.state().temperature == self.device.start_state["temperature"]
+        assert self.state().load_power == load_power
 
     def test_usb_on(self):
         self.device.usb_off()  # ensure off
diff --git a/miio/tests/test_powerstrip.py b/miio/tests/test_powerstrip.py
index dd6fa2e38..18b9e9460 100644
--- a/miio/tests/test_powerstrip.py
+++ b/miio/tests/test_powerstrip.py
@@ -1,6 +1,6 @@
 from unittest import TestCase
 from miio import PowerStrip
-from miio.powerstrip import PowerMode, PowerStripException
+from miio.powerstrip import PowerMode, PowerStripStatus, PowerStripException
 from .dummies import DummyDevice
 import pytest
 
@@ -57,6 +57,8 @@ def test_off(self):
     def test_status(self):
         self.device._reset_state()
 
+        assert repr(self.state()) == repr(PowerStripStatus(self.device.start_state))
+
         assert self.is_on() is True
         assert self.state().mode == PowerMode(self.device.start_state["mode"])
         assert self.state().temperature == self.device.start_state["temperature"]
diff --git a/miio/tests/test_vacuum.py b/miio/tests/test_vacuum.py
index b7ba0d5c3..e0a7c2669 100644
--- a/miio/tests/test_vacuum.py
+++ b/miio/tests/test_vacuum.py
@@ -71,6 +71,9 @@ def status(self):
 
     def test_status(self):
         self.device._reset_state()
+
+        assert repr(self.status()) == repr(VacuumStatus(self.device.start_state))
+
         status = self.status()
         assert status.is_on is False
         assert status.dnd is True
diff --git a/miio/tests/test_yeelight.py b/miio/tests/test_yeelight.py
index 722956138..2af70f362 100644
--- a/miio/tests/test_yeelight.py
+++ b/miio/tests/test_yeelight.py
@@ -62,6 +62,9 @@ class TestYeelight(TestCase):
     def test_status(self):
         self.device._reset_state()
         status = self.device.status()  # type: YeelightStatus
+
+        assert repr(status) == repr(YeelightStatus(self.device.start_state))
+
         assert status.name == self.device.start_state["name"]
         assert status.is_on is False
         assert status.brightness == 100