From: zhouhao <haozhou.zhou@samsung.com>
Date: Wed, 14 Aug 2024 09:51:09 +0000 (+0800)
Subject: Support zstd compression in mic to pack image
X-Git-Tag: accepted/tools/devbase/tools/20250527.103804~4
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=1407146aa674b8aa6101e4e5b68ad7945e67ca69;p=tools%2Fmic.git

Support zstd compression in mic to pack image

Change-Id: I565f0ffd52bad601e8a0e74c241183443764c762
Signed-off-by: zhouhao <haozhou.zhou@samsung.com>
---

diff --git a/mic/archive.py b/mic/archive.py
index 0d9a3d0..9942db8 100644
--- a/mic/archive.py
+++ b/mic/archive.py
@@ -160,6 +160,32 @@ def _do_lzop(input_name, compression=True):
 
     return output_name
 
+def _do_zstd(input_name, compression=True):
+    """ Compress/decompress the file with 'zstd' utility.
+
+    @input_name: the file name to compress/decompress
+    @compress: True for compressing, False for decompressing
+    @retval: the path of the compressed/decompressed file
+    """
+    if which("zstd") is  None:
+        msger.error("zstd is not in mic-bootstrap, please add zstd to mic-bootstrap")
+
+    compressor = "zstd"
+
+    if compression:
+        cmdln = [compressor,"--rm",  "-f",  input_name]
+    else:
+        cmdln = [compressor, "--rm", "-d", "-f", input_name]
+
+    _call_external(cmdln)
+
+    if compression:
+        output_name = input_name + ".zst"
+    else:
+        output_name = os.path.splitext(input_name)[0]
+
+    return output_name
+
 _COMPRESS_SUFFIXES = {
     ".lzo"     : [".lzo"],
     ".gz"      : [".gz"],
@@ -356,12 +382,14 @@ def _make_zipfile(archive_name, target_name):
 
     return os.path.exists(archive_name)
 
+
 _ARCHIVE_SUFFIXES = {
     "zip"   : [".zip"],
     "tar"   : [".tar"],
     "lzotar": [".tzo", ".tar.lzo"],
     "gztar" : [".tgz", ".taz", ".tar.gz"],
     "bztar" : [".tbz", ".tbz2", ".tar.bz", ".tar.bz2"],
+    "zsttar": [".tar.zst"],
 }
 
 _ARCHIVE_FORMATS = {
@@ -370,6 +398,7 @@ _ARCHIVE_FORMATS = {
     "lzotar": ( _make_tarball, {"compressor" : _do_lzop} ),
     "gztar" : ( _make_tarball, {"compressor" : _do_gzip} ),
     "bztar" : ( _make_tarball, {"compressor" : _do_bzip2} ),
+    "zsttar" : ( _make_tarball, {"compressor" : _do_zstd} ),
 }
 
 def get_archive_formats():
diff --git a/mic/imager/baseimager.py b/mic/imager/baseimager.py
index 2602c60..272ca7f 100644
--- a/mic/imager/baseimager.py
+++ b/mic/imager/baseimager.py
@@ -117,7 +117,7 @@ class BaseImageCreator(object):
 
             if self.pack_to:
                 (tar, ext) = os.path.splitext(self.pack_to)
-                if ext in (".gz", ".bz2", ".lzo", ".bz") and tar.endswith(".tar"):
+                if ext in (".gz", ".bz2", ".lzo", ".bz", ".zst") and tar.endswith(".tar"):
                     ext = ".tar" + ext
                 if ext not in get_archive_suffixes():
                     self.pack_to += ".tar"
diff --git a/tests/test_archive.py b/tests/test_archive.py
index 609e7cc..4593407 100644
--- a/tests/test_archive.py
+++ b/tests/test_archive.py
@@ -267,7 +267,7 @@ class ArchiveTest(unittest.TestCase):
         archive_formats = archive.get_archive_formats()
         archive_formats.sort()
         self.assertEqual(archive_formats,
-                        ["bztar", "gztar", "lzotar", "tar", 'zip'])
+                        ["bztar", "gztar", "lzotar", "tar", 'zip', 'zsttar'])
 
     def test_get_archive_suffixes(self):
         """Test get archive suffixes"""
@@ -275,7 +275,7 @@ class ArchiveTest(unittest.TestCase):
         archive_suffixes.sort()
 
         self.assertEqual(archive_suffixes,
-                         ['.tar', '.tar.bz', '.tar.bz2', '.tar.gz', '.tar.lzo',
+                         ['.tar', '.tar.bz', '.tar.bz2', '.tar.gz', '.tar.lzo','.tar.zst',
                          '.taz', '.tbz', '.tbz2', '.tgz', '.tzo', '.zip'])
 
     def test_make_archive_negtive_archive_name_is_required(self):
@@ -688,5 +688,22 @@ class ArchiveTest(unittest.TestCase):
             self.assertTrue(os.path.exists(os.path.join(out_dir, item)))
             shutil.rmtree(out_dir)
 
+    def test_make_archive_tar_zst_with_different_name(self):
+        """ Test make_archive format: tar.zst
+            it packs the source with another name """
+        for item in self.files + self.dirs:
+            out_file = 'df.tar.zst'
+            self.assertTrue(archive.make_archive(out_file, item))
+            self.assertTrue(os.path.exists(out_file))
+            os.remove(out_file)
+
+    def test_make_archive_tar_zst(self):
+        """ Test make_archive format: tar.zst"""
+        for item in self.files + self.dirs:
+            out_file = '%s.tar.zst' % item
+            self.assertTrue(archive.make_archive(out_file, item))
+            self.assertTrue(os.path.exists(out_file))
+            os.remove(out_file)
+
 if __name__ == "__main__":
     unittest.main()