Add support for factory reset (#60)

* Add support for factory reset

* Fix incorrectly named test

* Format code

Author: emontnemery

python_otbr_api/__init__.py

@@ -17,6 +17,10 @@ class OTBRError(Exception):
     """Raised on error."""
 
 
+class FactoryResetNotSupportedError(OTBRError):
+    """Raised when attempting to factory reset a router which does not support it."""
+
+
 class ThreadNetworkActiveError(OTBRError):
     """Raised on attempts to modify the active dataset when thread network is active."""
 
@@ -32,6 +36,20 @@ def __init__(
         self._url = url
         self._timeout = timeout
 
+    async def factory_reset(self) -> None:
+        """Factory reset the router."""
+
+        response = await self._session.delete(
+            f"{self._url}/node",
+            timeout=aiohttp.ClientTimeout(total=10),
+        )
+
+        if response.status == HTTPStatus.METHOD_NOT_ALLOWED:
+            raise FactoryResetNotSupportedError
+
+        if response.status != HTTPStatus.OK:
+            raise OTBRError(f"unexpected http status {response.status}")
+
     async def set_enabled(self, enabled: bool) -> None:
         """Enable or disable the router."""
 

tests/test_init.py

@@ -38,6 +38,39 @@
 }
 
 
+async def test_factory_reset(aioclient_mock: AiohttpClientMocker) -> None:
+    """Test factory_reset."""
+    otbr = python_otbr_api.OTBR(BASE_URL, aioclient_mock.create_session())
+
+    aioclient_mock.delete(f"{BASE_URL}/node", status=HTTPStatus.OK)
+
+    await otbr.factory_reset()
+    assert aioclient_mock.call_count == 1
+    assert aioclient_mock.mock_calls[-1][0] == "DELETE"
+    assert aioclient_mock.mock_calls[-1][1].path == "/node"
+    assert aioclient_mock.mock_calls[-1][2] is None
+
+
+async def test_factory_reset_unsupported(aioclient_mock: AiohttpClientMocker) -> None:
+    """Test factory_reset is unsupported."""
+    otbr = python_otbr_api.OTBR(BASE_URL, aioclient_mock.create_session())
+
+    aioclient_mock.delete(f"{BASE_URL}/node", status=HTTPStatus.METHOD_NOT_ALLOWED)
+
+    with pytest.raises(python_otbr_api.FactoryResetNotSupportedError):
+        await otbr.factory_reset()
+
+
+async def test_factory_reset_201(aioclient_mock: AiohttpClientMocker) -> None:
+    """Test factory_reset with error."""
+    otbr = python_otbr_api.OTBR(BASE_URL, aioclient_mock.create_session())
+
+    aioclient_mock.delete(f"{BASE_URL}/node", status=HTTPStatus.CREATED)
+
+    with pytest.raises(python_otbr_api.OTBRError):
+        await otbr.factory_reset()
+
+
 async def test_set_enabled(aioclient_mock: AiohttpClientMocker) -> None:
     """Test set_enabled."""
     otbr = python_otbr_api.OTBR(BASE_URL, aioclient_mock.create_session())