cmd/list: support listing formulae installed on request or automatically #17125

ZhongRuoyu · 2024-04-22T04:02:37Z

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same change?
Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes? Here's an example.
Have you successfully run brew style with your changes locally?
Have you successfully run brew typecheck with your changes locally?
Have you successfully run brew tests with your changes locally?

Sample usage:

$ brew ls --installed-on-request
gcc
llvm
[...]
$ brew ls --installed-as-dependency
grpc
protobuf
[...]
$ brew ls --installed-on-request --installed-as-dependency
gcc: installed on request
grpc: installed as dependency
llvm: installed on request
protobuf: installed as dependency
[...]

Resolves #17117.

Sample usage: $ brew ls --manual gcc llvm [...] $ brew ls --auto grpc protobuf [...] $ brew ls --manual --auto gcc: manual grpc: auto llvm: manual protobuf: auto [...] Resolves #17117.

ZhongRuoyu · 2024-04-22T04:37:48Z

On a related note, this logic is extracted from a local command brew mark that I wrote some time ago but haven't had a chance to consider contributing yet. It marks a formula as installed on request or automatically, and is analogous to apt-mark, dnf mark, port {,un}setrequested, etc.

The reason I wrote it is mainly because brew upgrade and brew reinstall can change a formula's status from automatically installed to installed on request, which is not always desired. Sometimes I do brew reinstall to work around the tab bug (#16032) so that I can safely use brew autoremove to prune the dependencies that are actually not needed anymore. But as an unintended consequence (to me), the formula itself becomes installed on request, so it can no longer be autoremoved later. brew mark --auto <formula> became a solution for me.

