Feature Request: Support for homebrew cask #24653

fgimian · 2015-06-12T23:46:02Z

Hey there guys, hope you're doing well 😄

I was wondering if you would please consider supporting homebrew-cask in the future?

This allows OS X users to install desktop applications via the CLI. Ansible contains support for it and it works rather well, but I'd really like to try Salt instead for automating the build of my Mac 😄

Thanks heaps and have a great weekend!
Fotis

justinta · 2015-06-16T19:40:54Z

@fgimian Thank you for this feature idea.

DavidJFelix · 2015-07-15T03:04:38Z

👍 +1

cliffrowley · 2015-11-30T20:01:59Z

Yes please! ;-) I'm more than happy to help test (I am refactoring my home lab and looking at using saltstack to orchestrate my mini server and its virtual machines).

stale · 2018-02-17T20:05:50Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

If this issue is closed prematurely, please leave a comment and we will gladly reopen the issue.

fgimian · 2018-02-19T07:50:39Z

This would still be desirable if possible 😄

stale · 2018-02-19T07:50:40Z

Thank you for updating this issue. It is no longer marked as stale.

weswhet · 2018-04-03T00:42:09Z

I believe this merged PR should bring support for cask installs. e.g. caskroom/cask/opera

lmf-mx · 2019-04-30T06:06:22Z

#45309 adds some support for checking if a cask is installed. There are, however, a few outstanding issues.

caskroom/cask appears to be an alias/redirect from the migration of the repo to Homebrew/homebrew-cask. With cask becoming part of core, tapping caskroom/cask is no longer necessary. brew taps the repo as homebrew/cask.
caskroom/versions is also now located at Homebrew/homebrew-cask-versions and tapped as homebew/cask-versions. The check at 4aa3e23#diff-922c510bbabef7d622da0ff9dce6acd3R151 doesn't account for the casks in this repo.
Installing a package such as vlc-nightly via homebrew/cask-versions/vlc-nightly or caskroom/versions/vlc-nightly will sucessfully install. The pkg.installed state will return as failed, since vlc-nightly will be returned as 'caskroom/cask/vlc-nightly'.

cdalvaro · 2020-07-14T17:25:42Z

It is currently supported, just install your package specifying the full name: homebrew/cask/visual-studio-code

visual-studio-code:
  pkg.installed:
    - name: homebrew/cask/visual-studio-code

It works for custom taps too:

cdalvaro/tap/cpp-plotly:
  pkg.installed

or even fonts:

fira code nerd font:
  pkg.installed:
    - name: - name: homebrew/cask-fonts/font-fira-code-nerd-font

This support was added on #54216

Warning: The only thing I haven't tested yet, is what does happen when installing a cask formula which requires user password...

gabeio · 2021-01-14T19:16:04Z

brew changed how to interface with casks:

[ERROR   ] The following packages failed to install/update: homebrew/cask/google-chrome
[ERROR   ] Command '['su', '-l', 'gabeio', '-c', 'cd -- /Users/gabeio && { /usr/local/bin/brew cask list --versions\n }']' failed with return code: 1
[ERROR   ] stderr: Error: Calling brew cask list is disabled! Use brew list [--cask] instead.
[ERROR   ] retcode: 1

if anyone is interested in the brew version(s) I have:

$ brew --version
Homebrew 2.7.4
Homebrew/homebrew-core (git revision b36d1; last commit 2021-01-14)
Homebrew/homebrew-cask (git revision 71a8b0; last commit 2021-01-15)

and salt version:

$ salt --version
salt 3002.2

cdalvaro · 2021-01-14T19:18:21Z

brew changed how to interface with casks:

[ERROR   ] The following packages failed to install/update: homebrew/cask/google-chrome
[ERROR   ] Command '['su', '-l', 'gabeio', '-c', 'cd -- /Users/gabeio && { /usr/local/bin/brew cask list --versions\n }']' failed with return code: 1
[ERROR   ] stderr: Error: Calling brew cask list is disabled! Use brew list [--cask] instead.
[ERROR   ] retcode: 1

