vagrant-google 0.1.3

data/lib/vagrant-google/action.rb

@@ -0,0 +1,140 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module Google
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # 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
+            else
+              b2.use MessageWillNotDestroy
+            end
+          end
+        end
+      end
+
+      # This action is called when `vagrant provision` is called.
+      def self.action_provision
+        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 Provision
+            b2.use SyncFolders
+          end
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectGoogle
+          b.use ReadSSHInfo
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectGoogle
+          b.use ReadState
+        end
+      end
+
+      # This action is called to SSH into the machine.
+      def self.action_ssh
+        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 SSHExec
+          end
+        end
+      end
+
+      def self.action_ssh_run
+        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 SSHRun
+          end
+        end
+      end
+
+      # This action is called to bring the box up from nothing.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use HandleBoxUrl
+          b.use ConfigValidate
+          b.use ConnectGoogle
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use MessageAlreadyCreated
+              next
+            end
+
+            b2.use Provision
+            b2.use SyncFolders
+            b2.use WarnNetworks
+            b2.use RunInstance
+          end
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectGoogle, action_root.join("connect_google")
+      autoload :IsCreated, action_root.join("is_created")
+      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 :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

@@ -0,0 +1,241 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require "vagrant"
+
+module VagrantPlugins
+  module Google
+    class Config < Vagrant.plugin("2", :config)
+      # The Service Account Client ID Email address
+      #
+      # @return [String]
+      attr_accessor :google_client_email
+
+      # The path to the Service Account private key
+      #
+      # @return [String]
+      attr_accessor :google_key_location
+
+      # The Google Cloud Project ID (not name or number)
+      #
+      # @return [String]
+      attr_accessor :google_project_id
+
+      # The image name of the instance to use.
+      #
+      # @return [String]
+      attr_accessor :image
+
+      # The type of machine to launch, such as "n1-standard-1"
+      #
+      # @return [String]
+      attr_accessor :machine_type
+
+      # The user metadata string
+      #
+      # @return [Hash<String, String>]
+      attr_accessor :metadata
+
+      # The name of the instance
+      #
+      # @return [String]
+      attr_accessor :name
+
+      # The name of the network
+      #
+      # @return [String]
+      attr_accessor :network
+
+      # 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-a.
+      #
+      # @return [String]
+      attr_accessor :zone
+
+      def initialize(zone_specific=false)
+        @google_client_email = UNSET_VALUE
+        @google_key_location = UNSET_VALUE
+        @google_project_id   = UNSET_VALUE
+        @image               = UNSET_VALUE
+        @machine_type        = UNSET_VALUE
+        @metadata            = {}
+        @name                = UNSET_VALUE
+        @network             = UNSET_VALUE
+        @instance_ready_timeout = UNSET_VALUE
+        @zone                = UNSET_VALUE
+
+        # Internal state (prefix with __ so they aren't automatically
+        # merged)
+        @__compiled_zone_configs = {}
+        @__finalized = false
+        @__zone_config = {}
+        @__zone_specific = zone_specific
+      end
+
+      # Allows zone-specific overrides of any of the settings on this
+      # configuration object. This allows the user to override things like
+      # image and machine type name for zones. Example:
+      #
+      #     google.zone_config "us-central1-a" do |zone|
+      #       zone.image = "debian-7-wheezy-v20140619"
+      #       zone.machine_type = "n1-standard-4"
+      #     end
+      #
+      # @param [String] zone The zone name to configure.
+      # @param [Hash] attributes Direct attributes to set on the configuration
+      #   as a shortcut instead of specifying a full block.
+      # @yield [config] Yields a new Google configuration.
+      def zone_config(zone, attributes=nil, &block)
+        # Append the block to the list of zone configs for that zone.
+        # We'll evaluate these upon finalization.
+        @__zone_config[zone] ||= []
+
+        # Append a block that sets attributes if we got one
+        if attributes
+          attr_block = lambda do |config|
+            config.set_options(attributes)
+          end
+
+          @__zone_config[zone] << attr_block
+        end
+
+        # Append a block if we got one
+        @__zone_config[zone] << block if block_given?
+      end
+
+      #-------------------------------------------------------------------
+      # Internal methods.
+      #-------------------------------------------------------------------
+
+      def merge(other)
+        super.tap do |result|
+          # Copy over the zone specific flag. "True" is retained if either
+          # has it.
+          new_zone_specific = other.instance_variable_get(:@__zone_specific)
+          result.instance_variable_set(
+            :@__zone_specific, new_zone_specific || @__zone_specific)
+
+          # Go through all the zone configs and prepend ours onto
+          # theirs.
+          new_zone_config = other.instance_variable_get(:@__zone_config)
+          @__zone_config.each do |key, value|
+            new_zone_config[key] ||= []
+            new_zone_config[key] = value + new_zone_config[key]
+          end
+
+          # Set it
+          result.instance_variable_set(:@__zone_config, new_zone_config)
+
+          # Merge in the metadata
+          result.metadata.merge!(self.metadata)
+          result.metadata.merge!(other.metadata)
+        end
+      end
+
+      def finalize!
+        # Try to get access keys from standard Google environment variables; they
+        # will default to nil if the environment variables are not present.
+        @google_client_email = ENV['GOOGLE_CLIENT_EMAIL'] if @google_client_email == UNSET_VALUE
+        @google_key_location = ENV['GOOGLE_KEY_LOCATION'] if @google_key_location == UNSET_VALUE
+        @google_project_id   = ENV['GOOGLE_PROJECT_ID'] if @google_project_id == UNSET_VALUE
+
+        # Image must be nil, since we can't default that
+        @image = "debian-7-wheezy-v20140619" if @image == UNSET_VALUE
+
+        # Default instance type is an n1-standard-1
+        @machine_type = "n1-standard-1" if @machine_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
+
+        # Network defaults to 'default'
+        @network = "default" if @network == UNSET_VALUE
+
+        # Default zone is us-central1-a.
+        @zone = "us-central1-a" if @zone == UNSET_VALUE
+
+        # Default instance_ready_timeout
+        @instance_ready_timeout = 20 if @instance_ready_timeout == UNSET_VALUE
+
+        # Compile our zone specific configurations only within
+        # NON-zone-SPECIFIC configurations.
+        if !@__zone_specific
+          @__zone_config.each do |zone, blocks|
+            config = self.class.new(true).merge(self)
+
+            # Execute the configuration for each block
+            blocks.each { |b| b.call(config) }
+
+            # The zone name of the configuration always equals the
+            # zone config name:
+            config.zone = zone
+
+            # Finalize the configuration
+            config.finalize!
+
+            # Store it for retrieval
+            @__compiled_zone_configs[zone] = config
+          end
+        end
+
+        # Mark that we finalized
+        @__finalized = true
+      end
+
+      def validate(machine)
+        errors = _detected_errors
+
+        errors << I18n.t("vagrant_google.config.zone_required") if @zone.nil?
+
+        if @zone
+          config = get_zone_config(@zone)
+
+          errors << I18n.t("vagrant_google.config.google_project_id_required") if \
+            config.google_project_id.nil?
+          errors << I18n.t("vagrant_google.config.google_client_email_required") if \
+            config.google_client_email.nil?
+          errors << I18n.t("vagrant_google.config.google_key_location_required") if \
+            config.google_key_location.nil?
+        end
+
+        errors << I18n.t("vagrant_google.config.image_required") if config.image.nil?
+        errors << I18n.t("vagrant_google.config.name_required") if @name.nil?
+
+        { "Google Provider" => errors }
+      end
+
+      # This gets the configuration for a specific zone. It shouldn't
+      # be called by the general public and is only used internally.
+      def get_zone_config(name)
+        if !@__finalized
+          raise "Configuration must be finalized before calling this method."
+        end
+
+        # Return the compiled zone config
+        @__compiled_zone_configs[name] || self
+      end
+    end
+  end
+end

