Calling brew cask install is disabled! Use brew install [--cask] instead. #1524

dsnyder0pc · 2020-12-21T18:47:57Z

SUMMARY

I have a simple playbook that ensures a set of brew casks are installed. It stopped working this morning (actually, probably three days ago with this merge) because, apparently, the Homebrew folks disabled brew cask install. I'm submitting this as a bug report because I imagine it affects everyone using the homebrew_cask module. Cask installation is no longer possible with homebrew_cask until this issue is resolved.

ISSUE TYPE

Bug Report

COMPONENT NAME

homebrew_cask

ANSIBLE VERSION

ansible 2.10.3
  config file = None
  configured module search path = ['/Users/dsnyder/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/dsnyder/.pyenv/versions/3.9.1/lib/python3.9/site-packages/ansible
  executable location = /Users/dsnyder/.pyenv/versions/3.9.1/bin/ansible
  python version = 3.9.1 (default, Dec 14 2020, 14:55:40) [Clang 11.0.3 (clang-1103.0.32.62)]

CONFIGURATION

// No Changes //

OS / ENVIRONMENT

macOS Catalina v10.15.7
MacBook Pro (13-inch, 2019, Four Thunderbolt 3 ports)
Processor. 2.8 GHz Quad-Core Intel Core i7
Memory. 16 GB 2133 MHz LPDDR3

STEPS TO REPRODUCE

Create a simple inventory playbook to ensure that the "docker" cask is installed locally.

$ head -n 500 inventory docker.yml
==> inventory <==
localhost ansible_connection=local ansible_python_interpreter=/Users/dsnyder/.pyenv/shims/python3

==> docker.yml <==
---
- name: Homebrew Cask Demo
  hosts: all
  tasks:
    - name: Try to install the docker cask
      community.general.homebrew_cask:
        name: docker
        install_options: 'debug,appdir=/Applications'
        accept_external_apps: true
        state: present

$ ansible-playbook -i inventory docker.yml

EXPECTED RESULTS

Since I already have this cask installed, I expect Ansible to report that no change was required.

ACTUAL RESULTS

The play fails with this stack trace:

Updating Homebrew...
Error: Calling brew cask install is disabled! Use brew install [--cask] instead.
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:177:in `run'
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:117:in `run'
/usr/local/Homebrew/Library/Homebrew/cmd/cask.rb:15:in `cask'
/usr/local/Homebrew/Library/Homebrew/brew.rb:124:in `<main>'
Error: Kernel.exit
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:188:in `exit'
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:188:in `rescue in run'
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:165:in `run'
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:117:in `run'
/usr/local/Homebrew/Library/Homebrew/cmd/cask.rb:15:in `cask'
/usr/local/Homebrew/Library/Homebrew/brew.rb:124:in `<main>'

$ ansible-playbook -i inventory docker.yml

PLAY [Homebrew Cask Demo] ******************************************************

TASK [Gathering Facts] *********************************************************
ok: [localhost]

TASK [Try to install the docker cask] ******************************************
fatal: [localhost]: FAILED! => {"changed": false, "msg": "Updating Homebrew...\nError: Calling brew cask install is disabled! Use brew install [--cask] instead.\n/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:177:in `run'\n/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:117:in `run'\n/usr/local/Homebrew/Library/Homebrew/cmd/cask.rb:15:in `cask'\n/usr/local/Homebrew/Library/Homebrew/brew.rb:124:in `<main>'\nError: Kernel.exit\n/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:188:in `exit'\n/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:188:in `rescue in run'\n/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:165:in `run'\n/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:117:in `run'\n/usr/local/Homebrew/Library/Homebrew/cmd/cask.rb:15:in `cask'\n/usr/local/Homebrew/Library/Homebrew/brew.rb:124:in `<main>'"}

PLAY RECAP *********************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

ADDITIONAL COMMENTS

I can easily reproduce this error by running the following command:

$ brew cask --debug --appdir=/Applications install docker
Error: Calling brew cask install is disabled! Use brew install [--cask] instead.
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:177:in `run'
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:117:in `run'
/usr/local/Homebrew/Library/Homebrew/cmd/cask.rb:15:in `cask'
/usr/local/Homebrew/Library/Homebrew/brew.rb:124:in `<main>'
Error: Kernel.exit
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:188:in `exit'
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:188:in `rescue in run'
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:165:in `run'
/usr/local/Homebrew/Library/Homebrew/cask/cmd.rb:117:in `run'
/usr/local/Homebrew/Library/Homebrew/cmd/cask.rb:15:in `cask'
/usr/local/Homebrew/Library/Homebrew/brew.rb:124:in `<main>'

The solution seems to be to use a command-line like this instead:

$ brew install --cask --appdir=/Applications docker
Warning: Cask 'docker' is already installed.

To re-install docker, run:
  brew reinstall docker

$ echo $?
0

TRYING community.general.homebrew

I tried to do the same thing with the homebrew module, but the idempotency check fails because the --cask option is required for both list and install for casks:

$ cat docker2.yml
---
- name: Homebrew Cask Demo
  hosts: all
  tasks:
    - name: Try to install the docker cask
      community.general.homebrew:
        name: docker
        install_options: 'cask,appdir=/Applications'
        state: present

$ ansible-playbook -i inventory docker2.yml

PLAY [Homebrew Cask Demo] ******************************************************************

TASK [Gathering Facts] *********************************************************************
ok: [localhost]

TASK [Try to install the docker cask] ******************************************************
fatal: [localhost]: FAILED! => {"changed": false, "msg": "Warning: Cask 'docker' is already installed.\n\nTo re-install docker, run:\n  brew reinstall docker"}

PLAY RECAP *********************************************************************************
localhost                  : ok=1    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

I've not studied the code in the homebrew module, but I imagine it checks for installation by doing something like this:

$ brew list docker
Error: No such keg: /usr/local/Cellar/docker

For casks, it needs to do this:

$ brew list --cask docker
==> App
/Applications/Docker.app (15,133 files, 1.3GB)

I can work around this idempotency issue by adding another task to check if docker is installed first, but that's messy. This check should really be handled by the module.

$ cat docker3.yml
---
- name: Homebrew Cask Demo
  hosts: all
  tasks:
    - name: Check to see if docker is installed
      command: brew list --cask docker
      register: result
      ignore_errors: true
      changed_when: false

    - name: Try to install the docker cask
      community.general.homebrew:
        name: docker
        install_options: 'cask,appdir=/Applications'
        state: present
      when: result is failed

$ ansible-playbook -i inventory docker3.yml

PLAY [Homebrew Cask Demo] ******************************************************************

TASK [Gathering Facts] *********************************************************************
ok: [localhost]

TASK [Check to see if docker is installed] *************************************************
ok: [localhost]

TASK [Try to install the docker cask] ******************************************************
skipping: [localhost]

PLAY RECAP *********************************************************************************
localhost                  : ok=2    changed=0    unreachable=0    failed=0    skipped=1    rescued=0    ignored=0

The text was updated successfully, but these errors were encountered:

ansibullbot · 2020-12-21T18:52:27Z

Files identified in the description:
None

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

dsnyder0pc · 2020-12-21T19:08:00Z

Note: I've commented here about this issue. It's not helpful that the Homebrew folks have decided against maintaining a stable command-line interface. It would be worth checking for other Homebrew subcommands that may be in deprecated state since those changes will create similar problems.

dsnyder0pc · 2020-12-21T19:18:43Z

There's probably more to do, but these quick local edits (patch file below) seem to have things working as expected for me.

--- homebrew_cask.py	2020-12-21 18:04:53.000000000 -0800
+++ homebrew_cask_edit.py	2020-12-21 18:05:07.000000000 -0800
@@ -437,8 +437,8 @@
         cask_is_outdated_command = (
             [
                 self.brew_path,
-                'cask',
                 'outdated',
+                '--cask',
             ]
             + (['--greedy'] if self.greedy else [])
             + [self.current_cask]
@@ -456,8 +456,8 @@
 
         cmd = [
             "{brew_path}".format(brew_path=self.brew_path),
-            "cask",
             "list",
+            "--cask",
             self.current_cask
         ]
         rc, out, err = self.module.run_command(cmd)
@@ -538,7 +538,7 @@
             raise HomebrewCaskException(self.message)
 
         opts = (
-            [self.brew_path, 'cask', 'upgrade']
+            [self.brew_path, 'upgrade', '--cask']
         )
 
         cmd = [opt for opt in opts if opt]
@@ -587,7 +587,7 @@
             raise HomebrewCaskException(self.message)
 
         opts = (
-            [self.brew_path, 'cask', 'install', self.current_cask]
+            [self.brew_path, 'install', '--cask', self.current_cask]
             + self.install_options
         )
 
@@ -651,7 +651,7 @@
             raise HomebrewCaskException(self.message)
 
         opts = (
-            [self.brew_path, 'cask', command]
+            [self.brew_path, 'command', '--cask']
             + self.install_options
             + [self.current_cask]
         )
@@ -704,7 +704,7 @@
             raise HomebrewCaskException(self.message)
 
         opts = (
-            [self.brew_path, 'cask', 'uninstall', self.current_cask]
+            [self.brew_path, 'uninstall', '--cask', self.current_cask]
             + self.install_options
         )

ahawkins · 2020-12-21T21:59:40Z

tl;dr: The recent homebrew 2.7 release broke the homebrew_cask module.

raymondyou97 · 2020-12-21T22:15:04Z

Was able to get it working again by downgrading and locking Homebrew to 2.6.2

Downgrade to 2.6.2

cd /usr/local/Homebrew
git fetch --tags
git checkout 2.6.2

Prevent automatic brew upgrades whenever you install/upgrade something. In your .zshrc or .bashrc,

export HOMEBREW_NO_AUTO_UPDATE=1

felixfontein · 2020-12-21T22:25:55Z

There's already a PR for this: #1481

Since you are Homebrew users, would be great if you could test it!

felixfontein · 2020-12-21T22:28:42Z

(Also, I'm quite confused why ~~everyone~~ some people is are saying that brew cask is deprecated. It is apparently not deprecated (otherwise it would still work), but has been removed. Deprecation means there will be a warning that it will be removed in the future.)

ansibullbot · 2020-12-21T22:30:55Z

Files identified in the description:

plugins/modules/packaging/os/homebrew_cask.py

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibullbot · 2020-12-21T22:30:56Z

cc @Akasurde @danieljaouen @enriclluelles @indrajitr @kyleabenson @martinm82
click here for bot help

dsnyder0pc · 2020-12-21T22:59:28Z

(Also, I'm quite confused why ~~everyone~~ some people is are saying that brew cask is deprecated. It is apparently not deprecated (otherwise it would still work), but has been removed. Deprecation means there will be a warning that it will be removed in the future.)

Well, from looking at the commit history, the brew cask subcommand has been deprecated for a while. As of 2.7 of Homebrew, brew cask was deleted.

dsnyder0pc · 2020-12-21T23:06:30Z

Response from the Homebrew team:

Homebrew/discussions#340 (comment)

felixfontein · 2020-12-22T07:49:42Z

(Also, I'm quite confused why ~~everyone~~ some people is are saying that brew cask is deprecated. It is apparently not deprecated (otherwise it would still work), but has been removed. Deprecation means there will be a warning that it will be removed in the future.)

Well, from looking at the commit history, the brew cask subcommand has been deprecated for a while. As of 2.7 of Homebrew, brew cask was deleted.

Ok, so it was indeed just deprecated a few days ago (December 1st), and got removed only since yesterday. So talking about it as deprecated was actually correct until the day before yesterday :)

Rylan12 · 2020-12-23T05:37:39Z

Hi there, Homebrew maintainer here.

I can clear up a few things:

brew cask commands were deprecated on 2020-12-01 with the release of Homebrew 2.6.0. Starting then, all brew cask commands succeeded but displayed a warning informing users that the command would soon be disabled. The message also provides the appropriate replacement.
brew cask commands were disabled on 2020-12-21 with the release of Homebrew 2.7.0. Starting then, all brew cask commands failed and displayed a warning informing users that the command is disabled. The message also provides the appropriate replacement.
With the release of Homebrew 2.8.0 (release date TBD), this disable message will be removed.

The alternative to brew cask <command> is to use brew <command>. In many cases, you can add the --cask flag to specify casks only. For example, brew cask install atom is now brew install atom or brew install --cask atom. There are some casks that share a name with formulae (e.g. wireshark) so adding --cask ensures that the cask is installed not the formula.

I'm not much of an ansible user but I'm happy to try and help out if needed. Feel free to point me in the right direction if anything is blocked and could use feedback from the Homebrew side of things.

felixfontein · 2020-12-23T08:06:49Z

@Rylan12 thanks! We already have a PR which should fix that (#1481), it needs a little more work but should already work. It detects the homebrew version so it will work with older versions of homebrew as well.

rpalri · 2020-12-25T02:54:44Z

Hi there, Homebrew maintainer here.

I can clear up a few things:

brew cask commands were deprecated on 2020-12-01 with the release of Homebrew 2.6.0. Starting then, all brew cask commands succeeded but displayed a warning informing users that the command would soon be disabled. The message also provides the appropriate replacement.

brew cask commands were disabled on 2020-12-21 with the release of Homebrew 2.7.0. Starting then, all brew cask commands failed and displayed a warning informing users that the command is disabled. The message also provides the appropriate replacement.

With the release of Homebrew 2.8.0 (release date TBD), this disable message will be removed.

The alternative to brew cask <command> is to use brew <command>. In many cases, you can add the --cask flag to specify casks only. For example, brew cask install atom is now brew install atom or brew install --cask atom. There are some casks that share a name with formulae (e.g. wireshark) so adding --cask ensures that the cask is installed not the formula.

I'm not much of an ansible user but I'm happy to try and help out if needed. Feel free to point me in the right direction if anything is blocked and could use feedback from the Homebrew side of things.

Thank you @Rylan12!
For everyone else, this is the solution.

carlos-ssh · 2020-12-26T16:37:06Z

Very helpful @raymondyou97 Thanks.

…o and we're just waiting for Ansible 2.10.5 to get pushed out. ansible-collections/community.general#1524

ansibullbot added affects_2.10 bug This issue/PR relates to a bug needs_triage python3 labels Dec 21, 2020

ansibullbot added module module os packaging plugins plugin (any type) and removed needs_triage labels Dec 21, 2020

felixfontein mentioned this issue Dec 21, 2020

updated deprecated homebrew cask commands #1481

Merged

ansibullbot added the has_pr label Dec 21, 2020

This was referenced Dec 22, 2020

brew cask install is deprecated in favour of brew install --cask geerlingguy/ansible-role-homebrew#155

Closed

New versions of Homebrew forbids calling brew cask. geerlingguy/mac-dev-playbook#87

Closed

duianto mentioned this issue Dec 26, 2020

macOS Source Code Pro font installation step syl20bnr/spacemacs#8085

Closed

ghost mentioned this issue Apr 24, 2021

Updated Homebrew Installation Command. davicorreiajr/spotify-now-playing#48

Closed

ivandenysov mentioned this issue Jun 28, 2021

update brew installation command in README.md overtake/TelegramSwift#639

Closed

decodyng mentioned this issue Jun 29, 2021

Fix Brew Cask Install Syntax minerllabs/minerl#537

Merged

mzmt mentioned this issue Jul 1, 2021

update brew command Swordfish90/cool-retro-term#664

Merged

wells0790 pushed a commit to wells0790/demo that referenced this issue Feb 7, 2022

The cask install for google-chrome problem was fixed a couple days ag…

5d58e72

…o and we're just waiting for Ansible 2.10.5 to get pushed out. ansible-collections/community.general#1524

s4na mentioned this issue Jun 5, 2022

docs: update homebrew instructions for newer versions lwouis/alt-tab-macos#1660

Closed

geerlingguy mentioned this issue Jul 11, 2022

Old cask in use geerlingguy/ansible-collection-mac#46

Closed

BoggyBumblebee mentioned this issue Feb 22, 2024

Running straight from clone installation throws exception - Brew Casks Functionality Broken geerlingguy/mac-dev-playbook#196

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Calling brew cask install is disabled! Use brew install [--cask] instead. #1524

Calling brew cask install is disabled! Use brew install [--cask] instead. #1524

dsnyder0pc commented Dec 21, 2020 •

edited by felixfontein

Loading

ansibullbot commented Dec 21, 2020

dsnyder0pc commented Dec 21, 2020

dsnyder0pc commented Dec 21, 2020 •

edited

Loading

ahawkins commented Dec 21, 2020

raymondyou97 commented Dec 21, 2020 •

edited

Loading

felixfontein commented Dec 21, 2020

felixfontein commented Dec 21, 2020 •

edited

Loading

ansibullbot commented Dec 21, 2020

ansibullbot commented Dec 21, 2020

dsnyder0pc commented Dec 21, 2020

dsnyder0pc commented Dec 21, 2020

felixfontein commented Dec 22, 2020

Rylan12 commented Dec 23, 2020

felixfontein commented Dec 23, 2020

rpalri commented Dec 25, 2020

carlos-ssh commented Dec 26, 2020

Calling brew cask install is disabled! Use brew install [--cask] instead. #1524

Calling brew cask install is disabled! Use brew install [--cask] instead. #1524

Comments

dsnyder0pc commented Dec 21, 2020 • edited by felixfontein Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ANSIBLE VERSION

CONFIGURATION

OS / ENVIRONMENT

STEPS TO REPRODUCE

EXPECTED RESULTS

ACTUAL RESULTS

ADDITIONAL COMMENTS

TRYING community.general.homebrew

ansibullbot commented Dec 21, 2020

dsnyder0pc commented Dec 21, 2020

dsnyder0pc commented Dec 21, 2020 • edited Loading

ahawkins commented Dec 21, 2020

raymondyou97 commented Dec 21, 2020 • edited Loading

felixfontein commented Dec 21, 2020

felixfontein commented Dec 21, 2020 • edited Loading

ansibullbot commented Dec 21, 2020

ansibullbot commented Dec 21, 2020

dsnyder0pc commented Dec 21, 2020

dsnyder0pc commented Dec 21, 2020

felixfontein commented Dec 22, 2020

Rylan12 commented Dec 23, 2020

felixfontein commented Dec 23, 2020

rpalri commented Dec 25, 2020

carlos-ssh commented Dec 26, 2020

dsnyder0pc commented Dec 21, 2020 •

edited by felixfontein

Loading

dsnyder0pc commented Dec 21, 2020 •

edited

Loading

raymondyou97 commented Dec 21, 2020 •

edited

Loading

felixfontein commented Dec 21, 2020 •

edited

Loading