if anyone is interested in the brew version(s) I have:

$ brew --version
Homebrew 2.7.4
Homebrew/homebrew-core (git revision b36d1; last commit 2021-01-14)
Homebrew/homebrew-cask (git revision 71a8b0; last commit 2021-01-15)

and salt version:

$ salt --version
salt 3002.2

This have been solved in #58381

gabeio · 2021-01-14T19:19:25Z

@cdalvaro thanks for the info! do you know when that is going to get out onto salt?

cdalvaro · 2021-01-14T19:22:02Z

@cdalvaro thanks for the info! do you know when that is going to get out onto salt?

You are welcome! I know that it is planned to be released with the Aluminium version. ~~But I don't know the release date yet.~~

Update: You can check here the Aluminium release date. Apparently, it is scheduled for February 24th.

maneamarius · 2021-02-16T10:27:42Z

Hey guys, as of salt 3002.2, this doesn't work on Mac:

visual-studio-code:
  pkg.installed:
    - name: homebrew/cask/visual-studio-code

It just fails this way:

----------
          ID: vscode-installed
    Function: pkg.installed
        Name: homebrew/cask/visual-studio-code
      Result: False
     Comment: The following packages failed to install/update: homebrew/cask/visual-studio-code
     Started: 05:22:27.302660
    Duration: 5702.606 ms
     Changes:

Is there any way to make this work the salt way? I can make it work with cmd.run, but this shouldn't be the right way :)

cdalvaro · 2021-02-16T10:45:25Z