data/lib/vagrant-google/errors.rb

@@ -0,0 +1,32 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require "vagrant"
+
+module VagrantPlugins
+  module Google
+    module Errors
+      class VagrantGoogleError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_google.errors")
+      end
+
+      class FogError < VagrantGoogleError
+        error_key(:fog_error)
+      end
+
+      class RsyncError < VagrantGoogleError
+        error_key(:rsync_error)
+      end
+    end
+  end
+end

data/lib/vagrant-google/plugin.rb

@@ -0,0 +1,86 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant Google plugin must be run within Vagrant."
+end
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < "1.2.0"
+  raise "The Vagrant Google plugin is only compatible with Vagrant 1.2+"
+end
+
+module VagrantPlugins
+  module Google
+    class Plugin < Vagrant.plugin("2")
+      name "Google"
+      description <<-DESC
+      This plugin installs a provider that allows Vagrant to manage
+      Google Compute Engine instances.
+      DESC
+
+      config(:google, :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider(:google, parallel: true) do
+        # Setup logging and i18n
+        setup_logging
+        setup_i18n
+
+        # Return the provider
+        require_relative "provider"
+        Provider
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", Google.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require "log4r"
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV["VAGRANT_LOG"].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new("vagrant_google")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-google/provider.rb

@@ -0,0 +1,63 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+require "log4r"
+require "vagrant"
+
+module VagrantPlugins
+  module Google
+    class Provider < Vagrant.plugin("2", :provider)
+      def initialize(machine)
+        @machine = machine
+      end
+
+      def action(name)
+        # Attempt to get the action method from the Action class if it
+        # exists, otherwise return nil to show that we don't support the
+        # given action.
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+        nil
+      end
+
+      def ssh_info
+        # Run a custom action called "read_ssh_info" which does what it
+        # says and puts the resulting SSH info into the `:machine_ssh_info`
+        # key in the environment.
+        env = @machine.action("read_ssh_info")
+        env[:machine_ssh_info]
+      end
+
+      def state
+        # Run a custom action we define called "read_state" which does
+        # what it says. It puts the state in the `:machine_state_id`
+        # key in the environment.
+        env = @machine.action("read_state")
+
+        state_id = env[:machine_state_id]
+
+        # Get the short and long description
+        short = I18n.t("vagrant_google.states.short_#{state_id}")
+        long  = I18n.t("vagrant_google.states.long_#{state_id}")
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        id = @machine.id.nil? ? "new" : @machine.id
+        "Google (#{id})"
+      end
+    end
+  end
+end

data/lib/vagrant-google/util/timer.rb

@@ -0,0 +1,30 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+module VagrantPlugins
+  module Google
+    module Util
+      class Timer
+        # A basic utility method that times the execution of the given
+        # block and returns it.
+        def self.time
+          start_time = Time.now.to_f
+          yield
+          end_time = Time.now.to_f
+
+          end_time - start_time
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-google/version.rb

@@ -0,0 +1,18 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+module VagrantPlugins
+  module Google
+    VERSION = "0.1.3"
+  end
+end

data/lib/vagrant-google.rb

@@ -0,0 +1,31 @@
+# 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.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "pathname"
+require "vagrant-google/plugin"
+
+module VagrantPlugins
+  module Google
+    lib_path = Pathname.new(File.expand_path("../vagrant-google", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end