vagrant-fifo 0.2.0

data/lib/vagrant-fifo/action/sync_folders.rb

@@ -0,0 +1,57 @@
+require "log4r"
+
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module Fifo
+    module Action
+      # This middleware uses `rsync` to sync the folders over to the
+      # Fifo instance.
+      class SyncFolders
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_fifo::action::sync_folders")
+        end
+
+        def call(env)
+          @app.call(env)
+
+          ssh_info = env[:machine].ssh_info
+
+          env[:machine].config.vm.synced_folders.each do |id, data|
+            hostpath  = File.expand_path(data[:hostpath], env[:root_path])
+            guestpath = data[:guestpath]
+
+            # Make sure there is a trailing slash on the host path to
+            # avoid creating an additional directory with rsync
+            hostpath = "#{hostpath}/" if hostpath !~ /\/$/
+
+            env[:ui].info(I18n.t("vagrant_fifo.rsync_folder",
+                                :hostpath => hostpath,
+                                :guestpath => guestpath))
+
+            # Create the guest path
+            env[:machine].communicate.sudo("mkdir -p '#{guestpath}'")            
+            env[:machine].communicate.sudo(
+              "chown #{ssh_info[:username]} '#{guestpath}'")
+
+            # Rsync over to the guest path using the SSH info
+            command = [
+              "rsync", "--verbose", "--archive", "-z",
+              "-e", "ssh -o StrictHostKeyChecking=no -p #{ssh_info[:port]} -i '#{ssh_info[:private_key_path]}'",
+              hostpath,
+             "#{ssh_info[:username]}@#{ssh_info[:host]}:#{guestpath}" ]
+
+            r = Vagrant::Util::Subprocess.execute(*command)
+            if r.exit_code != 0
+              raise Errors::RsyncError,
+                :guestpath => guestpath,
+                :hostpath => hostpath,
+                :stderr => r.stderr
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/terminate_instance.rb

@@ -0,0 +1,44 @@
+require "log4r"
+
+module VagrantPlugins
+  module Fifo
+    module Action
+      # This terminates the running instance.
+      class TerminateInstance
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_fifo::action::run_instance")
+        end
+
+        def call(env)
+          server = env[:fifo_compute].vms.get(env[:machine].id)
+
+          # Destroy the server and remove the tracking ID
+          env[:ui].info(I18n.t("vagrant_fifo.terminating"))
+
+          # Machine must be in a stopped state before it's destroyed.
+          #
+          # More info here:
+          #
+          #   https://us-west-1.api.fifocloud.com/docs#DeleteMachine
+          #
+          env[:fifo_compute].vms.delete(server['uuid'])
+
+          # Wait for server to be completely gone from invetory
+          while true do
+            ids = env[:fifo_compute].vms.list
+
+            unless ids.include?(env[:machine].id) then
+              break
+            end
+            sleep 5
+          end
+
+          env[:machine].id = nil
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action/timed_provision.rb

@@ -0,0 +1,21 @@
+require "vagrant-fifo/util/timer"
+
+module VagrantPlugins
+  module Fifo
+    module Action
+      # This is the same as the builtin provision except it times the
+      # provisioner runs.
+      class TimedProvision < Vagrant::Action::Builtin::Provision
+        def run_provisioner(env, name, p)
+          timer = Util::Timer.time do
+            super
+          end
+
+          env[:metrics] ||= {}
+          env[:metrics]["provisioner_times"] ||= []
+          env[:metrics]["provisioner_times"] << [name, timer]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module VagrantPlugins
+  module Fifo
+    module Action
+      class WarnNetworks
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          if env[:machine].config.vm.networks.length > 0
+            env[:ui].warn(I18n.t("vagrant_fifo.warn_networks"))
+          end
+
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/action.rb

@@ -0,0 +1,112 @@
+require "pathname"
+
+require "vagrant/action/builder"
+
+module VagrantPlugins
+  module Fifo
+    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 ConnectFifo
+              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 ConnectFifo
+          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 ConnectFifo
+          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
+
+      # This action is called to bring the box up from nothing.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectFifo
+          b.use Call, IsCreated do |env, b2|
+            if env[:result]
+              b2.use MessageAlreadyCreated
+              next
+            end
+
+            b2.use TimedProvision
+            b2.use SyncFolders
+            b2.use RunInstance
+          end
+        end
+      end
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path("../action", __FILE__))
+      autoload :ConnectFifo, action_root.join("connect_fifo")
+      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 :TerminateInstance, action_root.join("terminate_instance")
+    end
+  end
+end

