updated deprecated homebrew cask commands (#1481)

* updated deprecated homebrew cask commands

* added methods for brew version deprecation check

* added comments and changelog fragment

* added unit test for version comparison

* switch to use disutils LooseVersion for version comparison

* updated changelog message and minor refactor for building brew command based on version

* added caching logic for retrieval of brew version and updated PR changelog yaml

* Update changelogs/fragments/1481-deprecated-brew-cask-command.yaml

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/packaging/os/homebrew_cask.py

* Update plugins/modules/packaging/os/homebrew_cask.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/packaging/os/homebrew_cask.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* switch to use subprocess.check_output instead of subprocess.run

* replace subprocess with run_command

* removed unused subprocess import

* removed error handling logic to depend on check_rc=True instead

Co-authored-by: Felix Fontein <felix@fontein.de>

changelogs/fragments/1481-deprecated-brew-cask-command.yaml

@@ -0,0 +1,2 @@
+minor_changes:
+  - homebrew_cask - Homebrew will be deprecating use of ``brew cask`` commands as of version 2.6.0, see https://brew.sh/2020/12/01/homebrew-2.6.0/. Added logic to stop using ``brew cask`` for brew version >= 2.6.0 (https://github.com/ansible-collections/community.general/pull/1481).

plugins/modules/packaging/os/homebrew_cask.py

@@ -139,6 +139,7 @@ EXAMPLES = '''
 import os
 import re
 import tempfile
+from distutils import version
 
 from ansible.module_utils._text import to_bytes
 from ansible.module_utils.basic import AnsibleModule
@@ -356,6 +357,18 @@ class HomebrewCask(object):
         else:
             self._current_cask = cask
             return cask
+
+    @property
+    def brew_version(self):
+        try:
+            return self._brew_version
+        except AttributeError:
+            return None
+
+    @brew_version.setter
+    def brew_version(self, brew_version):
+        self._brew_version = brew_version
+
     # /class properties -------------------------------------------- }}}
 
     def __init__(self, module, path=path, casks=None, state=None,
@@ -434,15 +447,12 @@ class HomebrewCask(object):
         if not self.valid_cask(self.current_cask):
             return False
 
-        cask_is_outdated_command = (
+        if self._brew_cask_command_is_deprecated():
-            [
+            base_opts = [self.brew_path, 'outdated', '--cask']
-                self.brew_path,
+        else:
-                'cask',
+            base_opts = [self.brew_path, 'cask', 'outdated']
-                'outdated',
+
-            ]
+        cask_is_outdated_command = base_opts + (['--greedy'] if self.greedy else []) + [self.current_cask]
-            + (['--greedy'] if self.greedy else [])
-            + [self.current_cask]
-        )
 
         rc, out, err = self.module.run_command(cask_is_outdated_command)
 
@@ -454,18 +464,35 @@ class HomebrewCask(object):
             self.message = 'Invalid cask: {0}.'.format(self.current_cask)
             raise HomebrewCaskException(self.message)
 
-        cmd = [
+        if self._brew_cask_command_is_deprecated():
-            "{brew_path}".format(brew_path=self.brew_path),
+            base_opts = [self.brew_path, "list", "--cask"]
-            "cask",
+        else:
-            "list",
+            base_opts = [self.brew_path, "cask", "list"]
-            self.current_cask
+
-        ]
+        cmd = base_opts + [self.current_cask]
         rc, out, err = self.module.run_command(cmd)
 
         if rc == 0:
             return True
         else:
             return False
+
+    def _get_brew_version(self):
+        if self.brew_version:
+            return self.brew_version
+
+        cmd = [self.brew_path, '--version']
+
+        rc, out, err = self.module.run_command(cmd, check_rc=True)
+
+        # get version string from first line of "brew --version" output
+        version = out.split('\n')[0].split(' ')[1]
+        self.brew_version = version
+        return self.brew_version
+
+    def _brew_cask_command_is_deprecated(self):
+        # The `brew cask` replacements were fully available in 2.6.0 (https://brew.sh/2020/12/01/homebrew-2.6.0/)
+        return version.LooseVersion(self._get_brew_version()) >= version.LooseVersion('2.6.0')
     # /checks ------------------------------------------------------ }}}
 
     # commands ----------------------------------------------------- {{{
@@ -537,11 +564,10 @@ class HomebrewCask(object):
             self.message = 'Casks would be upgraded.'
             raise HomebrewCaskException(self.message)
 
-        opts = (
+        if self._brew_cask_command_is_deprecated():
-            [self.brew_path, 'cask', 'upgrade']
+            cmd = [self.brew_path, 'upgrade', '--cask']
-        )
+        else:
-
+            cmd = [self.brew_path, 'cask', 'upgrade']
-        cmd = [opt for opt in opts if opt]
 
         rc, out, err = '', '', ''
 
@@ -586,10 +612,12 @@ class HomebrewCask(object):
             )
             raise HomebrewCaskException(self.message)
 
-        opts = (
+        if self._brew_cask_command_is_deprecated():
-            [self.brew_path, 'cask', 'install', self.current_cask]
+            base_opts = [self.brew_path, 'install', '--cask']
-            + self.install_options
+        else:
-        )
+            base_opts = [self.brew_path, 'cask', 'install']
+
+        opts = base_opts + [self.current_cask] + self.install_options
 
         cmd = [opt for opt in opts if opt]
 
@@ -650,11 +678,13 @@ class HomebrewCask(object):
             )
             raise HomebrewCaskException(self.message)
 
-        opts = (
+        if self._brew_cask_command_is_deprecated():
-            [self.brew_path, 'cask', command]
+            base_opts = [self.brew_path, command, '--cask']
-            + self.install_options
+        else:
-            + [self.current_cask]
+            base_opts = [self.brew_path, 'cask', command]
-        )
+
+        opts = base_opts + self.install_options + [self.current_cask]
+
         cmd = [opt for opt in opts if opt]
 
         rc, out, err = '', '', ''
@@ -703,10 +733,12 @@ class HomebrewCask(object):
             )
             raise HomebrewCaskException(self.message)
 
-        opts = (
+        if self._brew_cask_command_is_deprecated():
-            [self.brew_path, 'cask', 'uninstall', self.current_cask]
+            base_opts = [self.brew_path, 'uninstall', '--cask']
-            + self.install_options
+        else:
-        )
+            base_opts = [self.brew_path, 'cask', 'uninstall']
+
+        opts = base_opts + [self.current_cask] + self.install_options
 
         cmd = [opt for opt in opts if opt]