From 55cdec8c4e115b3e404d7924fefeeea4f6653609 Mon Sep 17 00:00:00 2001
From: jan iversen <jancasacondor@gmail.com>
Date: Sun, 8 Nov 2020 17:42:45 +0100
Subject: [PATCH] Add test for register configuration for modbus switch
 (#42604)

* check for false config in modbus tests.

add call to pytest.fail() if device cannot be defined.

* correct bit error in register read.

Only LSB is to be considered for checking ON/OFF

* Add register tests for modbus switch.

Copy the coil tests to work for register tests.

* allow test coverage to control switch.py

With both register and coil test the coverage is a log higher than 50%

* Correct minor bug in handling of register in modbus switch

* Add state_on/state_off test for modbus switch

* restore modbus switch exclusion from coverage

switch file coverage is only at 72%, ideally we want either 80%+ coverage on the file or 90%+ on the component itself which is only about 83% currently with this file included. this is so we keep the overall project coverage in 90%+.

Co-authored-by: Chris Talkington <chris@talkingtontech.com>
---
 tests/components/modbus/conftest.py           |   2 +
 tests/components/modbus/test_modbus_switch.py | 127 +++++++++++++++++-
 2 files changed, 127 insertions(+), 2 deletions(-)

diff --git a/tests/components/modbus/conftest.py b/tests/components/modbus/conftest.py
index ca3e44dbe1d..ce6e6585512 100644
--- a/tests/components/modbus/conftest.py
+++ b/tests/components/modbus/conftest.py
@@ -64,6 +64,8 @@ async def setup_base_test(
 
     entity_id = f"{entity_domain}.{sensor_name}"
     device = hass.states.get(entity_id)
+    if device is None:
+        pytest.fail("CONFIG failed, see output")
     return entity_id, now, device
 
 
diff --git a/tests/components/modbus/test_modbus_switch.py b/tests/components/modbus/test_modbus_switch.py
index 75255389bea..da2ff953660 100644
--- a/tests/components/modbus/test_modbus_switch.py
+++ b/tests/components/modbus/test_modbus_switch.py
@@ -3,9 +3,22 @@ from datetime import timedelta
 
 import pytest
 
-from homeassistant.components.modbus.const import CALL_TYPE_COIL, CONF_COILS
+from homeassistant.components.modbus.const import (
+    CALL_TYPE_COIL,
+    CALL_TYPE_REGISTER_HOLDING,
+    CONF_COILS,
+    CONF_REGISTER,
+    CONF_REGISTERS,
+)
 from homeassistant.components.switch import DOMAIN as SWITCH_DOMAIN
-from homeassistant.const import CONF_NAME, CONF_SLAVE, STATE_OFF, STATE_ON
+from homeassistant.const import (
+    CONF_COMMAND_OFF,
+    CONF_COMMAND_ON,
+    CONF_NAME,
+    CONF_SLAVE,
+    STATE_OFF,
+    STATE_ON,
+)
 
 from .conftest import run_base_read_test, setup_base_test
 
@@ -61,3 +74,113 @@ async def test_coil_switch(hass, mock_hub, regs, expected):
         expected,
         now + timedelta(seconds=scan_interval + 1),
     )
+
+
+@pytest.mark.parametrize(
+    "regs,expected",
+    [
+        (
+            [0x00],
+            STATE_OFF,
+        ),
+        (
+            [0x80],
+            STATE_OFF,
+        ),
+        (
+            [0xFE],
+            STATE_OFF,
+        ),
+        (
+            [0xFF],
+            STATE_OFF,
+        ),
+        (
+            [0x01],
+            STATE_ON,
+        ),
+    ],
+)
+async def test_register_switch(hass, mock_hub, regs, expected):
+    """Run test for given config."""
+    switch_name = "modbus_test_switch"
+    scan_interval = 5
+    entity_id, now, device = await setup_base_test(
+        switch_name,
+        hass,
+        mock_hub,
+        {
+            CONF_REGISTERS: [
+                {
+                    CONF_NAME: switch_name,
+                    CONF_REGISTER: 1234,
+                    CONF_SLAVE: 1,
+                    CONF_COMMAND_OFF: 0x00,
+                    CONF_COMMAND_ON: 0x01,
+                },
+            ]
+        },
+        SWITCH_DOMAIN,
+        scan_interval,
+    )
+
+    await run_base_read_test(
+        entity_id,
+        hass,
+        mock_hub,
+        CALL_TYPE_REGISTER_HOLDING,
+        regs,
+        expected,
+        now + timedelta(seconds=scan_interval + 1),
+    )
+
+
+@pytest.mark.parametrize(
+    "regs,expected",
+    [
+        (
+            [0x40],
+            STATE_ON,
+        ),
+        (
+            [0x04],
+            STATE_OFF,
+        ),
+        (
+            [0xFF],
+            STATE_OFF,
+        ),
+    ],
+)
+async def test_register_state_switch(hass, mock_hub, regs, expected):
+    """Run test for given config."""
+    switch_name = "modbus_test_switch"
+    scan_interval = 5
+    entity_id, now, device = await setup_base_test(
+        switch_name,
+        hass,
+        mock_hub,
+        {
+            CONF_REGISTERS: [
+                {
+                    CONF_NAME: switch_name,
+                    CONF_REGISTER: 1234,
+                    CONF_SLAVE: 1,
+                    CONF_COMMAND_OFF: 0x04,
+                    CONF_COMMAND_ON: 0x40,
+                },
+            ]
+        },
+        SWITCH_DOMAIN,
+        scan_interval,
+    )
+
+    await run_base_read_test(
+        entity_id,
+        hass,
+        mock_hub,
+        CALL_TYPE_REGISTER_HOLDING,
+        regs,
+        expected,
+        now + timedelta(seconds=scan_interval + 1),
+    )