sahara 0.0.15 → 0.0.16

data/.gitignore

@@ -5,3 +5,5 @@ tmp/*
 .vagrant
 Vagrantfile
 Gemfile.lock
+.bundle/
+vendor/

data/lib/sahara.rb

@@ -2,7 +2,6 @@
 # vim: set fileencoding=utf-8
 
 require "vagrant"
-require File.expand_path("../sahara/session", __FILE__)
 
 module Sahara 
   class Plugin < Vagrant.plugin("2")
@@ -12,8 +11,14 @@ module Sahara
     DESC
 
     command("sandbox") do
+      setup_i18n
       require File.expand_path("../sahara/command/root", __FILE__)
       Command::Root
     end
+
+    def self.setup_i18n
+      I18n.load_path << File.expand_path('../../locales/en.yml', __FILE__)
+      I18n.reload!
+    end
   end
 end

data/lib/sahara/command/commit.rb

@@ -16,10 +16,19 @@ module Sahara
         argv = parse_options(opts)
         return if !argv
 
-        ses = Sahara::Session::Command.new(@app, @env)
-
         with_target_vms(argv, :reverse => true) do |machine|
-          ses.commit(machine)
+
+          ses = Sahara::Session::Factory.create(machine)
+          if !ses.is_vm_created? then
+            puts "[#{machine.name}] VM is not created"
+            next
+          end
+          if ses.is_snapshot_mode_on? then
+            ses.commit
+          else
+            puts "[#{machine.name}] Not sandbox mode now"
+          end
+
         end
       end
     end

data/lib/sahara/command/off.rb

@@ -16,10 +16,19 @@ module Sahara
         argv = parse_options(opts)
         return if !argv
 
-        ses = Sahara::Session::Command.new(@app, @env)
-
         with_target_vms(argv, :reverse => true) do |machine|
-          ses.off(machine)
+
+          ses = Sahara::Session::Factory.create(machine)
+          if !ses.is_vm_created? then
+            puts "[#{machine.name}] VM is not created"
+            next
+          end
+          if ses.is_snapshot_mode_on? then
+            ses.off
+          else
+            puts "[#{machine.name}] Not sandbox mode now"
+          end
+
         end
       end
     end

data/lib/sahara/command/on.rb

@@ -1,5 +1,3 @@
-require "optparse"
-
 module Sahara
   module Command
     class On < Vagrant.plugin("2", :command)
@@ -18,10 +16,19 @@ module Sahara
         argv = parse_options(opts)
         return if !argv
 
-        ses = Sahara::Session::Command.new(@app, @env)
-
         with_target_vms(argv, :reverse => true) do |machine|
-           ses.on(machine)
+
+          ses = Sahara::Session::Factory.create(machine)
+          if !ses.is_vm_created? then
+            puts "[#{machine.name}] VM is not created"
+            next
+          end
+          if !ses.is_snapshot_mode_on? then
+            ses.on
+          else
+            puts "[#{machine.name}] Already sandbox mode"
+          end
+
         end
       end
     end

data/lib/sahara/command/rollback.rb

@@ -16,10 +16,19 @@ module Sahara
         argv = parse_options(opts)
         return if !argv
 
-        ses = Sahara::Session::Command.new(@app, @env)
-
         with_target_vms(argv, :reverse => true) do |machine|
-          ses.rollback(machine)
+
+          ses = Sahara::Session::Factory.create(machine)
+          if !ses.is_vm_created? then
+            puts "[#{machine.name}] VM is not created"
+            next
+          end
+          if !ses.is_snapshot_mode_on? then
+            puts "[#{machine.name}] Not sandbox mode now"
+            next
+          end
+          ses.rollback
+
         end
       end
     end

data/lib/sahara/command/root.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require "sahara/session/factory"
 
 module Sahara 
   module Command

data/lib/sahara/command/status.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 module Sahara
   module Command
     class Status < Vagrant.plugin("2", :command)
@@ -19,10 +17,19 @@ module Sahara
         argv = parse_options(opts)
         return if !argv
 
-        ses = Sahara::Session::Command.new(@app, @env)
-
         with_target_vms(argv, :reverse => true) do |machine|
-          ses.status(machine)
+
+          ses = Sahara::Session::Factory.create(machine)
+          if !ses.is_vm_created? then
+            puts "[#{machine.name}] VM is not created"
+            next
+          end
+          if ses.is_snapshot_mode_on? then
+            puts "[#{machine.name}] Sandbox mode is on"
+          else
+            puts "[#{machine.name}] Sandbox mode is off"
+          end
+
         end
       end
     end

data/lib/sahara/errors.rb

@@ -0,0 +1,33 @@
+module Sahara
+  module Errors
+
+    class Error < Vagrant::Errors::VagrantError
+      error_namespace("sahara.errors")
+    end
+
+    class ProviderNotSupported < Sahara::Errors::Error
+      error_key("provider_not_supported")
+    end
+
+    class LibvirtConnectionError < Sahara::Errors::Error
+      error_key("libvirt_connection_error")
+    end
+
+    class SnapshotMissing < Sahara::Errors::Error
+      error_key("snapshot_missing")
+    end
+
+    class SnapshotDeletionError < Sahara::Errors::Error
+      error_key("snapshot_deletion_error")
+    end
+
+    class SnapshotCreationError < Sahara::Errors::Error
+      error_key("snapshot_creation_error")
+    end
+
+    class SnapshotReversionError < Sahara::Errors::Error
+      error_key("snapshot_reversion_error")
+    end
+
+  end
+end

data/lib/sahara/session/factory.rb

@@ -0,0 +1,20 @@
+require "sahara/errors"
+
+module Sahara
+  module Session
+    class Factory
+      def self.create(machine)
+        case machine.provider_name
+        when :virtualbox
+          require_relative "virtualbox"
+          Virtualbox.new(machine)
+        when :libvirt
+          require_relative "libvirt"
+          Libvirt.new(machine)
+        else
+          raise Sahara::Errors::ProviderNotSupported
+        end
+      end
+    end
+  end
+end

data/lib/sahara/session/libvirt.rb

@@ -0,0 +1,124 @@
+require "fog"
+
+module Sahara
+  module Session
+    class Libvirt
+
+      def initialize(machine)
+        @machine=machine
+        @sandboxname="sahara-sandbox"
+        @connection=connect_to_libvirt
+        @domain = @connection.client.lookup_domain_by_uuid(@machine.id)
+      end
+
+      # based on VagrantPlugins::ProviderLibvirt::Action::ConnectLibvirt
+      def connect_to_libvirt
+        # Get config options for libvirt provider.
+        config = @machine.provider_config
+
+        # Setup connection uri.
+        uri = config.driver
+        if config.connect_via_ssh
+          uri << '+ssh://'
+          if config.username
+            uri << config.username + '@'
+          end
+
+          if config.host
+            uri << config.host
+          else
+            uri << 'localhost'
+          end
+        else
+          uri << '://'
+          uri << config.host if config.host
+        end
+
+        uri << '/system?no_verify=1'
+        # set ssh key for access to libvirt host
+        home_dir = `echo ${HOME}`.chomp
+        uri << "&keyfile=#{home_dir}/.ssh/id_rsa"
+
+        conn_attr = {}
+        conn_attr[:provider] = 'libvirt'
+        conn_attr[:libvirt_uri] = uri
+        conn_attr[:libvirt_username] = config.username if config.username
+        conn_attr[:libvirt_password] = config.password if config.password
+
+        begin
+          Fog::Compute.new(conn_attr)
+        rescue Fog::Errors::Error => e
+          raise Sahara::Errors::LibvirtConnectionError,
+            :error_message => e.message
+        end
+      end
+
+      def get_snapshot_if_exists
+        # if we can get snapshot description without exception it exists
+        begin
+          snapshot = @domain.lookup_snapshot_by_name(@sandboxname)
+          snapshot_desc = snapshot.xml_desc
+        rescue
+          raise Sahara::Errors::SnapshotMissing
+        end
+        return snapshot
+      end
+
+      def is_snapshot_mode_on?
+        begin
+          snapshot = get_snapshot_if_exists
+        rescue Sahara::Errors::SnapshotMissing
+          return false
+        end
+        return true
+      end
+
+      def off
+        snapshot = get_snapshot_if_exists
+        begin
+          snapshot.delete
+        rescue Fog::Errors::Error => e
+          raise Sahara::Errors::SnapshotDeletionError,
+            :error_message => e.message
+        end
+      end
+
+      def on
+        snapshot_desc = <<-EOF
+        <domainsnapshot>
+          <name>sahara-sandbox</name>
+          <description>Snapshot for vagrant sandbox</description>
+        </domainsnapshot>
+        EOF
+        begin
+          @domain.snapshot_create_xml(snapshot_desc)
+        rescue Fog::Errors::Error => e
+          raise Sahara::Errors::SnapshotCreationError,
+            :error_message => e.message
+        end
+      end
+
+      def commit
+        off
+        on
+      end
+
+      def rollback
+        snapshot = get_snapshot_if_exists
+        begin
+          # 4 is VIR_DOMAIN_SNAPSHOT_REVERT_FORCE
+          # needed due to https://bugzilla.redhat.com/show_bug.cgi?id=1006886
+          @domain.revert_to_snapshot(snapshot, 4)
+        rescue Fog::Errors::Error => e
+          raise Sahara::Errors::SnapshotReversionError,
+            :error_message => e.message
+        end
+      end
+
+      def is_vm_created?
+        return !@machine.id.nil?
+      end
+
+    end
+  end
+end

data/lib/sahara/session/virtualbox.rb

@@ -0,0 +1,83 @@
+module Sahara
+  module Session
+    class Virtualbox
+
+      def initialize(machine)
+        @machine=machine
+        @instance_id = @machine.id
+        @vboxcmd=determine_vboxcmd
+        @sandboxname="sahara-sandbox"
+      end
+
+      def determine_vboxcmd
+        if windows?
+          # On Windows, we use the VBOX_INSTALL_PATH environmental
+          if ENV.has_key?("VBOX_INSTALL_PATH")
+            # The path usually ends with a \ but we make sure here
+            path = File.join(ENV["VBOX_INSTALL_PATH"], "VBoxManage.exe")
+            return "\"#{path}\""
+          end
+        else
+          # for other platforms assume it is on the PATH
+          return "VBoxManage"
+        end
+      end
+
+      def windows?
+        %W[mingw mswin].each do |text|
+          return true if RbConfig::CONFIG["host_os"].downcase.include?(text)
+        end
+        false
+      end
+
+      def list_snapshots
+        snapshotlist=Array.new
+        output = `#{@vboxcmd} showvminfo --machinereadable "#{@instance_id}"`
+        snapshotresult=output.scan(/SnapshotName.*=(.*)/).flatten
+        snapshotresult.each do |result|
+          clean=result.gsub(/\"/,'').chomp
+          snapshotlist << clean
+        end
+        snapshotlist
+      end
+
+      def is_snapshot_mode_on?
+        snapshots=self.list_snapshots
+        return snapshots.include?(@sandboxname)
+      end
+
+      def off
+        `#{@vboxcmd} snapshot "#{@instance_id}" delete "#{@sandboxname}" `
+      end
+
+      def on
+        `#{@vboxcmd} snapshot "#{@instance_id}" take "#{@sandboxname}" --pause`
+      end
+
+      def commit
+        `#{@vboxcmd} snapshot "#{@instance_id}" delete "#{@sandboxname}"`
+        `#{@vboxcmd} snapshot "#{@instance_id}" take "#{@sandboxname}" --pause`
+      end
+
+      def rollback
+        `#{@vboxcmd} controlvm "#{@instance_id}" poweroff `
+        sleep 2
+        `#{@vboxcmd} snapshot "#{@instance_id}" restore "#{@sandboxname}"`
+
+        gui_boot = @machine.provider_config.gui
+        if gui_boot
+          boot_mode = "gui"
+        else
+          boot_mode = "headless"
+        end
+        # restore boot mode
+        `#{@vboxcmd} startvm --type #{boot_mode} "#{@instance_id}" `
+      end
+
+      def is_vm_created?
+        return !@machine.id.nil?
+      end
+
+    end
+  end
+end

data/lib/sahara/version.rb

@@ -1,3 +1,3 @@
 module Sahara
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  sahara:
+    errors:
+      provider_not_supported: |-
+        Sahara does not support this provider.
+      libvirt_connection_error: |-
+        Error while connecting to libvirt: %{error_message}
+      snapshot_missing: |-
+        Snapshot used for sandbox had unexpectedly gone missing.
+      snapshot_deletion_error: |-
+        Error while deleting snapshot: %{error_message}
+      snapshot_creation_error: |-
+        Error while creating snapshot: %{error_message}
+      snapshot_reversion_error: |-
+        Error while reverting snapshot: %{error_message}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sahara
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: popen4
@@ -77,8 +77,12 @@ files:
 - lib/sahara/command/rollback.rb
 - lib/sahara/command/root.rb
 - lib/sahara/command/status.rb
-- lib/sahara/session.rb
+- lib/sahara/errors.rb
+- lib/sahara/session/factory.rb
+- lib/sahara/session/libvirt.rb
+- lib/sahara/session/virtualbox.rb
 - lib/sahara/version.rb
+- locales/en.yml
 - sahara.gemspec
 homepage: http://github.com/jedi4ever/sahara/
 licenses: []
@@ -94,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2159711704490986345
+      hash: -2734223008788270957
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/sahara/session.rb

@@ -1,135 +0,0 @@
-require 'pp'
-
-module Sahara
-  module Session
-    class Command 
-
-      def initialize(app, env)
-        @app = app
-        @env = env
-        @vboxcmd=determine_vboxcmd
-        @sandboxname="sahara-sandbox"
-      end
-  
-      def determine_vboxcmd
-        if windows?
-          # On Windows, we use the VBOX_INSTALL_PATH environmental
-          if ENV.has_key?("VBOX_INSTALL_PATH")
-            # The path usually ends with a \ but we make sure here
-            path = File.join(ENV["VBOX_INSTALL_PATH"], "VBoxManage.exe")
-            return "\"#{path}\""
-          end
-        else
-          # for other platforms assume it is on the PATH
-          return "VBoxManage"
-        end
-      end
-  
-      def windows?
-        %W[mingw mswin].each do |text|
-          return true if RbConfig::CONFIG["host_os"].downcase.include?(text)
-        end
-        false
-      end
-  
-      def list_snapshots(machine)
-        snapshotlist=Array.new
-        instance_id = machine.id
-        output = `#{@vboxcmd} showvminfo --machinereadable "#{instance_id}"`
-        snapshotresult=output.scan(/SnapshotName.*=(.*)/).flatten
-        snapshotresult.each do |result|
-          clean=result.gsub(/\"/,'').chomp
-          snapshotlist << clean
-        end
-        snapshotlist
-      end
-  
-      def status(machine)
-        if !self.is_vm_created?(machine) then
-          puts "[#{machine.name}] VM is not created"
-          return
-        end
-        if self.is_snapshot_mode_on?(machine) then
-          puts "[#{machine.name}] Sandbox mode is on"
-        else
-          puts "[#{machine.name}] Sandbox mode is off"
-        end
-      end
-  
-      def is_snapshot_mode_on?(machine)
-        snapshots=self.list_snapshots(machine)
-        return snapshots.include?(@sandboxname)
-      end
-  
-      def off(machine)
-        if !self.is_vm_created?(machine) then
-          puts "[#{machine.name}] VM is not created"
-          return
-        end
-        if self.is_snapshot_mode_on?(machine) then
-          instance_id = machine.id
-          `#{@vboxcmd} snapshot "#{instance_id}" delete "#{@sandboxname}" `
-        else
-          puts "[#{machine.name}] Not sandbox mode now"
-        end
-      end
-  
-      def on(machine)
-        if !self.is_vm_created?(machine) then
-          puts "[#{machine.name}] VM is not created"
-          return
-        end
-        if !self.is_snapshot_mode_on?(machine) then
-          instance_id = machine.id
-          `#{@vboxcmd} snapshot "#{instance_id}" take "#{@sandboxname}" --pause`
-        else
-          puts "[#{machine.name}] Already sandbox mode"
-        end
-      end
-  
-      def commit(machine)
-        if !self.is_vm_created?(machine) then
-          puts "[#{machine.name}] VM is not created"
-          return
-        end
-        if self.is_snapshot_mode_on?(machine) then
-          instance_id = machine.id
-          `#{@vboxcmd} snapshot "#{instance_id}" delete "#{@sandboxname}"`
-          `#{@vboxcmd} snapshot "#{instance_id}" take "#{@sandboxname}" --pause`
-        else
-          puts "[#{machine.name}] Not sandbox mode now"
-        end
-      end
-  
-      def rollback(machine)
-        if !self.is_vm_created?(machine) then
-          puts "[#{machine.name}] VM is not created"
-          return
-        end
-        if !self.is_snapshot_mode_on?(machine) then
-          puts "[#{machine.name}] Not sandbox mode now"
-          return
-        end
-  
-        instance_id = machine.id
-        `#{@vboxcmd} controlvm "#{instance_id}" poweroff `
-        sleep 2
-        `#{@vboxcmd} snapshot "#{instance_id}" restore "#{@sandboxname}"`
-  
-        gui_boot = machine.provider_config.gui
-        if gui_boot 
-          boot_mode = "gui"
-        else
-          boot_mode = "headless"
-        end
-        # restore boot mode
-        `#{@vboxcmd} startvm --type #{boot_mode} "#{instance_id}" `
-      end
-  
-      def is_vm_created?(machine)
-        return !machine.id.nil?
-      end
-  
-    end
-  end
-end