vagrant-google 0.1.5 → 0.2.0.rc1

data/lib/vagrant-google/action/start_instance.rb

@@ -0,0 +1,90 @@
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require 'log4r'
+require 'vagrant/util/retryable'
+require 'vagrant-google/util/timer'
+
+module VagrantPlugins
+  module Google
+    module Action
+      # This starts a stopped instance.
+      class StartInstance
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_google::action::start_instance")
+        end
+
+        def call(env)
+          # Initialize metrics if they haven't been
+          env[:metrics] ||= {}
+
+          server = env[:google_compute].servers.get(env[:machine].id, env[:machine].provider_config.zone)
+
+          env[:ui].info(I18n.t("vagrant_google.starting"))
+
+          begin
+            server.start
+
+            # Wait for the instance to be ready first
+            env[:metrics]["instance_ready_time"] = Util::Timer.time do
+
+              tries = env[:machine].provider_config.instance_ready_timeout / 2
+
+              env[:ui].info(I18n.t("vagrant_google.waiting_for_ready"))
+              begin
+                retryable(:on => Fog::Errors::TimeoutError, :tries => tries) do
+                  # If we're interrupted don't worry about waiting
+                  next if env[:interrupted]
+
+                  # Wait for the server to be ready
+                  server.wait_for(2) { ready? }
+                end
+              rescue Fog::Errors::TimeoutError
+                # Notify the user
+                raise Errors::InstanceReadyTimeout,
+                      timeout: env[:machine].provider_config.instance_ready_timeout
+              end
+            end
+          rescue Fog::Compute::Google::Error => e
+            raise Errors::FogError, :message => e.message
+          end
+
+          @logger.info("Time to instance ready: #{env[:metrics]["instance_ready_time"]}")
+
+          if !env[:interrupted]
+            env[:metrics]["instance_ssh_time"] = Util::Timer.time do
+              # Wait for SSH to be ready.
+              env[:ui].info(I18n.t("vagrant_google.waiting_for_ssh"))
+              while true
+                # If we're interrupted then just back out
+                break if env[:interrupted]
+                break if env[:machine].communicate.ready?
+                sleep 2
+              end
+            end
+
+            @logger.info("Time for SSH ready: #{env[:metrics]["instance_ssh_time"]}")
+
+            # Ready and booted!
+            env[:ui].info(I18n.t("vagrant_google.ready"))
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-google/action/stop_instance.rb

@@ -0,0 +1,48 @@
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require 'log4r'
+require 'vagrant/util/retryable'
+require 'vagrant-google/util/timer'
+
+module VagrantPlugins
+  module Google
+    module Action
+
+      # This stops the running instance.
+      class StopInstance
+
+        include Vagrant::Util::Retryable
+
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_google::action::stop_instance")
+        end
+
+        def call(env)
+          server = env[:google_compute].servers.get(env[:machine].id, env[:machine].provider_config.zone)
+
+          if env[:machine].state.id == :TERMINATED
+            env[:ui].info(I18n.t("vagrant_google.already_status", :status => env[:machine].state.id))
+          else
+            env[:ui].info(I18n.t("vagrant_google.stopping"))
+            operation = server.stop
+            operation.wait_for() { ready? }
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-google/action/warn_networks.rb

@@ -20,7 +20,8 @@ module VagrantPlugins
         end
 
         def call(env)
-          if env[:machine].config.vm.networks.length > 0
+          # Default SSH forward always exists so "> 1"
+          if env[:machine].config.vm.networks.length > 1
             env[:ui].warn(I18n.t("vagrant_google.warn_networks"))
           end
 

data/lib/vagrant-google/action.rb

@@ -19,14 +19,35 @@ module VagrantPlugins
       # Include the built-in modules so we can use them as top-level things.
       include Vagrant::Action::Builtin
 
+      # This action is called to halt the remote machine.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use ConnectGoogle
+            b2.use StopInstance
+          end
+        end
+      end
+
       # This action is called to terminate the remote machine.
       def self.action_destroy
         Vagrant::Action::Builder.new.tap do |b|
           b.use Call, DestroyConfirm do |env, b2|
             if env[:result]
               b2.use ConfigValidate
