Merge ~raharper/curtin:fix/support-txz-tbz into curtin:master

[Ryan Harper]

util: add support for 'tbz', 'txz' tar format types to sanitize_source

Curtin already supports tar.bz[2] and tar.xz via the helpers/smtar
tool but is missing the short-hand used in santize_sources to convert
a source URI into a source dictionary. This branch adds the two types
and adds unittest.

LP: #1843266

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:c155457d3904223ae085814d14e0e8f868b87f7f
https://jenkins.ubuntu.com/server/job/curtin-ci/3684/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-arm64/3684/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-ppc64el/3684/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-s390x/3684/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=torkoal/3684/

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/curtin-ci/3684//rebuild

review: Approve (continuous-integration)

[Scott Moser (smoser)]

review: Approve

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:c155457d3904223ae085814d14e0e8f868b87f7f
https://jenkins.ubuntu.com/server/job/curtin-ci/3685/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-arm64/3685/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-ppc64el/3685/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-s390x/3685/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=torkoal/3685/

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/curtin-ci/3685//rebuild

review: Approve (continuous-integration)

[Server Team CI bot (server-team-bot)]

PASSED: Continuous integration, rev:c155457d3904223ae085814d14e0e8f868b87f7f
https://jenkins.ubuntu.com/server/job/curtin-ci/3686/
Executed test runs:
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-arm64/3686/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-ppc64el/3686/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=metal-s390x/3686/
    SUCCESS: https://jenkins.ubuntu.com/server/job/curtin-ci/nodes=torkoal/3686/

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/curtin-ci/3686//rebuild

review: Approve (continuous-integration)

diff --git a/curtin/util.py b/curtin/util.py
index ebe219d..88426e6 100644
--- a/curtin/util.py
+++ b/curtin/util.py
@@ -906,8 +906,9 @@ def sanitize_source(source):
     if type(source) is dict:
         # already sanitized?
         return source
-    supported = ['tgz', 'dd-tgz', 'dd-tbz', 'dd-txz', 'dd-tar', 'dd-bz2',
-                 'dd-gz', 'dd-xz', 'dd-raw', 'fsimage', 'fsimage-layered']
+    supported = ['tgz', 'dd-tgz', 'tbz', 'dd-tbz', 'txz', 'dd-txz', 'dd-tar',
+                 'dd-bz2', 'dd-gz', 'dd-xz', 'dd-raw', 'fsimage',
+                 'fsimage-layered']
     deftype = 'tgz'
     for i in supported:
         prefix = i + ":"
diff --git a/tests/unittests/test_util.py b/tests/unittests/test_util.py
index d14a5f8..1339f5c 100644
--- a/tests/unittests/test_util.py
+++ b/tests/unittests/test_util.py
@@ -1095,4 +1095,41 @@ class TestLoadKernelModule(CiTestCase):
         self.assertEqual(0, self.m_subp.call_count)
 
 
+class TestSanitizeSource(CiTestCase):
+
+    # copied from curtin.util.sanitize_source
+    supported = ['tgz', 'dd-tgz', 'tbz', 'dd-tbz', 'txz', 'dd-txz', 'dd-tar',
+                 'dd-bz2', 'dd-gz', 'dd-xz', 'dd-raw', 'fsimage',
+                 'fsimage-layered']
+    source_url = 'http://curtin.io/root-fs.foo'
+
+    def test_supported_sources(self):
+        """ Verify supported sources types return expected dictionary. """
+        for stype in self.supported:
+            expected = {'type': stype, 'uri': self.source_url}
+            result = util.sanitize_source("%s:%s" % (stype, self.source_url))
+            self.assertEqual(expected, result)
+
+    def test_supported_squashfs_source_type(self):
+        """ Verify squashfs: prefix returns type=fsimage and correct uri."""
+        stype = 'fsimage'
+        expected = {'type': stype, 'uri': self.source_url}
+        result = util.sanitize_source("%s:%s" % (stype, self.source_url))
+        self.assertEqual(expected, result)
+
+    def test_supported_squashfs_suffix(self):
+        """ Verify .squash[fs] suffix returns type=fsimage and correct uri."""
+        for suff in ['squash', 'squashfs']:
+            source_url = "%s.%s" % (self.source_url, suff)
+            expected = {'type': 'fsimage', 'uri': source_url}
+            result = util.sanitize_source(source_url)
+            self.assertEqual(expected, result)
+
+    def test_unknown_type_assumed_to_be_tgz(self):
+        """ Verify unknown source type returns default type. """
+        expected = {'type': 'tgz', 'uri': self.source_url}
+        result = util.sanitize_source(self.source_url)
+        self.assertEqual(expected, result)
+
+
 # vi: ts=4 expandtab syntax=python