[PATCH v5 20/21] binman: Add xz bintool

[Stefan Herbrechtsmeier]

From: Stefan Herbrechtsmeier <stefan.herbrechtsmeier at weidmueller.com>

Add xz bintool to binman to support on-the-fly compression.

Signed-off-by: Stefan Herbrechtsmeier <stefan.herbrechtsmeier at weidmueller.com>

---

Changes in v5:
- Add algorithm name to entry.py
- Add tool name to ftest.py

Changes in v2:
- Add commit to add xz bintool

 tools/binman/btool/xz.py | 31 +++++++++++++++++++++++++++++++
 tools/binman/entry.py    |  2 +-
 tools/binman/ftest.py    |  2 +-
 3 files changed, 33 insertions(+), 2 deletions(-)
 create mode 100644 tools/binman/btool/xz.py

diff --git a/tools/binman/btool/xz.py b/tools/binman/btool/xz.py
new file mode 100644
index 0000000000..e2b413d18b
--- /dev/null
+++ b/tools/binman/btool/xz.py
@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: GPL-2.0+
+# Copyright (C) 2022 Weidmüller Interface GmbH & Co. KG
+# Stefan Herbrechtsmeier <stefan.herbrechtsmeier at weidmueller.com>
+#
+"""Bintool implementation for xz
+
+xz allows compression and decompression of files.
+
+Documentation is available via::
+
+   man xz
+"""
+
+from binman import bintool
+
+# pylint: disable=C0103
+class Bintoolxz(bintool.BintoolPacker):
+    """Compression/decompression using the xz algorithm
+
+    This bintool supports running `xz` to compress and decompress data, as
+    used by binman.
+
+    It is also possible to fetch the tool, which uses `apt` to install it.
+
+    Documentation is available via::
+
+        man xz
+    """
+    def __init__(self, name):
+        super().__init__(name, fetch_package='xz-utils',
+                         version_regex=r'xz \(XZ Utils\) ([0-9.]+)')
diff --git a/tools/binman/entry.py b/tools/binman/entry.py
index ae3e94a167..0d4990cf5d 100644
--- a/tools/binman/entry.py
+++ b/tools/binman/entry.py
@@ -1157,7 +1157,7 @@ features to produce new behaviours.
         """
         algo = self.compress
         if algo != 'none':
-            algos = ['bzip2', 'gzip', 'lz4', 'lzma', 'lzo']
+            algos = ['bzip2', 'gzip', 'lz4', 'lzma', 'lzo', 'xz']
             if algo not in algos:
                 raise ValueError("Unknown algorithm '%s'" % algo)
             names = {'lzma': 'lzma_alone', 'lzo': 'lzop'}
diff --git a/tools/binman/ftest.py b/tools/binman/ftest.py
index 2cac505d8b..b337e2168c 100644
--- a/tools/binman/ftest.py
+++ b/tools/binman/ftest.py
@@ -107,7 +107,7 @@ BASE_DTB_PROPS = ['offset', 'size', 'image-pos']
 REPACK_DTB_PROPS = ['orig-offset', 'orig-size']
 
 # Supported compression bintools
-COMP_BINTOOLS = ['bzip2', 'gzip', 'lz4', 'lzma_alone', 'lzop']
+COMP_BINTOOLS = ['bzip2', 'gzip', 'lz4', 'lzma_alone', 'lzop', 'xz']
 
 class TestFunctional(unittest.TestCase):
     """Functional tests for binman
-- 
2.30.2