Add optional test fixture collection to enphase_envoy diagnostic report

homeassistant/components/enphase_envoy/config_flow.py

@@ -12,12 +12,22 @@
 import voluptuous as vol
 
 from homeassistant.components import zeroconf
-from homeassistant.config_entries import ConfigEntry, ConfigFlow, ConfigFlowResult
+from homeassistant.config_entries import (
+    ConfigEntry,
+    ConfigFlow,
+    ConfigFlowResult,
+    OptionsFlowWithConfigEntry,
+)
 from homeassistant.const import CONF_HOST, CONF_NAME, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.core import HomeAssistant, callback
 from homeassistant.helpers.httpx_client import get_async_client
 
-from .const import DOMAIN, INVALID_AUTH_ERRORS
+from .const import (
+    DOMAIN,
+    INVALID_AUTH_ERRORS,
+    OPTION_DIAGNOSTICS_INCLUDE_FIXTURES,
+    OPTION_DIAGNOSTICS_INCLUDE_FIXTURES_DEFAULT_VALUE,
+)
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -50,6 +60,12 @@ def __init__(self) -> None:
         self.protovers: str | None = None
         self._reauth_entry: ConfigEntry | None = None
 
+    @staticmethod
+    @callback
+    def async_get_options_flow(config_entry: ConfigEntry) -> EnvoyOptionsFlowHandler:
+        """Options flow handler for Enphase_Envoy."""
+        return EnvoyOptionsFlowHandler(config_entry)
+
     @callback
     def _async_generate_schema(self) -> vol.Schema:
         """Generate schema."""
@@ -282,3 +298,33 @@ async def async_step_reconfigure(
             description_placeholders=description_placeholders,
             errors=errors,
         )
+
+
+class EnvoyOptionsFlowHandler(OptionsFlowWithConfigEntry):
+    """Envoy config flow options handler."""
+
+    async def async_step_init(
+        self, user_input: dict[str, Any] | None = None
+    ) -> ConfigFlowResult:
+        """Manage the options."""
+        if user_input is not None:
+            return self.async_create_entry(title="", data=user_input)
+
+        return self.async_show_form(
+            step_id="init",
+            data_schema=vol.Schema(
+                {
+                    vol.Required(
+                        OPTION_DIAGNOSTICS_INCLUDE_FIXTURES,
+                        default=self.config_entry.options.get(
+                            OPTION_DIAGNOSTICS_INCLUDE_FIXTURES,
+                            OPTION_DIAGNOSTICS_INCLUDE_FIXTURES_DEFAULT_VALUE,
+                        ),
+                    ): bool,
+                }
+            ),
+            description_placeholders={
+                CONF_SERIAL: self.config_entry.unique_id,
+                CONF_HOST: self.config_entry.data.get("host"),
+            },
+        )

homeassistant/components/enphase_envoy/const.py

@@ -15,3 +15,6 @@
 ]
 
 INVALID_AUTH_ERRORS = (EnvoyAuthenticationError, EnvoyAuthenticationRequired)
+
+OPTION_DIAGNOSTICS_INCLUDE_FIXTURES = "diagnostics_include_fixtures"
+OPTION_DIAGNOSTICS_INCLUDE_FIXTURES_DEFAULT_VALUE = False

homeassistant/components/enphase_envoy/diagnostics.py

@@ -6,6 +6,8 @@
 from typing import TYPE_CHECKING, Any
 
 from attr import asdict
+from pyenphase.envoy import Envoy
+from pyenphase.exceptions import EnvoyError
 
 from homeassistant.components.diagnostics import async_redact_data
 from homeassistant.config_entries import ConfigEntry
@@ -21,7 +23,7 @@
 from homeassistant.helpers.json import json_dumps
 from homeassistant.util.json import json_loads
 
-from .const import DOMAIN
+from .const import DOMAIN, OPTION_DIAGNOSTICS_INCLUDE_FIXTURES
 from .coordinator import EnphaseUpdateCoordinator
 
 CONF_TITLE = "title"