At the moment, if you have access to you salt-master files, you can add this file: mac_brew_pkg.py (04b62a5) (#59439) to your custom _modules directory in order to overwrite the bundled one:

pillar/
reactor/
salt/
  _modules/
    mac_brew_pkg.py
  _states/
  data/

and then sync your minion modules:

salt '*' saltutil.sync_modules

If you prefer, you can use this version of mac_brew_pkg.py (7129b5b) (#58381), which is already merged into master, but not yet released.

maneamarius · 2021-02-16T12:23:33Z

Thank you!
I tried that, and for some reason, it installs the package and fails the state:

---------- ID: p4v-installed Function: pkg.installed Name: homebrew/cask/p4v Result: False Comment: The following packages failed to install/update: homebrew/cask/p4v=21.1 Started: 07:20:22.134855 Duration: 20268.193 ms Changes: ---------- homebrew/cask/p4v: ---------- new: 21.1,2075061 old: p4v: ---------- new: 21.1,2075061 old:

and here's the code I used:

p4v-installed: pkg.installed: - runas: {{ mac_user }} - name: homebrew/cask/p4v - version: {{ p4v_version }} - unless: brew list | grep p4v

cdalvaro · 2021-02-16T13:01:55Z

Could you try this instead (if you have used patch #59439)?

p4v-installed:
  pkg.installed:
    - name: p4v

or if you have used #58381, try using this one?

p4v-installed:
  pkg.installed:
    - name: homebrew/cask/p4v

brew won't update the cask if it is already installed so the unless condition is not necessary.

maneamarius · 2021-02-16T18:10:48Z

I did not use any patches, I just used vanilla 3002.2
Which patch should I use? And how do I apply it? (I haven't done that before)
I think I should apply a patch which will be included in the next release, right?

thanks a lot,
Marius

cdalvaro · 2021-02-16T18:33:33Z

#58381 and #59371 are already merged with master and should be available when Salt Aluminium version is released.

Download the salt/modules/mac_brew_pkg.py file from master (link) and put it inside salt/_modules directory in your salt-master host.

pillar/
  top.sls
salt/
  _modules/
    mac_brew_pkg.py
  top.sls

Then you have to sync all modules with your minions (salt '*' saltutil.sync_modules) and try your p4v formula this way:

p4v-installed:
  pkg.installed:
    - name: homebrew/cask/p4v

Warning: You must remember to delete this file when Salt 3003 is available to avoid freezing the module for future updates.

maneamarius · 2021-02-16T18:49:27Z

I copied the file, did refresh modules, and I still get this error.
So it installs it, but returns with error for some reason.

`----------
ID: p4v-installed
Function: pkg.installed
Name: homebrew/cask/p4v
Result: False
Comment: The following packages failed to install/update: homebrew/cask/p4v=21.1
Started: 13:45:26.494591
Duration: 25542.42 ms
Changes:
----------
homebrew/cask/p4v:
----------
new:
21.1,2075061
old:

Summary for xyz

Succeeded: 0 (changed=1)
Failed: 1

Total states run: 1
Total run time: 25.542 s`

maneamarius · 2021-02-16T18:50:06Z

If I remove runas from my state, it doesn't run at all, I get this:

---------- ID: p4v-installed Function: pkg.installed Name: homebrew/cask/p4v Result: False Comment: Unable to run command '['brew', '--prefix']' with the context '{'cwd': '/var/root', 'shell': False, 'env': {'PATH': '/usr/bin:/bin:/usr/sbin:/sbin', 'PWD': '/', 'XPC_FLAGS': '0x0', 'XPC_SERVICE_NAME': 'com.saltstack.salt.minion', 'SHLVL': '0', 'LC_CTYPE': 'C', 'LC_NUMERIC': 'C', 'LC_TIME': 'C', 'LC_COLLATE': 'C', 'LC_MONETARY': 'C', 'LC_MESSAGES': 'C', 'LC_PAPER': 'C', 'LC_NAME': 'C', 'LC_ADDRESS': 'C', 'LC_TELEPHONE': 'C', 'LC_MEASUREMENT': 'C', 'LC_IDENTIFICATION': 'C', 'LANGUAGE': 'C'}, 'stdin': None, 'stdout': -1, 'stderr': -2, 'with_communicate': True, 'timeout': None, 'bg': False, 'close_fds': True}', reason: [Errno 2] No such file or directory: 'brew': 'brew' Started: 13:48:30.725950 Duration: 18.479 ms Changes:

cdalvaro · 2021-02-16T18:51:48Z

I think the problem is that you are specifying the version of the app homebrew/cask/p4v=21.1, try without telling salt to install version 21.1

maneamarius · 2021-02-16T18:52:39Z

yeah you are right, I just tried without version, and doesn't error out anymore.

I'd like to pin to specific version though, is there a way to do that?

cdalvaro · 2021-02-16T18:55:24Z

I have never tried that feature. Not even directly with brew. I will try to test it as soon as possible.

maneamarius · 2021-02-16T19:13:46Z

thanks a lot, I appreciate all your help so far!

maneamarius · 2021-02-16T19:14:58Z

Just to note, that visual-studio-code brew package can be installed using cask and version.
But p4v package cannot be installed using the version, it errors out as described above.
Maybe it helps you in troubleshooting?

cdalvaro · 2021-02-16T19:20:05Z

May be you need to specify the full p4v version: 21.1,2075061

maneamarius · 2021-02-16T19:53:45Z

I tried that as well, still didn't work :(

cdalvaro · 2021-02-16T20:42:43Z

I'm not really sure, but it seems like casks cannot be pinned:

~
❯  brew pin visual-studio-code
Error: No available formula with the name "visual-studio-code".

~
❯  brew pin homebrew/cask/visual-studio-code
Error: No available formula with the name "homebrew/cask/visual-studio-code".

~
❯  brew list --pinned

~
❯  brew pin boost

~
❯  brew list --pinned
boost

~
❯  brew unpin boost

~
❯  brew list --pinned

Update: Homebrew will install the cask version available at the moment of the first installation. Then, apps with auto-update won't be updated by Homebrew using brew upgrade. Instead, they'll use its own mechanism.

You cannot either install specific Homebrew formulas version unless they provide a specific formula for such version, like ruby

❯  brew search '/ruby@[0-9.]+/'
==> Formulae
ruby@2.4                      ruby@2.5                      ruby@2.6                      ruby@2.7                      ruby@3 ✔                      ruby@3.0 ✔

maneamarius · 2021-02-17T13:32:11Z

Yes, I think you are right, some casks offer the option to specify version, and some not.
It's a pity they don't follow same standard across..

justinta added Feature new functionality including changes to functionality and code refactors, etc. Platform Relates to OS, containers, platform-based utilities like FS, system based apps labels Jun 16, 2015

justinta added this to the Approved milestone Jun 16, 2015

jfindlay added the P2 Priority 2 label Aug 25, 2015

jfindlay added the MacOS pertains to the OS of fruit label Sep 25, 2015

stale bot added the stale label Feb 17, 2018

stale bot removed the stale label Feb 19, 2018

sagetherage removed the P2 Priority 2 label Jun 3, 2020

cdalvaro mentioned this issue Feb 5, 2021

Use --json=v2 for listing macOS brew casks #59439

Merged

3 tasks

Ch3LL closed this as completed in #59439 Sep 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature Request: Support for homebrew cask #24653

Feature Request: Support for homebrew cask #24653

fgimian commented Jun 12, 2015

justinta commented Jun 16, 2015

DavidJFelix commented Jul 15, 2015

cliffrowley commented Nov 30, 2015

stale bot commented Feb 17, 2018

fgimian commented Feb 19, 2018

stale bot commented Feb 19, 2018

weswhet commented Apr 3, 2018

lmf-mx commented Apr 30, 2019

cdalvaro commented Jul 14, 2020 •

edited

Loading

gabeio commented Jan 14, 2021 •

edited

Loading

cdalvaro commented Jan 14, 2021

gabeio commented Jan 14, 2021 •

edited

Loading

cdalvaro commented Jan 14, 2021 •

edited

Loading

maneamarius commented Feb 16, 2021 •

edited

Loading

cdalvaro commented Feb 16, 2021 •

edited

Loading

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021 •

edited

Loading

maneamarius commented Feb 17, 2021

Feature Request: Support for homebrew cask #24653

Feature Request: Support for homebrew cask #24653

Comments

fgimian commented Jun 12, 2015

justinta commented Jun 16, 2015

DavidJFelix commented Jul 15, 2015

cliffrowley commented Nov 30, 2015

stale bot commented Feb 17, 2018

fgimian commented Feb 19, 2018

stale bot commented Feb 19, 2018

weswhet commented Apr 3, 2018

lmf-mx commented Apr 30, 2019

cdalvaro commented Jul 14, 2020 • edited Loading

gabeio commented Jan 14, 2021 • edited Loading

cdalvaro commented Jan 14, 2021

gabeio commented Jan 14, 2021 • edited Loading

cdalvaro commented Jan 14, 2021 • edited Loading

maneamarius commented Feb 16, 2021 • edited Loading

cdalvaro commented Feb 16, 2021 • edited Loading

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

Summary for xyz

Succeeded: 0 (changed=1) Failed: 1

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021

maneamarius commented Feb 16, 2021

cdalvaro commented Feb 16, 2021 • edited Loading

maneamarius commented Feb 17, 2021

cdalvaro commented Jul 14, 2020 •

edited

Loading

gabeio commented Jan 14, 2021 •

edited

Loading

gabeio commented Jan 14, 2021 •

edited

Loading

cdalvaro commented Jan 14, 2021 •

edited

Loading

maneamarius commented Feb 16, 2021 •

edited

Loading

cdalvaro commented Feb 16, 2021 •

edited

Loading

Succeeded: 0 (changed=1)
Failed: 1

cdalvaro commented Feb 16, 2021 •

edited

Loading