From 8fedfbfd810209a1bea43b8a21ad22f80110b3cf Mon Sep 17 00:00:00 2001
From: Frederic Crozat <fcrozat@suse.com>
Date: Tue, 31 Dec 2024 15:24:24 +0100
Subject: [PATCH 1/3] allow to override default boxes cache location

If KIWI_BOXED_CACHE_DIR environment variable is set,
it will be used to store kiwi boxes used for build.
---
 kiwi_boxed_plugin/defaults.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/kiwi_boxed_plugin/defaults.py b/kiwi_boxed_plugin/defaults.py
index 5b800e2..34fe472 100644
--- a/kiwi_boxed_plugin/defaults.py
+++ b/kiwi_boxed_plugin/defaults.py
@@ -79,6 +79,9 @@ def get_plugin_config_file() -> str:
 
     @staticmethod
     def get_local_box_cache_dir() -> str:
+        local_box_cache_dir_env: str | None = os.environ.get("KIWI_BOXED_CACHE_DIR")
+        if local_box_cache_dir_env is not None and os.path.exists(local_box_cache_dir_env):
+            return local_box_cache_dir_env
         return f'{os.environ.get("HOME")}/.kiwi_boxes'
 
     @staticmethod

From 3bc0fb83eb6bb275793eb7d2008d39511df175bd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marcus=20Sch=C3=A4fer?= <marcus.schaefer@gmail.com>
Date: Tue, 7 Jan 2025 11:30:36 +0100
Subject: [PATCH 2/3] Added test for custom cache dir

---
 kiwi_boxed_plugin/defaults.py  | 10 +++++++---
 test/unit/box_download_test.py | 19 +++++++++++++++++++
 2 files changed, 26 insertions(+), 3 deletions(-)

diff --git a/kiwi_boxed_plugin/defaults.py b/kiwi_boxed_plugin/defaults.py
index 34fe472..91c27fe 100644
--- a/kiwi_boxed_plugin/defaults.py
+++ b/kiwi_boxed_plugin/defaults.py
@@ -17,7 +17,9 @@
 #
 import os
 import pathlib
-from typing import List
+from typing import (
+    List, Optional
+)
 from kiwi.path import Path
 from pkg_resources import resource_filename
 import subprocess
@@ -79,8 +81,10 @@ def get_plugin_config_file() -> str:
 
     @staticmethod
     def get_local_box_cache_dir() -> str:
-        local_box_cache_dir_env: str | None = os.environ.get("KIWI_BOXED_CACHE_DIR")
-        if local_box_cache_dir_env is not None and os.path.exists(local_box_cache_dir_env):
+        local_box_cache_dir_env: Optional[str] = os.environ.get(
+            'KIWI_BOXED_CACHE_DIR'
+        )
+        if local_box_cache_dir_env and os.path.isdir(local_box_cache_dir_env):
             return local_box_cache_dir_env
         return f'{os.environ.get("HOME")}/.kiwi_boxes'
 
diff --git a/test/unit/box_download_test.py b/test/unit/box_download_test.py
index 2ec19af..9cf392a 100644
--- a/test/unit/box_download_test.py
+++ b/test/unit/box_download_test.py
@@ -42,6 +42,25 @@ def setup_method(
     ):
         self.setup()
 
+    @patch('kiwi_boxed_plugin.defaults.Defaults.get_plugin_config_file')
+    @patch('kiwi_boxed_plugin.box_download.Path')
+    @patch('kiwi_boxed_plugin.box_download.DirFiles')
+    @patch('os.path.isdir')
+    def test_custom_box_cache_dir(
+        self, mock_os_path_isdir, mock_DirFiles, mock_Path,
+        mock_get_plugin_config_file
+    ):
+        mock_os_path_isdir.return_value = True
+        mock_DirFiles.return_value = \
+            Mock().register.return_value = 'register_file'
+        mock_get_plugin_config_file.return_value = \
+            '../data/kiwi_boxed_plugin.yml'
+        with patch.dict('os.environ', {'KIWI_BOXED_CACHE_DIR': '/some/custom/dir'}):
+            BoxDownload('suse', 'x86_64')
+        mock_Path.create.assert_called_once_with(
+            '/some/custom/dir/suse'
+        )
+
     @patch('kiwi_boxed_plugin.box_download.Command.run')
     @patch('kiwi_boxed_plugin.box_download.Uri')
     @patch('kiwi_boxed_plugin.box_download.SolverRepository.new')

From 162f5a92e5414a1f4ed5db3956ee5361847e4fc1 Mon Sep 17 00:00:00 2001
From: Frederic Crozat <fcrozat@suse.com>
Date: Tue, 7 Jan 2025 16:42:06 +0100
Subject: [PATCH 3/3] add documentation to KIWI_BOXED_CACHE_DIR environment
 variable

---
 doc/source/commands/system_boxbuild.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/source/commands/system_boxbuild.rst b/doc/source/commands/system_boxbuild.rst
index c067dc8..275e410 100644
--- a/doc/source/commands/system_boxbuild.rst
+++ b/doc/source/commands/system_boxbuild.rst
@@ -174,6 +174,15 @@ OPTIONS
    the virtual machine. See the Example below how to provide
    options to the build command correctly.
 
+ENVIRONMENT
+-----------
+
+KIWI_BOXED_CACHE_DIR
+   By default, VM disk images used as build environment are
+   stored in $HOME/.kiwi_boxes directory. To override this
+   location, KIWI_BOXED_CACHE_DIR environment variable should
+   be set to a different absolute path.
+
 EXAMPLE
 -------