Add PurpleAir integration (#82110)

tests/components/purpleair/test_config_flow.py

@@ -0,0 +1,104 @@
+"""Define tests for the PurpleAir config flow."""
+from unittest.mock import AsyncMock, patch
+
+from aiopurpleair.errors import InvalidApiKeyError, PurpleAirError
+import pytest
+
+from homeassistant import data_entry_flow
+from homeassistant.components.purpleair import DOMAIN
+from homeassistant.config_entries import SOURCE_USER
+
+
+async def test_duplicate_error(hass, config_entry, setup_purpleair):
+    """Test that the proper error is shown when adding a duplicate config entry."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}, data={"api_key": "abcde12345"}
+    )
+    assert result["type"] == data_entry_flow.FlowResultType.ABORT
+    assert result["reason"] == "already_configured"
+
+
+@pytest.mark.parametrize(
+    "check_api_key_mock,check_api_key_errors",
+    [
+        (AsyncMock(side_effect=Exception), {"base": "unknown"}),
+        (AsyncMock(side_effect=InvalidApiKeyError), {"base": "invalid_api_key"}),
+        (AsyncMock(side_effect=PurpleAirError), {"base": "unknown"}),
+    ],
+)
+@pytest.mark.parametrize(
+    "get_nearby_sensors_mock,get_nearby_sensors_errors",
+    [
+        (AsyncMock(return_value=[]), {"base": "no_sensors_near_coordinates"}),
+        (AsyncMock(side_effect=Exception), {"base": "unknown"}),
+        (AsyncMock(side_effect=PurpleAirError), {"base": "unknown"}),
+    ],
+)
+async def test_create_entry_by_coordinates(
+    hass,
+    api,
+    check_api_key_errors,
+    check_api_key_mock,
+    get_nearby_sensors_errors,
+    get_nearby_sensors_mock,
+    setup_purpleair,
+):
+    """Test creating an entry by entering a latitude/longitude (including errors)."""
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": SOURCE_USER}
+    )
+    assert result["type"] == data_entry_flow.FlowResultType.FORM
+    assert result["step_id"] == "user"
+
+    # Test errors that can arise when checking the API key:
+    with patch.object(api, "async_check_api_key", check_api_key_mock):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"], user_input={"api_key": "abcde12345"}
+        )
+        assert result["type"] == data_entry_flow.FlowResultType.FORM
+        assert result["errors"] == check_api_key_errors
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"], user_input={"api_key": "abcde12345"}
+    )
+    assert result["type"] == data_entry_flow.FlowResultType.FORM
+    assert result["step_id"] == "by_coordinates"
+
+    # Test errors that can arise when searching for nearby sensors:
+    with patch.object(api.sensors, "async_get_nearby_sensors", get_nearby_sensors_mock):
+        result = await hass.config_entries.flow.async_configure(
+            result["flow_id"],
+            user_input={
+                "latitude": 51.5285582,
+                "longitude": -0.2416796,
+                "distance": 5,
+            },
+        )
+        assert result["type"] == data_entry_flow.FlowResultType.FORM
+        assert result["errors"] == get_nearby_sensors_errors
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input={
+            "latitude": 51.5285582,
+            "longitude": -0.2416796,
+            "distance": 5,
+        },
+    )
+    assert result["type"] == data_entry_flow.FlowResultType.FORM
+    assert result["step_id"] == "choose_sensor"
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input={
+            "sensor_index": "123456",
+        },
+    )
+    assert result["type"] == data_entry_flow.FlowResultType.CREATE_ENTRY
+    assert result["title"] == "abcde"
+    assert result["data"] == {
+        "api_key": "abcde12345",
+    }
+    assert result["options"] == {
+        "sensor_indices": [123456],
+    }