Migrate to voluptuous (#3374)

homeassistant/components/binary_sensor/nx584.py

@@ -1,41 +1,56 @@
 """
-Support for exposing nx584 elements as sensors.
+Support for exposing NX584 elements as sensors.
 
 For more details about this platform, please refer to the documentation at
-https://home-assistant.io/components/sensor.nx584/
+https://home-assistant.io/components/binary_sensor.nx584/
 """
 import logging
 import threading
 import time
 
 import requests
+import voluptuous as vol
 
 from homeassistant.components.binary_sensor import (
-    SENSOR_CLASSES, BinarySensorDevice)
+    SENSOR_CLASSES, BinarySensorDevice, PLATFORM_SCHEMA)
+from homeassistant.const import (CONF_HOST, CONF_PORT)
+import homeassistant.helpers.config_validation as cv
 
 REQUIREMENTS = ['pynx584==0.2']
+
 _LOGGER = logging.getLogger(__name__)
 
+CONF_EXCLUDE_ZONES = 'exclude_zones'
+CONF_ZONE_TYPES = 'zone_types'
+
+DEFAULT_HOST = 'localhost'
+DEFAULT_PORT = '5007'
+DEFAULT_SSL = False
+
+ZONE_TYPES_SCHEMA = vol.Schema({
+    cv.positive_int: vol.In(SENSOR_CLASSES),
+})
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Optional(CONF_EXCLUDE_ZONES, default=[]):
+        vol.All(cv.ensure_list, [cv.positive_int]),
+    vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
+    vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
+    vol.Optional(CONF_ZONE_TYPES, default={}): ZONE_TYPES_SCHEMA,
+})
+
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """Setup nx584 binary sensor platform."""
+    """Setup the NX584 binary sensor platform."""
     from nx584 import client as nx584_client
 
-    host = config.get('host', 'localhost:5007')
+    host = config.get(CONF_HOST)
-    exclude = config.get('exclude_zones', [])
+    port = config.get(CONF_PORT)
-    zone_types = config.get('zone_types', {})
+    exclude = config.get(CONF_EXCLUDE_ZONES)
-
+    zone_types = config.get(CONF_ZONE_TYPES)
-    if not all(isinstance(zone, int) for zone in exclude):
-        _LOGGER.error('Invalid excluded zone specified (use zone number)')
-        return False
-
-    if not all(isinstance(zone, int) and ztype in SENSOR_CLASSES
-               for zone, ztype in zone_types.items()):
-        _LOGGER.error('Invalid zone_types entry')
-        return False
 
     try:
-        client = nx584_client.Client('http://%s' % host)
+        client = nx584_client.Client('http://{}:{}'.format(host, port))
         zones = client.list_zones()
     except requests.exceptions.ConnectionError as ex:
         _LOGGER.error('Unable to connect to NX584: %s', str(ex))
@@ -43,7 +58,7 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
 
     version = [int(v) for v in client.get_version().split('.')]
     if version < [1, 1]:
