Convert Zap test to spec.

2 files changed, 396 insertions, 0 deletions

diff --git a/Library/Homebrew/cask/spec/cask/artifact/zap_spec.rb b/Library/Homebrew/cask/spec/cask/artifact/zap_spec.rb
new file mode 100644
index 000000000..bd14cd6de
--- /dev/null
+++ b/Library/Homebrew/cask/spec/cask/artifact/zap_spec.rb
@@ -0,0 +1,319 @@
+require "spec_helper"
+
+# TODO: test that zap removes an alternate version of the same Cask
+describe Hbc::Artifact::Zap do
+  let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-installable.rb") }
+
+  let(:zap_artifact) {
+    Hbc::Artifact::Zap.new(cask, command: Hbc::FakeSystemCommand)
+  }
+
+  before(:each) do
+    shutup do
+      InstallHelper.install_without_artifacts(cask)
+    end
+  end
+
+  describe "#zap_phase" do
+    subject {
+      shutup do
+        zap_artifact.zap_phase
+      end
+    }
+
+    context "when using launchctl" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-launchctl.rb") }
+      let(:launchctl_list_cmd) { %w[/bin/launchctl list my.fancy.package.service] }
+      let(:launchctl_remove_cmd) { %w[/bin/launchctl remove my.fancy.package.service] }
+      let(:unknown_response) { "launchctl list returned unknown response\n" }
+      let(:service_info) {
+        <<-EOS.undent
+          {
+                  "LimitLoadToSessionType" = "Aqua";
+                  "Label" = "my.fancy.package.service";
+                  "TimeOut" = 30;
+                  "OnDemand" = true;
+                  "LastExitStatus" = 0;
+                  "ProgramArguments" = (
+                          "argument";
+                  );
+          };
+        EOS
+      }
+
+      context "when launchctl job is owned by user" do
+        it "can zap" do
+          Hbc::FakeSystemCommand.stubs_command(
+            launchctl_list_cmd,
+            service_info
+          )
+
+          Hbc::FakeSystemCommand.stubs_command(
+            sudo(launchctl_list_cmd),
+            unknown_response
+          )
+
+          Hbc::FakeSystemCommand.expects_command(launchctl_remove_cmd)
+
+          subject
+        end
+      end
+
+      describe "when launchctl job is owned by system" do
+        it "can zap" do
+          Hbc::FakeSystemCommand.stubs_command(
+            launchctl_list_cmd,
+            unknown_response
+          )
+
+          Hbc::FakeSystemCommand.stubs_command(
+            sudo(launchctl_list_cmd),
+            service_info
+          )
+
+          Hbc::FakeSystemCommand.expects_command(sudo(launchctl_remove_cmd))
+
+          subject
+        end
+      end
+    end
+
+    context "when using pkgutil" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-pkgutil.rb") }
+      let(:main_pkg_id) { "my.fancy.package.main" }
+      let(:agent_pkg_id) { "my.fancy.package.agent" }
+      let(:main_files) {
+        %w[
+          fancy/bin/fancy.exe
+          fancy/var/fancy.data
+        ]
+      }
+      let(:main_dirs) {
+        %w[
+          fancy
+          fancy/bin
+          fancy/var
+        ]
+      }
+      let(:agent_files) {
+        %w[
+          fancy/agent/fancy-agent.exe
+          fancy/agent/fancy-agent.pid
+          fancy/agent/fancy-agent.log
+        ]
+      }
+      let(:agent_dirs) {
+        %w[
+          fancy
+          fancy/agent
+        ]
+      }
+      let(:pkg_info_plist) {
+        <<-EOS.undent
+          <?xml version="1.0" encoding="UTF-8"?>
+          <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+          <plist version="1.0">
+          <dict>
+                  <key>install-location</key>
+                  <string>tmp</string>
+                  <key>volume</key>
+                  <string>/</string>
+          </dict>
+          </plist>
+        EOS
+      }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.stubs_command(
+          %w[/usr/sbin/pkgutil --pkgs=my.fancy.package.*],
+          "#{main_pkg_id}\n#{agent_pkg_id}"
+        )
+
+        [
+          [main_pkg_id, main_files, main_dirs],
+          [agent_pkg_id, agent_files, agent_dirs],
+        ].each do |pkg_id, pkg_files, pkg_dirs|
+          Hbc::FakeSystemCommand.stubs_command(
+            %W[/usr/sbin/pkgutil --only-files --files #{pkg_id}],
+            pkg_files.join("\n")
+          )
+
+          Hbc::FakeSystemCommand.stubs_command(
+            %W[/usr/sbin/pkgutil --only-dirs --files #{pkg_id}],
+            pkg_dirs.join("\n")
+          )
+
+          Hbc::FakeSystemCommand.stubs_command(
+            %W[/usr/sbin/pkgutil --files #{pkg_id}],
+            (pkg_files + pkg_dirs).join("\n")
+          )
+
+          Hbc::FakeSystemCommand.stubs_command(
+            %W[/usr/sbin/pkgutil --pkg-info-plist #{pkg_id}],
+            pkg_info_plist
+          )
+
+          Hbc::FakeSystemCommand.expects_command(sudo(%W[/usr/sbin/pkgutil --forget #{pkg_id}]))
+
+          Hbc::FakeSystemCommand.expects_command(
+            sudo(%w[/bin/rm -f --] + pkg_files.map { |path| Pathname("/tmp/#{path}") })
+          )
+        end
+
+        subject
+      end
+    end
+
+    context "when using kext" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-kext.rb") }
+      let(:kext_id) { "my.fancy.package.kernelextension" }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.stubs_command(
+          sudo(%W[/usr/sbin/kextstat -l -b #{kext_id}]), "loaded"
+        )
+
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(%W[/sbin/kextunload -b #{kext_id}])
+        )
+
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(%W[/usr/sbin/kextfind -b #{kext_id}]), "/Library/Extensions/FancyPackage.kext\n"
+        )
+
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(["/bin/rm", "-rf", "/Library/Extensions/FancyPackage.kext"])
+        )
+
+        subject
+      end
+    end
+
+    context "when using quit" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-quit.rb") }
+      let(:bundle_id) { "my.fancy.package.app" }
+      let(:quit_application_script) {
+        %Q(tell application id "#{bundle_id}" to quit)
+      }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.stubs_command(
+          %w[/bin/launchctl list], "999\t0\t#{bundle_id}\n"
+        )
+
+        Hbc::FakeSystemCommand.stubs_command(
+          %w[/bin/launchctl list]
+        )
+
+        subject
+      end
+    end
+
+    context "when using signal" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-signal.rb") }
+      let(:bundle_id) { "my.fancy.package.app" }
+      let(:signals) { %w[TERM KILL] }
+      let(:unix_pids) { [12_345, 67_890] }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.stubs_command(
+          %w[/bin/launchctl list], unix_pids.map { |pid| [pid, 0, bundle_id].join("\t") }.join("\n")
+        )
+
+        signals.each do |signal|
+          expect(Process).to receive(:kill).with(signal, *unix_pids)
+        end
+
+        subject
+      end
+    end
+
+    context "when using delete" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-delete.rb") }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(%w[/bin/rm -rf --],
+               Pathname.new("/permissible/absolute/path"),
+               Pathname.new("~/permissible/path/with/tilde").expand_path)
+        )
+
+        subject
+      end
+    end
+
+    context "when using trash" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-trash.rb") }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(%w[/bin/rm -rf --],
+               Pathname.new("/permissible/absolute/path"),
+               Pathname.new("~/permissible/path/with/tilde").expand_path)
+        )
+
+        subject
+      end
+    end
+
+    context "when using rmdir" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-rmdir.rb") }
+      let(:dir_pathname) { Pathname.new("#{TEST_FIXTURE_DIR}/cask/empty_directory") }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(%w[/bin/rm -f --], dir_pathname.join(".DS_Store"))
+        )
+
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(%w[/bin/rmdir --], dir_pathname)
+        )
+
+        subject
+      end
+    end
+
+    context "when using script" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-script.rb") }
+      let(:script_pathname) { cask.staged_path.join("MyFancyPkg", "FancyUninstaller.tool") }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.expects_command(%w[/bin/chmod -- +x] + [script_pathname])
+
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(cask.staged_path.join("MyFancyPkg", "FancyUninstaller.tool"), "--please")
+        )
+
+        subject
+      end
+    end
+
+    context "when using early_script" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-early-script.rb") }
+      let(:script_pathname) { cask.staged_path.join("MyFancyPkg", "FancyUninstaller.tool") }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.expects_command(%w[/bin/chmod -- +x] + [script_pathname])
+
+        Hbc::FakeSystemCommand.expects_command(
+          sudo(cask.staged_path.join("MyFancyPkg", "FancyUninstaller.tool"), "--please")
+        )
+
+        subject
+      end
+    end
+
+    context "when using login_item" do
+      let(:cask) { Hbc::CaskLoader.load_from_file(TEST_FIXTURE_DIR/"cask/Casks/with-zap-login-item.rb") }
+
+      it "can zap" do
+        Hbc::FakeSystemCommand.expects_command(
+          ["/usr/bin/osascript", "-e", 'tell application "System Events" to delete every login ' \
+                                       'item whose name is "Fancy"']
+        )
+
+        subject
+      end
+    end
+  end
+end
diff --git a/Library/Homebrew/cask/spec/support/fake_system_command.rb b/Library/Homebrew/cask/spec/support/fake_system_command.rb
new file mode 100644
index 000000000..b9390d482
--- /dev/null
+++ b/Library/Homebrew/cask/spec/support/fake_system_command.rb
@@ -0,0 +1,77 @@
+def sudo(*args)
+  %w[/usr/bin/sudo -E --] + args.flatten
+end
+
+module Hbc
+  class FakeSystemCommand
+    def self.responses
+      @responses ||= {}
+    end
+
+    def self.expectations
+      @expectations ||= {}
+    end
+
+    def self.system_calls
+      @system_calls ||= Hash.new(0)
+    end
+
+    def self.clear
+      @responses    = nil
+      @expectations = nil
+      @system_calls = nil
+    end
+
+    def self.stubs_command(command, response = "")
+      responses[command] = response
+    end
+
+    def self.expects_command(command, response = "", times = 1)
+      stubs_command(command, response)
+      expectations[command] = times
+    end
+
+    def self.expect_and_pass_through(command, times = 1)
+      pass_through = ->(cmd, opts) { Hbc::SystemCommand.run(cmd, opts) }
+      expects_command(command, pass_through, times)
+    end
+
+    def self.verify_expectations!
+      expectations.each do |command, times|
+        unless system_calls[command] == times
+          raise("expected #{command.inspect} to be run #{times} times, but got #{system_calls[command]}")
+        end
+      end
+    end
+
+    def self.run(command_string, options = {})
+      command = Hbc::SystemCommand.new(command_string, options).command
+      puts command
+      unless responses.key?(command)
+        raise("no response faked for #{command.inspect}, faked responses are: #{responses.inspect}")
+      end
+      system_calls[command] += 1
+
+      response = responses[command]
+      if response.respond_to?(:call)
+        response.call(command_string, options)
+      else
+        Hbc::SystemCommand::Result.new(command, response, "", 0)
+      end
+    end
+
+    def self.run!(command, options = {})
+      run(command, options.merge(must_succeed: true))
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.after(:each) do
+    begin
+      Hbc::FakeSystemCommand.verify_expectations!
+    ensure
+      Hbc::FakeSystemCommand.clear
+    end
+  end
+end