@@ -38,6 +40,46 @@
 }
 
 
+async def _get_fixture_collection(envoy: Envoy, serial: str) -> dict[str, Any]:
+    """Collect Envoy endpoints to use for test fixture set."""
+    fixture_data: dict[str, Any] = {}
+    end_points = [
+        "/info",
+        "/api/v1/production",
+        "/api/v1/production/inverters",
+        "/production.json",
+        "/production.json?details=1",
+        "/production",
+        "/ivp/ensemble/power",
+        "/ivp/ensemble/inventory",
+        "/ivp/ensemble/dry_contacts",
+        "/ivp/ensemble/status",
+        "/ivp/ensemble/secctrl",
+        "/ivp/ss/dry_contact_settings",
+        "/admin/lib/tariff",
+        "/ivp/ss/gen_config",
+        "/ivp/ss/gen_schedule",
+        "/ivp/sc/pvlimit",
+        "/ivp/ss/pel_settings",
+        "/ivp/ensemble/generator",
+        "/ivp/meters",
+        "/ivp/meters/readings",
+    ]
+
+    for end_point in end_points:
+        response = await envoy.request(end_point)
+        fixture_data[end_point] = response.text.replace("\n", "").replace(
+            serial, CLEAN_TEXT
+        )
+        fixture_data[f"{end_point}_log"] = json_dumps(
+            {
+                "headers": dict(response.headers.items()),
+                "code": response.status_code,
+            }
+        )
+    return fixture_data
+
+
 async def async_get_config_entry_diagnostics(
     hass: HomeAssistant, entry: ConfigEntry
 ) -> dict[str, Any]:
@@ -113,12 +155,20 @@ async def async_get_config_entry_diagnostics(
         "ct_storage_meter": envoy.storage_meter_type,
     }
 
+    fixture_data: dict[str, Any] = {}
+    if entry.options.get(OPTION_DIAGNOSTICS_INCLUDE_FIXTURES, False):
+        try:
+            fixture_data = await _get_fixture_collection(envoy=envoy, serial=old_serial)
+        except EnvoyError as err:
+            fixture_data["Error"] = repr(err)
+
     diagnostic_data: dict[str, Any] = {
         "config_entry": async_redact_data(entry.as_dict(), TO_REDACT),
         "envoy_properties": envoy_properties,
         "raw_data": json_loads(coordinator_data_cleaned),
         "envoy_model_data": envoy_model,
         "envoy_entities_by_device": json_loads(device_entities_cleaned),
+        "fixtures": fixture_data,
     }
 
     return diagnostic_data

homeassistant/components/enphase_envoy/strings.json

@@ -36,6 +36,16 @@
       "reauth_successful": "[%key:common::config_flow::abort::reauth_successful%]"
     }
   },
+  "options": {
+    "step": {
+      "init": {
+        "title": "Envoy {serial} {host} options",
+        "data": {
+          "diagnostics_include_fixtures": "Include test fixture data in diagnostic report. Use when requested to provide test data for troubleshooting or development activies. With this option enabled the diagnostic report may take more time to download. When report is created best disable this option again."
+        }
+      }
+    }
+  },
   "entity": {
     "binary_sensor": {
       "communicating": {

tests/components/enphase_envoy/conftest.py

@@ -339,11 +339,22 @@ def mock_envoy_fixture(
         raw={"varies_by": "firmware_version"},
     )
     mock_envoy.update = AsyncMock(return_value=mock_envoy.data)
+
+    response = Mock()
+    response.status_code = 200
+    response.text = "Testing request \nreplies."
+    response.headers = {"Hello": "World"}
+    mock_envoy.request = AsyncMock(return_value=response)
+
     return mock_envoy
 
 
 @pytest.fixture(name="setup_enphase_envoy")
-async def setup_enphase_envoy_fixture(hass: HomeAssistant, config, mock_envoy):
+async def setup_enphase_envoy_fixture(
+    hass: HomeAssistant,
+    config,
+    mock_envoy,
+):
     """Define a fixture to set up Enphase Envoy."""
     with (
         patch(