homebrew module: task fails on warning message #7044

Fregf · 2023-07-31T10:04:24Z

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

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

ansibullbot · 2023-07-31T10:05:08Z

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 · 2023-07-31T10:05:09Z

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

felixfontein · 2023-07-31T14:56:02Z

!component =plugins/modules/homebrew.py

ansibullbot · 2023-07-31T15:05:22Z

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 · 2023-07-31T15:05:23Z

cc @andrew-d
click here for bot help

xaethos · 2023-08-21T06:13:14Z

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 · 2024-02-01T02:41:55Z

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 · 2024-03-29T02:49:06Z

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 · 2024-04-05T21:11:56Z

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

edv · 2024-04-07T11:36:34Z

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 · 2024-04-09T14:47:50Z

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.

egor-lopatin · 2024-04-16T21:33:39Z

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,
        ]

Yeah, that's the issue with the commit: fa30b02#diff-109efc689f4332320bad76472328471ef85a0faeae32ec97086c9790e244c69eR491-R494

^^ @thewalla07

where we start checking error messages (stderr) of the run_command, where the warning message is passed in such a cese.

@edv, I would love if you could create a PR for the fix. Do not want to take your credits ))
I supposed the fix that proposed by you well enough, because I see no options to suppress the warning (--quiet falg does not work for me here) and add some comples statement to ignore this particular message is not elegant as for me.

ansible-collections#7044

Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commint fixes ansible-collections#8229 ansible-collections#7044

Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commit fixes ansible-collections#8229 ansible-collections#7044

kustodian · 2024-05-22T20:36:00Z

I added a simple fix for this issue in #8406

Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commit fixes ansible-collections#8229 ansible-collections#7044

Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commit fixes #8229 #7044 Co-authored-by: Strahinja Kustudic <[email protected]>

Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commit fixes #8229 #7044 Co-authored-by: Strahinja Kustudic <[email protected]> (cherry picked from commit 43cb5a0)

…g because of warnings (#8425) Fix the homebrew module failing because of warnings (#8406) Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commit fixes #8229 #7044 Co-authored-by: Strahinja Kustudic <[email protected]> (cherry picked from commit 43cb5a0) Co-authored-by: Strahinja Kustudic <[email protected]>

…ons#8406) Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commit fixes ansible-collections#8229 ansible-collections#7044 Co-authored-by: Strahinja Kustudic <[email protected]> (cherry picked from commit 43cb5a0)

#8429) Fix the homebrew module failing because of warnings (#8406) Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commit fixes #8229 #7044 Co-authored-by: Strahinja Kustudic <[email protected]> (cherry picked from commit 43cb5a0) Co-authored-by: Strahinja Kustudic <[email protected]>

…ons#8406) Instead of checking if there is an error message, which can also be a warning, we now check the return code. This commit fixes ansible-collections#8229 ansible-collections#7044 Co-authored-by: Strahinja Kustudic <[email protected]>

ansibullbot added bug This issue/PR relates to a bug callback callback plugin plugins plugin (any type) labels Jul 31, 2023

ansibullbot added the module module label Jul 31, 2023

egor-lopatin added a commit to egor-lopatin/community.general that referenced this issue Apr 16, 2024

Local fix of the Issue ansible-collections#7044

608f4f2

ansible-collections#7044

egor-lopatin added a commit to egor-lopatin/community.general that referenced this issue Apr 16, 2024

Local fix of the Issue ansible-collections#7044

f1521f0

felixfontein mentioned this issue Apr 17, 2024

homebrew: reports failure when installing "emacs" formula #8229

Closed

1 task

kustodian mentioned this issue May 22, 2024

Fix the homebrew module failing because of warnings #8406

Merged

ansibullbot added the has_pr label May 22, 2024

felixfontein closed this as completed in #8406 May 26, 2024

patchback bot mentioned this issue May 26, 2024

[PR #8406/43cb5a0d backport][stable-9] Fix the homebrew module failing because of warnings #8425

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

homebrew module: task fails on warning message #7044

homebrew module: task fails on warning message #7044

Fregf commented Jul 31, 2023

ansibullbot commented Jul 31, 2023

ansibullbot commented Jul 31, 2023

felixfontein commented Jul 31, 2023

ansibullbot commented Jul 31, 2023

ansibullbot commented Jul 31, 2023

xaethos commented Aug 21, 2023

dokimyj commented Feb 1, 2024

HarryWeppner commented Mar 29, 2024

gaiazov commented Apr 5, 2024 •

edited

Loading

edv commented Apr 7, 2024 •

edited

Loading

xaethos commented Apr 9, 2024

egor-lopatin commented Apr 16, 2024

kustodian commented May 22, 2024

homebrew module: task fails on warning message #7044

homebrew module: task fails on warning message #7044

Comments

Fregf commented Jul 31, 2023

Summary

Issue Type

Component Name

Ansible Version

Community.general Version

Configuration

OS / Environment

Steps to Reproduce

Expected Results

Actual Results

Code of Conduct

ansibullbot commented Jul 31, 2023

ansibullbot commented Jul 31, 2023

felixfontein commented Jul 31, 2023

ansibullbot commented Jul 31, 2023

ansibullbot commented Jul 31, 2023

xaethos commented Aug 21, 2023

dokimyj commented Feb 1, 2024

HarryWeppner commented Mar 29, 2024

gaiazov commented Apr 5, 2024 • edited Loading

edv commented Apr 7, 2024 • edited Loading

xaethos commented Apr 9, 2024

egor-lopatin commented Apr 16, 2024

kustodian commented May 22, 2024

gaiazov commented Apr 5, 2024 •

edited

Loading

edv commented Apr 7, 2024 •

edited

Loading