vmreverter 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmJiODIzNGFjNTY0ZTZhNWI3NDViN2U4ZWU1ZDQwNDQyYTQxYTAzNA==
+  data.tar.gz: !binary |-
+    NzZkZjlmN2YwMmY5NWMzYWVmOTJjMzQ0MGEzNzJhZThhMTYxOGUyNg==
+SHA512:
+  metadata.gz: !binary |-
+    ZjUyZTljN2JiMDY1NzRjZGFmOTI2MTk3ZmNmZDg2YzE1NTk4NTNhZjQ4YWUx
+    MDhmODUwZTAzYmYwNjgyNGRkYWRiOTJhZDJiOTJiMzRkYzFkNzBiZjA2Mjkx
+    YmZhYjc5ZjQ1ZmY4NWMyYzk4MTliMGE1MDE4OTAyMTk3ZTI3NGY=
+  data.tar.gz: !binary |-
+    YzAxYWZhZTU1ZmE1NzQzYTU0MDhiZDlmZjgwODdkZGM2YmU4ZjY4MDU4OGVh
+    N2ZjYjE3Y2FmNDFkMGM4ODU4NjE4YTExZDgxMjc0MDRjN2U3OWQ2YjdhYzgy
+    NzQwMGFhYzk4MTM0NDU5ZGNiMmIzNTU5M2ZmMmY5MjczYTQ2ZWU=

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+*.dat
+.bundle
+.config
+build.sh
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rake"
+
+gemspec

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2014, Scott MacGregor
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,121 @@
+# VM Reverter
+
+This gem is used to revert a collection of virtual machines from many hypervisor frameworks using a yaml file back to specific snapshots.
+
+## Supported Hypervisors
+
+* VMWare VSphere Server [vshpere] ~> rbvmomi
+* AWS [aws] ~> Blimpy / Fog
+
+## Vsphere Credentials
+
+```yaml
+# ~/.fog
+:default:
+  :vsphere_server: 'vsphere.mydomain.com'
+  :vsphere_username: 'john_doe'
+  :vsphere_password: '$3cr3+_$@uc3'
+```
+## Configuration File
+
+### Required YAML Header:
+
+* HOSTS
+* vm-name 
+
+### Required Fields:
+
+* snapshots
+* hypervisor
+
+### Optional fields:
+
+* power - overide the saved state of the power of the snapshot [up|down|destroy]
+* tag - add a meta tag to a host
+
+## Configuration File - Revert
+
+revert.conf
+
+```yaml
+HOSTS:
+  test-server01:
+    hypervisor: vsphere
+    snapshot: gold-image
+    tag: interesting
+    power: up
+  test-server02:
+    hypervisor: vsphere
+    snapshot: gold-image
+  test-server03:
+    hypervisor: aws
+      aws-options:
+        ami-size: m1.small
+        ami-region: us-west-2
+        security-group: clients
+```
+
+
+### Configuration Example - Stop VMS
+
+This configuration will remove the hosts from aws.
+
+```yaml
+HOSTS:
+  test-server01:
+    hypervisor: aws
+    power: down
+  test-server02:
+    hypervisor: vsphere
+    power: down
+```
+
+
+### Configuration Example - Destruction
+
+This configuration will remove the hosts from the hypervisor (aws only).
+
+```yaml
+HOSTS:
+  test-server01:
+    hypervisor: aws
+    power: destroy
+  test-server02:
+    hypervisor: aws
+    power: destroy
+```
+
+## CLI Usage
+
+Using local conf file and turning on all machines after reverting.
+
+```
+$> vmreverter -c ./revert.conf 
+```
+## Tested Against
+
+* Ruby 1.9.3
+* VSphere 5.5
+
+## TODO
+
+* Unit Tests
+* API Mocks
+
+Further Hypervisor implementations:
+
+* OpenStack ~> Blimpy
+* VirtualBox ~> Vagrant
+
+
+## Legal notes
+
+This is some wildly refactored code (..legal speak..) from the puppet_acceptance gem. puppet labs, puppet_acceptance, or its authors do not endorse this code.
+
+Changes include namespace swaps, class additions, class removals, method additions, method removals, and complete code refactoring.
+
+All original code maintains its copyright from its original author(puppetlabs) and licensing of Apache 2, and only change sets from git rev 
+
+https://github.com/puppetlabs/puppet-acceptance/commit/68272162d0b30905f498a4d71ff641374d3eb8f0
+
+onward (circa Feb 2014) within the vmreverter namespace will include permissive of BSD-3 LICENSING as such approved by law. 

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask" 
+
+task :default => [:test]
+
+Rake::TestTask.new do |test|
+  test.libs << "test" 
+  test.test_files = Dir[ "test/test_*.rb" ]
+  test.verbose = true
+end