data/lib/vagrant-fifo/config.rb

@@ -0,0 +1,64 @@
+#: utf-8 -*-
+require "vagrant"
+
+module VagrantPlugins
+  module Fifo
+    class Config < Vagrant.plugin("2", :config)
+      attr_accessor :username
+      attr_accessor :password
+      attr_accessor :api_url
+      attr_accessor :dataset
+      attr_accessor :package
+      attr_accessor :iprange
+      attr_accessor :node_name
+      attr_accessor :ssh_username
+      attr_accessor :ssh_private_key_path
+
+      def initialize(datacenter_specific=false)
+        @username    = UNSET_VALUE
+        @password    = UNSET_VALUE
+        @api_url     = UNSET_VALUE
+        @dataset            = UNSET_VALUE
+        @package            = UNSET_VALUE
+        @iprange            = UNSET_VALUE
+        @node_name          = UNSET_VALUE
+        @ssh_username       = UNSET_VALUE
+        @ssh_private_key_path = UNSET_VALUE
+      end
+
+      #-------------------------------------------------------------------
+      # Internal methods.
+      #-------------------------------------------------------------------
+
+      def finalize!
+        # API
+        @username = nil if @username == UNSET_VALUE
+        @password = nil if @password == UNSET_VALUE
+        @api_url  = nil if @api_url  == UNSET_VALUE
+
+        # Machines
+        @dataset = nil if @dataset == UNSET_VALUE
+        @package = "medium" if @package == UNSET_VALUE
+        @iprange = "default" if @iprange == UNSET_VALUE
+        @node_name = nil if @node_name == UNSET_VALUE
+        @ssh_username = "root" if @ssh_username == UNSET_VALUE
+        @ssh_private_key_path = nil if @ssh_private_key_path == UNSET_VALUE
+      end
+
+      def validate(machine)
+        config = self.class.new(true)
+
+        errors = []
+        errors << I18n.t("vagrant_fifo.config.username_required") if config.username.nil?
+        errors << I18n.t("vagrant_fifo.config.password_required") if config.password.nil?
+        errors << I18n.t("vagrant_fifo.config.api_url_required") if config.api_url.nil?
+        errors << I18n.t("vagrant_fifo.config.dataset_required") if config.dataset.nil?
+        errors << I18n.t("vagrant_fifo.config.package_required") if config.package.nil?
+        errors << I18n.t("vagrant_fifo.config.iprange_required") if config.iprange.nil?
+        errors << I18n.t("vagrant_fifo.config.ssh_username_required") if config.ssh_username.nil?
+        errors << I18n.t("vagrant_fifo.config.ssh_private_key_path_required") if config.ssh_private_key_path.nil?
+        { "Fifo Provider" => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/errors.rb

@@ -0,0 +1,19 @@
+require "vagrant"
+
+module VagrantPlugins
+  module Fifo
+    module Errors
+      class VagrantFifoError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_fifo.errors")
+      end
+
+      class FogError < VagrantFifoError
+        error_key(:fog_error)
+      end
+
+      class RsyncError < VagrantFifoError
+        error_key(:rsync_error)
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/plugin.rb

@@ -0,0 +1,73 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant Fifo 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.1.0"
+  raise "The Vagrant Fifo plugin is only compatible with Vagrant 1.1+"
+end
+
+module VagrantPlugins
+  module Fifo
+    class Plugin < Vagrant.plugin("2")
+      name "Fifo"
+      description <<-DESC
+      This plugin installs a provider that allows Vagrant to manage
+      machines in Project-Fifo.
+      DESC
+
+      config(:fifo, :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider(:fifo) 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", Fifo.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_fifo")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-fifo/provider.rb

@@ -0,0 +1,50 @@
+require "log4r"
+require "vagrant"
+
+module VagrantPlugins
+  module Fifo
+    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_fifo.states.short_#{state_id}")
+        long  = I18n.t("vagrant_fifo.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
+        "Fifo (#{id})"
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Fifo
+    VERSION = "0.2.0"
+  end
+end

data/lib/vagrant-fifo.rb

@@ -0,0 +1,18 @@
+require "pathname"
+
+require "vagrant-fifo/plugin"
+
+module VagrantPlugins
+  module Fifo
+    lib_path = Pathname.new(File.expand_path("../vagrant-fifo", __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,65 @@
+en:
+  vagrant_fifo:
+    already_created: |-
+      The machine is already created.
+    launching_instance: |-
+      Launching an instance with the following settings...
+    not_created: |-
+      Instance is not created. Please run `vagrant up` first.
+    ready: |-
+      Machine is booted and ready for use!
+    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...
+    will_not_destroy: |-
+      The instance '%{name}' will not be destroyed, since the confirmation
+      was declined.
+
+    config:
+      fifo_username_required: |-
+        A Fifo Username must be specified via "fifo_username"
+      fifo_keyname_required: |-
+        A Fifo Keyname must be specified via "fifo_keyname"
+      fifo_keyfile_required: |-
+        A Fifo Keyfile must be specified via "fifo_keyfile"
+      fifo_api_url_required: |-
+        A Fifo Datacenter API endpoint must be specified via "fifo_api_url"
+      dataset_required: |-
+        A Fifo Dataset must be specified via "dataset"
+      node_name_required: |-
+        A Node Name must be specified via "node_name"
+      ssh_username_required: |-
+        An SSH username must be specified via "ssh_username"
+      ssh_private_key_path_required: |-
+        An SSH Private Key must be specified via "ssh_private_key_path"
+
+    errors:
+      fog_error: |-
+        There was an error talking to Fifo. The error message is shown
+        below:
+
+        %{message}
+      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 Fifo instance is not created. Run `vagrant up` to create it.
+
+      short_running: |-
+        running
+      long_running: |-
+        The Fifo instance is running. To stop this machine, you can run
+        `vagrant halt`. To destroy the machine, you can run `vagrant destroy`.

data/vagrant-fifo.gemspec

@@ -0,0 +1,19 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "vagrant-fifo/version"
+
+Gem::Specification.new do |s|
+  s.name          = "vagrant-fifo"
+  s.version       = VagrantPlugins::Fifo::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = [ "Sean OMeara", "Brian Akins" ]
+  s.email         = [ "someara@opscode.com", "brian@akins.org" ]
+  s.homepage      = "http://www.vagrantup.com"
+  s.summary       = "Enables Vagrant to manage machines in Fifo cloud and SDC"
+  s.description   = "Enables Vagrant to manage machines in Fifo cloud and SDC"
+
+  s.add_dependency "project-fifo-ruby"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.require_path  = 'lib'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-fifo
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean OMeara
+- Brian Akins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: project-fifo-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enables Vagrant to manage machines in Fifo cloud and SDC
+email:
+- someara@opscode.com
+- brian@akins.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example_box/README.md
+- example_box/Vagrantfile
+- example_box/metadata.json
+- lib/vagrant-fifo.rb
+- lib/vagrant-fifo/action.rb
+- lib/vagrant-fifo/action/connect_fifo.rb
+- lib/vagrant-fifo/action/is_created.rb
+- lib/vagrant-fifo/action/message_already_created.rb
+- lib/vagrant-fifo/action/message_not_created.rb
+- lib/vagrant-fifo/action/message_will_not_destroy.rb
+- lib/vagrant-fifo/action/read_ssh_info.rb
+- lib/vagrant-fifo/action/read_state.rb
+- lib/vagrant-fifo/action/run_instance.rb
+- lib/vagrant-fifo/action/sync_folders.rb
+- lib/vagrant-fifo/action/terminate_instance.rb
+- lib/vagrant-fifo/action/timed_provision.rb
+- lib/vagrant-fifo/action/warn_networks.rb
+- lib/vagrant-fifo/config.rb
+- lib/vagrant-fifo/errors.rb
+- lib/vagrant-fifo/plugin.rb
+- lib/vagrant-fifo/provider.rb
+- lib/vagrant-fifo/util/timer.rb
+- lib/vagrant-fifo/version.rb
+- locales/en.yml
+- vagrant-fifo.gemspec
+homepage: http://www.vagrantup.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Enables Vagrant to manage machines in Fifo cloud and SDC
+test_files: []
+has_rdoc: