Merge pull request #9127 from briancain/parallel-destroy-flag

Introduce parallel destroy for certain providers

plugins/commands/destroy/command.rb

@@ -18,29 +18,50 @@ module VagrantPlugins
           o.on("-f", "--force", "Destroy without confirmation.") do |f|
             options[:force] = f
           end
+
+          o.on("--[no-]parallel",
+               "Enable or disable parallelism if provider supports it (automatically enables force)") do |p|
+            options[:parallel] = p
+          end
         end
 
         # Parse the options
         argv = parse_options(opts)
         return if !argv
 
-        @logger.debug("'Destroy' each target VM...")
+        if options[:parallel] && !options[:force]
-        declined = 0
+          @env.ui.warn(I18n.t("vagrant.commands.destroy.warning"))
-        total    = 0
+          sleep(5)
-        with_target_vms(argv, reverse: true) do |vm|
+          options[:force] = true
-          action_env = vm.action(
+        end
-            :destroy, force_confirm_destroy: options[:force])
 
-          total    += 1
+        @logger.debug("'Destroy' each target VM...")
-          declined += 1 if action_env.key?(:force_confirm_destroy_result) &&
+
-            action_env[:force_confirm_destroy_result] == false
+        machines = []
+        init_states = {}
+        declined = 0
+
+        @env.batch(options[:parallel]) do |batch|
+          with_target_vms(argv, reverse: true) do |vm|
+            # gather states to be checked after destroy
+            init_states[vm.name] = vm.state.id
+            machines << vm
+
+            batch.action(vm, :destroy, force_confirm_destroy: options[:force])
+          end
+        end
+
+        machines.each do |m|
+          if m.state.id == init_states[m.name]
+            declined += 1
+          end
         end
 
         # Nothing was declined
         return 0 if declined == 0
 
-        # Everything was declined
+        # Everything was declined, state was not changed
-        return 1 if declined == total
+        return 1 if declined == machines.length
 
         # Some was declined
         return 2

templates/locales/en.yml

@@ -1697,6 +1697,9 @@ en:
         will_not_destroy: |-
           The VM '%{name}' will not be destroyed, since the confirmation
           was declined.
+        warning: |-
+          Destroying guests with `--parallel` automatically enables `--force`.
+          Press ctrl-c to cancel.
       init:
         success: |-
           A `Vagrantfile` has been placed in this directory. You are now

test/unit/plugins/commands/destroy/command_test.rb

