updated deprecated homebrew cask commands #1481

jaanhio · 2020-12-13T09:03:09Z

SUMMARY

Replaced deprecated brew cask commands with --cask (e.g brew install --cask <app>)

See https://brew.sh/2020/12/01/homebrew-2.6.0/ & Homebrew/brew#8899

Fixes #1524.

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

plugins/modules/homebrew_cask.py

ADDITIONAL INFORMATION

ansibullbot · 2020-12-13T09:05:12Z

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

felixfontein · 2020-12-13T09:12:38Z

Which versions support the new commands, and which ones do not? Maybe the code needs to be able to handle both cases.

Also, you need a changelog fragment.

plugins/modules/packaging/os/homebrew_cask.py

apiology · 2020-12-19T14:45:43Z

It looks like Homebrew has removed the old syntax:

TASK [Install emacs] **************************************************************
fatal: [bigbookpro]: FAILED! => {"changed": false, "msg": "Updating Homebrew...\nError: Calling brew cask install is disabled! Use brew install [--cask] instead."}

plugins/modules/packaging/os/homebrew_cask.py

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

…d based on version

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

plugins/modules/packaging/os/homebrew_cask.py

…gelog yaml

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

Co-authored-by: Felix Fontein <[email protected]>

felixfontein

Besides this, looks good. Cannot verify that it works since I'm not using Homebrew though.

plugins/modules/packaging/os/homebrew_cask.py

felixfontein · 2020-12-25T08:55:09Z

@dsnyder0pc can you test again?

Previous fix didn't do the trick. I'm going to wait for this to be fixed upstream. ansible-collections/community.general#1481

apiology · 2020-12-31T16:52:09Z

I used this command to use the code from this PR for the moment:

ansible-galaxy collection install --force git+https://github.com/jaanhio/community.general.git,update-deprecated-homebrew-cask-commands

* 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 <[email protected]> * Update plugins/modules/packaging/os/homebrew_cask.py * Update plugins/modules/packaging/os/homebrew_cask.py Co-authored-by: Felix Fontein <[email protected]> * Update plugins/modules/packaging/os/homebrew_cask.py Co-authored-by: Felix Fontein <[email protected]> * 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 <[email protected]> (cherry picked from commit ed81317)

felixfontein · 2020-12-31T18:14:26Z

@jaanhio thanks for fixing this!
@Akasurde @apiology @dsnyder0pc thanks for reviewing and testing!

rounakdatta · 2020-12-31T18:21:37Z

Thanks @jaanhio and the reviewers for this new year gift! 🙂

* 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 <[email protected]> * Update plugins/modules/packaging/os/homebrew_cask.py * Update plugins/modules/packaging/os/homebrew_cask.py Co-authored-by: Felix Fontein <[email protected]> * Update plugins/modules/packaging/os/homebrew_cask.py Co-authored-by: Felix Fontein <[email protected]> * 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 <[email protected]> (cherry picked from commit ed81317) Co-authored-by: Jianhao Tan <[email protected]>

felixfontein · 2020-12-31T23:10:09Z

Backport is merged and will be in the release on January 4th, which in turn will be included in the next Ansible 2.10.x release (planned for January 5th).

If someone wants to backport this to ansible/ansible's stable-2.9 branch, it can also appear in the next 2.9.x release.

jaanhio · 2021-01-01T05:26:29Z

thanks all for the guidance and advice provided! happy new year all!

jorhett · 2021-03-05T20:50:49Z

FYI the version detection fails fails when brew updates itself before running the command.

failed: [ansible-development] (item=docker) => {"ansible_loop_var": "item", "changed": false, "item": "docker", "msg": "Updating Homebrew...\n==> **SNIP** ==> Auto-updated Homebrew!\nUpdated 1 tap (homebrew/core).\n==> Updated Formulae\nUpdated 4647 formulae.\n\nError: Unknown command: cask"}

Check version -- select older syntax
Update homebrew
Run homebrew older syntax which fails

updated deprecated homebrew cask commands

c1f9322

ansibullbot added affects_2.10 community_review feature This issue/PR relates to a feature request module module needs_triage new_contributor Help guide this first time contributor os packaging plugins plugin (any type) labels Dec 13, 2020

ansibullbot removed the needs_triage label Dec 13, 2020

Akasurde reviewed Dec 14, 2020

View reviewed changes

plugins/modules/packaging/os/homebrew_cask.py Outdated Show resolved Hide resolved

jaanhio added 3 commits December 17, 2020 16:53

