From 25d829c8f2d880c51c66c3b0d90b187fb5d57a2c Mon Sep 17 00:00:00 2001
From: Matt Clay <matt@mystile.com>
Date: Tue, 27 Sep 2016 10:46:28 -0700
Subject: [PATCH] Detect tar type (bsd, gnu) and only use gnu tar. (#4352)

* Detect tar type (bsd, gnu) and only use gnu tar.

* Revert return code checking for TgzArchive.
---
 lib/ansible/modules/files/unarchive.py | 40 ++++++++++++++++++++------
 1 file changed, 31 insertions(+), 9 deletions(-)

diff --git a/lib/ansible/modules/files/unarchive.py b/lib/ansible/modules/files/unarchive.py
index 0eb8e49eab4..8af1c4106ce 100644
--- a/lib/ansible/modules/files/unarchive.py
+++ b/lib/ansible/modules/files/unarchive.py
@@ -558,12 +558,12 @@ class ZipArchive(object):
 
     def can_handle_archive(self):
         if not self.cmd_path:
-            return False
+            return False, 'Command "unzip" not found.'
         cmd = [ self.cmd_path, '-l', self.src ]
         rc, out, err = self.module.run_command(cmd)
         if rc == 0:
-            return True
-        return False
+            return True, None
+        return False, 'Command "%s" could not handle archive.' % self.cmd_path
 
 
 # class to handle gzipped tar files
@@ -586,6 +586,21 @@ class TgzArchive(object):
         self.zipflag = '-z'
         self._files_in_archive = []
 
+        if self.cmd_path:
+            self.tar_type = self._get_tar_type()
+        else:
+            self.tar_type = None
+
+    def _get_tar_type(self):
+        cmd = [self.cmd_path, '--version']
+        (rc, out, err) = self.module.run_command(cmd)
+        tar_type = None
+        if out.startswith('bsdtar'):
+            tar_type = 'bsd'
+        elif out.startswith('tar') and 'GNU' in out:
+            tar_type = 'gnu'
+        return tar_type
+
     @property
     def files_in_archive(self, force_refresh=False):
         if self._files_in_archive and not force_refresh:
@@ -678,16 +693,19 @@ class TgzArchive(object):
 
     def can_handle_archive(self):
         if not self.cmd_path:
-            return False
+            return False, 'Commands "gtar" and "tar" not found.'
+
+        if self.tar_type != 'gnu':
+            return False, 'Command "%s" detected as tar type %s. GNU tar required.' % (self.cmd_path, self.tar_type)
 
         try:
             if self.files_in_archive:
-                return True
+                return True, None
         except UnarchiveError:
-            pass
+            return False, 'Command "%s" could not handle archive.' % self.cmd_path
         # Errors and no files in archive assume that we weren't able to
         # properly unarchive it
-        return False
+        return False, 'Command "%s" found no files in archive.' % self.cmd_path
 
 
 # class to handle tar files that aren't compressed
@@ -715,11 +733,15 @@ class TarXzArchive(TgzArchive):
 # try handlers in order and return the one that works or bail if none work
 def pick_handler(src, dest, file_args, module):
     handlers = [ZipArchive, TgzArchive, TarArchive, TarBzipArchive, TarXzArchive]
+    reasons = set()
     for handler in handlers:
         obj = handler(src, dest, file_args, module)
-        if obj.can_handle_archive():
+        (can_handle, reason) = obj.can_handle_archive()
+        if can_handle:
             return obj
-    module.fail_json(msg='Failed to find handler for "%s". Make sure the required command to extract the file is installed.' % src)
+        reasons.add(reason)
+    reason_msg = ' '.join(reasons)
+    module.fail_json(msg='Failed to find handler for "%s". Make sure the required command to extract the file is installed. %s' % (src, reason_msg))
 
 
 def main():