vmreverter 0.0.2

data/lib/vmreverter/hypervisor/vsphere_helper.rb

@@ -0,0 +1,187 @@
+# Apache Licensed - (github/puppetlabs) ripped from puppet_acceptance. ** See Legal notes
+# Changes include namespace swaps, and refactoring
+
+begin
+  require 'Vmreverter/logger'
+rescue LoadError
+  require File.expand_path(File.join(File.dirname(__FILE__), '..', 'logger.rb'))
+end
+
+class VsphereHelper
+  
+  #Class methods
+  def self.load_config authfile
+    vsphere_credentials = {}
+
+    if File.exists?(authfile)
+      vInfo = YAML.load_file(authfile)
+    elsif File.exists?( File.join(ENV['HOME'], '.fog') )
+      vInfo = YAML.load_file( File.join(ENV['HOME'], '.fog') )
+    else
+      report_and_raise(@logger, RuntimeError.new("Couldn't authentication for vSphere in auth file !"), "VSphereHelper::load_config")
+    end  
+
+    begin
+      vsphere_credentials[:server] = vInfo[:default][:vsphere_server]
+      vsphere_credentials[:user]   = vInfo[:default][:vsphere_username]
+      vsphere_credentials[:pass]   = vInfo[:default][:vsphere_password]
+    rescue
+      report_and_raise(@logger, RuntimeError.new("Couldn't load authentication for vSphere in auth file !"), "VSphereHelper::load_config")
+    end
+
+    return vsphere_credentials
+  end
+
+  def initialize vInfo = {}
+    @logger = vInfo[:logger] || Vmreverter::Logger.new
+    begin
+      require 'rbvmomi'
+    rescue LoadError
+      raise "Unable to load RbVmomi, please ensure its installed"
+    end
+    
+    # If you don’t have trusted SSL certificates installed on the host you’re connecting to, 
+    #you’ll get an +OpenSSL::SSL::SSLError+ “certificate verify failed”. 
+    #You can work around this by using the :insecure option to +RbVmomi::VIM.connect+.
+    
+    @connection = RbVmomi::VIM.connect :host     => vInfo[:server],
+                                       :user     => vInfo[:user],
+                                       :password => vInfo[:pass],
+                                       :insecure => true
+  end  
+  #Instance Methods
+  def find_snapshot vm, snapname
+    search_child_snaps vm.snapshot.rootSnapshotList, snapname
+  end
+
+  def search_child_snaps tree, snapname
+    snapshot = nil
+    tree.each do |child|
+      if child.name == snapname
+        snapshot ||= child.snapshot
+      else
+        snapshot ||= search_child_snaps child.childSnapshotList, snapname
+      end
+    end
+    snapshot
+  end
+
+  def find_customization name
+    csm = @connection.serviceContent.customizationSpecManager
+
+    begin
+      customizationSpec = csm.GetCustomizationSpec({:name => name}).spec
+    rescue
+      customizationSpec = nil
+    end
+
+    return customizationSpec
+  end
+
+  # an easier wrapper around the horrid PropertyCollector interface,
+  # necessary for searching VMs in all Datacenters that may be nested
+  # within folders of arbitrary depth
+  # returns a hash array of <name> => <VirtualMachine ManagedObjects>
+  def find_vms names, connection = @connection
+    names = names.is_a?(Array) ? names : [ names ]
+    containerView = get_base_vm_container_from connection
+    propertyCollector = connection.propertyCollector
+
+    objectSet = [{
+      :obj => containerView,
+      :skip => true,
+      :selectSet => [ RbVmomi::VIM::TraversalSpec.new({
+          :name => 'gettingTheVMs',
+          :path => 'view',
+          :skip => false,
+          :type => 'ContainerView'
+      }) ]
+    }]
+
+    propSet = [{
+      :pathSet => [ 'name' ],
+      :type => 'VirtualMachine'
+    }]
+
+    results = propertyCollector.RetrievePropertiesEx({
+      :specSet => [{
+        :objectSet => objectSet,
+        :propSet   => propSet
+      }],
+      :options => { :maxObjects => nil }
+    })
+
+    vms = {}
+    results.objects.each do |result|
+      name = result.propSet.first.val
+      next unless names.include? name
+      vms[name] = result.obj
+    end
+
+    while results.token do
+      results = propertyCollector.ContinueRetrievePropertiesEx({:token => results.token})
+      results.objects.each do |result|
+        name = result.propSet.first.val
+        next unless names.include? name
+        vms[name] = result.obj
+      end
+    end
+    vms
+  end
+
+  def find_datastore datastorename
+    datacenter = @connection.serviceInstance.find_datacenter
+    datacenter.find_datastore(datastorename)
+  end
+
+  def find_folder foldername
+    datacenter = @connection.serviceInstance.find_datacenter
+    base = datacenter.vmFolder
+    folders = foldername.split('/')
+    folders.each do |folder|
+      case base
+        when RbVmomi::VIM::Folder
+          base = base.childEntity.find { |f| f.name == folder }
+        else
+          abort "Unexpected object type encountered (#{base.class}) while finding folder"
+      end
+    end
+
+    base
+  end
+
+  def find_pool poolname
+    datacenter = @connection.serviceInstance.find_datacenter
+    base = datacenter.hostFolder
+    pools = poolname.split('/')
+    pools.each do |pool|
+      case base
+        when RbVmomi::VIM::Folder
+          base = base.childEntity.find { |f| f.name == pool }
+        when RbVmomi::VIM::ClusterComputeResource
+          base = base.resourcePool.resourcePool.find { |f| f.name == pool }
+        when RbVmomi::VIM::ResourcePool
+          base = base.resourcePool.find { |f| f.name == pool }
+        else
+          abort "Unexpected object type encountered (#{base.class}) while finding resource pool"
+      end
+    end
+
+    base = base.resourcePool unless base.is_a?(RbVmomi::VIM::ResourcePool) and base.respond_to?(:resourcePool)
+    base
+  end
+
+  def get_base_vm_container_from connection
+    viewManager = connection.serviceContent.viewManager
+    viewManager.CreateContainerView({
+      :container => connection.serviceContent.rootFolder,
+      :recursive => true,
+      :type      => [ 'VirtualMachine' ]
+    })
+  end
+
+  def close_connection
+    @connection.close
+  end
+end
+

data/lib/vmreverter/hypervisor.rb

@@ -0,0 +1,34 @@
+# Apache Licensed - (github/puppetlabs) ripped from puppet_acceptance. ** See Legal notes
+# Changes include namespace swaps, method removal, method additions, and complete code refactoring
+
+module Vmreverter
+
+  # Factory Pattern - Class to generate the correct hypervisor object, given type
+  class Hypervisor
+
+    def configure(hosts)
+      @logger.debug "No post-provisioning configuration necessary for #{self.class.name} boxes"
+    end
+
+    def self.register type, hosts_to_provision, options, config
+      @logger = options[:logger]
+      @logger.notify("Hypervisor found some #{type} boxes to hook") 
+      case type.downcase
+        when /vsphere/
+          return Vmreverter::Vsphere.new hosts_to_provision, options, config
+        when /aws/
+          return Vmreverter::AWS.new hosts_to_provision, options, config
+        else
+          report_and_raise(@logger, RuntimeError.new("Missing Class for hypervisor invocation: (#{type})"), "Hypervisor::register")
+      end    
+    end
+  end
+end
+
+%w( vsphere_helper aws vsphere ).each do |lib|
+  begin
+    require "hypervisor/#{lib}"
+  rescue LoadError
+    require File.expand_path(File.join(File.dirname(__FILE__), "hypervisor", lib))
+  end
+end

data/lib/vmreverter/logger.rb