added methods for brew version deprecation check

48ea19b

added comments and changelog fragment

fd6aacc

added unit test for version comparison

0cadc05

ansibullbot added needs_maintainer tests tests unit tests/unit labels Dec 18, 2020

felixfontein reviewed Dec 19, 2020

View reviewed changes

jaanhio added 2 commits December 20, 2020 16:16

switch to use disutils LooseVersion for version comparison

f7dbbbf

updated changelog message and minor refactor for building brew comman…

6a3f618

…d based on version

ansibullbot removed the needs_maintainer label Dec 20, 2020

felixfontein reviewed Dec 20, 2020

View reviewed changes

changelogs/fragments/1481-deprecated-brew-cask-command.yaml Outdated Show resolved Hide resolved

plugins/modules/packaging/os/homebrew_cask.py Outdated Show resolved Hide resolved

added caching logic for retrieval of brew version and updated PR chan…

21c2029

…gelog yaml

felixfontein reviewed Dec 21, 2020

View reviewed changes

changelogs/fragments/1481-deprecated-brew-cask-command.yaml Outdated Show resolved Hide resolved

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

4f0fabf

Co-authored-by: Felix Fontein <[email protected]>

felixfontein reviewed Dec 21, 2020

View reviewed changes

plugins/modules/packaging/os/homebrew_cask.py Outdated Show resolved Hide resolved

plugins/modules/packaging/os/homebrew_cask.py Outdated Show resolved Hide resolved

ansibullbot added the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Dec 22, 2020

switch to use subprocess.check_output instead of subprocess.run

e8ca4e1

jaanhio force-pushed the update-deprecated-homebrew-cask-commands branch from e0d51da to e8ca4e1 Compare December 22, 2020 14:31

ansibullbot added community_review and removed merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Dec 22, 2020

felixfontein reviewed Dec 23, 2020

View reviewed changes

plugins/modules/packaging/os/homebrew_cask.py Outdated Show resolved Hide resolved

jpraczyk added a commit to jpraczyk/community.general that referenced this pull request Dec 23, 2020

homebrew_cask: Use patch from ansible-collections#1481

bad0505

jaanhio added 2 commits December 23, 2020 22:25

replace subprocess with run_command

fca2222

removed unused subprocess import

2980440

felixfontein reviewed Dec 23, 2020

View reviewed changes

plugins/modules/packaging/os/homebrew_cask.py Outdated Show resolved Hide resolved

removed error handling logic to depend on check_rc=True instead

32a1048

felixfontein approved these changes Dec 25, 2020

View reviewed changes

f1sherman added a commit to f1sherman/new-machine-bootstrap that referenced this pull request Dec 29, 2020

Revert cask changes

ebb0992

Previous fix didn't do the trick. I'm going to wait for this to be fixed upstream. ansible-collections/community.general#1481

TomBerriot mentioned this pull request Dec 31, 2020

Use of outdated brew cask commands by Ansible Dalokae/mac-playbook#131

Closed

felixfontein merged commit ed81317 into ansible-collections:main Dec 31, 2020

patchback bot mentioned this pull request Dec 31, 2020

[PR #1481/ed813176 backport][stable-1] updated deprecated homebrew cask commands #1565

Merged

felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Dec 31, 2020

jorhett mentioned this pull request Mar 5, 2021

homebrew_cask needs to use new syntax when command will upgrade homebrew #1973

Open

1 task

mitchblank mentioned this pull request May 20, 2022

homebrew_cask: unhelpful error when become_user set wrong #4708

Open

1 task

updated deprecated homebrew cask commands #1481

updated deprecated homebrew cask commands #1481

Uh oh!

Conversation

jaanhio commented Dec 13, 2020 • edited by felixfontein Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Uh oh!

ansibullbot commented Dec 13, 2020

Uh oh!

felixfontein commented Dec 13, 2020

Uh oh!

Uh oh!

apiology commented Dec 19, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

felixfontein left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

felixfontein commented Dec 25, 2020

Uh oh!

apiology commented Dec 31, 2020

Uh oh!

felixfontein commented Dec 31, 2020

Uh oh!

rounakdatta commented Dec 31, 2020

Uh oh!

felixfontein commented Dec 31, 2020

Uh oh!

jaanhio commented Jan 1, 2021

Uh oh!

jorhett commented Mar 5, 2021

Uh oh!

Uh oh!

jaanhio commented Dec 13, 2020 •

edited by felixfontein

Loading