Merge pull request #3396 from amyspark/hacktoberfest-upgrade

Implement `brew cask upgrade`

8 files changed, 250 insertions, 10 deletions

diff --git a/Library/Homebrew/test/cask/cli/reinstall_spec.rb b/Library/Homebrew/test/cask/cli/reinstall_spec.rb
index 5e551e5b5..3737a7a70 100644
--- a/Library/Homebrew/test/cask/cli/reinstall_spec.rb
+++ b/Library/Homebrew/test/cask/cli/reinstall_spec.rb
@@ -13,7 +13,8 @@ describe Hbc::CLI::Reinstall, :cask do
       Already downloaded: .*local-caffeine--1.2.3.zip
       ==> Verifying checksum for Cask local-caffeine
       ==> Uninstalling Cask local-caffeine
-      ==> Removing App '.*Caffeine.app'.
+      ==> Moving App 'Caffeine.app' back to '.*Caffeine.app'.
+      ==> Purging files for version 1.2.3 of Cask local-caffeine
       ==> Installing Cask local-caffeine
       ==> Moving App 'Caffeine.app' to '.*Caffeine.app'.
       .*local-caffeine was successfully installed!
diff --git a/Library/Homebrew/test/cask/cli/uninstall_spec.rb b/Library/Homebrew/test/cask/cli/uninstall_spec.rb
index 1ab8f7e4d..345e1b9f2 100644
--- a/Library/Homebrew/test/cask/cli/uninstall_spec.rb
+++ b/Library/Homebrew/test/cask/cli/uninstall_spec.rb
@@ -12,7 +12,8 @@ describe Hbc::CLI::Uninstall, :cask do
 
     output = Regexp.new <<~EOS
       ==> Uninstalling Cask local-caffeine