-              b2.use ConnectGoogle
-              b2.use TerminateInstance
+              b2.use Call, IsCreated do |env2, b3|
+                if !env2[:result]
+                  b3.use MessageNotCreated
+                  next
+                end
+                b3.use ConnectGoogle
+                b3.use TerminateInstance
+              end
             else
               b2.use MessageWillNotDestroy
             end
@@ -45,7 +66,7 @@ module VagrantPlugins
             end
 
             b2.use Provision
-            b2.use SyncFolders
+            b2.use SyncedFolders
           end
         end
       end
@@ -106,17 +127,44 @@ module VagrantPlugins
         Vagrant::Action::Builder.new.tap do |b|
           b.use HandleBox
           b.use ConfigValidate
+          b.use BoxCheckOutdated
           b.use ConnectGoogle
-          b.use Call, IsCreated do |env, b2|
-            if env[:result]
-              b2.use MessageAlreadyCreated
+          b.use Call, IsCreated do |env1, b1|
+            if env1[:result]
+              b1.use Call, IsTerminated do |env2, b2|
+                if env2[:result]
+                  b2.use Provision
+                  b2.use SyncedFolders
+                  b2.use WarnNetworks
+                  b2.use StartInstance
+                else
+                  # TODO: Impement better messages for different states
+                  b2.use MessageAlreadyCreated
+                end
+              end
+            else
+              b1.use Provision
+              b1.use SyncedFolders
+              b1.use WarnNetworks
+              b1.use RunInstance
+            end
+          end
+        end
+      end
+
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectGoogle
+          b.use Call, IsCreated do |env1, b1|
+            if !env1[:result]
+              b1.use MessageNotCreated
               next
             end
 
-            b2.use Provision
-            b2.use SyncFolders
-            b2.use WarnNetworks
-            b2.use RunInstance
+            # TODO: Think about implementing through server.reboot
+            b1.use action_halt
+            b1.use action_up
           end
         end
       end
@@ -125,16 +173,18 @@ module VagrantPlugins
       action_root = Pathname.new(File.expand_path("../action", __FILE__))
       autoload :ConnectGoogle, action_root.join("connect_google")
       autoload :IsCreated, action_root.join("is_created")
+      autoload :IsTerminated, action_root.join("is_terminated")
       autoload :MessageAlreadyCreated, action_root.join("message_already_created")
       autoload :MessageNotCreated, action_root.join("message_not_created")
       autoload :MessageWillNotDestroy, action_root.join("message_will_not_destroy")
       autoload :ReadSSHInfo, action_root.join("read_ssh_info")
       autoload :ReadState, action_root.join("read_state")
       autoload :RunInstance, action_root.join("run_instance")
-      autoload :SyncFolders, action_root.join("sync_folders")
+      autoload :StartInstance, action_root.join("start_instance")
+      autoload :StopInstance, action_root.join("stop_instance")
+      autoload :TerminateInstance, action_root.join("terminate_instance")
       autoload :TimedProvision, action_root.join("timed_provision")
       autoload :WarnNetworks, action_root.join("warn_networks")
-      autoload :TerminateInstance, action_root.join("terminate_instance")
     end
   end
 end

data/lib/vagrant-google/config.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 require "vagrant"
+require "securerandom"
 
 module VagrantPlugins
   module Google
@@ -81,7 +82,7 @@ module VagrantPlugins
       # @return [Array]
       attr_accessor :tags
 
-      # wether to enable ip forwarding
+      # whether to enable ip forwarding
       #
       # @return Boolean
       attr_accessor :can_ip_forward
@@ -91,28 +92,49 @@ module VagrantPlugins
       # @return String
       attr_accessor :external_ip
 
-      # wether to autodelete disk on instance delete
+      # whether to autodelete disk on instance delete
       #
       # @return Boolean
       attr_accessor :autodelete_disk
 
+      # Availability policy
+      # whether to run instance as preemptible
+      #
+      # @return Boolean
+      attr_accessor :preemptible
+
+      # Availability policy
+      # whether to have instance restart on failures
+      #
+      # @return Boolean
+      attr_accessor :auto_restart
+
+      # Availability policy
+      # specify what to do when infrastructure maintenance events occur
+      # Options: MIGRATE, TERMINATE
+      # The default is MIGRATE.
+      #
+      # @return String
+      attr_accessor :on_host_maintenance
+
       # The timeout value waiting for instance ready
       #
       # @return [Int]
       attr_accessor :instance_ready_timeout
 
