Merge pull request #6330 from hogand/add-upgrade-dry-run

Add --dry-run to brew upgrade and brew cask upgrade

Library/Homebrew/cask/cmd/upgrade.rb

@@ -9,6 +9,7 @@ module Cask
       option "--quiet",  :quiet, false
       option "--force", :force, false
       option "--skip-cask-deps", :skip_cask_deps, false
+      option "--dry-run", :dry_run, false
 
       def initialize(*)
         super
@@ -32,7 +33,8 @@ module Cask
         end
 
         ohai "Casks with `auto_updates` or `version :latest` will not be upgraded" if args.empty? && !greedy?
-        oh1 "Upgrading #{outdated_casks.count} #{"outdated package".pluralize(outdated_casks.count)}:"
+        verb = dry_run? ? "Would upgrade" : "Upgrading"
+        oh1 "#{verb} #{outdated_casks.count} #{"outdated package".pluralize(outdated_casks.count)}:"
         caught_exceptions = []
 
         upgradable_casks = outdated_casks.map { |c| [CaskLoader.load(c.installed_caskfile), c] }
@@ -40,6 +42,7 @@ module Cask
         puts upgradable_casks
           .map { |(old_cask, new_cask)| "#{new_cask.full_name} #{old_cask.version} -> #{new_cask.version}" }
           .join(", ")
+        return if dry_run?
 
         upgradable_casks.each do |(old_cask, new_cask)|
           begin

Library/Homebrew/cmd/upgrade.rb

@@ -47,6 +47,8 @@ module Homebrew
       switch "--display-times",
              env:         :display_install_times,
              description: "Print install times for each formula at the end of the run."
+      switch "--dry-run",
+             description: "Show what would be upgraded, but do not actually upgrade anything."
       conflicts "--build-from-source", "--force-bottle"
       formula_options
     end
@@ -94,7 +96,8 @@ module Homebrew
     if formulae_to_install.empty?
       oh1 "No packages to upgrade"
     else
-      oh1 "Upgrading #{formulae_to_install.count} outdated #{"package".pluralize(formulae_to_install.count)}:"
+      verb = args.dry_run? ? "Would upgrade" : "Upgrading"
+      oh1 "#{verb} #{formulae_to_install.count} outdated #{"package".pluralize(formulae_to_install.count)}:"
       formulae_upgrades = formulae_to_install.map do |f|
         if f.optlinked?
           "#{f.full_specified_name} #{Keg.new(f.opt_prefix).version} -> #{f.pkg_version}"
@@ -104,6 +107,7 @@ module Homebrew
       end
       puts formulae_upgrades.join(", ")
     end
+    return if args.dry_run?
 
     upgrade_formulae(formulae_to_install)
 

Library/Homebrew/manpages/brew-cask.1.md

@@ -97,13 +97,16 @@ graphical user interface.
     Uninstall the given Cask. With `--force`, uninstall even if the Cask
     does not appear to be present.
 
-  * `upgrade` [--force] [--greedy] <token> [ <token> ... ]:
+  * `upgrade` [--force] [--greedy] [--dry-run] <token> [ <token> ... ]:
     Without token arguments, upgrade all the installed Casks that have newer
     versions available in the tap; otherwise update the tokens given
     in the command line.
     If `--greedy` is given then also upgrade the Casks having `auto_updates true`
     or `version :latest`.
 
+    If `--dry-run` is given, show what would be upgraded, but do not actually
+    upgrade anything.
+
   * `zap` [--force] <token> [ <token> ... ]:
     Unconditionally remove _all_ files associated with the given Cask.
     With `--force`, zap even if the Cask does not appear to be currently installed.

Library/Homebrew/test/cask/cmd/upgrade_spec.rb

@@ -170,6 +170,179 @@ describe Cask::Cmd::Upgrade, :cask do
     end
   end
 