data/bin/vmreverter

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'rubygems' unless defined?(Gem)
+require 'vmreverter'
+
+Vmreverter::CLI.new.execute!
+
+puts "done."
+exit 0

data/components.LICENSE.puppet_acceptance

@@ -0,0 +1,17 @@
+   puppet-acceptance - Puppet's system level acceptance test harness
+
+   Copyright (C) 2011-2013 Puppet Labs Inc
+
+   Puppet Labs can be contacted at: info@puppetlabs.com
+
+   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.

data/lib/vmreverter/cli.rb

@@ -0,0 +1,50 @@
+module Vmreverter
+  class CLI
+    def initialize
+      @options = Vmreverter::Options.parse_args
+      @logger = Vmreverter::Logger.new(@options)
+      @options[:logger] = @logger
+
+      if not @options[:config] 
+        report_and_raise(@logger, ArgumentError.new("Missing config, specify one (-c or --config)!"), "CLI: initialize") 
+      end
+
+      @logger.debug("Options")
+      @options.each do |opt, val|
+        if val and val != [] 
+          @logger.debug("\t#{opt.to_s}:")
+          if val.kind_of?(Array)
+            val.each do |v|
+              @logger.debug("\t\t#{v.to_s}")
+            end
+          else
+            @logger.debug("\t\t#{val.to_s}")
+          end
+        end
+      end
+
+      @config = Vmreverter::ConfigTester.new(@options[:config], @options)
+
+    end
+
+    def execute!
+            
+      begin
+        trap(:INT) do
+          @logger.warn "Interrupt received; exiting..."
+          exit(1)
+        end
+       
+        begin
+          @vmmanager = Vmreverter::VMManager.new(@config, @options, @logger)
+          @vmmanager.invoke
+          @vmmanager.close_connection
+        rescue => e
+          raise e
+        end 
+
+      end #trap
+    end #execute!
+
+  end
+end

data/lib/vmreverter/config_tester.rb

@@ -0,0 +1,63 @@
+
+
+module Vmreverter
+  # Config was taken by Ruby.
+  class ConfigTester
+
+    attr_accessor :logger
+    def initialize(config_file, options)
+      @options = options
+      @logger = options[:logger]
+      @config = load_file(config_file)
+    end
+
+    def [](key)
+      @config[key]
+    end
+
+    def load_file(config_file)
+      if config_file.is_a? Hash
+        config = config_file
+      else
+        config = YAML.load_file(config_file)
+
+        # Make sure the tag array is present for all hosts
+        config['HOSTS'].each_key do |host|
+          config['HOSTS'][host]['tags'] ||= []
+
+          report_and_raise(@logger, RuntimeError.new("Missing hypervisor: (#{host})"), "ConfigTester::load_file")  unless config['HOSTS'][host].include? "hypervisor" 
+          hypervisor = config['HOSTS'][host]['hypervisor'].downcase 
+          #check to see if this host has a hypervisor 
+          report_and_raise(@logger, RuntimeError.new("Invalid hypervisor: #{hypervisor} (#{host})"), "ConfigTester::load_file") unless Vmreverter::HYPERVISOR_TYPES.include? hypervisor
+          
+          #check to see if this host has a hypervisor 
+          report_and_raise(@logger, RuntimeError.new("Missing snapshot: (#{host})"), "ConfigTester::load_file")  unless config['HOSTS'][host].include? "snapshot"
+
+        end
+        
+      end
+
+      # Merge some useful date into the config hash
+      config['CONFIG'] ||= {}
+
+      config
+    end
+
+
+    # Print out test configuration
+    def dump
+
+      # Access "tags" for each host
+      @config["HOSTS"].each_key do|host|
+        @config["HOSTS"][host]['tags'].each do |tag|
+          @logger.notify "Tags for #{host} #{tag}"
+        end
+      end
+      
+      # Access @config keys/values
+      @config["CONFIG"].each_key do|cfg|
+          @logger.notify "Config Key|Val: #{cfg} #{@config["CONFIG"][cfg].inspect}"
+      end
+    end
+  end
+end