-      # The tags for the machine.
-      # TODO(erjohnso): not supported in fog
-      #
-      # @return [Hash<String, String>]
-      #attr_accessor :tags
-
       # The zone to launch the instance into. If nil, it will
       # use the default us-central1-f.
       #
       # @return [String]
       attr_accessor :zone
 
+      # The list of access controls for service accounts.
+      #
+      # @return [Array]
+      attr_accessor :service_accounts
+      alias_method :scopes, :service_accounts
+      alias_method :scopes=, :service_accounts=
+
       def initialize(zone_specific=false)
         @google_client_email = UNSET_VALUE
         @google_key_location = UNSET_VALUE
@@ -130,8 +152,12 @@ module VagrantPlugins
         @can_ip_forward      = UNSET_VALUE
         @external_ip         = UNSET_VALUE
         @autodelete_disk     = UNSET_VALUE
+        @preemptible         = UNSET_VALUE
+        @auto_restart        = UNSET_VALUE
+        @on_host_maintenance = UNSET_VALUE
         @instance_ready_timeout = UNSET_VALUE
         @zone                = UNSET_VALUE
+        @service_accounts    = UNSET_VALUE
 
         # Internal state (prefix with __ so they aren't automatically
         # merged)
@@ -225,9 +251,10 @@ module VagrantPlugins
         @disk_type = "pd-standard" if @disk_type == UNSET_VALUE
 
         # Instance name defaults to a new datetime value (hour granularity)
-        t = Time.now
-        @name = "i-#{t.year}#{t.month.to_s.rjust(2,'0')}#{t.day.to_s.rjust(2,'0')}#{t.hour.to_s.rjust(2,'0')}" if @name == UNSET_VALUE
-
+        if @name == UNSET_VALUE
+          t = Time.now
+          @name = "i-#{t.strftime("%Y%m%d%H")}-" + SecureRandom.hex(4)
+        end
         # Network defaults to 'default'
         @network = "default" if @network == UNSET_VALUE
 
@@ -243,9 +270,21 @@ module VagrantPlugins
         # external_ip defaults to nil
         @external_ip = nil if @external_ip == UNSET_VALUE
 
+        # preemptible defaults to false
+        @preemptible = false if @preemptible == UNSET_VALUE
+
+        # auto_restart defaults to true
+        @auto_restart = true if @auto_restart == UNSET_VALUE
+
+        # on_host_maintenance defaults to MIGRATE
+        @on_host_maintenance = "MIGRATE" if @on_host_maintenance == UNSET_VALUE
+
         # Default instance_ready_timeout
         @instance_ready_timeout = 20 if @instance_ready_timeout == UNSET_VALUE
 
+        # Default service_accounts
+        @service_accounts = nil if @service_accounts == UNSET_VALUE
+
         # Compile our zone specific configurations only within
         # NON-zone-SPECIFIC configurations.
         if !@__zone_specific
@@ -288,6 +327,12 @@ module VagrantPlugins
           errors << I18n.t("vagrant_google.config.google_key_location_required") if \
             config.google_key_location.nil? and config.google_json_key_location.nil?
 
+          if config.preemptible
+            errors << I18n.t("vagrant_google.config.auto_restart_invalid_on_preemptible") if \
+             config.auto_restart
+            errors << I18n.t("vagrant_google.config.on_host_maintenance_invalid_on_preemptible") unless \
+             config.on_host_maintenance == "TERMINATE"
+          end
         end
 
         errors << I18n.t("vagrant_google.config.image_required") if config.image.nil?

data/lib/vagrant-google/errors.rb

@@ -20,11 +20,7 @@ module VagrantPlugins
         error_namespace("vagrant_google.errors")
       end
 
-      class ExternalIpError < VagrantGoogleError
-        error_key(:external_ip_error)
-      end
-
-      class DiskTypeError <VagrantGoogleError
+      class DiskTypeError < VagrantGoogleError
         error_key(:disk_type_error)
       end
 
