Add option to create root folder for cache

Author: brefra

plugwise_usb/__init__.py

@@ -269,15 +269,15 @@ async def connect(self, port: str | None = None) -> None:
         )
 
     @raise_not_connected
-    async def initialize(self) -> None:
+    async def initialize(self, create_root_cache_folder: bool = False) -> None:
         """Initialize connection to USB-Stick."""
         await self._controller.initialize_stick()
         if self._network is None:
             self._network = StickNetwork(self._controller)
             self._network.cache_folder = self._cache_folder
             self._network.cache_enabled = self._cache_enabled
             if self._cache_enabled:
-                await self._network.initialize_cache()
+                await self._network.initialize_cache(create_root_cache_folder)
 
     @raise_not_connected
     @raise_not_initialized

plugwise_usb/helpers/cache.py

@@ -45,10 +45,10 @@ def cache_root_directory(self, cache_root_dir: str = "") -> None:
             self._initialized = False
         self._root_dir = cache_root_dir
 
-    async def initialize_cache(self) -> None:
+    async def initialize_cache(self, create_root_folder: bool = False) -> None:
         """Set (and create) the plugwise cache directory to store cache file."""
         if self._root_dir != "":
-            if not await ospath.exists(self._root_dir):
+            if not create_root_folder and not await ospath.exists(self._root_dir):
                 raise CacheError(f"Unable to initialize caching. Cache folder '{self._root_dir}' does not exists.")
             cache_dir = self._root_dir
         else:

plugwise_usb/network/__init__.py

@@ -103,11 +103,11 @@ def cache_folder(self, cache_folder: str) -> None:
         for node in self._nodes.values():
             node.cache_folder = cache_folder
 
-    async def initialize_cache(self) -> None:
+    async def initialize_cache(self, create_root_folder: bool = False) -> None:
         """Initialize the cache folder."""
         if not self._cache_enabled:
             raise CacheError("Unable to initialize cache, enable cache first.")
-        await self._register.initialize_cache()
+        await self._register.initialize_cache(create_root_folder)
 
     @property
     def controller_active(self) -> bool:

plugwise_usb/network/registry.py

@@ -63,11 +63,11 @@ def cache_enabled(self, enable: bool = True) -> None:
             _LOGGER.debug("Disable cache")
         self._cache_enabled = enable
 
-    async def initialize_cache(self) -> None:
+    async def initialize_cache(self, create_root_folder: bool = False) -> None:
         """Initialize cache"""
         if not self._cache_enabled:
             raise CacheError("Unable to initialize cache, enable cache first.")
-        await self._network_cache.initialize_cache()
+        await self._network_cache.initialize_cache(create_root_folder)
 
     @property
     def cache_folder(self) -> str:

tests/test_usb.py

@@ -1350,14 +1350,24 @@ async def aiofiles_os_remove(file) -> None:
                 return
             raise pw_exceptions.CacheError("Invalid file")
 
+        async def makedirs(cache_dir, exist_ok) -> None:
+            if cache_dir != "non_existing_folder":
+                raise pw_exceptions.CacheError("wrong folder to create")
+
         monkeypatch.setattr(pw_helpers_cache, "aiofiles_os_remove", aiofiles_os_remove)
+        monkeypatch.setattr(pw_helpers_cache, "makedirs", makedirs)
         monkeypatch.setattr(pw_helpers_cache, "ospath", MockOsPath())
 
         pw_cache = pw_helpers_cache.PlugwiseCache("test-file", "non_existing_folder")
         assert not pw_cache.initialized
         assert pw_cache.cache_root_directory == "non_existing_folder"
         with pytest.raises(pw_exceptions.CacheError):
             await pw_cache.initialize_cache()
+        assert not pw_cache.initialized
+
+        # test create folder
+        await pw_cache.initialize_cache(create_root_folder=True)
+        assert pw_cache.initialized
 
         # Windows
         pw_cache = pw_helpers_cache.PlugwiseCache("file_that_exists.ext", "mock_folder_that_exists")