homebrew module: task fails on warning message

[Fregf]

Summary

Given this Ansible task:

- community.general.homebrew:
        name:
          - android-studio
          - clion
          - cyberduck
          - intellij-idea-ce
          - keka
          - vscodium
        state: latest

If one of the packages is already the latest version, execution is stopped and the tasks fails:

fatal: [host.example.org]: FAILED! => changed=false 
  msg: 'Warning: Not upgrading android-studio, the latest version is already installed'

I expect this to be a non-fatal warning, and that it continues running the playbook.

Issue Type

Bug Report

Component Name

homebrew

Ansible Version

$ ansible --version
ansible [core 2.14.3]
  config file = /home/frederik/ig-macos/ansible.cfg
  configured module search path = ['/home/frederik/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3/dist-packages/ansible
  ansible collection location = /home/frederik/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.11.2 (main, Mar 13 2023, 12:18:29) [GCC 12.2.0] (/usr/bin/python3)
  jinja version = 3.1.2
  libyaml = True

Community.general Version

$ ansible-galaxy collection list community.general

# /home/frederik/.ansible/collections/ansible_collections
Collection        Version
----------------- -------
community.general 3.6.0  

# /usr/lib/python3/dist-packages/ansible_collections
Collection        Version
----------------- -------
community.general 6.4.0  

Configuration

$ ansible-config dump --only-changed
ANSIBLE_NOCOWS(/home/frederik/ig-macos/ansible.cfg) = True
CONFIG_FILE() = /home/frederik/ig-macos/ansible.cfg
DEFAULT_FORKS(/home/frederik/ig-macos/ansible.cfg) = 16
DEFAULT_HOST_LIST(/home/frederik/ig-macos/ansible.cfg) = ['/home/frederik/ig-macos/inventory']
DEFAULT_LOG_PATH(/home/frederik/ig-macos/ansible.cfg) = /home/frederik/ig-macos/ansible.log
DEFAULT_ROLES_PATH(/home/frederik/ig-macos/ansible.cfg) = ['/home/frederik/ig-macos/roles', '/etc/ansible/roles']
DEFAULT_STDOUT_CALLBACK(/home/frederik/ig-macos/ansible.cfg) = yaml
DEFAULT_STRATEGY(/home/frederik/ig-macos/ansible.cfg) = free
DEFAULT_TIMEOUT(/home/frederik/ig-macos/ansible.cfg) = 60

OS / Environment

Debian 12

Steps to Reproduce

- community.general.homebrew:
        name:
          - android-studio
          - clion
          - cyberduck
          - intellij-idea-ce
          - keka
          - vscodium
        state: latest

Expected Results

When one of the packages is already up to date, it continues upgrading the other packages and this tasks succeeds.

Actual Results

fatal: [host.example.org]: FAILED! => changed=false 
  msg: 'Warning: Not upgrading android-studio, the latest version is already installed'

Execution stops at this point.

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibullbot]

Files identified in the description:

• plugins/callback/say.py

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

click here for bot help

[ansibullbot]

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

[felixfontein]

!component =plugins/modules/homebrew.py

[ansibullbot]

Files identified in the description:

• plugins/modules/homebrew.py

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

click here for bot help

[ansibullbot]

cc @andrew-d
click here for bot help

[xaethos]

I was just having the same issue with visual-studio-code. It was fixed by using the community.general.homebrew_cask module instead, which should apply here too, since android-studio is a Cask, not a Formula.

[dokimyj]

Is this fixed or any other workarounds? I am having the same issue with community.general.homebrew_cask with Temurin8 installation(or skip if exists) still in 2024 Feb

Avoiding with $HOMEBREW_PATH/Caskroom check as workaround.

[HarryWeppner]

We see a similar failure mode when the intention is to install a formula.

failed: [localhost] (item=docker) => {"ansible_loop_var": "item", "changed": false, "item": "docker", "msg": "Warning: Treating docker as a formula. For the cask, use homebrew/cask/docker or specify the --cask flag."}

What's the recommended approach here?

[gaiazov]

@HarryWeppner seeing the same issue. Tried adding install_options: formula and it didn't help. ignore_errors: true works but is... not ideal

[edv]

We see a similar failure mode when the intention is to install a formula.

failed: [localhost] (item=docker) => {"ansible_loop_var": "item", "changed": false, "item": "docker", "msg": "Warning: Treating docker as a formula. For the cask, use homebrew/cask/docker or specify the --cask flag."}

What's the recommended approach here?

I encounter this same problem, and it seems to be caused by packages that are also available as casks (like awscli, httpie, etc.). I specified the install_options: 'formula' option, but this does not fully resolve the problem.

As a workaround I resolved this locally by doing the following:

• edit ~/.ansible/collections/ansible_collections/community/general/plugins/modules/homebrew.py
• modify the code from line 484, by adding --formula, this might be a nice permanent fix, as there is a seperate ansible module for homebrew casks (so maybe everything in this one should be forced to be a formula?).

        cmd = [
            "{brew_path}".format(brew_path=self.brew_path),
            "info",
            "--formula",
            "--json=v2",
            self.current_package,
        ]

[xaethos]

this might be a nice permanent fix, as there is a seperate ansible module for homebrew casks (so maybe everything in this one should be forced to be a formula?).

It is a breaking change for anyone who is using this module for casks, though in my mind absolutely worth it. Even using Homebrew CLI directly this duality has been an issue for me.