[PATCH v2 09/10] 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 v2:
- Added

 tools/binman/btool/xz.py  | 31 +++++++++++++++++++++++++++++++
 tools/binman/comp_util.py | 18 +++++++++---------
 2 files changed, 40 insertions(+), 9 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/comp_util.py b/tools/binman/comp_util.py
index e7cba23aa8..35835450e2 100644
--- a/tools/binman/comp_util.py
+++ b/tools/binman/comp_util.py
@@ -11,7 +11,7 @@ from binman import bintool
 from patman import tools
 
 # Supported compressions
-COMPRESSIONS = ['bzip2', 'gzip', 'lz4', 'lzma', 'lzo']
+COMPRESSIONS = ['bzip2', 'gzip', 'lz4', 'lzma', 'lzo', 'xz']
 
 bintools = {}
 
@@ -34,14 +34,14 @@ def compress(indata, algo):
     Note that for lzma this uses an old version of the algorithm, not that
     provided by xz.
 
-    This requires 'bzip2', 'gzip', 'lz4', 'lzma_alone' and 'lzop' tools. It
-    also requires an output directory to be previously set up, by calling
+    This requires 'bzip2', 'gzip', 'lz4', 'lzma_alone' 'lzop' and 'xz' tools.
+    It also requires an output directory to be previously set up, by calling
     PrepareOutputDir().
 
     Args:
         indata (bytes): Input data to compress
-        algo (str): Algorithm to use ('none', 'bzip2', 'gzip', 'lz4', 'lzma' or
-                    'lzo')
+        algo (str): Algorithm to use ('none', 'bzip2', 'gzip', 'lz4', 'lzma',
+                    'lzo' or 'xz')
 
     Returns:
         bytes: Compressed data
@@ -62,14 +62,14 @@ def decompress(indata, algo):
     Note that for lzma this uses an old version of the algorithm, not that
     provided by xz.
 
-    This requires 'bzip2', 'gzip', 'lz4', 'lzma_alone' and 'lzop' tools. It
-    also requires an output directory to be previously set up, by calling
+    This requires 'bzip2', 'gzip', 'lz4', 'lzma_alone', 'lzop' and 'xz' tools.
+    It also requires an output directory to be previously set up, by calling
     PrepareOutputDir().
 
     Args:
         indata (bytes): Input data to decompress
-        algo (str): Algorithm to use ('none', 'bzip2', 'gzip', 'lz4', 'lzma' or
-                    'lzo')
+        algo (str): Algorithm to use ('none', 'bzip2', 'gzip', 'lz4', 'lzma',
+                    'lzo' or 'xz')
 
     Returns:
         (bytes) Compressed data
-- 
2.30.2