Skip to content

Commit 2b5d7b3

Browse files
drc38drc38
authored
Add websockets, ocpp module dependencies to test env (#61)
1 parent 857c546 commit 2b5d7b3

File tree

8 files changed

+167
-99
lines changed

8 files changed

+167
-99
lines changed

‎.github/workflows/constraints.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
pip==21.1.3
1+
pip<=20.3
22
pre-commit==2.13.0
33
black==21.6b0
44
flake8==3.9.2
55
reorder-python-imports==2.5.0
6+
websockets==9.1
7+
sqlalchemy==1.4.17
8+
ocpp>=0.8.3

‎.github/workflows/tests.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ jobs:
7474
- name: Install requirements
7575
run: |
7676
pip install --constraint=.github/workflows/constraints.txt pip
77-
pip install -r requirements_test.txt
77+
pip install -r requirements_test.txt --constraint=.github/workflows/constraints.txt
7878
- name: Tests suite
7979
run: |
8080
pytest \

‎requirements_test.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
-r requirements_dev.txt
22
pytest-homeassistant-custom-component==0.4.2
3+
websockets
4+
ocpp

‎tests/conftest.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
pytest_plugins = "pytest_homeassistant_custom_component"
77

88

9+
@pytest.fixture(autouse=True)
10+
def auto_enable_custom_integrations(enable_custom_integrations):
11+
"""Enable custom integrations defined in the test dir."""
12+
yield
13+
14+
915
# This fixture is used to prevent HomeAssistant from attempting to create and dismiss persistent
1016
# notifications. These calls would fail without this fixture since the persistent_notification
1117
# integration is never loaded during a test.

‎tests/const.py

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,51 @@
11
"""Constants for ocpp tests."""
2-
from custom_components.ocpp.const import CONF_HOST, CONF_NAME, CONF_PORT
2+
from custom_components.ocpp.const import (
3+
CONF_CPID,
4+
CONF_CSID,
5+
CONF_HOST,
6+
CONF_METER_INTERVAL,
7+
CONF_MONITORED_VARIABLES,
8+
CONF_PORT,
9+
)
10+
from ocpp.v16.enums import Measurand
311

412
MOCK_CONFIG = {
5-
CONF_NAME: "test_charger",
613
CONF_HOST: "0.0.0.0",
7-
CONF_PORT: 9123,
14+
CONF_PORT: 9000,
15+
CONF_CPID: "test_cpid",
16+
CONF_CSID: "test_csid",
17+
CONF_METER_INTERVAL: 60,
818
}
19+
MOCK_CONFIG_2 = {
20+
Measurand.current_export.value: True,
21+
Measurand.current_import.value: True,
22+
Measurand.current_offered.value: True,
23+
Measurand.energy_active_export_register.value: True,
24+
Measurand.energy_active_import_register.value: True,
25+
Measurand.energy_reactive_export_register.value: True,
26+
Measurand.energy_reactive_import_register.value: True,
27+
Measurand.energy_active_export_interval.value: True,
28+
Measurand.energy_active_import_interval.value: True,
29+
Measurand.energy_reactive_export_interval.value: True,
30+
Measurand.energy_reactive_import_interval.value: True,
31+
Measurand.frequency.value: True,
32+
Measurand.power_active_export.value: True,
33+
Measurand.power_active_import.value: True,
34+
Measurand.power_factor.value: True,
35+
Measurand.power_offered.value: True,
36+
Measurand.power_reactive_export.value: True,
37+
Measurand.power_reactive_import.value: True,
38+
Measurand.rpm.value: True,
39+
Measurand.soc.value: True,
40+
Measurand.temperature.value: True,
41+
Measurand.voltage.value: True,
42+
}
43+
MOCK_CONFIG_DATA = {
44+
CONF_HOST: "0.0.0.0",
45+
CONF_PORT: 9000,
46+
CONF_CPID: "test_cpid",
47+
CONF_CSID: "test_csid",
48+
CONF_METER_INTERVAL: 60,
49+
CONF_MONITORED_VARIABLES: "Current.Export,Current.Import,Current.Offered,Energy.Active.Export.Register,Energy.Active.Import.Register,Energy.Reactive.Export.Register,Energy.Reactive.Import.Register,Energy.Active.Export.Interval,Energy.Active.Import.Interval,Energy.Reactive.Export.Interval,Energy.Reactive.Import.Interval,Frequency,Power.Active.Export,Power.Active.Import,Power.Factor,Power.Offered,Power.Reactive.Export,Power.Reactive.Import,RPM,SoC,Temperature,Voltage",
50+
}
51+
DEFAULT_NAME = "test"

‎tests/test_config_flow.py

Lines changed: 61 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,14 @@
33

44
from homeassistant import config_entries, data_entry_flow
55
import pytest
6-
from pytest_homeassistant_custom_component.common import MockConfigEntry
76

8-
from custom_components.ocpp.const import (
9-
BINARY_SENSOR,
7+
from custom_components.ocpp.const import ( # BINARY_SENSOR,; PLATFORMS,; SENSOR,; SWITCH,
108
DOMAIN,
11-
PLATFORMS,
12-
SENSOR,
13-
SWITCH,
149
)
1510

16-
from .const import MOCK_CONFIG
11+
from .const import MOCK_CONFIG, MOCK_CONFIG_2, MOCK_CONFIG_DATA
12+
13+
# from pytest_homeassistant_custom_component.common import MockConfigEntry
1714

1815

1916
# This fixture bypasses the actual setup of the integration
@@ -49,61 +46,70 @@ async def test_successful_config_flow(hass, bypass_get_data):
4946
result["flow_id"], user_input=MOCK_CONFIG
5047
)
5148

49+
# Check that the config flow shows the user form as the first step
50+
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
51+
assert result["step_id"] == "measurands"
52+
53+
# Call again for step_id == "measurands" with default measurand
54+
result = await hass.config_entries.flow.async_configure(
55+
result["flow_id"], user_input=MOCK_CONFIG_2
56+
)
57+
5258
# Check that the config flow is complete and a new entry is created with
5359
# the input data
5460
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
55-
assert result["title"] == "test_username"
56-
assert result["data"] == MOCK_CONFIG
61+
assert result["title"] == "test_csid"
62+
assert result["data"] == MOCK_CONFIG_DATA
5763
assert result["result"]
5864

5965

6066
# In this case, we want to simulate a failure during the config flow.
6167
# We use the `error_on_get_data` mock instead of `bypass_get_data`
6268
# (note the function parameters) to raise an Exception during
6369
# validation of the input config.
64-
async def test_failed_config_flow(hass, error_on_get_data):
65-
"""Test a failed config flow due to credential validation failure."""
66-
67-
result = await hass.config_entries.flow.async_init(
68-
DOMAIN, context={"source": config_entries.SOURCE_USER}
69-
)
70-
71-
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
72-
assert result["step_id"] == "user"
73-
74-
result = await hass.config_entries.flow.async_configure(
75-
result["flow_id"], user_input=MOCK_CONFIG
76-
)
77-
78-
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
79-
assert result["errors"] == {"base": "auth"}
80-
81-
82-
# Our config flow also has an options flow, so we must test it as well.
83-
async def test_options_flow(hass):
84-
"""Test an options flow."""
85-
# Create a new MockConfigEntry and add to HASS (we're bypassing config
86-
# flow entirely)
87-
entry = MockConfigEntry(domain=DOMAIN, data=MOCK_CONFIG, entry_id="test")
88-
entry.add_to_hass(hass)
89-
90-
# Initialize an options flow
91-
await hass.config_entries.async_setup(entry.entry_id)
92-
result = await hass.config_entries.options.async_init(entry.entry_id)
93-
94-
# Verify that the first options step is a user form
95-
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
96-
assert result["step_id"] == "user"
97-
98-
# Enter some fake data into the form
99-
result = await hass.config_entries.options.async_configure(
100-
result["flow_id"],
101-
user_input={platform: platform != SENSOR for platform in PLATFORMS},
102-
)
103-
104-
# Verify that the flow finishes
105-
assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
106-
assert result["title"] == "test_username"
107-
108-
# Verify that the options were updated
109-
assert entry.options == {BINARY_SENSOR: True, SENSOR: False, SWITCH: True}
70+
# async def test_failed_config_flow(hass, error_on_get_data):
71+
# """Test a failed config flow due to credential validation failure."""
72+
#
73+
# result = await hass.config_entries.flow.async_init(
74+
# DOMAIN, context={"source": config_entries.SOURCE_USER}
75+
# )
76+
#
77+
# assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
78+
# assert result["step_id"] == "user"
79+
#
80+
# result = await hass.config_entries.flow.async_configure(
81+
# result["flow_id"], user_input=MOCK_CONFIG
82+
# )
83+
#
84+
# assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
85+
# assert result["errors"] == {"base": "auth"}
86+
#
87+
#
88+
# # Our config flow also has an options flow, so we must test it as well.
89+
# async def test_options_flow(hass):
90+
# """Test an options flow."""
91+
# # Create a new MockConfigEntry and add to HASS (we're bypassing config
92+
# # flow entirely)
93+
# entry = MockConfigEntry(domain=DOMAIN, data=MOCK_CONFIG, entry_id="test")
94+
# entry.add_to_hass(hass)
95+
#
96+
# # Initialize an options flow
97+
# await hass.config_entries.async_setup(entry.entry_id)
98+
# result = await hass.config_entries.options.async_init(entry.entry_id)
99+
#
100+
# # Verify that the first options step is a user form
101+
# assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
102+
# assert result["step_id"] == "user"
103+
#
104+
# # Enter some fake data into the form
105+
# result = await hass.config_entries.options.async_configure(
106+
# result["flow_id"],
107+
# user_input={platform: platform != SENSOR for platform in PLATFORMS},
108+
# )
109+
#
110+
# # Verify that the flow finishes
111+
# assert result["type"] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY
112+
# assert result["title"] == "test_username"
113+
#
114+
# # Verify that the options were updated
115+
# assert entry.options == {BINARY_SENSOR: True, SENSOR: False, SWITCH: True}

‎tests/test_init.py

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""Test ocpp setup process."""
2-
from homeassistant.exceptions import ConfigEntryNotReady
3-
import pytest
2+
# from homeassistant.exceptions import ConfigEntryNotReady
3+
# import pytest
44
from pytest_homeassistant_custom_component.common import MockConfigEntry
55

66
from custom_components.ocpp import (
@@ -11,7 +11,7 @@
1111
)
1212
from custom_components.ocpp.const import DOMAIN
1313

14-
from .const import MOCK_CONFIG
14+
from .const import MOCK_CONFIG_DATA
1515

1616

1717
# We can pass fixtures as defined in conftest.py to tell pytest to use the fixture
@@ -22,7 +22,9 @@
2222
async def test_setup_unload_and_reload_entry(hass, bypass_get_data):
2323
"""Test entry setup and unload."""
2424
# Create a mock entry so we don't have to go through config flow
25-
config_entry = MockConfigEntry(domain=DOMAIN, data=MOCK_CONFIG, entry_id="test")
25+
config_entry = MockConfigEntry(
26+
domain=DOMAIN, data=MOCK_CONFIG_DATA, entry_id="test"
27+
)
2628

2729
# Set up the entry and assert that the values set during setup are where we expect
2830
# them to be. Because we have patched the ocppDataUpdateCoordinator.async_get_data
@@ -41,12 +43,14 @@ async def test_setup_unload_and_reload_entry(hass, bypass_get_data):
4143
assert config_entry.entry_id not in hass.data[DOMAIN]
4244

4345

44-
async def test_setup_entry_exception(hass, error_on_get_data):
45-
"""Test ConfigEntryNotReady when API raises an exception during entry setup."""
46-
config_entry = MockConfigEntry(domain=DOMAIN, data=MOCK_CONFIG, entry_id="test")
47-
48-
# In this case we are testing the condition where async_setup_entry raises
49-
# ConfigEntryNotReady using the `error_on_get_data` fixture which simulates
50-
# an error.
51-
with pytest.raises(ConfigEntryNotReady):
52-
assert await async_setup_entry(hass, config_entry)
46+
# async def test_setup_entry_exception(hass, error_on_get_data):
47+
# """Test ConfigEntryNotReady when API raises an exception during entry setup."""
48+
# config_entry = MockConfigEntry(
49+
# domain=DOMAIN, data=MOCK_CONFIG_DATA, entry_id="test"
50+
# )
51+
#
52+
# # In this case we are testing the condition where async_setup_entry raises
53+
# # ConfigEntryNotReady using the `error_on_get_data` fixture which simulates
54+
# # an error.
55+
# with pytest.raises(ConfigEntryNotReady):
56+
# assert await async_setup_entry(hass, config_entry)

‎tests/test_switch.py

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
11
"""Test ocpp switch."""
2-
from unittest.mock import call, patch
2+
# from unittest.mock import call, patch
33

4-
from homeassistant.components.switch import SERVICE_TURN_OFF, SERVICE_TURN_ON
5-
from homeassistant.const import ATTR_ENTITY_ID
4+
# from homeassistant.components.switch import SERVICE_TURN_OFF, SERVICE_TURN_ON
5+
# from homeassistant.const import ATTR_ENTITY_ID
66
from pytest_homeassistant_custom_component.common import MockConfigEntry
77

88
from custom_components.ocpp import async_setup_entry
9-
from custom_components.ocpp.const import DEFAULT_NAME, DOMAIN, SWITCH
9+
from custom_components.ocpp.const import DOMAIN # SWITCH
1010

11-
from .const import MOCK_CONFIG
11+
from .const import MOCK_CONFIG_DATA
12+
13+
# from .const import DEFAULT_NAME
1214

1315

1416
async def test_switch_services(hass):
1517
"""Test switch services."""
1618
# Create a mock entry so we don't have to go through config flow
17-
config_entry = MockConfigEntry(domain=DOMAIN, data=MOCK_CONFIG, entry_id="test")
19+
config_entry = MockConfigEntry(
20+
domain=DOMAIN, data=MOCK_CONFIG_DATA, entry_id="test"
21+
)
1822
assert await async_setup_entry(hass, config_entry)
1923
await hass.async_block_till_done()
2024

2125
# Functions/objects can be patched directly in test code as well and can be used to test
2226
# additional things, like whether a function was called or what arguments it was called with
23-
with patch("custom_components.ocpp.ocppApiClient.async_set_title") as title_func:
24-
await hass.services.async_call(
25-
SWITCH,
26-
SERVICE_TURN_OFF,
27-
service_data={ATTR_ENTITY_ID: f"{SWITCH}.{DEFAULT_NAME}_{SWITCH}"},
28-
blocking=True,
29-
)
30-
assert title_func.called
31-
assert title_func.call_args == call("foo")
32-
33-
title_func.reset_mock()
34-
35-
await hass.services.async_call(
36-
SWITCH,
37-
SERVICE_TURN_ON,
38-
service_data={ATTR_ENTITY_ID: f"{SWITCH}.{DEFAULT_NAME}_{SWITCH}"},
39-
blocking=True,
40-
)
41-
assert title_func.called
42-
assert title_func.call_args == call("bar")
27+
# with patch("custom_components.ocpp.ocppApiClient.async_set_title") as title_func:
28+
# await hass.services.async_call(
29+
# SWITCH,
30+
# SERVICE_TURN_OFF,
31+
# service_data={ATTR_ENTITY_ID: f"{SWITCH}.{DEFAULT_NAME}_{SWITCH}"},
32+
# blocking=True,
33+
# )
34+
# assert title_func.called
35+
# assert title_func.call_args == call("foo")
36+
#
37+
# title_func.reset_mock()
38+
#
39+
# await hass.services.async_call(
40+
# SWITCH,
41+
# SERVICE_TURN_ON,
42+
# service_data={ATTR_ENTITY_ID: f"{SWITCH}.{DEFAULT_NAME}_{SWITCH}"},
43+
# blocking=True,
44+
# )
45+
# assert title_func.called
46+
# assert title_func.call_args == call("bar")

0 commit comments

Comments
 (0)