core: can specify a "post_up_message" [GH-1968]

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.6.0 (unreleased)
+
+FEATURES:
+
+  - Can now specify a `post_up_message` in your Vagrantfile that is shown
+    after a `vagrant up`. This is useful for putting some instructions of how
+    to use the development environment.
+
 ## 1.5.4 (April 21, 2014)
 
 IMPROVEMENTS:

plugins/commands/up/command.rb

@@ -54,6 +54,7 @@ module VagrantPlugins
         @logger.debug("'Up' each target VM...")
 
         # Build up the batch job of what we'll do
+        machines = []
         @env.batch(options[:parallel]) do |batch|
           names = argv
           if names.empty? then
@@ -65,10 +66,26 @@ module VagrantPlugins
               :name => machine.name,
               :provider => machine.provider_name))
 
+            machines << machine
+
             batch.action(machine, :up, options)
           end
         end
 
+        # Output the post-up messages that we have, if any
+        machines.each do |m|
+          next if !m.config.vm.post_up_message
+          next if m.config.vm.post_up_message == ""
+
+          # Add a newline to separate things.
+          @env.ui.info("", prefix: false)
+
+          m.ui.success(I18n.t(
+            "vagrant.post_up_message",
+            name: m.name.to_s,
+            message: m.config.vm.post_up_message))
+        end
+
         # Success, exit status 0
         0
       end

plugins/kernel_v2/config/vm.rb

@@ -29,6 +29,7 @@ module VagrantPlugins
       attr_accessor :graceful_halt_timeout
       attr_accessor :guest
       attr_accessor :hostname
+      attr_accessor :post_up_message
       attr_accessor :usable_port_range
       attr_reader :provisioners
 
@@ -47,6 +48,7 @@ module VagrantPlugins
         @graceful_halt_timeout        = UNSET_VALUE
         @guest                        = UNSET_VALUE
         @hostname                     = UNSET_VALUE
+        @post_up_message              = UNSET_VALUE
         @provisioners                 = []
         @usable_port_range            = UNSET_VALUE
 
@@ -321,6 +323,7 @@ module VagrantPlugins
         @guest = nil if @guest == UNSET_VALUE
         @hostname = nil if @hostname == UNSET_VALUE
         @hostname = @hostname.to_s if @hostname
+        @post_up_message = "" if @post_up_message == UNSET_VALUE
 
         if @usable_port_range == UNSET_VALUE
           @usable_port_range = (2200..2250)

templates/locales/en.yml

@@ -165,6 +165,11 @@ en:
       and reinstalled:
 
       %{names}
+    post_up_message: |-
+      Machine '%{name}' has a post `vagrant up` message. This is a message
+      from the creator of the Vagrantfile, and not from Vagrant itself:
+
+      %{message}
     provisioner_cleanup: |-
       Running cleanup tasks for '%{name}' provisioner...
     rsync_auto_initial: |-

test/unit/plugins/kernel_v2/config/vm_test.rb

@@ -170,6 +170,19 @@ describe VagrantPlugins::Kernel_V2::VMConfig do
     end
   end
 
+  describe "#post_up_message" do
+    it "defaults to empty string" do
+      subject.finalize!
+      expect(subject.post_up_message).to eq("")
+    end
+
+    it "can be set" do
+      subject.post_up_message = "foo"
+      subject.finalize!
+      expect(subject.post_up_message).to eq("foo")
+    end
+  end
+
   describe "#provider and #get_provider_config" do
     it "compiles the configurations for a provider" do
       subject.provider "virtualbox" do |vb|