vagrant-skytap 0.1.1a

data/lib/vagrant-skytap/util/ip_address.rb

@@ -0,0 +1,69 @@
+module VagrantPlugins
+  module Skytap
+    module Util
+      class IpAddress
+        class InvalidIp < RuntimeError; end
+        IP_REGEX = /^(0[0-7]*|0[x][0-9a-f]+|[1-9][0-9]*)\.(0[0-7]*|0[x][0-9a-f]+|[1-9][0-9]*)\.(0[0-7]*|0[x][0-9a-f]+|[1-9][0-9]*)\.(0[0-7]*|0[x][0-9a-f]+|[1-9][0-9]*)$/i
+        MAX_IP4_INT = 2**32 - 1
+
+        class << self
+          def str_to_int(str)
+            raise InvalidIp.new("'#{str}' does not look like an IP") unless str =~ IP_REGEX
+            bytes = [Integer($1), Integer($2), Integer($3), Integer($4)]
+            raise InvalidIp.new("'#{str}' octet exceeds 255") if bytes.any?{|b| b > 255}
+            bytes.zip([24, 16, 8, 0]).collect{|n,shift| n << shift}.inject(&:+)
+          end
+          def int_to_str(i)
+            raise InvalidIp.new("#{i} exceeds maximum IPv4 address") if i > MAX_IP4_INT
+            [24, 16, 8, 0].collect{|shift| (i & (255 << shift)) >> shift}.join('.')
+          end
+        end
+
+        def initialize(str_or_int)
+          if str_or_int.is_a?(String)
+            @i = self.class.str_to_int(str_or_int)
+          elsif str_or_int.is_a?(Integer)
+            raise InvalidIp.new("IP #{str_or_int} is greater than the maximum IPv4 value") if str_or_int > MAX_IP4_INT
+            raise InvalidIp.new("IP value must be non-negative")  if str_or_int < 0
+            @i = str_or_int
+          else
+            raise InvalidIp.new("Don't know how to make an IP out of #{str_or_int}")
+          end
+        end
+
+        def to_i
+          @i
+        end
+
+        def to_s
+          self.class.int_to_str(@i)
+        end
+
+        MAX_IP4 = self.new(MAX_IP4_INT)
+
+        # IpAddress arithmetic ops result in new IP addresses
+        [:+, :-, :&, :|, :<<, :>>].each do |name|
+          define_method(name) do |other|
+            IpAddress.new(@i.send(name, other.to_i))
+          end
+        end
+
+        # IpAddress comparisons just proxy to the .to_i value
+        [:==, :<, :>, :>=, :<=, :<=>].each do |name|
+          define_method(name) do |other|
+            @i.send(name, other.to_i)
+          end
+        end
+
+        def inverse
+          MAX_IP4 - self
+        end
+        alias_method :~, :inverse
+
+        def succ
+          self + 1
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-skytap/util/subnet.rb