data/lib/vmreverter/hypervisor/aws.rb

@@ -0,0 +1,121 @@
+module Vmreverter 
+  class AWS 
+
+    #AWS support will dynamically create a Security Group for you if you specify ports in the Blimpfile, this means you can easily stand up a machine with specific ports open. 
+    #Blimpy uses a unique hash of the ports to avoid re-creating the Security Groups unless necessary.
+    #Blimpy will import your ~/.ssh/id_rsa.pub or ~/.ssh/id_dsa.pub into a Key Pair in every region that you use in your Blimpfiles.
+    def initialize(blimpy_hosts, options, config)
+      @options = options
+      @config = config
+      @logger = options[:logger]
+      @blimpy_hosts = blimpy_hosts
+      require 'rubygems' unless defined?(Gem)
+      require 'yaml' unless defined?(YAML)
+      begin
+        require 'blimpy'
+      rescue LoadError
+        raise "Unable to load Blimpy, please ensure its installed"
+      end
+      
+      @fleet = Blimpy.fleet do |fleet|
+        @blimpy_hosts.each do |host|
+          #use snapshot provided for this host - This is an AMI! 
+          # host
+          #   ami-size: m1.small
+          #   ami-region: 'us-west-2'
+          #   security-group: 'Clients'
+ 
+          if not host['snapshot']
+            raise "No snapshot/ami provided for AWS provisioning"
+          end
+          
+          @logger.debug "Configuring hypervision AWS for host #{host.name}(#{host['snapshot']}:#{host['amisize']}) "
+
+          fleet.add(:aws) do |ship|
+            ship.name = host.name
+            ship.group = host['security-group']
+            ship.image_id = host['snapshot'] 
+            ship.flavor = host['amisize'] || 'm1.small'
+            ship.region = host['ami-region'] || 'us-west-2'
+            ship.tags = host['tags'] 
+            ship.username = 'root'
+          end #fleet
+          @logger.debug "Configuration completed."
+        end #blimpy_hosts
+      end#fleet
+
+      return self 
+    end #init
+
+    def invoke 
+      if (@config['HOSTS'][name]['launch'] == :on)
+        revert
+      end
+    end
+
+    def close_connection
+      @fleet = nil
+    end
+    
+    private
+
+    def revert
+      @logger.notify "Begin Launching AWS Hosts"
+      
+      # Attempt to start the fleet, we wrap it with some error handling that deals
+      # with generic Fog errors and retrying in case these errors are transient.
+      fleet_retries = 0
+      begin
+        @fleet.start
+      rescue Fog::Errors::Error => ex
+        fleet_retries += 1
+        if fleet_retries <= 3
+          sleep_time = rand(10) + 10
+          @logger.notify("Calling fleet.destroy, sleeping #{sleep_time} seconds and retrying fleet.start due to Fog::Errors::Error (#{ex.message}), retry attempt #{fleet_retries}.")
+          begin
+            timeout(30) do
+              @fleet.destroy
+            end
+          rescue
+          end
+          sleep sleep_time
+          retry
+        else
+          @logger.error("Retried Fog #{fleet_retries} times, giving up and throwing the exception")
+          raise ex
+        end
+      end
+    end
+
+    # https://github.com/rtyler/blimpy/blob/2d2c711bfcb129f5eb0346f08da62e0cfcde7917/lib/blimpy/fleet.rb#L135
+    def power toggle=:on
+      @logger.notify "Power #{toggle} AWS boxes"
+      if (toggle == :off)
+        start = Time.now
+        @fleet.stop
+        @logger.notify "Spent %.2f seconds halting" % (Time.now - start)
+      else (toggle == :on) 
+        start = Time.now
+        @fleet.start
+        @logger.notify "Spent %.2f seconds booting" % (Time.now - start)
+      end
+    end
+
+    def destroy
+      #fleet = Blimpy.fleet do |fleet|
+      #  @blimpy_hosts.each do |host|
+      #    fleet.add(:aws) do |ship|
+      #      ship.name = host.name
+      #    end
+      #  end
+      #end
+
+      @logger.notify "Destroying Blimpy boxes"
+      #fleet.destroy
+      @fleet.destroy
+    end
+
+
+
+  end
+end

