Merge branch 'master' of github.com:materialsproject/custodian

Author: shyuep

src/custodian/utils.py

@@ -21,12 +21,13 @@ def backup(filenames, prefix="error", directory="./") -> None:
         directory (str): directory where the files exist
     """
     num = max([0] + [int(file.split(".")[-3]) for file in glob(os.path.join(directory, f"{prefix}.*.tar.gz"))])
-    filename = os.path.join(directory, f"{prefix}.{num + 1}.tar.gz")
+    prefix = f"{prefix}.{num + 1}"
+    filename = os.path.join(directory, f"{prefix}.tar.gz")
     logging.info(f"Backing up run to {filename}.")
     with tarfile.open(filename, "w:gz") as tar:
         for fname in filenames:
             for file in glob(os.path.join(directory, fname)):
-                tar.add(file)
+                tar.add(file, arcname=os.path.join(prefix, os.path.basename(file)))
 
 
 def get_execution_host_info():

tests/test_utils.py

@@ -30,12 +30,43 @@ def some_func(x):
     assert n_calls == 3
 
 
-def test_backup(tmp_path) -> None:
+def test_backup(tmp_path, monkeypatch) -> None:
+    monkeypatch.chdir(tmp_path)
+    with open("INCAR", "w") as f:
+        f.write("This is a test file.")
+
+    backup(["INCAR"])
+
+    assert Path("error.1.tar.gz").exists()
+    with tarfile.open("error.1.tar.gz", "r:gz") as tar:
+        assert len(tar.getmembers()) == 1
+        assert tar.getnames() == ["error.1/INCAR"]
+
+
+def test_backup_with_glob(tmp_path, monkeypatch) -> None:
+    monkeypatch.chdir(tmp_path)
+    with open("INCAR", "w") as f:
+        f.write("This is a test file.")
+    with open("POSCAR", "w") as f:
+        f.write("This is a test file.")
+    with open("garbage", "w") as f:
+        f.write("This is a test file.")
+
+    backup(["*CAR"])
+
+    assert Path("error.1.tar.gz").exists()
+    with tarfile.open("error.1.tar.gz", "r:gz") as tar:
+        assert len(tar.getmembers()) == 2
+        assert tar.getnames() == ["error.1/INCAR", "error.1/POSCAR"]
+
+
+def test_backup_with_directory(tmp_path) -> None:
     with open(tmp_path / "INCAR", "w") as f:
         f.write("This is a test file.")
 
     backup(["INCAR"], directory=tmp_path)
 
     assert Path(tmp_path / "error.1.tar.gz").exists()
     with tarfile.open(tmp_path / "error.1.tar.gz", "r:gz") as tar:
-        assert len(tar.getmembers()) > 0
+        assert len(tar.getmembers()) == 1
+        assert tar.getnames() == ["error.1/INCAR"]