Achievement of platinum on the integration quality scale

DEVELOPERS.md

@@ -0,0 +1,15 @@
+Hi community!
+
+A Solcast API simulator and unit tests are available for this custom integration. To set up for both, add these mounts to your HA dev container, adjusting for your local integration fork.
+
+```
+  "mounts": [
+    "source=${localEnv:HOME}/Documents/GitHub/ha-solcast-solar/custom_components/solcast_solar,target=${containerWorkspaceFolder}/config/custom_components/solcast_solar,type=bind",
+    "source=${localEnv:HOME}/Documents/GitHub/ha-solcast-solar/tests,target=${containerWorkspaceFolder}/tests/components/solcast_solar,type=bind",
+    "source=${localEnv:HOME}/Documents/GitHub/ha-solcast-solar/sim,target=${containerWorkspaceFolder}/config/custom_components/solcast_solar/sim,type=bind"
+  ],
+```
+
+To get the simulator to work, the container will need a `pip install flask`, along with modifying `/etc/hosts` to specify `127.0.0.1 localhost api.solcast.com.au`. For a quick start, `cd config/custom_components/solcast_solar/sim` and execute `python3 -u wsgi.py --limit 5000 --no429`, which gets 5,000 API calls max, and no 'too busy' errors generated on the hour. (`python3 -u wsgi.py --help` for options, or inspect `wsgi.py` for doco.) Note that if the integration has never been started in your dev container then dependencies like `isodate` will not yet be installed. Do start the dev container once before trying to execute the simulator, or `pip install` the missing dependencies.
+
+The unit tests will show up at `tests/components/solcast_solar`. `cd` to there and execute `pytest`. Additional test contributions will be most welcome.

README.md

@@ -783,6 +783,9 @@ series:
 
 ## Changes
 
+v4.2.8
+* Catch duplicate API key being specified by @autoSteve
+
 v4.2.7
 * Fix an issue with API key validation by @autoSteve
 * Fix an issue preventing clean integration removal by @autoSteve

custom_components/solcast_solar/config_flow.py

@@ -137,9 +137,12 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None) -> Flo
             # Validate API key
             api_key = user_input[CONF_API_KEY].replace(" ", "")
             api_key = [s for s in api_key.split(",") if s]
-            for key in api_key:
+            for index, key in enumerate(api_key):
                 if re.match(LIKE_SITE_ID, key):
                     return self.async_abort(reason="API key looks like a site ID")
+                for i, k in enumerate(api_key):
+                    if index != i and key == k:
+                        return self.async_abort(reason="Duplicate API key specified")
             api_count = len(api_key)
             api_key = ",".join(api_key)
 
@@ -150,9 +153,9 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None) -> Flo
                 if not q.isnumeric():
                     return self.async_abort(reason="API limit is not a number")
                 if int(q) < 1:
-                    return self.async_abort(reason="API limit must be one  or greater!")
+                    return self.async_abort(reason="API limit must be one or greater")
             if len(api_quota) > api_count:
-                return self.async_abort(reason="There are more API limit counts entered than keys!")
+                return self.async_abort(reason="There are more API limit counts entered than keys")
             api_quota = ",".join(api_quota)
 
             options = {
@@ -232,9 +235,12 @@ async def async_step_init(self, user_input: dict | None = None) -> Any:
                 # Validate API key
                 api_key = user_input[CONF_API_KEY].replace(" ", "")
                 api_key = [s for s in api_key.split(",") if s]
-                for key in api_key:
+                for index, key in enumerate(api_key):
                     if re.match(LIKE_SITE_ID, key):
                         return self.async_abort(reason="API key looks like a site ID")
+                    for i, k in enumerate(api_key):
+                        if index != i and key == k:
+                            return self.async_abort(reason="Duplicate API key specified")
                 api_count = len(api_key)
                 api_key = ",".join(api_key)
                 all_config_data[CONF_API_KEY] = api_key
@@ -269,6 +275,8 @@ async def async_step_init(self, user_input: dict | None = None) -> Any:
                     if val < 0:
                         return self.async_abort(reason="Hard limit is not a positive number")
                     to_set.append(f"{val:.1f}")
+                if len(hard_limit) > api_count:
+                    return self.async_abort(reason="There are more hard limits entered than keys")
                 hard_limit = ",".join(to_set)
                 all_config_data[HARD_LIMIT_API] = hard_limit
 

custom_components/solcast_solar/manifest.json

@@ -10,5 +10,5 @@
   "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/BJReplay/ha-solcast-solar/issues",
   "requirements": ["aiohttp>=3.8.5", "aiofiles>=23.2.0", "datetime>=4.3", "isodate>=0.6.1"],
-  "version": "4.2.7"
+  "version": "4.2.8"
 }