@@ -0,0 +1,97 @@
+require_relative 'ip_address'
+
+module VagrantPlugins
+  module Skytap
+    module Util
+      class Subnet
+        class InvalidSubnet < RuntimeError ; end
+
+        attr_reader :size, :mask, :address
+
+        def initialize(cidr_block)
+          unless cidr_block =~ /^(.*)\/(.*)/
+            raise InvalidSubnet.new 'Not in CIDR block form (XX.XX.XX.XX/YY)'
+          end
+
+          network = $1
+          begin
+            @size = Integer($2)
+          rescue
+            raise InvalidSubnet.new 'Invalid size'
+          end
+
+          @address = IpAddress.new(network)
+          @mask = size_to_mask(@size)
+        end
+
+        def network_portion
+          @network_portion ||= (mask & address)
+        end
+        alias_method :min, :network_portion
+
+        def ==(other)
+          other.is_a?(Subnet) && \
+          (size == other.size) && \
+          network_portion == other.network_portion
+        end
+
+        def overlaps?(other)
+          min <= other.max && max >= other.min
+        end
+
+        def subsumes?(other)
+          min <= other.min && max >= other.max
+        end
+
+        def strictly_subsumes?(other)
+          subsumes?(other) && self != other
+        end
+
+        def max
+          @max ||= (mask.inverse | network_portion)
+        end
+
+        def each_address
+          (min.to_i..max.to_i).each{|i| yield IpAddress.new(i)}
+        end
+
+        def contains?(ip)
+          ip = IpAddress.new(ip) unless ip.is_a?(IpAddress)
+          (ip & mask) == network_portion
+        end
+
+        def num_addresses
+          2 ** (32-size)
+        end
+
+        def min_machine_ip
+          min + 1
+        end
+
+        def normalized?
+          address == network_portion
+        end
+
+        def normalize
+          Subnet.new("#{network_portion}/#{size}")
+        end
+
+        def to_s
+          "#{address}/#{size}"
+        end
+
+        def <=>(other)
+          to_s <=> other.to_s
+        end
+
+        private
+
+        def size_to_mask(numbits)
+          raise InvalidSubnet.new("Subnet size in bits must be between 0 and 32") unless numbits >= 0 and numbits <= 32
+          IpAddress.new((2**numbits - 1) << (32 - numbits))
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module Skytap
+    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-skytap/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Skytap
+    VERSION = "0.1.1a"
+  end
+end

data/lib/vagrant-skytap/version.rb.orig

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Skytap
+    VERSION = "0.0.6"
+  end
+end

data/lib/vagrant-skytap/vm_properties.rb

@@ -0,0 +1,22 @@
+require 'vagrant-skytap/properties'
+
+module VagrantPlugins
+  module Skytap
+    class VmProperties < Properties
+      def self.filename
+        'vm'
+      end
+
+      def ssh_info
+        return {} unless properties
+
+        @ssh_info ||= {
+          username: properties['username'],
+          password: properties['password'],
+          host: properties['host'],
+          port: properties['port'],
+        }
+      end
+    end
+  end
+end

data/lib/vagrant-skytap.rb

