vmth 0.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1. Initial Release

data/CONFIG.rdoc

@@ -0,0 +1,7 @@
+== Config file format
+
+Here's the format of the test config file. it is a yaml file and specified
+by the '-c' parameter to vmth. It is included with the gem named 'sample_config.yaml'
+
+  :include: sample_config.yaml
+

data/DESCRIPTION

@@ -0,0 +1 @@
+The VMTH (Virtual Machine Test Harness) provides a mechanism to unit-test your infrastructure automation - puppet policies, chef rules, release deployment scripts, etc. It uses features of modern VM monitors (like qemu) to snapshot system state, and then reset that state after each test, so that a series of tests can be performed on a VM instance in rapid succession.

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 Greg Retkowski
+
+   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/Manifest

@@ -0,0 +1,18 @@
+CHANGELOG
+CONFIG.rdoc
+DESCRIPTION
+LICENSE
+Manifest
+QUICKSTART.rdoc
+README.rdoc
+Rakefile
+bin/virb
+bin/vmth
+lib/defaults.yaml
+lib/virb.rb
+lib/vmth.rb
+sample_config.yaml
+test/helpers.rb
+test/test_virb.rb
+test/test_vmth.rb
+vmth.gemspec

data/QUICKSTART.rdoc

@@ -0,0 +1,44 @@
+This is a not-so-quickstart introduction to getting vmth up and running in your environment.
+
+== Setting up system images
+
+Get a copy of one of your system images
+
+One way to do this would be to boot from a rescue CD, then 'dd if=/dev/sda of=/some/other/filesystem/my-system.img'. presumably you'd want your system to have a fairly small harddrive to do this!
+
+If your system image is shrunk down (as we do) you can add space to the end of it via: 'dd if=/dev/zero bs=10240 count=5000000 >>your.img'
+
+Next convert the system image to a qemu compatable cow (copy-on-write) file.
+
+qemu-img convert -f raw linux-img-6.img -O qcow2 linux-img-6-large.cow
+
+== Setting up your 'host' system..
+Make sure you have qemu & kvm installed - and the kernel module loaded. Performance was unacceptably slow when running with the CPU emulated instead of directly accessed via kvm.
+
+== Editing your disk image.
+
+use 'vmth -q -i /your/image/file.cow
+
+This will spit out the qemu command line to launch your image.
+Run that - log into your system and configure it to be ready for vmth to interact with it. Some changes you may want to make are: removing the root password, ensuring sshd will allow root to login w/o a password.. change /etc/hosts if you have to hard-code some of the hosts your system will talk to, etc...
+
+Once you are done enter 'savevm init-test' and quit qemu.
+
+This saves the current state of the VM - so that when the vmth runs the test it doesn't have to boot the vm - it starts from that precise moment.
+
+== Creating the yaml specification for your tests
+
+Next you'll want to edit the test config yaml for your test. You can use the 'sample_config.yaml' as a starting point. The 'prep' steps are completed once before testing starts - the 'applying' applies changes to your system in preparation for a test. The 'testing' runs your unit test script. and the teardown is done after applying and testing has completed. Most commands are passed through ERB, so you can put expansions here.
+
+Put a list of scenarios you want to test into a file, like testable_scenarios.txt. Each scenario should be a single word on its own line.
+
+== Running the test
+sudo bin/vmth -e testable_scenarios.txt -i /data/vms/system-test.cow -p /path/to/my/automation/code -c my_config.yaml -d -o my_config.output.yaml
+
+After your run completes, the vmth will print a report of what passed or failed via the 'applying' and the 'testing' steps. You can use 'virb' to look at your output yaml and understand where tests may have failed.
+
+== Debugging
+
+use 'vmth --console' for debugging; it'll launch the vm, apply all the prep steps, and then leave you at a qemu prompt.. From here you can ssh into the machine and interact with it at will.. and you can always reset via 'loadvm init-test' or 'loadvm test-freeze' to get you back to the start.
+
+

data/README.rdoc

@@ -0,0 +1,37 @@
+=== Introduction
+
+:include: DESCRIPTION
+
+It can be integrated with your continuous integration environment and triggered each time a commit is made to your automation code.
+
+
+=== What it does
+
+It will go through a series of scenarios (a scenario is usualy a service name).  It will run the 'prep' steps, freeze the vm, then run one scenario at a time, and unfreeze after
+each scenario.
+
+== Getting started
+
+See QUICKSTART[link:files/QUICKSTART_rdoc.html] to get started.
+
+== Command-line tools
+
+* vmth[link:files/bin/vmth.html]: vm test harness command-line tool
+* virb[link:files/bin/virb.html]: Interactive vm test debugger...
+
+== Gochas
+
+Took a while to track down a bug where our VM instance was running out of memory and then crashing. It just appeared that qemu just plain exited without error. traced it to the guest having vm.panic_on_oom to 1 - which causes the kernel to panic and exit if we run out of memory.
+
+Here is the Vmth[link:classes/Vmth.html] class documentation.
+
+== Config file format
+
+See sample_config.yaml[link:files/CONFIG_rdoc.html] for the vmth config file format.
+
+== Support
+
+For support or to report bugs open an issue at the gitub issue tracker:
+
+https://github.com/gregretkowski/vmth/issues
+

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('vmth', '0.0.1') do |p|
+  p.description    = File.open(File.dirname(__FILE__+"/DESCRIPTION")).read
+  p.summary        = "A VM test harness for testing operational configurations"
+  p.url            = "http://github.com/gregretkowski/vmth"
+  p.author         = "Greg Retkowski"
+  p.email          = "greg@rage.net"
+  p.ignore_pattern = ["tmp/*", "script/*", "ol/*"]
+  p.rdoc_template  = nil
+  p.rdoc_pattern = /^(lib|bin|tasks|ext)|^README|^CHANGELOG|^TODO|^LICENSE|^QUICKSTART|^CONFIG|^COPYING$/
+#  p.rdoc_template = ""
+  p.development_dependencies = []
+  p.runtime_dependencies = [
+    'formatr',
+    'net-ssh',
+    'net-scp',
+  ]
+
+end

data/bin/virb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby
+
+
+=begin rdoc
+
+This tool helps you to debug and browse through results from the
+VM test harness. Use to examine the output yaml produced by vmth.
+
+It is an extension to irb, so all irb commands work. The loaded
+yaml is stored in global variable $y. To get started use:
+
+load_obj 'filename' 
+
+.. that will load the yaml output into virb.. Then use these
+commands to examine the outout..
+
+p_apply 'scenario' # Shows output of apply step
+
+p_test 'scenario' # Shows output of test step
+
+f_apply 'scenario','filename' # Write out a scenario's output to a file
+
+=end
+
+#--
+# Copyright 2011 Greg Retkowski
+#
+# 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.
+#++
+
+exec "irb -r virb.rb --simple-prompt"

data/bin/vmth