+  context "dry run upgrade" do
+    let(:installed) {
+      [
+        "outdated/local-caffeine",
+        "outdated/local-transmission",
+        "outdated/auto-updates",
+        "outdated/version-latest",
+      ]
+    }
+
+    before do
+      installed.each { |cask| Cask::Cmd::Install.run(cask) }
+
+      allow_any_instance_of(described_class).to receive(:verbose?).and_return(true)
+    end
+
+    describe 'without --greedy it ignores the Casks with "version latest" or "auto_updates true"' do
+      it "would update all the installed Casks when no token is provided" do
+        local_caffeine = Cask::CaskLoader.load("local-caffeine")
+        local_caffeine_path = Cask::Config.global.appdir.join("Caffeine.app")
+        local_transmission = Cask::CaskLoader.load("local-transmission")
+        local_transmission_path = Cask::Config.global.appdir.join("Transmission.app")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).to include("1.2.2")
+
+        expect(local_transmission).to be_installed
+        expect(local_transmission_path).to be_a_directory
+        expect(local_transmission.versions).to include("2.60")
+
+        described_class.run("--dry-run")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).to include("1.2.2")
+        expect(local_caffeine.versions).not_to include("1.2.3")
+
+        expect(local_transmission).to be_installed
+        expect(local_transmission_path).to be_a_directory
+        expect(local_transmission.versions).to include("2.60")
+        expect(local_transmission.versions).not_to include("2.61")
+      end
+
+      it "would update only the Casks specified in the command line" do
+        local_caffeine = Cask::CaskLoader.load("local-caffeine")
+        local_caffeine_path = Cask::Config.global.appdir.join("Caffeine.app")
+        local_transmission = Cask::CaskLoader.load("local-transmission")
+        local_transmission_path = Cask::Config.global.appdir.join("Transmission.app")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).to include("1.2.2")
+
+        expect(local_transmission).to be_installed
+        expect(local_transmission_path).to be_a_directory
+        expect(local_transmission.versions).to include("2.60")
+
+        described_class.run("--dry-run", "local-caffeine")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).to include("1.2.2")
+        expect(local_caffeine.versions).not_to include("1.2.3")
+
+        expect(local_transmission).to be_installed
+        expect(local_transmission_path).to be_a_directory
+        expect(local_transmission.versions).to include("2.60")
+        expect(local_transmission.versions).not_to include("2.61")
+      end
+
+      it 'would update "auto_updates" and "latest" Casks when their tokens are provided in the command line' do
+        local_caffeine = Cask::CaskLoader.load("local-caffeine")
+        local_caffeine_path = Cask::Config.global.appdir.join("Caffeine.app")
+        auto_updates = Cask::CaskLoader.load("auto-updates")
+        auto_updates_path = Cask::Config.global.appdir.join("MyFancyApp.app")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).to include("1.2.2")
+
+        expect(auto_updates).to be_installed
+        expect(auto_updates_path).to be_a_directory
+        expect(auto_updates.versions).to include("2.57")
+
+        described_class.run("--dry-run", "local-caffeine", "auto-updates")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).to include("1.2.2")
+        expect(local_caffeine.versions).not_to include("1.2.3")
+
+        expect(auto_updates).to be_installed
+        expect(auto_updates_path).to be_a_directory
+        expect(auto_updates.versions).to include("2.57")
+        expect(auto_updates.versions).not_to include("2.61")
+      end
+    end
+
+    describe "with --greedy it checks additional Casks" do
+      it 'would include the Casks with "auto_updates true" or "version latest"' do
+        local_caffeine = Cask::CaskLoader.load("local-caffeine")
+        local_caffeine_path = Cask::Config.global.appdir.join("Caffeine.app")
+        auto_updates = Cask::CaskLoader.load("auto-updates")
+        auto_updates_path = Cask::Config.global.appdir.join("MyFancyApp.app")
+        local_transmission = Cask::CaskLoader.load("local-transmission")
+        local_transmission_path = Cask::Config.global.appdir.join("Transmission.app")
+        version_latest = Cask::CaskLoader.load("version-latest")
+        version_latest_path_1 = Cask::Config.global.appdir.join("Caffeine Mini.app")
+        version_latest_path_2 = Cask::Config.global.appdir.join("Caffeine Pro.app")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).to include("1.2.2")
+
+        expect(auto_updates).to be_installed
+        expect(auto_updates_path).to be_a_directory
+        expect(auto_updates.versions).to include("2.57")
+
+        expect(local_transmission).to be_installed
+        expect(local_transmission_path).to be_a_directory
+        expect(local_transmission.versions).to include("2.60")
+
+        expect(version_latest).to be_installed
+        expect(version_latest_path_1).to be_a_directory
+        expect(version_latest.versions).to include("latest")
+
+        described_class.run("--greedy", "--dry-run")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).to include("1.2.2")
+        expect(local_caffeine.versions).not_to include("1.2.3")
+
+        expect(auto_updates).to be_installed
+        expect(auto_updates_path).to be_a_directory
+        expect(auto_updates.versions).to include("2.57")
+        expect(auto_updates.versions).not_to include("2.61")
+
+        expect(local_transmission).to be_installed
+        expect(local_transmission_path).to be_a_directory
+        expect(local_transmission.versions).to include("2.60")
+        expect(local_transmission.versions).not_to include("2.61")
+
+        expect(version_latest).to be_installed
+        expect(version_latest_path_2).to be_a_directory
+      end
+
+      it 'does not include the Casks with "auto_updates true" when the version did not change' do
+        cask = Cask::CaskLoader.load("auto-updates")
+        cask_path = cask.config.appdir.join("MyFancyApp.app")
+
+        expect(cask).to be_installed
+        expect(cask_path).to be_a_directory
+        expect(cask.versions).to include("2.57")
+
+        described_class.run("--dry-run", "auto-updates", "--greedy")
+
+        expect(cask).to be_installed
+        expect(cask_path).to be_a_directory
+        expect(cask.versions).to include("2.57")
+        expect(cask.versions).not_to include("2.61")
+
+        described_class.run("--dry-run", "auto-updates", "--greedy")
+
+        expect(cask).to be_installed
+        expect(cask_path).to be_a_directory
+        expect(cask.versions).to include("2.57")
+        expect(cask.versions).not_to include("2.61")
+      end
+    end
+  end
+
   context "failed upgrade" do
     let(:installed) {
       [

docs/Manpage.md

@@ -557,6 +557,8 @@ upgraded formulae or, every 30 days, for all formulae.
   Don't delete the temporary files created during installation.
 * `--display-times`:
   Print install times for each formula at the end of the run.
+* `--dry-run`:
+  Show what would be upgraded, but do not actually upgrade anything.
 
 ### `uses` [*`options`*] *`formula`*
 

manpages/brew-cask.1

@@ -100,9 +100,12 @@ Check the given Casks for correct style using RuboCop (with custom Cask cops)\.
 Uninstall the given Cask\. With \fB\-\-force\fR, uninstall even if the Cask does not appear to be present\.
 .
 .TP
-\fBupgrade\fR [\-\-force] [\-\-greedy] \fItoken\fR [ \fItoken\fR \.\.\. ]
+\fBupgrade\fR [\-\-force] [\-\-greedy] [\-\-dry\-run] \fItoken\fR [ \fItoken\fR \.\.\. ]
 Without token arguments, upgrade all the installed Casks that have newer versions available in the tap; otherwise update the tokens given in the command line\. If \fB\-\-greedy\fR is given then also upgrade the Casks having \fBauto_updates true\fR or \fBversion :latest\fR\.
 .
+.IP
+If \fB\-\-dry\-run\fR is given, show what would be upgraded, but do not actually upgrade anything\.
+.
 .TP
 \fBzap\fR [\-\-force] \fItoken\fR [ \fItoken\fR \.\.\. ]
 Unconditionally remove \fIall\fR files associated with the given Cask\. With \fB\-\-force\fR, zap even if the Cask does not appear to be currently installed\.

manpages/brew.1

@@ -690,6 +690,10 @@ Don\'t delete the temporary files created during installation\.
 \fB\-\-display\-times\fR
 Print install times for each formula at the end of the run\.
 .
+.TP
+\fB\-\-dry\-run\fR
+Show what would be upgraded, but do not actually upgrade anything\.
+.
 .SS "\fBuses\fR [\fIoptions\fR] \fIformula\fR"
 Show the formulae that specify \fIformula\fR as a dependency\. When given multiple formula arguments, show the intersection of formulae that use \fIformula\fR\.
 .