add simple tests

Author: GeigerJ2

src/aiida/tools/archive/create.py

@@ -141,7 +141,7 @@ def create_archive(
 
     :param backend: the backend to export from. If not specified, the default backend is used.
 
-    :param temp_dir: Directory to use for temporary files during archive creation.
+    :param tmp_dir: Directory to use for temporary files during archive creation.
         If not specified, a temporary directory will be created in the same directory as the output file
         with a '.aiida-export-' prefix. This parameter is useful when the output directory has limited
         space or when you want to use a specific filesystem (e.g., faster storage) for temporary operations.
@@ -200,7 +200,7 @@ def querybuilder():
         # Taken from: https://stackoverflow.com/a/2113511
         if not os.access(tmp_dir, os.W_OK | os.X_OK):
             msg = f"Specified temporary directory '{tmp_dir}' is not writable"
-            raise ArchiveExportError()
+            raise ArchiveExportError(msg)
         tmp_prefix = None  # Use default tempfile prefix
     else:
         # Create temporary directory in the same folder as the output file
@@ -311,9 +311,6 @@ def querybuilder():
     # Create and open the archive for writing.
     # We create in a temp dir then move to final place at end,
     # so that the user cannot end up with a half written archive on errors
-    # import ipdb; ipdb.set_trace()
-    tmp_dir = Path('/mount')  # or whatever directory you want to use
-
     try:
         with tempfile.TemporaryDirectory(dir=tmp_dir, prefix=tmp_prefix) as tmpdir:
             tmp_filename = Path(tmpdir) / 'export.zip'
@@ -406,10 +403,11 @@ def transform(d):
             shutil.move(tmp_filename, filename)
     except OSError as e:
         if e.errno == 28:  # No space left on device
-            raise ArchiveExportError(
+            msg = (
                 f"Insufficient disk space in temporary directory '{tmp_dir}'. "
                 f'Consider using --tmp-dir to specify a location with more available space.'
-            ) from e
+            )
+            raise ArchiveExportError(msg) from e
         raise ArchiveExportError(f'Failed to create temporary directory: {e}') from e
 
     EXPORT_LOGGER.report('Archive created successfully')

tests/tools/archive/test_simple.py

@@ -18,6 +18,7 @@
 from aiida.common.exceptions import IncompatibleStorageSchema, LicensingException
 from aiida.common.links import LinkType
 from aiida.tools.archive import create_archive, import_archive
+from aiida.tools.archive.exceptions import ArchiveExportError
 
 
 @pytest.mark.parametrize('entities', ['all', 'specific'])
@@ -154,3 +155,63 @@ def crashing_filter(_):
 
     with pytest.raises(LicensingException):
         create_archive([struct], test_run=True, forbidden_licenses=crashing_filter)
+
+
+@pytest.mark.usefixtures("aiida_profile_clean")
+def test_tmp_dir_custom_valid(tmp_path):
+    """Test using a custom valid temporary directory."""
+    from unittest.mock import patch
+
+    node = orm.Int(42).store()
+    custom_tmp = tmp_path / 'custom_tmp'
+    custom_tmp.mkdir()
+    filename = tmp_path / 'export.aiida'  # Put output file outside custom_tmp
+
+    with patch('tempfile.TemporaryDirectory') as mock_temp_dir:
+        # Create the actual temp directory that the mock returns
+        actual_temp_dir = custom_tmp / 'temp_dir'
+        actual_temp_dir.mkdir()
+
+        mock_temp_dir.return_value.__enter__.return_value = str(actual_temp_dir)
+        mock_temp_dir.return_value.__exit__.return_value = None
+
+        create_archive([node], filename=filename, tmp_dir=custom_tmp)
+
+        # Check that TemporaryDirectory was called with custom directory
+        mock_temp_dir.assert_called_once_with(dir=custom_tmp, prefix=None)
+
+@pytest.mark.usefixtures("aiida_profile_clean")
+def test_tmp_dir_validation_errors(tmp_path):
+    """Test tmp_dir validation errors."""
+
+    node = orm.Int(42).store()
+    filename = tmp_path / 'export.aiida'
+
+    # Non-existent directory
+    with pytest.raises(ArchiveExportError, match="does not exist"):
+        create_archive([node], filename=filename, tmp_dir=tmp_path / 'nonexistent')
+
+    # File instead of directory
+    not_a_dir = tmp_path / 'file.txt'
+    not_a_dir.write_text('content')
+    with pytest.raises(ArchiveExportError, match="is not a directory"):
+        create_archive([node], filename=filename, tmp_dir=not_a_dir)
+
+@pytest.mark.usefixtures("aiida_profile_clean")
+def test_tmp_dir_disk_space_error(tmp_path):
+    """Test disk space error handling."""
+    from unittest.mock import patch
+
+    node = orm.Int(42).store()
+    custom_tmp = tmp_path / 'custom_tmp'
+    custom_tmp.mkdir()
+    filename = tmp_path / 'export.aiida'
+
+    def mock_temp_dir_error(*args, **kwargs):
+        error = OSError("No space left on device")
+        error.errno = 28
+        raise error
+
+    with patch('tempfile.TemporaryDirectory', side_effect=mock_temp_dir_error):
+        with pytest.raises(ArchiveExportError, match="Insufficient disk space.*--tmp-dir"):
+            create_archive([node], filename=filename, tmp_dir=custom_tmp)