@@ -0,0 +1,232 @@
+#!/usr/bin/ruby
+
+=begin rdoc
+This is the command line tool to invoke the puppet test harness.
+
+  Usage: vmth [options]
+    -s, --service service_name       Test this service
+    -q, --vmm-cmd-line               Just output the vm monitor command line and exit
+    -t, --console                    Prep a vm and allocate it to a user
+    -c, --config-yaml file.yaml      The file used to configure the vmth
+    -d, --debug                      Run in debugging mode
+    -n, --no-vmm                     Run w/o VM management (for dev/debug)
+    -i /path/to/image.cow            Specify the vm disk image file
+        --image-file
+    -y, --yaml                       Output Yaml instead of formatted text
+    -e /path/to/scenarios            Specify the scenarios list file
+        --scenarios-file
+    -o, --output-file output.yaml    Output results to a yaml file
+    -p /path/to/your/source/dir      Path to your source directory
+        --path
+    -h, -?                           Show this message
+
+One example command-line may look like:
+
+    sudo vmth -e testable_services.txt -i /data/greg-test.cow -p /home/greg/puppet -c testpup26.yaml -d -o testpup26.output.yaml
+
+See sample_config.yaml for what the config file specified by '-c' should contain.
+
+The output of the test harness looks something like...
+
+  VM Test Harness Results....
+  Elapsed time to complete testing: 06:08:14
+  ------------------+------------+------------+----------------+
+   Scenario         | Apply      | Test       | Execution Time |
+  ------------------+------------+------------+----------------+
+   0nulltest        |     Passed |     Passed |       00:22:37 |
+   dbserver         |     Passed |     Passed |       00:09:29 |
+   loadbalancer     |     Passed |     Passed |       00:04:04 |
+   webserver        |     Passed |     Passed |       00:04:03 |
+   ...
+
+=end
+
+#--
+# Copyright 2011 Greg Retkowski
+#
+# 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.
+#++
+
+require 'rubygems'
+require 'vmth'
+require 'optparse'
+require 'formatr'
+progname = File.basename($0)
+
+# PARSE COMMAND LINE OPTIONS
+
+options = {
+  :action => "all",
+  :qemu => true,
+  :path => ".",
+  :output => 'text',
+  :debug => false
+}
+op = OptionParser.new do |opts|
+  opts.banner = "Usage: #{progname} [options]"
+  opts.on("-s", "--service service_name", "Test this service") do |s|
+    options[:action] = 'service'
+    options[:services] ||= Array.new()
+    options[:services] << s
+  end
+  opts.on("-q", "--vmm-cmd-line", "Just output the vm monitor command line and exit") do
+    options[:action] = "vmm-command-line"
+  end
+  opts.on("-t", "--console", "Prep a vm and allocate it to a user") do
+    options[:action] = "console"
+  end
+  
+  opts.on("-c", "--config-yaml file.yaml", "The file used to configure the vmth") do |f|
+    options[:config_file] = f
+  end
+  opts.on("-d", "--debug", "Run in debugging mode") do
+    options[:debug] = true
+  end
+  opts.on("-n", "--no-vmm","Run w/o VM management (for dev/debug)") do
+    options[:vmm_enabled] = false
+  end
+  opts.on("-i", "--image-file /path/to/image.cow","Specify the vm disk image file") do |i|
+    options[:image_file] = i
+  end
+  opts.on("-y", "--yaml","Output Yaml instead of formatted text") do
+    options[:out_format] = 'yaml'
+  end
+  opts.on("-e", "--scenarios-file /path/to/scenarios","Specify the scenarios list file") do |e|
+    options[:scenarios_file] = e
+  end
+  opts.on("-o", "--output-file output.yaml","Output results to a yaml file") do |o|
+    options[:out_file] = o
+  end
+  opts.on("-p", "--path /path/to/your/source/dir","Path to your source directory") do |p|
+    options[:source_path] = p
+  end
+  opts.on_tail("-h", "-?", "Show this message") do
+    puts "Runs the VM Test Harness"
+    puts
+    puts opts
+    exit
+  end
+end.order!
+
+# FORMATTING FOR PRETTY OUTPUT
+
+include FormatR
+@top_ex = <<DOT
+VM Test Harness Results....
+Elapsed time to complete testing: @<<<<<<<<<<<<<<<<<<<<<
+s[:total_elapsed]
++------------------+------------+------------+----------------+
+| Scenario         |      Apply |       Test | Execution Time |
++------------------+------------+------------+----------------+
+DOT
+@ex = <<TO
+| @<<<<<<<<<<<<<<<<|@>>>>>>>>>> |@>>>>>>>>>> |@>>>>>>>>>>>>>> |
+s[:name], s[:apply], s[:test], s[:elapsed]
+TO
+@footer_ex = <<DOD
++------------------+------------+------------+----------------+
+DOD
+@body_fmt = Format.new(@top_ex,@ex,@footer_ex)
+@body_fmt.setPageLength(1000)
+
+def pretty_secs(s) #:nodoc:
+  begin
+    h,s=s.divmod(3600)
+    m,s=s.divmod(60)
+    return "%02i:%02i:%02i"%[h,m,s.to_i]
+  rescue
+    return "Unknown"
+  end
+end 
+
+def print_pretty(results) #:nodoc:
+  results['tests'].keys.sort.each do |k|
+    v = results['tests'][k]
+    s = {
+      :name =>  k,
+      :apply => (v['apply']['passed'] ? "Passed" : "FAILED" ),
+      :test => (v['test']['passed'] ? "Passed" : "FAILED" ),
+      :elapsed => (pretty_secs(v['elapsed_time'])),
+      :total_elapsed => (pretty_secs(results['elapsed_time']))
+    }
+    @body_fmt.printFormat(binding)
+  end
+end
+
+# EXECUTE TESTS AND PRINT RESULTS
+
+def err_catcher() #:nodoc:
+  begin
+    yield
+  rescue PTY::ChildExited, Errno::EIO => e
+    @qemu_r.flush rescue nil
+    $stderr.puts "Bad things happened to vmm!"
+    $stderr.puts "#{e.class}: #{e.message}"
+    $stderr.puts "Last output:"
+    $stderr.puts @qemu_r
+    raise e.class, e.message
+  end
+end
+
+@test = Vmth.new(options)
+ 
+
+unless options[:image_file]
+  $stderr.puts "Image file is mandatory"
+  exit 1
+end
+unless options[:config_file]
+  $stderr.puts "Config file is mandatory"
+  exit 1
+end
+
+if options[:action] == "vmm-command-line"
+  puts @test.vmcl
+  exit
+elsif options[:action] == 'console'
+  @test.console
+  exit
+elsif options[:action] == 'service'
+  err_catcher { results = @test.test_services(options[:services]) }
+elsif options[:action] == 'all'
+  err_catcher { results = @test.test }
+end
+results = @test.results
+
+if options[:out_file]
+  File.open(options[:out_file],"w") do |f|
+    f.puts YAML.dump(results)
+  end
+end
+if options[:output] == 'yaml'
+  puts YAML.dump(results)
+elsif options[:output] == 'text'
+  print_pretty(results)
+end
+
+# Handle the exit code.. Exit with the number of 'fails'
+# we have.. That'll indicate to a continuous integration
+# system that it 'failed' if exits != 0.
+def get_exit_code(results) #:nodoc:
+  pass_array = results['tests'].collect do |k,v|
+    v['test']['passed'] and v['apply']['passed']
+  end
+  if pass_array.size == 0
+    return 255
+  end
+  return pass_array.select{|g| g == false}.size
+end
+# remove state file.
+@test.cleanup
+exit get_exit_code(results)
+