custom_components/solcast_solar/solcastapi.py

@@ -186,7 +186,7 @@ def __init__(self, *args, **kwargs) -> None:
         """Initialise the decoder."""
         json.JSONDecoder.__init__(self, object_hook=self.object_hook, *args, **kwargs)  # noqa: B026
 
-    def object_hook(self, o: Any) -> dict:  # pylint: disable=method-hidden
+    def object_hook(self, o: Any) -> dict:
         """Return converted datetimes."""
         result = {}
         for key, value in o.items():

tests/__init__.py

@@ -0,0 +1 @@
+"""Init.py for Solcast Solar tests."""

tests/test_config_flow.py

@@ -0,0 +1,203 @@
+"""Test the Solcast Solar config flow."""
+
+import copy
+import logging
+from unittest.mock import AsyncMock
+
+# As a core component, these imports would be homeassistant.components.solcast_solar and not config.custom_components.solcast_solar
+from config.custom_components.solcast_solar.config_flow import (
+    SolcastSolarFlowHandler,
+    SolcastSolarOptionFlowHandler,
+)
+from config.custom_components.solcast_solar.const import (
+    API_QUOTA,
+    AUTO_UPDATE,
+    BRK_ESTIMATE,
+    BRK_ESTIMATE10,
+    BRK_ESTIMATE90,
+    BRK_HALFHOURLY,
+    BRK_HOURLY,
+    BRK_SITE,
+    BRK_SITE_DETAILED,
+    CUSTOM_HOUR_SENSOR,
+    DOMAIN,
+    HARD_LIMIT_API,
+    KEY_ESTIMATE,
+    SITE_DAMP,
+    TITLE,
+)
+
+from homeassistant.const import CONF_API_KEY
+from homeassistant.core import HomeAssistant
+from homeassistant.data_entry_flow import FlowResultType
+
+from tests.common import MockConfigEntry
+
+_LOGGER = logging.getLogger(__name__)
+
+KEY = "65sa6d46-sadf876_sd54"
+DEFAULT_INPUT = {
+    CONF_API_KEY: KEY,
+    API_QUOTA: "10",
+    AUTO_UPDATE: "1",
+    CUSTOM_HOUR_SENSOR: 1,
+    HARD_LIMIT_API: "100.0",
+    KEY_ESTIMATE: "estimate",
+    BRK_ESTIMATE: True,
+    BRK_ESTIMATE10: True,
+    BRK_ESTIMATE90: True,
+    BRK_SITE: True,
+    BRK_HALFHOURLY: True,
+    BRK_HOURLY: True,
+    BRK_SITE_DETAILED: False,
+    SITE_DAMP: False,
+}
+SITE_DAMP = {f"damp{factor:02d}": 1.0 for factor in range(24)}
+
+MOCK_ENTRY = MockConfigEntry(domain=DOMAIN, data={}, options=DEFAULT_INPUT)
+
+
+async def test_create_entry(hass: HomeAssistant) -> None:
+    """Test that a valid user input creates an entry."""
+    flow = SolcastSolarFlowHandler()
+    flow.hass = hass
+    flow.__conflicting_integration = AsyncMock(return_value=(False, ""))
+
+    user_input = {CONF_API_KEY: "65sa6d46-sadf876_sd54", API_QUOTA: "10", AUTO_UPDATE: "1"}
+    result = await flow.async_step_user(user_input)
+    assert result["type"] == FlowResultType.CREATE_ENTRY
+    assert result["title"] == TITLE
+    assert result["data"] == {}
+    assert result["options"][CONF_API_KEY] == KEY
+    assert result["options"][API_QUOTA] == "10"
+    assert result["options"][AUTO_UPDATE] == 1
+    assert result["options"][CUSTOM_HOUR_SENSOR] == 1
+    assert result["options"][HARD_LIMIT_API] == "100.0"
+    assert result["options"][KEY_ESTIMATE] == "estimate"
+    assert result["options"][BRK_ESTIMATE] is True
+    assert result["options"][BRK_ESTIMATE10] is True
+    assert result["options"][BRK_ESTIMATE90] is True
+    assert result["options"][BRK_SITE] is True
+    assert result["options"][BRK_HALFHOURLY] is True
+    assert result["options"][BRK_HOURLY] is True
+    assert result["options"][BRK_SITE_DETAILED] is False
+
+
+async def test_invalid_api_key(hass: HomeAssistant) -> None:
+    """Test that invalid API key is handled."""
+    flow = SolcastSolarFlowHandler()
+    flow.hass = hass
+    flow.__conflicting_integration = AsyncMock(return_value=(False, ""))
+
+    user_input = {CONF_API_KEY: "1234-5678-8765-4321", API_QUOTA: "10", AUTO_UPDATE: "1"}
+    result = await flow.async_step_user(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "API key looks like a site ID"
+
+    user_input = {CONF_API_KEY: KEY + "," + KEY, API_QUOTA: "10", AUTO_UPDATE: "1"}
+    result = await flow.async_step_user(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "Duplicate API key specified"
+
+
+async def test_invalid_api_quota(hass: HomeAssistant) -> None:
+    """Test that invalid API quota is handled."""
+    flow = SolcastSolarFlowHandler()
+    flow.hass = hass
+    flow.__conflicting_integration = AsyncMock(return_value=(False, ""))
+
+    user_input = {CONF_API_KEY: KEY, API_QUOTA: "invalid", AUTO_UPDATE: "1"}
+    result = await flow.async_step_user(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "API limit is not a number"
+
+    user_input = {CONF_API_KEY: KEY, API_QUOTA: "0", AUTO_UPDATE: "1"}
+    result = await flow.async_step_user(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "API limit must be one or greater"
+
+    user_input = {CONF_API_KEY: KEY, API_QUOTA: "10,10", AUTO_UPDATE: "1"}
+    result = await flow.async_step_user(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "There are more API limit counts entered than keys"
+
+
+async def test_option_invalid_api_key(hass: HomeAssistant) -> None:
+    """Test that invalid API key is handled."""
+    flow = SolcastSolarOptionFlowHandler(MOCK_ENTRY)
+    flow.hass = hass
+    flow.__conflicting_integration = AsyncMock(return_value=(False, ""))
+
+    user_input = {CONF_API_KEY: "1234-5678-8765-4321", API_QUOTA: "10", AUTO_UPDATE: "1"}
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "API key looks like a site ID"
+
+    user_input[CONF_API_KEY] = KEY + "," + KEY
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "Duplicate API key specified"
+
+
+async def test_option_invalid_custom_hour_sensor(hass: HomeAssistant) -> None:
+    """Test that invalid custom hour sensor is handled."""
+    flow = SolcastSolarOptionFlowHandler(MOCK_ENTRY)
+    flow.hass = hass
+    flow.__conflicting_integration = AsyncMock(return_value=(False, ""))
+
+    user_input = copy.deepcopy(DEFAULT_INPUT)
+    user_input[CUSTOM_HOUR_SENSOR] = 0
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "Custom sensor not between 1 and 144"
+
+    user_input[CUSTOM_HOUR_SENSOR] = 145
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "Custom sensor not between 1 and 144"
+
+
+async def test_option_invalid_api_quota(hass: HomeAssistant) -> None:
+    """Test that invalid API quota is handled."""
+    flow = SolcastSolarOptionFlowHandler(MOCK_ENTRY)
+    flow.hass = hass
+    flow.__conflicting_integration = AsyncMock(return_value=(False, ""))
+
+    user_input = copy.deepcopy(DEFAULT_INPUT)
+    user_input[API_QUOTA] = "invalid"
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "API limit is not a number"
+
+    user_input[API_QUOTA] = "0"
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "API limit must be one or greater"
+
+    user_input[API_QUOTA] = "10,10"
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "There are more API limit counts entered than keys"
+
+
+async def test_option_invalid_hard_limit(hass: HomeAssistant) -> None:
+    """Test that invalid hard limit is handled."""
+    flow = SolcastSolarOptionFlowHandler(MOCK_ENTRY)
+    flow.hass = hass
+    flow.__conflicting_integration = AsyncMock(return_value=(False, ""))
+
+    user_input = copy.deepcopy(DEFAULT_INPUT)
+    user_input[HARD_LIMIT_API] = "invalid"
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "Hard limit is not a positive number"
+
+    user_input[HARD_LIMIT_API] = "-1"
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "Hard limit is not a positive number"
+
+    user_input[HARD_LIMIT_API] = "6,6"
+    result = await flow.async_step_init(user_input)
+    assert result["type"] == FlowResultType.ABORT
+    assert result["reason"] == "There are more hard limits entered than keys"