After a quick search I do see previous request for such functionality (e.g., #10754), but that was not implemented in the end. I'd like to raise this to see if there is still interest in this; if so, I can prepare a PR for that.

MikeMcQuaid

Looks good, thanks @ZhongRuoyu! Happy to be self-merged once the naming is updated (or we can discuss more)

Library/Homebrew/cmd/list.rb

MikeMcQuaid · 2024-04-22T12:42:45Z

Library/Homebrew/test/cmd/list_spec.rb

@@ -18,4 +34,25 @@
 .and not_to_output.to_stderr
 .and be_a_success
 end
+
+ it "lists the formulae installed on request or automatically",
+ :integration_test do


Don't think it's worth adding another (slow, sadly) integration test for this.

Tangential: Now that each command is a separate class, do you think it'd be possible to create integration-like tests that don't require spinning up a new Ruby process? It might have been possible before but now it seems like a more viable option. Most of the slowness has to do with shelling out to a new Ruby process, right?

CC: @dduugg

@apainintheneck Yeh, I think this would be nice.

We still want to make sure we have some proper/slow integration coverage because it catches when the issues are in bin/brew or bin/brew.rb but that could be a smaller subset of critical commands e.g. brew install/brew upgrade/etc.

MikeMcQuaid · 2024-04-22T12:44:14Z

I'd like to raise this to see if there is still interest in this; if so, I can prepare a PR for that.

Yeh, seems like a good idea. Not sure brew mark is the best name but I think having functionality to set/unset "installed on request" state would be desirable.

Library/Homebrew/cmd/list.rb

apainintheneck · 2024-04-23T02:52:45Z

Library/Homebrew/test/cmd/list_spec.rb

@@ -18,4 +34,25 @@
 .and not_to_output.to_stderr
 .and be_a_success
 end
+
+ it "lists the formulae installed on request or automatically",
+ :integration_test do


Tangential: Now that each command is a separate class, do you think it'd be possible to create integration-like tests that don't require spinning up a new Ruby process? It might have been possible before but now it seems like a more viable option. Most of the slowness has to do with shelling out to a new Ruby process, right?

CC: @dduugg

apainintheneck · 2024-04-23T02:56:23Z

Library/Homebrew/test/cmd/list_spec.rb

+ tab = Tab.new(
+ "installed_on_request" => installed_on_request,
+ "tabfile" => keg_dir/Tab::FILENAME,
+ )
+ tab.write


Tangential: This is starting to crop up in the test code a bit more and I'm wondering if it'd be better to just add an option to setup_test_formula that facilitates that like with_tab: { "installed_on_request" => true }.

CC: @reitermarkus because we've talked about this a bit before

@apainintheneck good idea 👍🏻

Co-authored-by: Kevin <[email protected]>

MikeMcQuaid

Thanks again @ZhongRuoyu!

ZhongRuoyu added 3 commits April 22, 2024 12:00

cmd/list: support listing formulae installed on request or automatically

868c15f

Sample usage: $ brew ls --manual gcc llvm [...] $ brew ls --auto grpc protobuf [...] $ brew ls --manual --auto gcc: manual grpc: auto llvm: manual protobuf: auto [...] Resolves #17117.

brew tc --update

5e63d31

Update manpage and completions

a6268a1

ZhongRuoyu added the features New features label Apr 22, 2024

Fix tapioca compiler args test

15c2819

MikeMcQuaid approved these changes Apr 22, 2024

View reviewed changes

apainintheneck reviewed Apr 23, 2024

View reviewed changes

MikeMcQuaid and others added 3 commits April 23, 2024 08:35

cmd/list: more consistent switches.

2b09fcd

cmd/list: update description for --installed-as-dependency

a1a0cbb

Co-authored-by: Kevin <[email protected]>

cmd/list: tweak wording

7cf6cb2

ZhongRuoyu force-pushed the brew-list-manual-auto branch 2 times, most recently from 3735761 to 3e57a49 Compare April 23, 2024 07:53

ZhongRuoyu added 4 commits April 23, 2024 15:55

cmd/list: update switches and logic

ba85f92

brew tc --update

4e0c786

test/cmd/list_spec: remove an integration test

107b8c7

Fix tapioca compiler args test

b53998c

ZhongRuoyu force-pushed the brew-list-manual-auto branch from 3e57a49 to 90b629d Compare April 23, 2024 07:55

Update manpage and completions

0084791

ZhongRuoyu force-pushed the brew-list-manual-auto branch from 90b629d to 0084791 Compare April 23, 2024 07:58

MikeMcQuaid approved these changes Apr 23, 2024

View reviewed changes

MikeMcQuaid enabled auto-merge April 23, 2024 07:59

MikeMcQuaid merged commit 966454c into master Apr 23, 2024
26 checks passed

MikeMcQuaid deleted the brew-list-manual-auto branch April 23, 2024 08:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmd/list: support listing formulae installed on request or automatically #17125

cmd/list: support listing formulae installed on request or automatically #17125

ZhongRuoyu commented Apr 22, 2024 •

edited

ZhongRuoyu commented Apr 22, 2024

MikeMcQuaid left a comment

MikeMcQuaid Apr 22, 2024

apainintheneck Apr 23, 2024

MikeMcQuaid Apr 23, 2024

MikeMcQuaid commented Apr 22, 2024

apainintheneck Apr 23, 2024

apainintheneck Apr 23, 2024

MikeMcQuaid Apr 23, 2024

MikeMcQuaid left a comment

cmd/list: support listing formulae installed on request or automatically #17125

cmd/list: support listing formulae installed on request or automatically #17125

Conversation

ZhongRuoyu commented Apr 22, 2024 • edited

ZhongRuoyu commented Apr 22, 2024

MikeMcQuaid left a comment

Choose a reason for hiding this comment

MikeMcQuaid Apr 22, 2024

Choose a reason for hiding this comment

apainintheneck Apr 23, 2024

Choose a reason for hiding this comment

MikeMcQuaid Apr 23, 2024

Choose a reason for hiding this comment

MikeMcQuaid commented Apr 22, 2024

apainintheneck Apr 23, 2024

Choose a reason for hiding this comment

apainintheneck Apr 23, 2024

Choose a reason for hiding this comment

MikeMcQuaid Apr 23, 2024

Choose a reason for hiding this comment

MikeMcQuaid left a comment

Choose a reason for hiding this comment

ZhongRuoyu commented Apr 22, 2024 •

edited