data/lib/vmreverter/hypervisor/vsphere.rb

@@ -0,0 +1,96 @@
+# 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 Vsphere
+
+    def initialize(vsphere_hosts, options, config)
+      @options = options
+      @config = config
+      @logger = options[:logger]
+      @vsphere_hosts = vsphere_hosts
+      require 'yaml' unless defined?(YAML)
+      vsphere_credentials = VsphereHelper.load_config options[:auth]
+
+      @logger.notify "Connecting to vSphere at #{vsphere_credentials[:server]}" + " with credentials for #{vsphere_credentials[:user]}"
+
+      @vsphere_helper = VsphereHelper.new( vsphere_credentials )
+
+      #Transpose Hash for @vsphere_vms = {"test-server01" => "gold-image", "test-server02" => "silver-image"}
+      @vsphere_vms = {}
+      @vsphere_hosts.each do |host|
+        @vsphere_vms[host] = config['HOSTS'][host]['snapshot']
+      end
+
+      #Index Hosts Available via rbvmomi
+      vms = @vsphere_helper.find_vms(@vsphere_vms.keys)
+      
+      # Test if host exists and host's snapshot requested exists
+      @vsphere_vms.each_pair do |name, snap|
+        #Find Host in Index
+        report_and_raise(@logger, RuntimeError.new("Couldn't find VM #{name} in vSphere!"), "VSphere::initialize") unless vm = vms[name]
+        #snap ~> config['HOSTS'][vm]['snapshot']
+        report_and_raise(@logger, RuntimeError.new("Could not find snapshot '#{snap}' for VM #{vm.name}!"), "VSphere::initialize")  unless @vsphere_helper.find_snapshot(vm, snap) 
+      end
+
+      return self    
+    end
+
+    def invoke 
+      revert
+    end
+
+    def close_connection
+      @vsphere_helper.close_connection
+    end
+
+    private 
+    
+    def revert
+      @logger.notify "Begin Reverting"
+      @vsphere_vms.each_pair do |name, snap|        
+
+        vm = @vsphere_helper.find_vms(@vsphere_vms.keys)[name]
+        @logger.notify "Reverting #{vm.name} to snapshot '#{snap}'"
+        start = Time.now
+        
+        # This will block for each snapshot...
+        # The code to issue them all and then wait until they are all done sucks
+        snapshot = @vsphere_helper.find_snapshot(vm, snap)
+        snapshot.RevertToSnapshot_Task.wait_for_completion
+
+        time = Time.now - start
+        @logger.notify "Spent %.2f seconds reverting" % time
+        
+        if (@config['HOSTS'][name]['power'] == 'up')
+          host_power_on(vm)
+        elsif (@config['HOSTS'][name]['power'] == 'down')
+          host_power_off(vm)
+        else
+          @logger.notify "VM #{name} defaulting to snapshot '#{snap}' power setting"
+        end
+
+      end
+    end
+
+    def host_power_on(vm)
+        unless vm.runtime.powerState == "poweredOn"
+          @logger.notify "Booting #{vm.name}"
+          start = Time.now
+          vm.PowerOnVM_Task.wait_for_completion
+          @logger.notify "Spent %.2f seconds booting #{vm.name}" % (Time.now - start)
+        end
+    end
+
+    def host_power_off(vm)
+        unless vm.runtime.powerState == "poweredOff"
+          @logger.notify "Shutting down #{vm.name}"
+          start = Time.now
+          vm.PowerOffVM_Task.wait_for_completion
+          @logger.notify "Spent %.2f seconds halting #{vm.name}" % (Time.now - start)
+        end
+    end
+
+    
+
+  end
+end