@@ -32,6 +28,18 @@ module VagrantPlugins
         error_key(:fog_error)
       end
 
+      class ExternalIpInUseError < VagrantGoogleError
+        error_key(:external_ip_error)
+      end
+
+      class ExternalIpDoesNotExistError < VagrantGoogleError
+        error_key(:external_ip_does_not_exist_error)
+      end
+
+      class InstanceReadyTimeout < VagrantGoogleError
+        error_key(:instance_ready_timeout)
+      end
+
       class RsyncError < VagrantGoogleError
         error_key(:rsync_error)
       end

data/lib/vagrant-google/version.rb

@@ -13,6 +13,6 @@
 # limitations under the License.
 module VagrantPlugins
   module Google
-    VERSION = "0.1.5"
+    VERSION = "0.2.0.rc1"
   end
 end

data/lib/vagrant-google.rb

@@ -1,11 +1,11 @@
 # Copyright 2013 Google Inc. All Rights Reserved.
-# 
+#
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

data/locales/en.yml

@@ -2,6 +2,8 @@ en:
   vagrant_google:
     already_created: |-
       The machine is already created.
+    already_status: |-
+      The machine is already in %{status} status.
     launching_instance: |-
       Launching an instance with the following settings...
     not_created: |-
@@ -15,16 +17,30 @@ en:
       Make sure rsync is installed and the binary can be found in the PATH.
     rsync_folder: |-
       Rsyncing folder: %{hostpath} => %{guestpath}
+    starting: |-
+      Starting the instance...
+    stopping: |-
+      Stopping the instance...
     terminating: |-
       Terminating the instance...
     waiting_for_ready: |-
       Waiting for instance to become "ready"...
+    waiting_for_stop: |-
+      Waiting for instance to become terminated...
     waiting_for_ssh: |-
       Waiting for SSH to become available...
     warn_networks: |-
       Warning! The Google provider doesn't support any of the Vagrant
       high-level network configurations (`config.vm.network`). They
       will be silently ignored.
+    warn_ssh_vagrant_user: |-
+      Warning! SSH credentials are not set (`ssh.username`, `ssh.private_key`).
+      Unless Vagrant's default insecure private key is added to GCE metadata,
+      "vagrant up" will timeout while trying to estabilish an ssh connection
+      to the instance.
+      NOTE! Adding Vagrant private key to GCE metadata is heavily discouraged,
+      since it potentially allows anyone to connect to your instances,
+      including those not managed by Vagrant.
     will_not_destroy: |-
       The instance '%{name}' will not be destroyed, since the confirmation
       was declined.
@@ -50,6 +66,11 @@ en:
         Config must specify only one key location.
       google_project_id_required: |-
         A Google Cloud Project ID is required via "google_project_id"
+      auto_restart_invalid_on_preemptible: |-
+        "auto_restart" option must be set to "false" for preemptible instances.
+      on_host_maintenance_invalid_on_preemptible: |-
+        "on_host_maintenance" option must be set to "TERMINATE" for preemptible
+        instances.
 #-------------------------------------------------------------------------------
 # Translations for exception classes
 #-------------------------------------------------------------------------------
@@ -72,7 +93,10 @@ en:
         Guest path: %{guestpath}
         Error: %{stderr}
       external_ip_error: |-
-        Specified external IP address is invalid or already in use.
+        Specified external IP address is already in use.
+        IP address requested: %{externalip}
+      external_ip_does_not_exist_error: |-
+        Specified external IP address is invalid or does not exist.
         IP address requested: %{externalip}
       disk_type_error: |-
         Specified disk type is not available in the region selected.
@@ -98,6 +122,12 @@ en:
         Resources have been acquired and the instance is being prepared for
         launch and should be in the RUNNING state soon.
 
+      short_STOPPING: |-
+        stopping
+      long_STOPPING: |-
+        The GCE instance is stopping. Wait until is completely stopped to
+        run `vagrant up` and start it.
+
       short_RUNNING: |-
         running
       long_RUNNING: |-
@@ -114,6 +144,5 @@ en:
       short_TERMINATED: |-
         terminated
       long_TERMINATED: |-
-        The Google instance failed for some reason or was shutdown.  This is
-        a permanent status, and the only way to repair the instance is to
-        delete it with `vagrant destroy`.
+        The Google instance was halted or failed for some reason. You can
+        attempt to restart the instance by running `vagrant up`.