-        _LOGGER.error('NX584 is too old to use for sensors (>=0.2 required)')
+        _LOGGER.error("NX584 is too old to use for sensors (>=0.2 required)")
         return False
 
     zone_sensors = {
@@ -57,13 +72,12 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
         watcher = NX584Watcher(client, zone_sensors)
         watcher.start()
     else:
-        _LOGGER.warning('No zones found on NX584')
+        _LOGGER.warning("No zones found on NX584")
-
     return True
 
 
 class NX584ZoneSensor(BinarySensorDevice):
-    """Represents a NX584 zone as a sensor."""
+    """Representation of a NX584 zone as a sensor."""
 
     def __init__(self, zone, zone_type):
         """Initialize the nx594 binary sensor."""
@@ -96,7 +110,7 @@ class NX584Watcher(threading.Thread):
     """Event listener thread to process NX584 events."""
 
     def __init__(self, client, zone_sensors):
-        """Initialize nx584 watcher thread."""
+        """Initialize NX584 watcher thread."""
         super(NX584Watcher, self).__init__()
         self.daemon = True
         self._client = client
@@ -130,5 +144,5 @@ class NX584Watcher(threading.Thread):
             try:
                 self._run()
             except requests.exceptions.ConnectionError:
-                _LOGGER.error('Failed to reach NX584 server')
+                _LOGGER.error("Failed to reach NX584 server")
                 time.sleep(10)

tests/components/binary_sensor/test_nx584.py

@@ -3,9 +3,11 @@ import requests
 import unittest
 from unittest import mock
 
-from homeassistant.components.binary_sensor import nx584
 from nx584 import client as nx584_client
 
+from homeassistant.components.binary_sensor import nx584
+from homeassistant.bootstrap import setup_component
+
 
 class StopMe(Exception):
     """Stop helper."""
@@ -14,7 +16,7 @@ class StopMe(Exception):
 
 
 class TestNX584SensorSetup(unittest.TestCase):
-    """Test the nx584 sensor platform."""
+    """Test the NX584 sensor platform."""
 
     def setUp(self):
         """Setup things to be run when tests are started."""
@@ -35,16 +37,26 @@ class TestNX584SensorSetup(unittest.TestCase):
         """Stop everything that was started."""
         self._mock_client.stop()
 
+    def test_setup_no_config(self):
+        """Test the setup with no configuration."""
+        hass = mock.MagicMock()
+        assert setup_component(hass, 'binary_sensor', {'nx584': {}})
+
     @mock.patch('homeassistant.components.binary_sensor.nx584.NX584Watcher')
     @mock.patch('homeassistant.components.binary_sensor.nx584.NX584ZoneSensor')
-    def test_setup_no_config(self, mock_nx, mock_watcher):
+    def test_setup_defaults(self, mock_nx, mock_watcher):
         """Test the setup with no configuration."""
         add_devices = mock.MagicMock()
         hass = mock.MagicMock()
-        self.assertTrue(nx584.setup_platform(hass, {}, add_devices))
+        config = {
-        mock_nx.assert_has_calls([
+            'host': nx584.DEFAULT_HOST,
-            mock.call(zone, 'opening')
+            'port': nx584.DEFAULT_PORT,
-            for zone in self.fake_zones])
+            'exclude_zones': [],
+            'zone_types': {},
+            }
+        self.assertTrue(nx584.setup_platform(hass, config, add_devices))
+        mock_nx.assert_has_calls(
+             [mock.call(zone, 'opening') for zone in self.fake_zones])
         self.assertTrue(add_devices.called)
         nx584_client.Client.assert_called_once_with('http://localhost:5007')
 
@@ -53,7 +65,8 @@ class TestNX584SensorSetup(unittest.TestCase):
     def test_setup_full_config(self, mock_nx, mock_watcher):
         """Test the setup with full configuration."""
         config = {
-            'host': 'foo:123',
+            'host': 'foo',
+            'port': 123,
             'exclude_zones': [2],
             'zone_types': {3: 'motion'},
             }
@@ -71,8 +84,7 @@ class TestNX584SensorSetup(unittest.TestCase):
     def _test_assert_graceful_fail(self, config):
         """Test the failing."""
         hass = add_devices = mock.MagicMock()
-        self.assertFalse(nx584.setup_platform(hass, config,
+        self.assertFalse(setup_component(hass, 'binary_sensor.nx584', config))
-                                              add_devices))
         self.assertFalse(add_devices.called)
 
     def test_setup_bad_config(self):
@@ -101,13 +113,12 @@ class TestNX584SensorSetup(unittest.TestCase):
         """Test the setup with no zones."""
         nx584_client.Client.return_value.list_zones.return_value = []
         hass = add_devices = mock.MagicMock()
-        self.assertTrue(nx584.setup_platform(hass, {},
+        self.assertTrue(nx584.setup_platform(hass, {}, add_devices))
-                                             add_devices))
         self.assertFalse(add_devices.called)
 
 
 class TestNX584ZoneSensor(unittest.TestCase):
-    """Test for the nx584 zone sensor."""
+    """Test for the NX584 zone sensor."""
 
     def test_sensor_normal(self):
         """Test the sensor."""
@@ -122,7 +133,7 @@ class TestNX584ZoneSensor(unittest.TestCase):
 
 
 class TestNX584Watcher(unittest.TestCase):
-    """Test the nx584 watcher."""
+    """Test the NX584 watcher."""
 
     @mock.patch.object(nx584.NX584ZoneSensor, 'update_ha_state')
     def test_process_zone_event(self, mock_update):