Merge pull request #11231 from briancain/add-force-option-for-box-outdated

Fixes #11228: Allow to force check for box updates

lib/vagrant/action/builtin/box_check_outdated.rb

@@ -40,7 +40,7 @@ module Vagrant
           # Have download options specified in the environment override
           # options specified for the machine.
           download_options = {
-            automatic_check: true,
+            automatic_check: !env[:box_outdated_force],
             ca_cert: env[:ca_cert] || machine.config.vm.box_download_ca_cert,
             ca_path: env[:ca_path] || machine.config.vm.box_download_ca_path,
             client_cert: env[:client_cert] ||

plugins/commands/box/command/outdated.rb

@@ -26,6 +26,10 @@ module VagrantPlugins
               options[:global] = g
             end
 
+            o.on("-f", "--force", "Force checks for latest box updates") do |f|
+              options[:force] = f
+            end
+
             build_download_options(o, download_options)
           end
 
@@ -40,7 +44,7 @@ module VagrantPlugins
 
           with_target_vms(argv) do |machine|
             @env.action_runner.run(Vagrant::Action.action_box_outdated, {
-              box_outdated_force: true,
+              box_outdated_force: options[:force],
               box_outdated_refresh: true,
               box_outdated_success_ui: true,
               machine: machine,

test/unit/plugins/commands/box/command/outdated_test.rb

@@ -20,6 +20,18 @@ describe VagrantPlugins::CommandBox::Command::Outdated do
     allow(iso_env).to receive(:action_runner).and_return(action_runner)
   end
 
+  context "with force argument" do
+    let(:argv) { ["--force"] }
+
+    it "passes along the force update option" do
+      expect(action_runner).to receive(:run).with(any_args) { |action, **opts|
+        expect(opts[:box_outdated_force]).to be_truthy
+        true
+      }
+      subject.execute
+    end
+  end
+
   context "with global argument" do
     let(:argv) { ["--global"] }
 
@@ -29,10 +41,6 @@ describe VagrantPlugins::CommandBox::Command::Outdated do
       subject.execute
     end
 
-    before do
-
-    end
-
     describe ".outdated_global" do
       let(:test_iso_env) { isolated_environment }
 

test/unit/vagrant/action/builtin/box_check_outdated_test.rb

@@ -54,11 +54,21 @@ describe Vagrant::Action::Builtin::BoxCheckOutdated do
       env[:box_outdated_force] = true
 
       expect(app).to receive(:call).with(env).once
+      expect(box).to receive(:has_update?)
 
       subject.call(env)
 
       expect(env).to have_key(:box_outdated)
     end
+
+    it "checks if not forced" do
+      machine.config.vm.box_check_update = false
+      env[:box_outdated_force] = false
+
+      expect(app).to receive(:call).with(env).once
+
+      subject.call(env)
+    end
   end
 
   context "no box" do

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

@@ -125,8 +125,13 @@ which may be different than the absolute latest version available.
 Checking for updates involves refreshing the metadata associated with
 a box. This generally requires an internet connection.
 
+By default, if Vagrant has recently checked for a box that's out of date, it will
+cache that answer and not look up another update for one hour. This cached value
+can be ignored if the `--force` flag is used.
+
 ## Options
 
+* `--force` - Check for updates for all installed boxes and ignore cache interval.
 * `--global` - Check for updates for all installed boxes, not just the
   boxes for the current Vagrant environment.