@@ -0,0 +1,155 @@
+require File.expand_path("../../../../base", __FILE__)
+
+require Vagrant.source_root.join("plugins/commands/destroy/command")
+
+describe VagrantPlugins::CommandDestroy::Command do
+  include_context "unit"
+
+  let(:entry_klass) { Vagrant::MachineIndex::Entry }
+  let(:argv)     { [] }
+  let(:vagrantfile_content){ "" }
+  let(:iso_env) do
+    env = isolated_environment
+    env.vagrantfile(vagrantfile_content)
+    env.create_vagrant_env
+  end
+
+  subject { described_class.new(argv, iso_env) }
+
+  let(:action_runner) { double("action_runner") }
+
+  def new_entry(name)
+    entry_klass.new.tap do |e|
+      e.name = name
+      e.vagrantfile_path = "/bar"
+    end
+  end
+
+  before do
+    allow(iso_env).to receive(:action_runner).and_return(action_runner)
+  end
+
+  context "with no argument" do
+    before { @state_var = :running }
+    let(:vagrantfile_content){ "Vagrant.configure(2){|config| config.vm.box = 'dummy'}" }
+    let(:state) { double("state", id: :running) }
+    let(:machine) do
+      iso_env.machine(iso_env.machine_names[0], :dummy).tap do |m|
+        allow(m).to receive(:state).and_return(state)
+      end
+    end
+
+    before do
+      allow(subject).to receive(:with_target_vms) { |&block| block.call machine }
+    end
+
+    it "should destroy the default box" do
+      allow_any_instance_of(Vagrant::BatchAction).to receive(:action) .with(machine, :destroy, anything)
+
+      expect(machine.state).to receive(:id).and_return(:running)
+      expect(machine.state).to receive(:id).and_return(:dead)
+      expect(subject.execute).to eq(0)
+    end
+
+    it "exits 1 if a vms destroy was declined" do
+      allow_any_instance_of(Vagrant::BatchAction).to receive(:action) .with(machine, :destroy, anything)
+
+      expect(machine.state).to receive(:id).and_return(:running)
+      expect(machine.state).to receive(:id).and_return(:running)
+      expect(subject.execute).to eq(1)
+    end
+
+    context "with VAGRANT_DEFAULT_PROVIDER set" do
+      before do
+        if ENV["VAGRANT_DEFAULT_PROVIDER"]
+          @original_default = ENV["VAGRANT_DEFAULT_PROVIDER"]
+        end
+        ENV["VAGRANT_DEFAULT_PROVIDER"] = "unknown"
+      end
+      after do
+        if @original_default
+          ENV["VAGRANT_DEFAULT_PROVIDER"] = @original_default
+        else
+          ENV.delete("VAGRANT_DEFAULT_PROVIDER")
+        end
+      end
+
+      it "should attempt to use dummy provider" do
+        expect{ subject.execute }.to raise_error(Vagrant::Errors::UnimplementedProviderAction)
+      end
+    end
+  end
+
+  context "with --parallel set" do
+    let(:argv){ ["--parallel", "--force"] }
+
+    it "passes in true to batch" do
+      batch = double("environment_batch")
+      expect(iso_env).to receive(:batch).with(true).and_yield(batch)
+      expect(batch).to receive(:action).with(anything, :destroy, anything) do |machine,action,args|
+        expect(machine).to be_kind_of(Vagrant::Machine)
+        expect(action).to eq(:destroy)
+      end
+      subject.execute
+    end
+  end
+
+  context "with a global machine" do
+    let(:argv){ ["1234"] }
+
+    it "destroys a vm with an id" do
+
+      global_env = isolated_environment
+      global_env.vagrantfile("Vagrant.configure(2){|config| config.vm.box = 'dummy'}")
+      global_venv = global_env.create_vagrant_env
+      global_machine = global_venv.machine(global_venv.machine_names[0], :dummy)
+      global_machine.id = "1234"
+      global = new_entry(global_machine.name)
+      global.provider = "dummy"
+      global.vagrantfile_path = global_env.workdir
+      locked = iso_env.machine_index.set(global)
+      iso_env.machine_index.release(locked)
+
+      allow(subject).to receive(:with_target_vms) { |&block| block.call global_machine }
+
+
+      batch = double("environment_batch")
+      expect(iso_env).to receive(:batch).and_yield(batch)
+      expect(batch).to receive(:action).with(global_machine, :destroy, anything) do |machine,action,args|
+        expect(machine).to be_kind_of(Vagrant::Machine)
+        expect(action).to eq(:destroy)
+      end
+      subject.execute
+    end
+  end
+
+  context "with an argument" do
+    let(:vagrantfile_content) do
+        <<-VF
+        Vagrant.configure("2") do |config|
+          config.vm.define "app"
+          config.vm.define "db"
+        end
+        VF
+    end
+    let(:argv){ ["app"] }
+    let(:machine) { iso_env.machine(iso_env.machine_names[0], :dummy) }
+
+    it "destroys a vm" do
+      batch = double("environment_batch")
+      expect(iso_env).to receive(:batch).and_yield(batch)
+      expect(batch).to receive(:action).with(machine, :destroy, anything) do |machine,action,args|
+        expect(machine).to be_kind_of(Vagrant::Machine)
+        expect(action).to eq(:destroy)
+      end
+      subject.execute
+    end
+
+    context "with an invalid argument" do
+      let(:argv){ ["notweb"] }
+      it "raises an exception" do
+        expect { subject.execute }.to raise_error(Vagrant::Errors::MachineNotFound)
+      end
+    end
+  end
+end

website/source/docs/cli/destroy.html.md

@@ -25,6 +25,9 @@ directory containing the `shutdown` command.
 ## Options
 
 * `-f` or `--force` - Do not ask for confirmation before destroying.
+* `--[no-]parallel` - Destroys multiple machines in parallel if the provider
+  supports it. Please consult the provider documentation to see if this feature
+  is supported.
 
 <div class="alert alert-info">
   The `destroy` command does not remove a box that may have been installed on