-      ==> Removing App '.*Caffeine.app'.
+      ==> Moving App 'Caffeine.app' back to '.*Caffeine.app'.
+      ==> Purging files for version 1.2.3 of Cask local-caffeine
     EOS
 
     expect {
diff --git a/Library/Homebrew/test/cask/cli/upgrade_spec.rb b/Library/Homebrew/test/cask/cli/upgrade_spec.rb
new file mode 100644
index 000000000..5f389d695
--- /dev/null
+++ b/Library/Homebrew/test/cask/cli/upgrade_spec.rb
@@ -0,0 +1,211 @@
+require_relative "shared_examples/invalid_option"
+
+describe Hbc::CLI::Upgrade, :cask do
+  it_behaves_like "a command that handles invalid options"
+
+  context "successful upgrade" do
+    let(:installed) {
+      [
+        "outdated/local-caffeine",
+        "outdated/local-transmission",
+        "outdated/auto-updates",
+      ]
+    }
+
+    before(:example) do
+      installed.each { |cask| Hbc::CLI::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 "updates all the installed Casks when no token is provided" do
+        local_caffeine = Hbc::CaskLoader.load("local-caffeine")
+        local_caffeine_path = Hbc.appdir.join("Caffeine.app")
+        local_transmission = Hbc::CaskLoader.load("local-transmission")
+        local_transmission_path = Hbc.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
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).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.61")
+      end
+
+      it "updates only the Casks specified in the command line" do
+        local_caffeine = Hbc::CaskLoader.load("local-caffeine")
+        local_caffeine_path = Hbc.appdir.join("Caffeine.app")
+        local_transmission = Hbc::CaskLoader.load("local-transmission")
+        local_transmission_path = Hbc.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("local-caffeine")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).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")
+      end
+
+      it 'updates "auto_updates" and "latest" Casks when their tokens are provided in the command line' do
+        local_caffeine = Hbc::CaskLoader.load("local-caffeine")
+        local_caffeine_path = Hbc.appdir.join("Caffeine.app")
+        auto_updates = Hbc::CaskLoader.load("auto-updates")
+        auto_updates_path = Hbc.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("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.3")
+
+        expect(auto_updates).to be_installed
+        expect(auto_updates_path).to be_a_directory
+        expect(auto_updates.versions).to include("2.61")
+      end
+    end
+
+    describe "with --greedy it checks additional Casks" do
+      it 'includes the Casks with "auto_updates true" or "version latest"' do
+        local_caffeine = Hbc::CaskLoader.load("local-caffeine")
+        local_caffeine_path = Hbc.appdir.join("Caffeine.app")
+        auto_updates = Hbc::CaskLoader.load("auto-updates")
+        auto_updates_path = Hbc.appdir.join("MyFancyApp.app")
+        local_transmission = Hbc::CaskLoader.load("local-transmission")
+        local_transmission_path = Hbc.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(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")
+
+        described_class.run("--greedy")
+
+        expect(local_caffeine).to be_installed
+        expect(local_caffeine_path).to be_a_directory
+        expect(local_caffeine.versions).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.61")
+
+        expect(local_transmission).to be_installed
+        expect(local_transmission_path).to be_a_directory
+        expect(local_transmission.versions).to include("2.61")
+      end
+
+      it 'does not include the Casks with "auto_updates true" when the version did not change' do
+        cask = Hbc::CaskLoader.load("auto-updates")
+        cask_path = Hbc.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("auto-updates", "--greedy")
+
+        expect(cask).to be_installed
+        expect(cask_path).to be_a_directory
+        expect(cask.versions).to include("2.61")
+
+        described_class.run("auto-updates", "--greedy")
+
+        expect(cask).to be_installed
+        expect(cask_path).to be_a_directory
+        expect(cask.versions).to include("2.61")
+      end
+    end
+  end
+
+  context "failed upgrade" do
+    let(:installed) {
+      [
+        "outdated/bad-checksum",
+        "outdated/will-fail-if-upgraded",
+      ]
+    }
+
+    before(:example) do
+      installed.each { |cask| Hbc::CLI::Install.run(cask) }
+
+      allow_any_instance_of(described_class).to receive(:verbose?).and_return(true)
+    end
+
+    output_reverted = Regexp.new <<~EOS
+      Warning: Reverting upgrade for Cask .*
+    EOS
+
+    it "restores the old Cask if the upgrade failed" do
+      will_fail_if_upgraded = Hbc::CaskLoader.load("will-fail-if-upgraded")
+      will_fail_if_upgraded_path = Hbc.appdir.join("container")
+
+      expect(will_fail_if_upgraded).to be_installed
+      expect(will_fail_if_upgraded_path).to be_a_file
+      expect(will_fail_if_upgraded.versions).to include("1.2.2")
+
+      expect {
+        described_class.run("will-fail-if-upgraded")
+      }.to raise_error(Hbc::CaskError).and output(output_reverted).to_stderr
+
+      expect(will_fail_if_upgraded).to be_installed
+      expect(will_fail_if_upgraded_path).to be_a_file
+      expect(will_fail_if_upgraded.versions).to include("1.2.2")
+      expect(will_fail_if_upgraded.staged_path).to_not exist
+    end
+
+    it "does not restore the old Cask if the upgrade failed pre-install" do
+      bad_checksum = Hbc::CaskLoader.load("bad-checksum")
+      bad_checksum_path = Hbc.appdir.join("Caffeine.app")
+
+      expect(bad_checksum).to be_installed
+      expect(bad_checksum_path).to be_a_directory
+      expect(bad_checksum.versions).to include("1.2.2")
+
+      expect {
+        described_class.run("bad-checksum")
+      }.to raise_error(Hbc::CaskSha256MismatchError).and(not_to_output(output_reverted).to_stderr)
+
+      expect(bad_checksum).to be_installed
+      expect(bad_checksum_path).to be_a_directory
+      expect(bad_checksum.versions).to include("1.2.2")
+      expect(bad_checksum.staged_path).to_not exist
+    end
+  end
+end
diff --git a/Library/Homebrew/test/support/fixtures/cask/Casks/auto-updates.rb b/Library/Homebrew/test/support/fixtures/cask/Casks/auto-updates.rb
index 1cada2561..4f61455bb 100644
--- a/Library/Homebrew/test/support/fixtures/cask/Casks/auto-updates.rb
+++ b/Library/Homebrew/test/support/fixtures/cask/Casks/auto-updates.rb
@@ -1,11 +1,11 @@
 cask 'auto-updates' do
   version '2.61'
-  sha256 'e44ffa103fbf83f55c8d0b1bea309a43b2880798dae8620b1ee8da5e1095ec68'
+  sha256 '5633c3a0f2e572cbf021507dec78c50998b398c343232bdfc7e26221d0a5db4d'
 
-  url "file://#{TEST_FIXTURE_DIR}/cask/transmission-2.61.dmg"
-  homepage 'http://example.com/auto-updates'
+  url "file://#{TEST_FIXTURE_DIR}/cask/MyFancyApp.zip"
+  homepage 'http://example.com/MyFancyApp'
 
   auto_updates true
 
-  app 'Transmission.app'
+  app 'MyFancyApp/MyFancyApp.app'
 end
diff --git a/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/auto-updates.rb b/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/auto-updates.rb
index e202f5a16..5844a0762 100644
--- a/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/auto-updates.rb
+++ b/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/auto-updates.rb
@@ -1,11 +1,11 @@
 cask 'auto-updates' do
   version '2.57'
-  sha256 'e44ffa103fbf83f55c8d0b1bea309a43b2880798dae8620b1ee8da5e1095ec68'
+  sha256 '5633c3a0f2e572cbf021507dec78c50998b398c343232bdfc7e26221d0a5db4d'
 
-  url "file://#{TEST_FIXTURE_DIR}/cask/transmission-2.61.dmg"
-  homepage 'http://example.com/auto-updates'
+  url "file://#{TEST_FIXTURE_DIR}/cask/MyFancyApp.zip"
+  homepage 'http://example.com/MyFancyApp'
 
   auto_updates true
 
-  app 'Transmission.app'
+  app 'MyFancyApp/MyFancyApp.app'
 end
diff --git a/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/bad-checksum.rb b/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/bad-checksum.rb
new file mode 100644
index 000000000..5e7e74483
--- /dev/null
+++ b/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/bad-checksum.rb
@@ -0,0 +1,9 @@
+cask 'bad-checksum' do
+  version '1.2.2'
+  sha256 '67cdb8a02803ef37fdbf7e0be205863172e41a561ca446cd84f0d7ab35a99d94'
+
+  url "file://#{TEST_FIXTURE_DIR}/cask/caffeine.zip"
+  homepage 'http://example.com/local-caffeine'
+
+  app 'Caffeine.app'
+end
diff --git a/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/will-fail-if-upgraded.rb b/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/will-fail-if-upgraded.rb
new file mode 100644
index 000000000..7735ffa84
--- /dev/null
+++ b/Library/Homebrew/test/support/fixtures/cask/Casks/outdated/will-fail-if-upgraded.rb
@@ -0,0 +1,9 @@
+cask 'will-fail-if-upgraded' do
+  version '1.2.2'
+  sha256 'fab685fabf73d5a9382581ce8698fce9408f5feaa49fa10d9bc6c510493300f5'
+
+  url "file://#{TEST_FIXTURE_DIR}/cask/container.tar.gz"
+  homepage 'https://example.com/container-tar-gz'
+
+  app 'container'
+end
diff --git a/Library/Homebrew/test/support/fixtures/cask/Casks/will-fail-if-upgraded.rb b/Library/Homebrew/test/support/fixtures/cask/Casks/will-fail-if-upgraded.rb
new file mode 100644
index 000000000..99ed4b87c
--- /dev/null
+++ b/Library/Homebrew/test/support/fixtures/cask/Casks/will-fail-if-upgraded.rb
@@ -0,0 +1,9 @@
+cask 'will-fail-if-upgraded' do
+  version '1.2.3'
+  sha256 'e44ffa103fbf83f55c8d0b1bea309a43b2880798dae8620b1ee8da5e1095ec68'
+
+  url "file://#{TEST_FIXTURE_DIR}/cask/transmission-2.61.dmg"
+  homepage 'http://example.com/local-transmission'
+
+  app 'container'
+end