@@ -0,0 +1,23 @@
+# TODO:NLA To add the box initially:
+# $ bundle exec vagrant box add skytap-dummy.box --provider=skytap --name=skytap-dummy
+require "pathname"
+
+require "vagrant-skytap/core_ext/object/blank"
+require "vagrant-skytap/core_ext/object/tap"
+require "vagrant-skytap/core_ext/try"
+require "vagrant-skytap/plugin"
+
+module VagrantPlugins
+  module Skytap
+    lib_path = Pathname.new(File.expand_path("../vagrant-skytap", __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

data/locales/en.yml

@@ -0,0 +1,127 @@
+en:
+  vagrant_skytap:
+    already_status: |-
+      The machine is already %{status}.
+
+    launching_instance: |-
+      Launching an instance with the following settings...
+    launching_vm: |-
+      Launching a VM with the following settings...
+    not_created: |-
+      Instance is not created. Please run `vagrant up` first.
+    ready: |-
+      Machine is booted and ready for use!
+    rsync_not_found_warning: |-
+      Warning! Folder sync disabled because the rsync binary is missing in the %{side}.
+      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_ssh: |-
+      Waiting for SSH to become available...
+    warn_networks: |-
+      Warning! The Skytap provider doesn't support any of the Vagrant
+      high-level network configurations (`config.vm.network`). They
+      will be silently ignored.
+    warn_ssh_access: |-
+      Warning! Vagrant might not be able to SSH into the instance.
+      Please check your security groups settings.
+    will_not_destroy: |-
+      The instance '%{name}' will not be destroyed, since the confirmation
+      was declined.
+    environment_url: |-
+      New Skytap environment created: %{url}
+    graceful_halt_environment_failed: |-
+      The environment could not be halted gracefully. Forcing halt.
+    graceful_halt_vm_failed: |-
+      The VM could not be halted gracefully. Forcing halt.
+
+    config:
+      username_required:
+        A Skytap username must be specified via "username" or in the
+        VAGRANT_SKYTAP_USERNAME environment variable.
+      api_token_required:
+        A Skytap API token must be specified via "api_token" or in the
+        VAGRANT_SKYTAP_API_TOKEN environment variable.
+      vm_url_required:
+        The URL of a Skytap VM must be specified via "vm_url"
+
+    errors:
+      instance_ready_timeout: |-
+        The instance never became "ready" in Skytap. 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 Skytap provider.
+      rsync_error: |-
+        There was an error when attempting to rsync a shared folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+      mkdir_error: |-
+        There was an error when attempting to create a shared host folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Error: %{err}
+
+      does_not_exist: |-
+        %{object_name} was not found.
+
+      operation_failed: |-
+        The operation failed: %{err}
+
+      vpn_connection_failed: |-
+        Could not connect to the VPN.
+
+      source_vm_not_stopped: |-
+        You cannot bring up the machine '%{name}' using the VM %{url} because the VM is running or suspended.
+
+      resource_busy: |-
+        This operation failed because the resource was busy: %{err}
+
+      rate_limited: |-
+        This operation failed due to rate limiting: %{err}
+
+      unprocessable_entity: |-
+        The operation failed: %{err}
+
+      no_connection_options: |-
+        There were no available options for connecting to the VM.
+        Currently, the provider supports connections over VPN only.
+
+    states:
+      short_not_created: |-
+        not created
+      long_not_created: |-
+        The Skytap instance is not created. Run `vagrant up` to create it.
+
+      short_stopped: |-
+        stopped
+      long_stopped: |-
+        The Skytap instance is stopped. Run `vagrant up` to start it.
+
+      short_suspended: |-
+        suspended
+      long_suspended: |-
+        The Skytap instance is suspended. Run `vagrant up` or `vagrant resume` to resume.
+
+      short_running: |-
+        running
+      long_running: |-
+        The Skytap instance is running. To stop this machine, you can run
+        `vagrant halt`. To destroy the machine, you can run `vagrant destroy`.
+
+      short_busy: |-
+        busy
+      long_busy: |-
+        The Skytap instance is busy. Wait for the current operation to complete.
+

data/spec/acceptance/base.rb

@@ -0,0 +1,2 @@
+require "vagrant-spec/acceptance"
+require_relative "shared/context_skytap"

data/spec/acceptance/provider/halt_spec.rb

@@ -0,0 +1,3 @@
+shared_examples 'provider/halt' do |provider, options|
+
+end

data/spec/acceptance/shared/context_skytap.rb

@@ -0,0 +1,3 @@
+shared_context "provider-context/skytap" do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+

data/spec/support/isolated_environment.rb

@@ -0,0 +1,45 @@
+require "fileutils"
+require "pathname"
+require "tmpdir"
+
+require "log4r"
+
+# This class manages an isolated environment for Vagrant to
+# run in. It creates a temporary directory to act as the
+# working directory as well as sets a custom home directory.
+#
+# This class also provides various helpers to create Vagrantfiles,
+# boxes, etc.
+class IsolatedEnvironment
+  attr_reader :homedir
+  attr_reader :workdir
+
+  # Initializes an isolated environment. You can pass in some
+  # options here to configure runing custom applications in place
+  # of others as well as specifying environmental variables.
+  #
+  # @param [Hash] apps A mapping of application name (such as "vagrant")
+  #   to an alternate full path to the binary to run.
+  # @param [Hash] env Additional environmental variables to inject
+  #   into the execution environments.
+  def initialize
+    @logger = Log4r::Logger.new("test::isolated_environment")
+
+    # Create a temporary directory for our work
+    @tempdir = Dir.mktmpdir("vagrant")
+    @logger.info("Initialize isolated environment: #{@tempdir}")
+
+    # Setup the home and working directories
+    @homedir = Pathname.new(File.join(@tempdir, "home"))
+    @workdir = Pathname.new(File.join(@tempdir, "work"))
+
+    @homedir.mkdir
+    @workdir.mkdir
+  end
+
+  # This closes the environment by cleaning it up.
+  def close
+    @logger.info("Removing isolated environment: #{@tempdir}")
+    FileUtils.rm_rf(@tempdir)
+  end
+end

data/spec/unit/base.rb

@@ -0,0 +1,57 @@
+require "tmpdir"
+require "rubygems"
+
+# Gems
+require "checkpoint"
+require "rspec/autorun"
+require "webmock/rspec"
+
+# Require Vagrant itself so we can reference the proper
+# classes to test.
+require "vagrant"
+require "vagrant/util/platform"
+
+# Add the test directory to the load path
+$:.unshift File.expand_path("../../", __FILE__)
+
+# Load in helpers
+require "unit/support/dummy_communicator"
+require "unit/support/dummy_provider"
+require "unit/support/shared/base_context"
+require "unit/support/shared/action_synced_folders_context"
+require "unit/support/shared/capability_helpers_context"
+require "unit/support/shared/plugin_command_context"
+require "unit/support/shared/skytap_context"
+
+# Do not buffer output
+$stdout.sync = true
+$stderr.sync = true
+
+# Configure RSpec
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+
+  if Vagrant::Util::Platform.windows?
+    c.filter_run_excluding :skip_windows
+  else
+    c.filter_run_excluding :windows
+  end
+end
+
+# Configure VAGRANT_CWD so that the tests never find an actual
+# Vagrantfile anywhere, or at least this minimizes those chances.
+ENV["VAGRANT_CWD"] = Dir.mktmpdir("vagrant")
+
+# Set the dummy provider to the default for tests
+ENV["VAGRANT_DEFAULT_PROVIDER"] = "dummy"
+
+# Unset all host plugins so that we aren't executing subprocess things
+# to detect a host for every test.
+Vagrant.plugin("2").manager.registered.dup.each do |plugin|
+  if plugin.components.hosts.to_hash.length > 0
+    Vagrant.plugin("2").manager.unregister(plugin)
+  end
+end
+
+# Disable checkpoint
+Checkpoint.disable!

data/spec/unit/config_spec.rb

@@ -0,0 +1,73 @@
+require "vagrant-skytap/config"
+
+describe VagrantPlugins::Skytap::Config do
+  let(:instance) { described_class.new }
+
+  # Ensure tests are not affected by Skytap credential environment variables
+  before :each do
+    ENV.stub(:[] => nil)
+  end
+
+  describe "defaults" do
+    subject do
+      instance.tap do |o|
+        o.finalize!
+      end
+    end
+
+    its("username")               { should be_nil }
+    its("api_token")              { should be_nil }
+    its("base_url")               { should == "https://cloud.skytap.com/" }
+    its("vm_url")                 { should be_nil }
+    its("instance_ready_timeout") { should == 120 }
+    its("cpus")                   { should be_nil }
+    its("cpuspersocket")          { should be_nil }
+    its("ram")                    { should be_nil }
+    its("guestos")                { should be_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.
+    [:username, :api_token, :base_url, :vm_url,
+      :instance_ready_timeout,
+      :cpus, :cpuspersocket, :ram, :guestos].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 Skytap credential environment variables" do
+      subject do
+        instance.tap do |o|
+          o.finalize!
+        end
+      end
+
+      its("username")  { should be_nil }
+      its("api_token") { should be_nil }
+    end
+
+    context "with Skytap credential environment variables" do
+      before :each do
+        ENV.stub(:[]).with("VAGRANT_SKYTAP_USERNAME").and_return("username")
+        ENV.stub(:[]).with("VAGRANT_SKYTAP_API_TOKEN").and_return("api_token")
+      end
+
+      subject do
+        instance.tap do |o|
+          o.finalize!
+        end
+      end
+
+      its("username")  { should == "username" }
+      its("api_token") { should == "api_token" }
+    end
+  end
+end