@@ -0,0 +1,170 @@
+# Apache Licensed - (github/puppetlabs) ripped from puppet_acceptance. ** See Legal notes
+# Changes include namespace swaps, method removal, method additions, and complete code refactoring
+
+module Vmreverter
+  class Logger
+    NORMAL         = "\e[00;00m"
+    BRIGHT_NORMAL  = "\e[00;01m"
+    BLACK          = "\e[00;30m"
+    RED            = "\e[00;31m"
+    GREEN          = "\e[00;32m"
+    YELLOW         = "\e[00;33m"
+    BLUE           = "\e[00;34m"
+    MAGENTA        = "\e[00;35m"
+    CYAN           = "\e[00;36m"
+    WHITE          = "\e[00;37m"
+    GREY           = "\e[01;30m"
+    BRIGHT_RED     = "\e[01;31m"
+    BRIGHT_GREEN   = "\e[01;32m"
+    BRIGHT_YELLOW  = "\e[01;33m"
+    BRIGHT_BLUE    = "\e[01;34m"
+    BRIGHT_MAGENTA = "\e[01;35m"
+    BRIGHT_CYAN    = "\e[01;36m"
+    BRIGHT_WHITE   = "\e[01;37m"
+
+    LOG_LEVELS      = {
+      :debug  => 1,
+      :warn   => 2,
+      :normal => 3,
+      :info   => 4
+    }
+
+    attr_accessor :color, :log_level, :destinations
+
+    def initialize(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      @color = options[:color]
+      @log_level = options[:debug] ? :debug : :normal
+      @destinations = []
+
+      dests = args
+      dests << STDOUT unless options[:quiet]
+      dests.uniq!
+      dests.each {|dest| add_destination(dest)}
+    end
+
+    def add_destination(dest)
+      case dest
+      when IO
+        @destinations << dest
+      when String
+        @destinations << File.open(dest, 'w')
+      else
+        raise "Unsuitable log destination #{dest.inspect}"
+      end
+    end
+
+    def remove_destination(dest)
+      case dest
+      when IO
+        @destinations.delete(dest)
+      when String
+        @destinations.delete_if {|d| d.respond_to?(:path) and d.path == dest}
+      else
+        raise "Unsuitable log destination #{dest.inspect}"
+      end
+    end
+
+    def is_debug?
+      LOG_LEVELS[@log_level] <= LOG_LEVELS[:debug]
+    end
+
+    def is_warn?
+      LOG_LEVELS[@log_level] <= LOG_LEVELS[:warn]
+    end
+
+    def host_output *args
+      return unless is_debug?
+      strings = strip_colors_from args
+      string = strings.join
+      optionally_color GREY, string, false
+    end
+
+    def debug *args
+      return unless is_debug?
+      optionally_color WHITE, args
+    end
+
+    def warn *args
+      return unless is_warn?
+      strings = args.map {|msg| "Warning: #{msg}" }
+      optionally_color YELLOW, strings
+    end
+
+    def success *args
+      optionally_color GREEN, args
+    end
+
+    def notify *args
+      optionally_color BRIGHT_WHITE, args
+    end
+
+    def error *args
+      optionally_color BRIGHT_RED, args
+    end
+
+    def strip_colors_from lines
+      Array(lines).map do |line|
+        line.gsub /\e\[(\d+;)?\d+m/, ''
+      end
+    end
+
+    def optionally_color color_code, msg, add_newline = true
+      print_statement = add_newline ? :puts : :print
+      @destinations.each do |to|
+        to.print color_code if @color
+        to.send print_statement, msg
+        to.print NORMAL if @color
+      end
+    end
+
+    # utility method to get the current call stack and format it
+    # to a human-readable string (which some IDEs/editors
+    # will recognize as links to the line numbers in the trace)
+    def pretty_backtrace backtrace = caller(1)
+      trace = purge_harness_files_from( Array( backtrace ) )
+      expand_symlinks( trace ).join "\n"
+    end
+
+   private
+    def expand_symlinks backtrace
+      backtrace.collect do |line|
+        file_path, line_num = line.split( ":" )
+        expanded_path = expand_symlink File.expand_path( file_path )
+        expanded_path.to_s + ":" + line_num.to_s
+      end
+    end
+
+    def purge_harness_files_from backtrace
+      mostly_purged = backtrace.reject do |line|
+        # LOADED_FEATURES is an array of anything `require`d, i.e. everything
+        # but the test in question
+        $LOADED_FEATURES.any? do |require_path|
+          line.include? require_path
+        end
+      end
+
+      # And remove lines that contain our program name in them
+      completely_purged = mostly_purged.reject {|line| line.include? $0 }
+    end
+
+    # utility method that takes a path as input, checks each component
+    # of the path to see if it is a symlink, and expands
+    # it if it is.  returns the expanded path.
+    def expand_symlink file_path
+      file_path.split( "/" ).inject do |full_path, next_dir|
+        next_path = full_path + "/" + next_dir
+        if File.symlink? next_path
+          link = File.readlink next_path
+          next_path =
+              case link
+                when /^\// then link
+                else
+                  File.expand_path( full_path + "/" + link )
+              end
+        end
+        next_path
+      end
+    end
+  end
+end

data/lib/vmreverter/options.rb

@@ -0,0 +1,104 @@
+module Vmreverter
+  class Options
+
+    def self.options
+      return @options
+    end
+
+
+    def self.parse_args
+      return @options if @options
+
+      @no_args = ARGV.empty? ? true : false
+
+      @defaults = {}
+      @options = {}
+      @options_from_file = {}
+
+      optparse = OptionParser.new do|opts|
+        # Set a banner
+        opts.banner = "Usage: #{File.basename($0)} [options...]"
+
+        @defaults[:auth] = File.join(ENV['HOME'], '.fog')
+        opts.on '-a', '--auth FILE',
+                'Use authentication FILE',
+                "Default: #{@defaults[:auth]}" do |file|
+          @options[:auth] = file
+        end
+
+        @defaults[:config] = nil
+        opts.on '-c', '--config FILE',
+                'Use configuration FILE', 
+                "Default: #{@defaults[:config]}" do |file|
+          @options[:config] = file
+        end
+
+        @defaults[:options_file] = nil
+        opts.on '-o', '--options-file FILE',
+                'Read options from FILE',
+                'This should evaluate to a ruby hash.',
+                'CLI optons are given precedence.' do |file|
+          @options_from_file = parse_options_file file
+        end
+
+        @defaults[:quiet] = false
+        opts.on '-q', '--[no-]quiet',
+                'Do not log output to STDOUT',
+                '(default: false)' do |bool|
+          @options[:quiet] = bool
+        end
+
+        @defaults[:color] = true
+        opts.on '--[no-]color',
+                'Do not display color in log output',
+                '(default: true)' do |bool|
+          @options[:color] = bool
+        end
+
+        @defaults[:debug] = false
+        opts.on '--[no-]debug',
+                'Enable full debugging',
+                '(default: false)' do |bool|
+          @options[:debug] = bool
+        end
+
+
+        opts.on_tail("-h","--help","Display this screen") do
+          puts opts
+          exit
+        end
+      end
+
+      optparse.parse!
+
+      # We have use the @no_args var because OptParse consumes ARGV as it parses
+      # so we have to check the value of ARGV at the begining of the method,
+      # let the options be set, then output usage.
+      puts optparse if @no_args
+
+      # merge in the options that we read from the file
+      @options = @options_from_file.merge(@options)
+      # merge in defaults
+      @options = @defaults.merge(@options)
+
+      @options
+    end
+
+    def self.parse_options_file(options_file_path)
+      options_file_path = File.expand_path(options_file_path)
+      unless File.exists?(options_file_path)
+        raise ArgumentError, "Specified options file '#{options_file_path}' does not exist!"
+      end
+      # This eval will allow the specified options file to have access to our
+      #  scope.  It is important that the variable 'options_file_path' is
+      #  accessible, because some existing options files (e.g. puppetdb) rely on
+      #  that variable to determine their own location (for use in 'require's, etc.)
+      result = eval(File.read(options_file_path))
+      unless result.is_a? Hash
+        raise ArgumentError, "Options file '#{options_file_path}' must return a hash!"
+      end
+
+      result
+    end
+  end
+end

data/lib/vmreverter/shared/error_handler.rb

@@ -0,0 +1,20 @@
+# Apache Licensed - (github/puppetlabs) ripped from puppet_acceptance. ** See Legal notes
+# Changes include namespace swaps, method removal, method additions, and complete code refactoring
+
+module Vmreverter 
+  module Shared
+    module ErrorHandler
+
+      def report_and_raise(logger, e, msg)
+        logger.error "Failed: errored in #{msg}"
+        logger.error(e.inspect)
+        bt = e.backtrace
+        logger.pretty_backtrace(bt).each_line do |line|
+          logger.error(line)
+        end 
+        raise e
+      end
+
+    end
+  end
+end

data/lib/vmreverter/shared.rb

@@ -0,0 +1,13 @@
+
+begin
+  require "vmreverter/shared/error_handler"
+rescue LoadError
+  require File.expand_path(File.join(File.dirname(__FILE__), 'shared', file))
+end
+
+module Vmreverter
+  module Shared
+    include Vmreverter::Shared::ErrorHandler
+  end
+end
+include Vmreverter::Shared

data/lib/vmreverter/version.rb

@@ -0,0 +1,3 @@
+module Vmreverter
+    VERSION = '0.0.2'
+end

data/lib/vmreverter/vmmanager.rb

@@ -0,0 +1,60 @@
+%w(hypervisor).each do |lib|
+  begin
+    require "vmreverter/#{lib}"
+  rescue LoadError
+    require File.expand_path(File.join(File.dirname(__FILE__), lib))
+  end
+end
+
+module Vmreverter
+  
+  HYPERVISOR_TYPES = ['vsphere', 'aws']
+  
+  #Collection using Proxy Pattern - Proxy normalized access to specific Hypervisors such as VSphere through creation by the Hypervisor Factory
+  class VMManager
+
+    attr_accessor :hypervisor_collection
+
+    def initialize(config, options, logger)
+      @logger = logger
+      @options = options
+      @hosts = []
+      @config = config
+      @hypervisor_collection = {}
+      @virtual_machines = {}
+
+      @config['HOSTS'].each_key do |name|
+        hypervisor = @config['HOSTS'][name]['hypervisor'] 
+        @logger.debug "Hypervisor for #{name} is #{hypervisor}"
+        @virtual_machines[hypervisor] = [] unless @virtual_machines[hypervisor]
+        @virtual_machines[hypervisor] << name
+      end
+
+      ## Data Model Looks like 
+      # @virtual_machines.inspect
+      # {"vsphere" => ["test_server01","test_server02"], "blimpy" => ["aws_test_server01","aws_test_server01"]}
+
+      @virtual_machines.each do |type, names|
+        @hypervisor_collection[type] = Vmreverter::Hypervisor.register(type, names, @options, @config)
+      end
+
+      #return instance created
+      return self
+    end
+
+    def invoke 
+      @hypervisor_collection.each do |hypervisor_type, hypervisor_instance|
+        @logger.notify("Invoking #{hypervisor_type} hosts") 
+        hypervisor_instance.invoke
+      end
+    end
+
+    def close_connection
+      @hypervisor_collection.each do |hypervisor_type, hypervisor_instance|
+        @logger.notify("Disconnecting from #{hypervisor_type}") 
+        hypervisor_instance.close_connection
+      end
+    end
+
+  end
+end

data/lib/vmreverter.rb

@@ -0,0 +1,29 @@
+require 'optparse'
+require 'open-uri'
+require 'yaml'
+
+require 'rubygems' unless defined?(Gem)
+
+require 'pry'
+require 'pry-nav'
+module Vmreverter
+  $:.unshift(File.dirname(__FILE__))
+
+  # logger
+  require 'vmreverter/logger'
+
+  # Shared methods and helpers
+  require 'vmreverter/shared'
+
+  # hypervisor methods and helpers
+  require 'vmreverter/hypervisor'
+
+  %w( options vmmanager config_tester cli ).each do |lib|
+    begin
+      require "vmreverter/#{lib}"
+    rescue LoadError
+      require File.expand_path(File.join(File.dirname(__FILE__), 'vmreverter', lib))
+    end
+  end
+
+end    

data/vmreverter.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require File.expand_path('../lib/vmreverter/version', __FILE__)
+
+require 'rbconfig'
+ruby_conf = defined?(RbConfig) ? RbConfig::CONFIG : Config::CONFIG
+less_than_one_nine = ruby_conf['MAJOR'].to_i == 1 && ruby_conf['MINOR'].to_i < 9
+
+Gem::Specification.new do |s|
+  s.name        = "vmreverter"
+  s.authors     = ["shadowbq"]
+  s.email       = ["shadowbq@gmail.com"]
+  s.homepage    = "https://github.com/shadowbq/vmreverter"
+  s.summary     = %q{Revert VM to previous snapshots }
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.version       = Vmreverter::VERSION
+  s.licenses      = ["BSD3", "APACHE2"]
+
+  s.add_development_dependency 'bundler', '~> 1.0'
+
+  # Testing dependencies
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-nav'
+ 
+
+  # Run time dependencies
+  s.add_runtime_dependency 'json'
+  # Fix bug with interdepency of rbnmomi and nokogiri https://github.com/vmware/rbvmomi/issues/31
+  s.add_runtime_dependency 'nokogiri', '1.5.5'
+  s.add_runtime_dependency 'rbvmomi'
+  s.add_runtime_dependency 'blimpy'
+end