tcr-vagrant-google 0.1.4

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.4"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,105 @@
+en:
+  vagrant_google:
+    already_created: |-
+      The machine is already created.
+    launching_instance: |-
+      Launching an instance with the following settings...
+    launch_vpc_warning: |-
+      Warning! You're launching this instance into a VPC without an
+      elastic IP. Please verify you're properly connected to a VPN so
+      you can access this machine, otherwise Vagrant will not be able
+      to SSH into it.
+    not_created: |-
+      Instance is not created. Please run `vagrant up` first.
+    ready: |-
+      Machine is booted and ready for use!
+    ready_ssh: |-
+      Machine is ready for SSH access!
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+    terminating: |-
+      Terminating the instance...
+    waiting_for_ready: |-
+      Waiting for instance to become "ready"...
+    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.
+    will_not_destroy: |-
+      The instance '%{name}' will not be destroyed, since the confirmation
+      was declined.
+
+    config:
+      google_client_email_required: |-
+        A Google Service Account client email is required via "google_client_email"
+      machine_required: |-
+        An MACHINE_TYPE must be configured via "machine"
+      private_key_missing: |-
+        The specified private key for Google could not be found
+      zone_required: |-
+        A zone must be specified via "zone"
+      name_required: |-
+        An instance name must be specified via "name"
+      google_key_location_required: |-
+        A private key pathname is required via "google_key_location"
+      google_project_id_required: |-
+        A Google Cloud Project ID is required via "google_project_id"
+
+    errors:
+      fog_error: |-
+        There was an error talking to Google. The error message is shown
+        below:
+
+        %{message}
+      instance_ready_timeout: |-
+        The instance never became "ready" in Google. The timeout currently
+        set waiting for the instance to become ready is %{timeout} seconds.
+        Please verify that the machine properly boots. If you need more time
+        set the `instance_ready_timeout` configuration on the Google provider.
+      rsync_error: |-
+        There was an error when attemping to rsync a share folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+
+    states:
+      short_not_created: |-
+        not created
+      long_not_created: |-
+        The Google instance is not created. Run `vagrant up` to create it.
+
+      short_PROVISIONING: |-
+        provsioning
+      long_PROVISIONING: |-
+        Resources are being reserved for this instance.  This instance is
+        not yet running.
+
+      short_STAGING: |-
+        staging
+      long_STAGING: |-
+        Resources have been acquired and the instance is being prepared for
+        launch and should be in the RUNNING state soon.
+
+      short_RUNNING: |-
+        running
+      long_RUNNING: |-
+        The Google instance is running. To stop this machine, you can run
+        `vagrant halt`. To destroy the machine, you can run `vagrant destroy`.
+
+      short_STOPPED: |-
+        stopped
+      long_STOPPED: |-
+        The Google instance is not currently running, either due to a failure
+        , or the instance is being shut down.  This is a temporary status;
+        the instance will move to either PROVISIONING or TERMINATED.
+
+      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`.

data/spec/vagrant-google/config_spec.rb

@@ -0,0 +1,202 @@
+# 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-google/config"
+
+describe VagrantPlugins::Google::Config do
+  let(:instance) { described_class.new }
+
+  # Ensure tests are not affected by Google credential environment variables
+  before :each do
+    ENV.stub(:[] => nil)
+  end
+
+  describe "defaults" do
+    subject do
+      instance.tap do |o|
+        o.finalize!
+      end
+    end
+    t = Time.now
+
+    its("name")              { should == "i-#{t.year}#{t.month.to_s.rjust(2,'0')}#{t.day.to_s.rjust(2,'0')}#{t.hour.to_s.rjust(2,'0')}" }
+    its("image")             { should == "debian-7-wheezy-v20140926" }
+    its("zone")              { should == "us-central1-f" }
+    its("network")           { should == "default" }
+    its("machine_type")      { should == "n1-standard-1" }
+    its("disk_size")         { should == 10 }
+    its("instance_ready_timeout") { should == 20 }
+    its("metadata")          { should == {} }
+    its("tags")              { should == [] }
+    its("service_accounts")  { should == nil }
+  end
+
+  describe "overriding defaults" do
+    # I typically don't meta-program in tests, but this is a very
+    # simple boilerplate test, so I cut corners here. It just sets
+    # each of these attributes to "foo" in isolation, and reads the value
+    # and asserts the proper result comes back out.
+    [:name, :image, :zone, :instance_ready_timeout, :machine_type, :disk_size,
+      :network, :metadata].each do |attribute|
+
+      it "should not default #{attribute} if overridden" do
+        instance.send("#{attribute}=".to_sym, "foo")
+        instance.finalize!
+        instance.send(attribute).should == "foo"
+      end
+    end
+  end
+
+  describe "getting credentials from environment" do
+    context "without Google credential environment variables" do
+      subject do
+        instance.tap do |o|
+          o.finalize!
+        end
+      end
+
+      its("google_client_email") { should be_nil }
+      its("google_key_location") { should be_nil }
+    end
+
+    context "with Google credential environment variables" do
+      before :each do
+        ENV.stub(:[]).with("GOOGLE_CLIENT_EMAIL").and_return("client_id_email")
+        ENV.stub(:[]).with("GOOGLE_KEY_LOCATION").and_return("/path/to/key")
+      end
+
+      subject do
+        instance.tap do |o|
+          o.finalize!
+        end
+      end
+
+      its("google_client_email") { should == "client_id_email" }
+      its("google_key_location") { should == "/path/to/key" }
+    end
+  end
+
+  describe "zone config" do
+    let(:config_image)           { "foo" }
+    let(:config_machine_type)    { "foo" }
+    let(:config_disk_size)       { 99 }
+    let(:config_name)            { "foo" }
+    let(:config_zone)            { "foo" }
+    let(:config_network)         { "foo" }
+
+    def set_test_values(instance)
+      instance.name              = config_name
+      instance.network           = config_network
+      instance.image             = config_image
+      instance.machine_type      = config_machine_type
+      instance.disk_size         = config_disk_size
+      instance.zone              = config_zone
+    end
+
+    it "should raise an exception if not finalized" do
+      expect { instance.get_zone_config("us-central1-f") }.
+        to raise_error
+    end
+
+    context "with no specific config set" do
+      subject do
+        # Set the values on the top-level object
+        set_test_values(instance)
+
+        # Finalize so we can get the zone config
+        instance.finalize!
+
+        # Get a lower level zone
+        instance.get_zone_config("us-central1-f")
+      end
+
+      its("name")              { should == config_name }
+      its("image")             { should == config_image }
+      its("machine_type")      { should == config_machine_type }
+      its("disk_size")         { should == config_disk_size }
+      its("network")           { should == config_network }
+      its("zone")              { should == config_zone }
+    end
+
+    context "with a specific config set" do
+      let(:zone_name) { "hashi-zone" }
+
+      subject do
+        # Set the values on a specific zone
+        instance.zone_config zone_name do |config|
+          set_test_values(config)
+        end
+
+        # Finalize so we can get the zone config
+        instance.finalize!
+
+        # Get the zone
+        instance.get_zone_config(zone_name)
+      end
+
+      its("name")              { should == config_name }
+      its("image")             { should == config_image }
+      its("machine_type")      { should == config_machine_type }
+      its("disk_size")         { should == config_disk_size }
+      its("network")           { should == config_network }
+      its("zone")              { should == zone_name }
+    end
+
+    describe "inheritance of parent config" do
+      let(:zone) { "hashi-zone" }
+
+      subject do
+        # Set the values on a specific zone
+        instance.zone_config zone do |config|
+          config.image = "child"
+        end
+
+        # Set some top-level values
+        instance.image = "parent"
+
+        # Finalize and get the zone
+        instance.finalize!
+        instance.get_zone_config(zone)
+      end
+
+      its("image")           { should == "child" }
+    end
+
+    describe "shortcut configuration" do
+      subject do
+        # Use the shortcut configuration to set some values
+        instance.zone_config "us-central1-f", :image => "child"
+        instance.finalize!
+        instance.get_zone_config("us-central1-f")
+      end
+
+      its("image") { should == "child" }
+    end
+
+    describe "merging" do
+      let(:first) { described_class.new }
+      let(:second) { described_class.new }
+
+      it "should merge the metadata" do
+        first.metadata["one"] = "foo"
+        second.metadata["two"] = "bar"
+
+        third = first.merge(second)
+        third.metadata.should == {
+          "one" => "foo",
+          "two" => "bar"
+        }
+      end
+    end
+  end
+end