data/tasks/acceptance.rake

@@ -1,3 +1,17 @@
+def colorize(text, color_code)
+  puts "\033[#{color_code}m#{text}\033[0m"
+end
+
+{
+  :red      => 31,
+  :green    => 32,
+  :yellow   => 33
+}.each do |key, color_code|
+  define_method key do |text|
+    colorize(text, color_code)
+  end
+end
+
 namespace :acceptance do
 
   desc "shows components that can be tested separately"
@@ -8,7 +22,7 @@ namespace :acceptance do
   desc "runs acceptance tests using vagrant-spec"
   task :run do
 
-    puts "NOTE: For acceptance tests to be functional, correct ssh key needs to be added to GCE metadata."
+    yellow "NOTE: For acceptance tests to be functional, correct ssh key needs to be added to GCE metadata."
 
     if !ENV["GOOGLE_JSON_KEY_LOCATION"] && !ENV["GOOGLE_KEY_LOCATION"]
       abort ("Environment variables GOOGLE_JSON_KEY_LOCATION or GOOGLE_KEY_LOCATION are not set. Aborting.")
@@ -27,7 +41,12 @@ namespace :acceptance do
     end
 
     components = %w(
+      multi_instance
+      preemptible
+      scopes
+      synced_folder/rsync
       provisioner/shell
+      provisioner/chef-solo
     ).map{ |s| "provider/google/#{s}" }
 
     command = "bundle exec vagrant-spec test --components=#{components.join(" ")}"

data/tasks/lint.rake

@@ -0,0 +1,3 @@
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:lint)

data/tasks/test.rake

@@ -4,5 +4,6 @@ require 'rspec/core/rake_task'
 namespace :test do
   RSpec::Core::RakeTask.new(:unit) do |t|
     t.pattern = "test/unit/**/*_test.rb"
+    t.rspec_opts = "--color"
   end
 end

data/test/acceptance/provider/multi_instance_spec.rb

@@ -0,0 +1,31 @@
+# This tests that multiple instances can be brought up correctly
+shared_examples 'provider/multi_instance' do |provider, options|
+  if !options[:box]
+    raise ArgumentError,
+          "box option must be specified for provider: #{provider}"
+  end
+
+  include_context 'acceptance'
+
+  before do
+    environment.skeleton('multi_instance')
+    assert_execute('vagrant', 'box', 'add', 'basic', options[:box])
+    assert_execute('vagrant', 'up', "--provider=#{provider}")
+  end
+
+  after do
+    assert_execute('vagrant', 'destroy', '--force')
+  end
+
+  it 'should bring up 2 machines in different zones' do
+    status("Test: both machines are running after up")
+    status("Test: machine1 is running after up")
+    result1 = execute("vagrant", "ssh", "z1a", "-c", "echo foo")
+    expect(result1).to exit_with(0)
+    expect(result1.stdout).to match(/foo\n$/)
+    status("Test: machine2 is running after up")
+    result1 = execute("vagrant", "ssh", "z1b", "-c", "echo foo")
+    expect(result1).to exit_with(0)
+    expect(result1.stdout).to match(/foo\n$/)
+  end
+end

data/test/acceptance/provider/preemptible_spec.rb

@@ -0,0 +1,26 @@
+# This tests that a preemptible instance can be brought up correctly
+shared_examples 'provider/preemptible' do |provider, options|
+  if !options[:box]
+    raise ArgumentError,
+          "box option must be specified for provider: #{provider}"
+  end
+
+  include_context 'acceptance'
+
+  before do
+    environment.skeleton('preemptible')
+    assert_execute('vagrant', 'box', 'add', 'basic', options[:box])
+    assert_execute('vagrant', 'up', "--provider=#{provider}")
+  end
+
+  after do
+    assert_execute('vagrant', 'destroy', '--force')
+  end
+
+  it 'should bring up machine with preemptible option' do
+    status("Test: machine is running after up")
+    result = execute("vagrant", "ssh", "-c", "echo foo")
+    expect(result).to exit_with(0)
+    expect(result.stdout).to match(/foo\n$/)
+  end
+end